List platform API keys

GET/v1/api-keys

List platform API keys.

Returns the organization's management keys (never the secret, only key_hint), revoked ones included. With workspace_id: the keys scoped to that workspace plus the organization-scoped keys, which also act in it. Not paginated.

With workspace_id, requires access to that workspace: an organization owner or admin, a member of the workspace, an organization-scoped va_ key with the admin role, or a va_ key scoped to the workspace. Without it, requires an organization owner or admin, or an organization-scoped va_ key with the admin role.

Authorization

AuthorizationBearer va_
A platform API key (va_...), created under Settings > API keys. Scoped to an organization or one workspace, with an admin or member role. Used by the management API.

Query parameters

organizationstringrequired
the organization's slug
workspace_idstring<uuid>
a workspace id (UUID) to limit the list to the keys that act in that workspace

Responses

200application/json

keysobject[]
The keys, revoked ones included; the list is not paginated.
Child attributes
- idstring<uuid>
  The key's id (UUID), used to revoke it.
- namestring
  The key's name, for people to recognise it.
- organizationstring
  The slug of the organization the key belongs to.
- workspace_idstring<uuid>
  The workspace (UUID) a workspace-scoped key is limited to; absent for an org-scoped key.
- scopeenum<string>
  org: the key acts across the whole organization. workspace: it acts only on workspace_id.
  One of "org", "workspace"
- roleenum<string>
  What the key may do: admin or member, with the same rights as a person with that role in its scope.
  One of "admin", "manager", "member"
- key_hintstring
  The key's last four characters, to tell keys apart.
- expires_atstring<date-time>
  When the key stops working (ISO 8601 date-time); absent when it does not expire.
- last_used_atstring<date-time>
  When the key last authenticated a request (ISO 8601 date-time); absent if it never has.
- created_bystring
  The user id of the person who created the key.
- statusenum<string>
  ACTIVE, or REVOKED once revoked; a revoked key is refused.
  One of "ACTIVE", "REVOKED"
- created_atstring<date-time>
  When the key was created (ISO 8601 date-time).
totalinteger<int32>
The number of entries in keys.

VectorAxis is built by GK Labs, a member of NVIDIA Inception.