NGngrok
PersonalAccessTokens

Update

Changed on

Update the description or scopes of an access token by ID.

patch/access_tokens/{id}

Request

  • Base URL
    https://api.ngrok.com
  • URL
    https://api.ngrok.com/access_tokens/{id}
  • Auth
    HTTP bearer

Path parameters

idstring required

unique identifier of the access token to update

Headers

ngrok-versioninteger required

Request body

idstring

unique identifier of the access token to update

descriptionstring

human-readable description of this token. Optional, max 255 bytes.

scopesstring[]

replaces the token's scopes. Omit to keep them.

Response

Update the description or scopes of an access token by ID.

idstring

unique identifier of the access token

uristring

URI of this access token API resource

descriptionstring

human-readable description of this token

tokenstring

opaque bearer token secret. Only present in the Create response.

created_atstring

timestamp when the token was created, RFC 3339 format

expires_atstring

optional expiration time, RFC 3339 format. Omitted if the token does not expire.

revoked_atstring

optional timestamp when the token was revoked, RFC 3339 format. Omitted if not revoked.

scopesstring[]

scopes this token was granted. Effective access is also limited by the owner's current role.

Changes