Skip to content

users_apikeys_revoke

Revoke an API key immediately.

Tool

users_apikeys_revoke

Revoke an API key immediately.

Revoke an API key immediately. A revoked server key stops authenticating code exchanges on the next request; there is no grace period and no un-revoke.

Behavior

HTTP
DELETE /users/api-keys/:id

Arguments

Name
Type
Required
Description
id
string
•
Id of the key to revoke. Revocation is immediate and final.

Response

Field
Type
Always
Description
id
string
•
Id of the key that was revoked.
revoked
boolean
•
Always true — revocation is immediate and final.

Try it

Revoke an API key immediately.

When to use

Revoke an API key immediately. A revoked server key stops authenticating code exchanges on the next request; there is no grace period and no un-revoke.

Example

Ask your agent something like this:

Revoke an API key immediately.

The agent will invoke users_apikeys_revoke with these arguments:

{
  "id": "<id>"
}

Esc

Start typing to search the docs.

↑↓navigate↵select