API Keys

List your API keys, create a key limited to some of your projects, for example one per customer project, and revoke one. These endpoints need an account-wide read_write key.

GET/api_keys

Your API keys, newest first, revoked ones included, with name, the visible prefix, scope, project_ids (empty for an account-wide key), last_used_at and revoked_at. Never the secret token. Also available below the Scale plan, so old keys can still be revoked.

Params:
  • page
  • per_pagedefault 20, max 100

POST/api_keys

Create a key limited to the projects in project_ids and owned by the calling key's user. Its secret token is returned only in this response, so store it. The key never sees other projects, and this endpoint never creates an account-wide key. A project you cannot access answers ERR_PROJECT_NOT_FOUND, and past 500 active keys ERR_LIMIT_REACHED until you revoke one. Requires the Scale plan or above.

Body (JSON):
  • namerequired, up to 100 characters
  • project_idsrequired, at least one project id
  • scoperead by default, or read_write

DELETE/api_keys/:id

Revoke one of your keys: it stops working immediately and cannot be restored. Revoking it again changes nothing. Also available below the Scale plan.

Path:
  • :idkey id from GET /api_keys

Returns ERR_NOT_FOUND for a key of another user.