Skip to main content
PATCH
Revoke an account API key

Authorizations

Authorization
string
header
required

Send a dashboard session token, an account API key (agt_t), or a command-line credential (afc_) as a Bearer token. Each endpoint lists accepted credential types.

Path Parameters

id
string
required

Resource identifier (version 7 universally unique identifier, or UUID).

Body

application/json

PATCH /v1/api-keys/{id} — the only mutation, and only downward.

active
boolean
required

Must be false. A revoked key is never brought back.

Response

OK

What revoking answers with.

active
boolean
required

Always false — the field is present so a client can write the reply straight into whatever it was holding.

id
string
required

The key's identifier.

revoked_at
string<date-time>
required

When the row records it stopped working.