Claude Platform Docs

Update API Key

$ ant organization:api-keys update
POST/v1/organizations/api_keys/{api_key_id}

Update API Key

Parameters
--api-key-id: string⁠Path parameter

ID of the API key.

--name: optional string

Name of the API key.

minLength1
maxLength500
--status: optional "active" or "archived" or "inactive"

Status of the API key.

One of the following:
"active"
"archived"
"inactive"
Returns
api_key: object{ type: "api_key", id, created_at, 7 more }
Errors

Any method can also return the general HTTP errors.

Each code below is the value of error.details.error_code in the response body.

error code org_api_key_limit_exceededHTTP status 400

The organization has reached its limit of active API keys.

error code workspace_api_key_limit_exceededHTTP status 400

The workspace has reached its limit of active API keys.

error code sandbox_egress_restrictedHTTP status 403

The request came from a Claude sandbox with restricted network access, which is not allowed to make this change. Send it from outside the sandbox, or from a sandbox with unrestricted network access.

Update API Key
ant organization:api-keys update \
  --api-key-id api_key_id
Returns Examples
Response 200
{
  "id": "apikey_01Rj2N8SVvo6BePZj99NhmiT",
  "created_at": "2024-10-30T23:58:27.427722Z",
  "created_by": {
    "id": "user_01WxYzAbCdEfGhJkMnPqRsTu",
    "type": "user"
  },
  "expires_at": "2024-10-30T23:58:27.427722Z",
  "name": "Developer Key",
  "partial_key_hint": "sk-ant-api03-R2D...igAA",
  "principal": {
    "type": "user_actor",
    "user_id": "user_01WxYzAbCdEfGhJkMnPqRsTu"
  },
  "scope": {
    "type": "workspace",
    "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ"
  },
  "status": "active",
  "type": "api_key"
}