v50

latestOpenAPI 3.1.0Proprietaryraw.githubusercontent.com2026-05-1759238438.1 KB

API Keys

Revoke an API key

Revokes an API key, immediately preventing it from being used for authentication.

post/v1beta/api-keys/{api_key_id}/revoke

Path parameters

api_key_idstring required

API key ID to revoke. Pattern: key_[0-9a-hjkmnp-tv-z]{26}

Request body

reasonstring nullable

Optional reason for revocation (for audit purposes). The revoking user's identity and timestamp are captured in audit logs separately.

Response

Success

Example response

{
  "api_key": {
    "id": "key_01jd4h5mck9gq6zrp8bn2t4w3x",
    "key_prefix": "ffy_prod_01jd4h5...",
    "name": "Production",
    "organization_id": "org_01h2xcejqtf2nbrexx3vqjhp41"
  }
}