Sign in
api-keys

Revoke My Api Key

Revoke one of the caller's own keys.

Ownership is enforced in the UPDATE predicate, not by a preceding read — someone else's key comes back as a 404, the same as an id that was never issued.

post/api/v1/api-keys/{api_key_id}/revoke

Path parameters

api_key_idinteger required

Headers

authorizationstring nullable
X-API-Keystring nullable

Response

Successful Response

idinteger required
namestring required
user_idinteger required
user_namestring nullable
user_emailstring nullable
key_prefixstring required
expires_atstring date-time required
last_used_atstring date-time nullable
revoked_atstring date-time nullable
status'active' | 'revoked' | 'expired' required
created_byinteger nullable
created_atstring date-time required

Changes

Changed in 1 of the 5 revisions of this API.1