Skip to navigation
Product SearchKeys

Revoke Key

Revoke a key at once, with every key it created. Takes a write key for every index. A key can’t revoke itself (409 KEY_IS_CALLER).

Authentication

AuthorizationBearer

A write key, issued by Captain. Server side only. Sent as Authorization: Bearer <key>.

Path parameters

key_idstringRequired

Headers

Idempotency-KeystringOptional<=255 characters

Replays within 24 hours return the stored response (header Idempotent-Replayed: true). The same key on a different request answers 422. A concurrent duplicate answers 409. Failed requests do not keep the key.

Query parameters

cascadeenumOptionalDefaults to created

created (default): also revoke every key this key created, and the keys those created, recursively. none: revoke only this key

Allowed values:

Response

revoked