---
title: "Revoke an API key"
method: DELETE
path: "/v1/api-keys/{keyId}"
tags: ["API keys"]
---

# Revoke an API key

`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

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.

## Path parameters

- `keyId` string, required

## Response `200`

Revoked.

- Envelope: Every successful response is `{ "success": true, "data": … }`.
  - `success` unknown, required
  - `data` object, required

## Other responses

- `400`: The request is malformed, or names a field this endpoint does not accept. Retrying it unchanged will fail identically.
- `401`: No credential, or one that is not accepted. `code` distinguishes `API_KEY_SUSPENDED` (subscription ended; restartable) from `API_KEY_REVOKED`, `SESSION_EXPIRED` and `OAUTH_TOKEN_EXPIRED` (a connected app's one-hour access token lapsed: refresh it and retry, or sign in again if no refresh token was issued or the refresh is refused).
- `403`: Refused, and **the code says which of three problems it is**, and they need different remedies: - `INSUFFICIENT_SCOPE`: the credential is valid but not scoped for this route. With an API key, issue one that carries the scope named in the message. With an OAuth access token, connect the app again asking for that scope as well as the ones it has, unless the message says a connected app can never be given it; then use an API key with every scope the message names, or have the account owner do it in the dashboard. - `PLAN_UPGRADE_REQUIRED`: the account's plan does not include the feature. **No key of any scope reaches it**, so issuing another is wasted work; the remedy is a plan change. Returned by the verification routes for `options.enrich`, and by the finder, the monitors, the audit log, auto-clean and the white-label routes. - `PLAN_LIMIT_EXCEEDED`: the plan includes the feature and the account is at its ceiling (webhook endpoints, team seats, integrations, auto-clean lists). Delete one or upgrade. - `FORBIDDEN`: refused for a reason none of the above covers. `ErrorCode` is an open set, so branch on the code with a default rather than exhaustively.
- `404`: No such resource on this account.
- `429`: Too many requests. When the server knows how long to wait, `Retry-After` says so and `error.retry_after_seconds` carries the same number; the `X-RateLimit-*` headers say where you stand.
- `500`: `INTERNAL_ERROR`: the revocation may not have happened, so **the key may still be active**. Retry, and confirm with `GET /v1/api-keys` that it is gone. Once the key is revoked the answer is `200`, including when some of the rows of the dashboard sessions created from it are left to clean up later: those sessions are refused on their next use either way.
- `default`: Any status this operation does not list. Kawaa's own errors carry the error envelope. The gateway in front of the API can answer any operation with its own bare body (`GatewayError`): a `503` after about 29 seconds, when the request may still have run and been charged, a `413` for a body over about 6 MB, or a `400` for a path with malformed percent-encoding.

---

[API](https://skmtc.dev/kawaa/apis/kawaa-api.md) · [All operations](https://skmtc.dev/kawaa/apis/kawaa-api/llms.txt) · [OpenAPI document](https://skmtc.dev/kawaa/apis/kawaa-api/revisions/d27c9c33f6ba?raw)