Update Clerk API key

Update an API key in a connected Clerk application.

← All Clerk endpoints · Capability overview

PATCH/v1/clerk/api-keys/{api_key_id}

https://api.vee3.io/v1/clerk/api-keys/{api_key_id}

8 tokens

Update an API key in a connected Clerk application.

Authorization

Send your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

MCP

The same capability is available as an MCP tool on Vee3 hosted MCP.

Tool name

clerk.update_api_key

Parameters7 fields

clerk_instance_idstringOptional

Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

api_key_idstringRequired

Clerk API key id (ak_...) to retrieve, update, delete, or revoke.

claimsobjectOptional

Updated custom claims for tokens minted from this API key.

scopesarrayOptional

Updated permission scopes for the API key.

descriptionstringOptional

Updated description for the API key.

subjectstringOptional

Updated subject (user_... or org_...).

seconds_until_expirationnumberOptional

Updated seconds until expiration from now.

Response17 fields

api_keyobject

16 fields

Updated Clerk API key from the Backend API.

idstring

Clerk API key id (ak_...).

namestring

Human-readable API key name.

subjectstring

Subject the API key is scoped to (user_... or org_...).

key_typestring

API key type (typically "api_key").

descriptionstring

Optional description for the API key.

claimsobject

1 field

Custom claims embedded in tokens minted from this API key.

claim_keystring

A key in the custom claims object.

scopesarrayitems

1 field

Permission scopes granted to this API key.

itemstring

A single scope string.

created_bystring

User id that created the API key, when set.

created_atinteger

Unix timestamp in milliseconds when the API key was created.

updated_atinteger

Unix timestamp in milliseconds when the API key was last updated.

expirationinteger

Unix timestamp in milliseconds when the API key expires, if set.

revokedboolean

Whether the API key has been revoked.

revocation_reasonstring

Reason recorded when the API key was revoked.

secretstring

API key secret value. Treat as high-privilege — do not log.

HTTP errors: clerk_connection_required, clerk_connection_not_found, clerk_connection_invalid, validation_error, unauthorized, payment_required

Example request

Python

import requests

url = "https://api.vee3.io/v1/clerk/api-keys/{api_key_id}"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
payload = {
    "api_key_id": "ak_2abc123"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Updated Clerk API key metadata.

updated_api_key.json

{
  "api_key": {
    "id": "ak_2abc123",
    "name": "server-integration",
    "subject": "user_2abc123",
    "description": "Updated integration key",
    "updated_at": 1710001000000
  }
}