Get External Key
api/admin/external_keys/retrieve
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/retrieve Changed · +27 / -28 lines
# Get External Key ## Path parameters ## Returns ## Example ### Response (200) ## Get External Key ### Path Parameters ### Returns ### Example #### Response
---- -title: Get External Key -url: https://platform.claude.com/docs/en/api/admin/external_keys/retrieve ---- +# Get External Key -## Get External Key +**GET** `/v1/organizations/external_keys/{external_key_id}` -**get** `/v1/organizations/external_keys/{external_key_id}` - Retrieve a single external key config in the caller's organization by ID. -### Path Parameters +## Path parameters - `external_key_id: string` ID of the External Key. -### Returns + maxLength: 2048 +## 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.
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.
- `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`
- `type: "gcp"` - - `"gcp"` + - `Azure object` - - `Azure object { key_name, tenant_id, type, 2 more }` - - `key_name: string` Name of the key within the vault.
- `type: "azure"` - - `"azure"` - - `vault_uri: string` Key Vault data-plane URI — https://<vault-name>.vault.azure.net or https://<hsm-name>.managedhsm.azure.net.
- `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 'anthropic-version: 2023-06-01' \ -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN" ``` -#### Response +### Response (200) ```json {