v8

latestOpenAPI 3.0.0raw.githubusercontent.com2026-01-23241216351.5 KB

APIKeys

Create

Create a new API key. The generated API key can be used to authenticate to the ngrok API.

post/api_keys

Headers

ngrok-versioninteger required

Request body

descriptionstring

human-readable description of what uses the API key to authenticate. optional, max 255 bytes.

metadatastring

arbitrary user-defined data of this API key. optional, max 4096 bytes

owner_idstring

If supplied at credential creation, ownership will be assigned to the specified User or Bot. Only admins may specify an owner other than themselves. Defaults to the authenticated User or Bot.

Response

Create a new API key. The generated API key can be used to authenticate to the ngrok API.

idstring

unique API key resource identifier

uristring

URI to the API resource of this API key

descriptionstring

human-readable description of what uses the API key to authenticate. optional, max 255 bytes.

metadatastring

arbitrary user-defined data of this API key. optional, max 4096 bytes

created_atstring

timestamp when the api key was created, RFC 3339 format

tokenstring

the bearer token that can be placed into the Authorization header to authenticate request to the ngrok API. This value is only available one time, on the API response from key creation. Otherwise it is null.

owner_idstring

If supplied at credential creation, ownership will be assigned to the specified User or Bot. Only admins may specify an owner other than themselves. Defaults to the authenticated User or Bot.