Skip to main content
PATCH

Authorizations

X-API-Key
string
header
required

API key for authentication

Path Parameters

api_key_id
string
required

API key resource ID (ULID, 26 characters)

Pattern: ^[0-9A-Z]{26}$

Body

application/json

Update the status of an API key.

status
enum<string>
required

Current status of the API key.

  • ACTIVE: Key is active and can be used for authentication
  • REVOKED: Key has been permanently revoked (terminal state)
  • SUSPENDED: Key is temporarily disabled and can be reactivated
  • EXPIRED: Key has expired and can be reactivated
Available options:
ACTIVE,
REVOKED,
SUSPENDED,
EXPIRED
Example:

"ACTIVE"

reason
string | null

Reason for the status change (for audit purposes)

Maximum string length: 2000
Example:

"Key compromised, revoking as a precaution"

Response

API key status updated successfully

api_key
object
required

API key resource. Key values are masked except during creation.