Sign in

v27

latestOpenAPI 3.0.3Apache 2.0raw.githubusercontent.com2026-08-01304498.9 KB
api-keys

Revoke a specific API key

Revokes a specific API key by changing its status to 'revoked'. The key will no longer be valid for authentication but remains visible in API key lists for audit purposes.

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

Path parameters

idstring required

ID of the API key to revoke

Response

OK. Key successfully revoked.

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"
}