Sign in

v1

latestOpenAPI 3.1.0raw.githubusercontent.com2026-06-25173140700.7 KB
ApiKey

Revoke an API key

Deactivate an API key so it can no longer authenticate requests.

patch/api/key/revoke/{api_key_id}

Path parameters

api_key_idinteger required

ID of the API key to revoke.

ID of the API key to revoke.

Query parameters

cookie_namestring nullable

Response

Successful Response

idinteger

Primary key for api keys

namestring nullable

Name for the key to be created. Max 100 characters.

descriptionstring nullable

Description of the key.

key_idstring required

Public part of the key

environmentstring

Environment where the key is used.

hashed_secretstring required

hashed api key

activeboolean

Whether the API key is currently active.

versionstring

Version of the API key for rotation purposes.

creator_user_idinteger required

ID of the user who created the key.

created_atstring date-time

Timestamp when the key was created.

last_used_atstring date-time

Timestamp when the API key was last used.

expires_atstring date-time

Timestamp when the API key expires.

Example response

{
  "active": true,
  "last_used_at": "2026-06-23T12:00:00Z",
  "expires_at": "2027-06-23T12:00:00Z"
}