Sign in
api-keys

Get a specific API key by ID

Returns metadata for a single API key by its ID.

get/api/v1/api-keys/{id}

Path parameters

idstring required

ID of the API key to retrieve

Response

OK response.

idstring required

Unique identifier for the API key

namestring required

User-friendly name for the API key

descriptionstring

Optional description providing context about the key's purpose

usernamestring

Username that owns this API key

groupsstring[]

User's groups at creation time (immutable snapshot for authorization)

creationDatestring date-time required

When the API key was created

expirationDatestring date-time

When the API key expires (empty for permanent keys)

status'active' | 'revoked' | 'expired' required

Current status of the API key

lastUsedAtstring date-time

When the API key was last used for validation

subscriptionstring

Name of the subscription associated with this API key

Example response

{
  "subscription": "premium-team-sub"
}

Changes

Changed in 3 of the 31 revisions of this API.12