latestOpenAPI 3.0.32026-08-20146131.7 MB

672b1916ba61

API Keys

Deactivate API key

Deactivates (soft deletes) an API key and invalidates it immediately.

delete/v1/api-keys/{keyId}

Path parameters

keyIdstring required

API key identifier.

Example:key_example

API key identifier.

Headers

x-project-idstring

Selects the active project for this request. Required for session/dashboard callers. Ignored when authenticating with an API key, whose scope is fixed to the key's project.

Example:prj_example

Selects the active project for this request. Required for session/dashboard callers. Ignored when authenticating with an API key, whose scope is fixed to the key's project.

Request body

confirmationstring required

Type the exact API key name to confirm deletion.

Example request

{
  "confirmation": "Primary Key"
}

Response

API key revoked

Example response

{
  "data": {
    "revokedAt": "2025-01-10T12:00:00.000Z"
  },
  "meta": {
    "requestId": "req_example",
    "timestamp": "2025-01-01T00:00:00.000Z"
  }
}