Sign in
APIKeys

Update

Update attributes of an API key by ID.

patch/api_keys/{id}

Path parameters

idstring required

Headers

ngrok-versioninteger required

Request body

idstring

n/a

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

Response

Update attributes of an API key by ID.

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.

Changes

Changed in 1 of the 9 revisions of this API.1