clerk.revoke_api_key
Revoke an API key in a connected Clerk application so it can no longer be used.
Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.
Returns the revoked API key summary.
Cost = 8 tokens.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| api_key_id | Yes | Clerk API key id (ak_...) to retrieve, update, delete, or revoke. | |
| clerk_instance_id | No | Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account. | |
| revocation_reason | No | Optional reason recorded when revoking the API key. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| api_key | No | Revoked Clerk API key from the Backend API. |