NGngrok
PersonalAccessTokens

Create

Changed on

Create a new access token. The token value is returned only in this response and can't be retrieved later. If you lose it, create a new token.

post/access_tokens

Request

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

Headers

ngrok-versioninteger required

Request body

descriptionstring

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

expires_atstring

optional expiration time for this token. If unset the token does not expire.

scopesstring[]

scopes this token can use, for example ["endpoints:read"]. Each must be a scope you can grant.

Response

Create a new access token. The token value is returned only in this response and can't be retrieved later. If you lose it, create a new token.

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