One change

Update External Key

api/admin/external_keys/update

25 Aug 2026 03:37 UTC first seen 14 Aug 2026 The page's own history The capture it came from

Nearest release: v2.1.245, published an hour after this site recorded the change. Shown because the two are within 24 hours of each other. Nothing here says the release caused the edit.

api/admin/external_keys/update Changed · +41 / -44 lines

# Update External Key ## Path parameters ## Body parameters ## Returns ## Example ### Response (200) ## Update External Key ### Path Parameters ### Body Parameters ### Returns ### Example #### Response

from line 1

----
-title: Update External Key
-url: https://platform.claude.com/docs/en/api/admin/external_keys/update
----
+# Update External Key
 
-## Update External Key
+**POST** `/v1/organizations/external_keys/{external_key_id}`
 
-**post** `/v1/organizations/external_keys/{external_key_id}`
-
 Partially update an external key config. Omitted fields are left unchanged.
 
 `display_name` is always editable. `geo` and `provider_config` cannot

from line 8

 be changed once any workspace references this config, because previously
 encrypted data requires the original key identity to decrypt.
 
-### Path Parameters
+## Path parameters
 
 - `external_key_id: string`
 
   ID of the External Key.
 
-### Body Parameters
+  maxLength: 2048
 
+## Body parameters
+
 - `display_name: optional string or null`
 
   Human-friendly display name.
 
+  maxLength: 255, minLength: 1
+
 - `geo: optional "us" or null`
 
   Data residency geo. Only `us` is supported.
 
-  - `"us"`
+- `provider_config: optional object or object or object or null`
 
-- `provider_config: optional object { kms_arn, type, region, role_arn }  or object { key_name, type }  or object { key_name, tenant_id, type, 2 more }  or null`
-
   KMS provider identity and auth coordinates.
 
-  - `Aws object { kms_arn, type, region, role_arn }`
+  - `Aws object`
 
     - `kms_arn: string`
 
       Full ARN of the AWS KMS key.
 
+      maxLength: 2048
+
     - `type: "aws"`
 
-      - `"aws"`
-
     - `region: optional string or null`
 
       AWS region. Derived from kms_arn if omitted.

from line 48

 
     - `role_arn: optional string or null`
 
+      **Deprecated**
+
       IAM role ARN. Deprecated — Anthropic reaches the KMS key via a managed intermediate role; this field is ignored.
 
-  - `Gcp object { key_name, type }`
+  - `Gcp object`
 
     - `key_name: string`

from line 60

 
     - `type: "gcp"`
 
-      - `"gcp"`
+  - `Azure object`
 
-  - `Azure object { key_name, tenant_id, type, 2 more }`
-
     Azure Key Vault provider configuration.
 
     - `key_name: string`

from line 74

 
     - `type: "azure"`
 
-      - `"azure"`
-
     - `vault_uri: string`
 
       Key Vault data-plane URI — https://<vault-name>.vault.azure.net or https://<hsm-name>.managedhsm.azure.net.

from line 82

 
       Azure AD application (client) ID. Omit to use Anthropic's multitenant app. Provide only if using a single-tenant app registration in the customer's directory.
 
-### Returns
+## Returns
 
 - `id: string`
 
   Identifier of the external key config. A tagged ID prefixed `ekey_`, or — for organizations on the Claude Platform on AWS — the AWS KMS key ARN.
 
-- `attachment: object { type }  or object { type }`
+- `attachment: object or object`
 
   Whether any workspace uses this config to encrypt its data — counting live and archived workspaces (an archived workspace's data remains encrypted under the config), excluding deleted ones. Only an attached config is used by the encryption path; an `unattached` config is inert and can be deleted.
 
-  - `Attached object { type }`
+  - `Attached object`
 
     - `type: "attached"`
 
-      - `"attached"`
+      default: attached
 
-  - `Unattached object { type }`
+  - `Unattached object`
 
     - `type: "unattached"`
 
-      - `"unattached"`
+      default: unattached
 
 - `created_at: string`
 
+  format: date-time
+
 - `display_name: string or null`
 
   Human-friendly display name. Null if none was set.

from line 116

 
   Data residency geo. Selects which regional validator handles this key's encrypt/decrypt roundtrips.
 
-- `provider_config: object { kms_arn, type, region, role_arn }  or object { key_name, type }  or object { key_name, tenant_id, type, 2 more }`
+- `provider_config: object or object or object`
 
   KMS provider identity and auth coordinates.
 
-  - `Aws object { kms_arn, type, region, role_arn }`
+  - `Aws object`
 
     - `kms_arn: string`
 
       Full ARN of the AWS KMS key.
 
+      maxLength: 2048
+
     - `type: "aws"`
 
-      - `"aws"`
-
     - `region: optional string or null`
 
       AWS region. Derived from kms_arn if omitted.

from line 136

 
     - `role_arn: optional string or null`
 
+      **Deprecated**
+
       IAM role ARN. Deprecated — Anthropic reaches the KMS key via a managed intermediate role; this field is ignored.
 
-  - `Gcp object { key_name, type }`
+  - `Gcp object`
 
     - `key_name: string`

from line 148

 
     - `type: "gcp"`
 
-      - `"gcp"`
+  - `Azure object`
 
-  - `Azure object { key_name, tenant_id, type, 2 more }`
-
     - `key_name: string`
 
       Name of the key within the vault.

from line 160

 
     - `type: "azure"`
 
-      - `"azure"`
-
     - `vault_uri: string`
 
       Key Vault data-plane URI — https://<vault-name>.vault.azure.net or https://<hsm-name>.managedhsm.azure.net.

from line 170

 
 - `type: "external_key"`
 
-  - `"external_key"`
+  default: external_key
 
 - `updated_at: string`
 
-### Example
+  format: date-time
 
-```http
+## Example
+
+```bash
 curl https://api.anthropic.com/v1/organizations/external_keys/$EXTERNAL_KEY_ID \
     -H 'Content-Type: application/json' \
     -H 'anthropic-version: 2023-06-01' \

from line 186

     -d '{}'
 ```
 
-#### Response
+### Response (200)
 
 ```json
 {