api-keys

DELETE /v1/api-keys/{apiKeyId}

Revoke an API key.

All api-keys endpoints

Authentication

Send an API key as a bearer token. The key must carry the apikeys.manage permission; a key without it is refused with 403, not 404.

This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.

Try it

Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.

curl -X DELETE https://api.zinndigital.com/v1/api-keys/{apiKeyId} \
  -H "Authorization: Bearer zdk_live_…"

Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console

Details

Revokes the key — it stops authenticating immediately and drops out of the list. The revocation is recorded in the audit log. Requires `apikeys.manage`.

Parameters

NameTypeRequiredWhat it is
apiKeyId (path)UuidYesThe API key's id.

Errors this endpoint can return

401 · 403 · 404 · 409