multi-router.aidocs

API Reference

API Tokens

Reading the metadata of the organization's API keys.

The API tokens endpoints read the organization's API keys: their names, scopes, routers and creators. They never return a key's secret, carry no ETag, and have no writes; keys are created and revoked on the API Keys page. See API Key.

MethodPathDescriptionScope
GET/v1/api-tokensList API keys. Paginated.api_tokens:read
GET/v1/api-tokens/{id}Get one API key.api_tokens:read
FieldType
idstring
The key id, prefixed tok_.
namestring
The key name.
descriptionstring or null
The key description.
key_prefixstring
The start of the key, to recognize it.
enabledboolean
Whether the key works.
expires_atstring or null
When the key expires, or null for never.
scopesarray or null
The scopes, or null for full control.
router_idsarray or null
The routers the key is limited to, or null for every router.
agent_idstring or null
The agent the key belongs to, if any.
created_byobject or null
The person, API key or machine identity that created it.
created_atstring
When the key was created.
CodeStatusMeaning
api_token_not_found404No API key has that id in the organization.
TagsBudgets
Was this helpful?