Sign-up and API keys are open. Paid top-ups open soon.What changed

API reference, Console keys

Revoke an API key

View as Markdown

DELETE/v1/console/keys/{key_id}operation id revokeKey

Revocation reaches every gateway replica within one second. Revoking an already revoked key also answers 204.

Authentication. Console session cookie (__Host-dex_session). State-changing routes also need the x-dex-csrf header.

Parameters

key_idpath · KeyIdrequired

pattern ^key_[0-9A-HJKMNP-TV-Z]{26}$

x-dex-csrfheader · stringrequired

The csrf_token returned by createSession. Required on every state-changing console route.

32 to 64 characters

Responses

204Key revoked.

Headers: x-request-id

401Missing, unknown, revoked or expired credentials.

Headers: x-request-id, x-client-request-id

Error envelope. See Errors for every type and code.

403The credentials are valid but not allowed to do this (missing scope, suspended account or failed CSRF check).

Headers: x-request-id, x-client-request-id

Error envelope. See Errors for every type and code.

404The model, key or route does not exist, or the model version is retired.

Headers: x-request-id, x-client-request-id

Error envelope. See Errors for every type and code.

500An unexpected error. Any charge was refunded. Retry with the same idempotency key.

Headers: x-request-id, x-client-request-id

Error envelope. See Errors for every type and code.

503maintenance: the console's database, sign-in or payments are unavailable for a moment. Retry after retry-after. Nothing was changed.

Headers: x-request-id, retry-after

Error envelope. See Errors for every type and code.