Update API Key

$ ant beta:organization:api-keys update

POST/v1/organizations/api_keys/{api_key_id}

Update API Key

Parameters

--api-key-id: string

ID of the API key.

--name: optional string

Name of the API key.

maxLength500

minLength1

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

Status of the API key.

Returns

beta_api_key: object{ id, created_at, created_by, 8 more }

id: string

ID of the API key.

created_at: string

RFC 3339 datetime string indicating when the API Key was created.

formatdate-time

created_by: object{ id, type }

The ID and type of the actor that created the API key, or null when the creator is not recorded (legacy, workload-identity-federated, or system-created keys).

id: string

ID of the actor that created the object.

type: "service_account" or "user"

Type of the actor that created the object.

One of the following:

"service_account"

"user"

expires_at: string

RFC 3339 datetime string indicating when the API Key expires, or null if it never expires.

formatdate-time

name: string

Name of the API key.

partial_key_hint: string

Partially redacted hint for the API key.

principal: BetaAPIKeyUserActor { type, user_id } or BetaAPIKeyServiceAccountActor { service_account_id, type }

The principal the API key acts as (a User or a Service Account), or null if the API key is not bound to a principal.

One of the following:

beta_api_key_user_actor: object{ type, user_id }

type: "user_actor"

Principal type. Always "user_actor" for a User.

user_id: string

ID of the User the API key acts as.

beta_api_key_service_account_actor: object{ service_account_id, type }

service_account_id: string

ID of the Service Account the API key acts as.

type: "service_account_actor"

Principal type. Always "service_account_actor" for a Service Account.

scope: BetaAPIKeyOrganizationScope { type } or BetaAPIKeyWorkspaceScope { type, workspace_id }

Where the API key belongs: its Workspace ({"type": "workspace", "workspace_id": "wrkspc_..."}, with the Workspace's real ID even when it is the organization's default Workspace), or the organization ({"type": "organization"}) for a principal-bound API key that has no Workspace.

One of the following:

beta_api_key_organization_scope: object{ type }

type: "organization"

Scope type. Always "organization": the API key has no Workspace. Only a principal-bound API key can have this scope.

beta_api_key_workspace_scope: object{ type, workspace_id }

type: "workspace"

Scope type. Always "workspace": the API key belongs to one Workspace.

workspace_id: string

ID of the Workspace the API key belongs to. Unlike the deprecated top-level workspace_id, this is the Workspace's real ID even for the organization's default Workspace.

status: "active" or "archived" or "expired" or "inactive"

Status of the API key.

One of the following:

"active"

"archived"

"expired"

"inactive"

type: "api_key"

Object type.

For API Keys, this is always "api_key".

workspace_id: string⁠Deprecated

Deprecated: use scope instead. ID of the Workspace associated with the API key, or null if the API key belongs to the default Workspace. Also null for a principal-bound API key that has no Workspace; scope tells the two apart.

Use `scope` instead. `workspace_id` is `null` both for an API key in the default Workspace and for a principal-bound API key that has no Workspace.

Update API Key

ant beta:organization:api-keys update \
  --api-key my-anthropic-api-key \
  --api-key-id api_key_id

{
  "id": "apikey_01Rj2N8SVvo6BePZj99NhmiT",
  "created_at": "2024-10-30T23:58:27.427722Z",
  "created_by": {
    "id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
    "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_01WCz1FkmYMm4gnmykNKUu3Q"
  },
  "scope": {
    "type": "workspace",
    "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ"
  },
  "status": "active",
  "type": "api_key",
  "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ"
}

Returns Examples

{
  "id": "apikey_01Rj2N8SVvo6BePZj99NhmiT",
  "created_at": "2024-10-30T23:58:27.427722Z",
  "created_by": {
    "id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
    "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_01WCz1FkmYMm4gnmykNKUu3Q"
  },
  "scope": {
    "type": "workspace",
    "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ"
  },
  "status": "active",
  "type": "api_key",
  "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ"
}