v8

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

Credentials

Get

Get detailed information about a tunnel authtoken credential

get/credentials/{id}

Path parameters

idstring required

a resource identifier

Headers

ngrok-versioninteger required

Response

Get detailed information about a tunnel authtoken credential

idstring

unique tunnel credential resource identifier

uristring

URI of the tunnel credential API resource

created_atstring

timestamp when the tunnel credential was created, RFC 3339 format

descriptionstring

human-readable description of who or what will use the credential to authenticate. Optional, max 255 bytes.

metadatastring

arbitrary user-defined machine-readable data of this credential. Optional, max 4096 bytes.

tokenstring

the credential's authtoken that can be used to authenticate an ngrok agent. This value is only available one time, on the API response from credential creation, otherwise it is null.

aclstring[]

optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the bind rule. The bind rule allows the caller to restrict what domains, addresses, and labels the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule bind:example.ngrok.io. Bind rules for domains may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of bind:*.example.com which will allow x.example.com, y.example.com, *.example.com, etc. Bind rules for labels may specify a wildcard key and/or value to match multiple labels. For example, you may specify a rule of bind:*=example which will allow x=example, y=example, etc. A rule of '*' is equivalent to no acl at all and will explicitly permit all actions.

owner_idstring

If supplied at credential creation, ownership will be assigned to the specified User or Service User. Only admins may specify an owner other than themselves. Defaults to the authenticated User or Service User. Accepts one of: User ID, User email, or SCIM User ID.