`list_api_keys`

Lists the API keys of a project in id order, at most 100 per call, revoked and expired ones included.

Call it: to find a key’s id before revoking it, or to review who has access.
Needs: an admin key with project_id, or a project key with scope keys (its own project; the argument is ignored).
Returns: items (id, name, prefix, scopes, dates; never a key string) and next_cursor: pass it as cursor for the next page; null on the last page. The same as GET /api/v1/projects/{project_id}/keys.

Arguments

object
cursorstring | null

next_cursor of the previous page; leave it out for the first.
limitinteger · int64 | null

Page size, 1 to 100; default 50.

1–100
project_idstring · uuid | null

The project whose keys to list. An admin key must pass it; a project key’s own project is used and this is ignored.

No other arguments are accepted.

The result comes back as structuredContent, with the same JSON as a text block.

object · all fields required
itemsarray of ApiKey

In id order; revoked and expired keys included.
10 fields
- ApiKey object · all fields required
- created_atstring · date-time
- expires_atstring · date-time | null
  
  null: never.
- idstring · uuid
  
  What revoking the key takes.
- kindKeyKind
  
  The kind of an API key.
  
  admin Everything, projects and admin keys included.
  
  project One project, within its scopes.
- last_used_atstring · date-time | null
  
  When the key was last used; null: not recorded yet.
- namestring
- prefixstring
  
  The public part of the key string, pw_<adm|prj>_<prefix>_...: how to tell which key a client holds.
- project_idstring · uuid | null
  
  The key’s project; null for an admin key.
- revoked_atstring · date-time | null
  
  When the key was revoked; null while it is not.
- scopesarray of KeyScope
  
  What the key may do; every scope for an admin key.
next_cursorstring | null

Pass as cursor for the next page; null on the last page.

An API key, without its secret (list_api_keys, list_admin_keys).

object · all fields required
created_atstring · date-time
expires_atstring · date-time | null

null: never.
idstring · uuid

What revoking the key takes.
kindKeyKind

The kind of an API key.

admin Everything, projects and admin keys included.

project One project, within its scopes.
last_used_atstring · date-time | null

When the key was last used; null: not recorded yet.
namestring
prefixstring

The public part of the key string, pw_<adm|prj>_<prefix>_...: how to tell which key a client holds.
project_idstring · uuid | null

The key’s project; null for an admin key.
revoked_atstring · date-time | null

When the key was revoked; null while it is not.
scopesarray of KeyScope

What the key may do; every scope for an admin key.

The kind of an API key.

string · enum

admin Everything, projects and admin keys included.

project One project, within its scopes.

A right of a project key. An admin key has all of them.

string · enum

A failed call answers isError: true with a code from the same table as the HTTP API, and detail. How tools report errors