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

# Update API Key

`BetaApiKey beta().organization().apiKeys().update(params = ApiKeyUpdateParams.none(), requestOptions = RequestOptions.none())`

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

Update API Key

## Parameters

- `ApiKeyUpdateParams params`

  - `Optional<String> apiKeyId` (path parameter)

    ID of the API key.

  - `Optional<String> name`

    Name of the API key.

    minLength: 1, maxLength: 500

  - `Optional<Status> status`

    Status of the API key.

    - `ACTIVE("active")`

    - `ARCHIVED("archived")`

    - `INACTIVE("inactive")`

## Returns

- `class BetaApiKey`

  - `JsonValue type = "api_key"`

    Object type.

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

  - `String id`

    ID of the API key.

  - `LocalDateTime createdAt`

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

    format: date-time

  - `Optional<BetaApiKeyCreatedBy> createdBy`

    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 type`

      Type of the actor that created the object.

      - `SERVICE_ACCOUNT("service_account")`

      - `USER("user")`

    - `String id`

      ID of the actor that created the object.

  - `Optional<LocalDateTime> expiresAt`

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

    format: date-time

  - `String name`

    Name of the API key.

  - `Optional<String> partialKeyHint`

    Partially redacted hint for the API key.

  - `Optional<Principal> principal`

    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 BetaApiKeyUserActor`

      - `JsonValue type = "user_actor"`

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

      - `String userId`

        ID of the User the API key acts as.

    - `class BetaApiKeyServiceAccountActor`

      - `JsonValue type = "service_account_actor"`

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

      - `String serviceAccountId`

        ID of the Service Account the API key acts as.

  - `Scope scope`

    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 BetaApiKeyOrganizationScope`

      - `JsonValue type = "organization"`

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

    - `class BetaApiKeyWorkspaceScope`

      - `JsonValue type = "workspace"`

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

      - `String workspaceId`

        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 status`

    Status of the API key.

    - `ACTIVE("active")`

    - `ARCHIVED("archived")`

    - `EXPIRED("expired")`

    - `INACTIVE("inactive")`

  - `Optional<String> workspaceId`

    **Deprecated**: 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.

    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.

## Example

```java
package com.anthropic.example;

import com.anthropic.client.AnthropicClient;
import com.anthropic.client.okhttp.AnthropicOkHttpClient;
import com.anthropic.models.beta.organization.apikeys.ApiKeyUpdateParams;
import com.anthropic.models.beta.organization.apikeys.BetaApiKey;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        AnthropicClient client = AnthropicOkHttpClient.fromEnv();

        BetaApiKey betaApiKey = client.beta().organization().apiKeys().update("api_key_id");
    }
}
```

### 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"
}
```