API keys

Revoke an API key

The key stops working at once, and so do any dashboard sessions created from it. Webhooks created with the key, or from a dashboard session created from it, are switched off (is_active: false, disabled_reason: "api_key_revoked") and stay listed until you turn them back on or delete them. They are switched off before the key is revoked: if that fails, this answers 500 and the key is not revoked, so the same request can be sent again, even with the key itself. The account's last active key cannot be revoked; create a replacement first.

delete/v1/api-keys/{keyId}

Request

  • Base URL: https://api.kawaa.com
  • URL: https://api.kawaa.com/v1/api-keys/{keyId}
  • Auth: one of:
    • API key in header X-Api-Key
    • HTTP bearer

Path parameters

keyIdstring required
Example:key_1a2b3c4d

Response

Revoked.

successunknown required
dataobject required

Changes

No recorded changes to this operation across all 1 revision of this API.