Revoke API key
DELETE
/keys/{key_id}
Revoked keys immediately cease to function. Tokens previously issued for this key are rejected. This operation is irreversible.
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ” key_id
required
string format: uuid
API key ID
Responses
Section titled “ Responses ”Revoked
API key metadata (excludes the actual key value).
object
api_key_id
required
Unique key identifier.
string format: uuid
created_at
required
When the key was created.
string format: date-time
expires_at
When the key expires (if set).
string | null format: date-time
name
required
Human-readable name.
string
revoked_at
When the key was revoked (if revoked).
string | null format: date-time
role
required
Role assigned to this key.
string
Example
{ "api_key_id": "b4d2f8a0-1c3e-4f5a-9b6d-7e8f90a1b2c3", "created_at": "2025-01-15T10:30:00Z", "expires_at": "2025-04-15T10:30:00Z", "name": "ci-deploy-key", "revoked_at": null, "role": "member"}Unauthorized
Not found
Already revoked
Server error