Skip to main content
PATCH

Authentication

Requires an API key in the Authorization header.

Request

string
required
The key’s database id, as returned by List API keys. Not the key_prefix.
string
required
The action to perform. One of disable or enable.

Disable a key

Re-enable a key

Response

Disabling is reversible - re-enable the same key with action=enable. A disabled key immediately returns 401 on any request.
Known issue: action=enable can also re-enable a key that was soft-revoked. Permanently delete a compromised key instead of relying on revocation.

Permissions

readonly members get 403. A tech member can only toggle their own keys; only a workspace admin can toggle another member’s key. A key that is out of your scope returns 404, the same as an unknown id.

Errors

Errors return the shared envelope with success, result.code, message, and request_id. A legacy error key is included alongside it.