API keys
Revoke an API key
Deactivates a key immediately. A key cannot revoke itself.
Required permission: `connections:write`
DELETE
/v1/api-keys/{id}connections:writeRequest
Authorization
Send your API key as a Bearer token in the Authorization header.
Path parameters
idstringrequiredAPI key id.
Response
Returns 200.
revokedbooleanrequiredidstringrequiredErrors
Failures use the standard error format.
| Status | Code | When it happens |
|---|---|---|
| 400 | invalid_request | The request body or query string failed validation. The message names the offending field. |
| 401 | invalid_api_key | The key does not exist, was revoked, or is malformed. Keys start with cdyn_live_. |
| 404 | not_found | The resource does not exist inside the resolved profile. |
| 429 | rate_limit_exceeded | Too many requests for this key. Honour the Retry-After header before retrying. |
| 500 | internal_error | Something failed on our side. Retry with the same Idempotency-Key; report the requestId if it persists. |