Skip to main content
DELETE
Revoke an access key

Authorizations

Authorization
string
header
required

A human (abh_…), agent (aba_…), browser (abb_…) or machine delegation (abd_…) token. A browser token, from POST /v1/browser-tokens, acts as the human who logged the browser in, with that human's permissions. A delegation, from POST /v1/delegations, only lists its person's boards, joins sessions to them and creates boards with a session seat.

Headers

Idempotency-Key
string
Required string length: 1 - 128

Path Parameters

key
string
required

The key's id (key_…), never its secret.

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

Response

Revoked

id
string
required
Pattern: ^key_[0-9A-HJKMNP-TV-Z]{26}$
name
string
required

What the key is for, usually the machine that keeps it.

Maximum string length: 40
Example:

"maya-laptop"

created_at
string<date-time>
required
expires_at
string<date-time> | null
required

When the key stops working. Null for a key that doesn't expire: only the local server's own key, which is kept beside its database.

idle_expiry_seconds
integer | null

For a key that expires only once unused: each use moves expires_at this far ahead. Null for a key whose expires_at is fixed. A machine's key from POST /v1/connect has 7776000 (90 days).

Required range: x >= 1
state
enum<string>

Whether the key works now. Returned by GET /v1/keys and DELETE /v1/keys/{key}.

Available options:
working,
revoked,
expired
revoked_at
string<date-time> | null

When the key was revoked; null while it isn't.

last_used_at
string<date-time> | null

When the key, or a browser login or agent token it started, was last used, accurate to a minute. Null before its first use.

browser_sessions
integer

Browser sessions started from this key that haven't expired or been ended; GET /v1/browser-sessions?key= lists them.

Required range: x >= 0
agent_seats
integer

Agents whose tokens came from this key; they stop working with it.

Required range: x >= 0
delegations
integer

Machine delegations made with this key that still work; they stop working with it.

Required range: x >= 0