---
title: Update API Key
url: https://platform.claude.com/docs/en/api/ruby/organization/api_keys/update
---

# Update API Key

`organization.api_keys.update(api_key_id, **kwargs) -> APIKey`

**POST** `/v1/organizations/api_keys/{api_key_id}`

Update API Key

## Parameters

- `api_key_id: String` (path parameter)

  ID of the API key.

- `name: String`

  Name of the API key.

  minLength: 1, maxLength: 500

- `status: :active | :archived | :inactive`

  Status of the API key.

  - `:active`

  - `:archived`

  - `:inactive`

## Returns

- `class APIKey`

  - `type: :api_key`

    Object type.

    For API Keys, this is always `"api_key"`.

  - `id: String`

    ID of the API key.

  - `created_at: Time`

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

    format: date-time

  - `created_by: APIKeyCreatedBy`

    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).

    - `type: :service_account | :user`

      Type of the actor that created the object.

      - `:service_account`

      - `:user`

    - `id: String`

      ID of the actor that created the object.

  - `expires_at: Time`

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

    format: date-time

  - `name: String`

    Name of the API key.

  - `partial_key_hint: String`

    Partially redacted hint for the API key.

  - `principal: APIKeyUserActor | APIKeyServiceAccountActor`

    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.

    - `class APIKeyUserActor`

      - `type: :user_actor`

        Principal type. Always `"user_actor"` for a User.

      - `user_id: String`

        ID of the User the API key acts as.

    - `class APIKeyServiceAccountActor`

      - `type: :service_account_actor`

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

      - `service_account_id: String`

        ID of the Service Account the API key acts as.

  - `scope: APIKeyOrganizationScope | APIKeyWorkspaceScope`

    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.

    - `class APIKeyOrganizationScope`

      - `type: :organization`

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

    - `class APIKeyWorkspaceScope`

      - `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 | :archived | :expired | :inactive`

    Status of the API key.

    - `:active`

    - `:archived`

    - `:expired`

    - `:inactive`

## Example

```ruby
require "anthropic"

anthropic = Anthropic::Client.new(api_key: "my-anthropic-api-key")

api_key = anthropic.organization.api_keys.update("api_key_id")

puts(api_key)
```

### Response (200)

```json
{
  "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"
}
```