Sign in

Get External Key

Retrieve a single external key config in the caller's organization by ID.

get/v1/organizations/external_keys/{external_key_id}?beta=true

Path parameters

external_key_idstring required

ID of the External Key.

ID of the External Key.

Headers

x-api-keystring

Your unique Admin API key for authentication.

This key is required in the header of all Admin API requests, to authenticate your account and access Anthropic's services. Get your Admin API key through the Console.

Your unique Admin API key for authentication.

This key is required in the header of all Admin API requests, to authenticate your account and access Anthropic's services. Get your Admin API key through the Console.

anthropic-versionstring

The version of the Claude API you want to use.

Read more about versioning and our version history here.

The version of the Claude API you want to use.

Read more about versioning and our version history here.

Response

Successful Response

created_atstring date-time required
display_namestring nullable required

Human-friendly display name. Null if none was set.

geostring required

Data residency geo. Selects which regional validator handles this key's encrypt/decrypt roundtrips.

idstring required

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.

type'external_key' required
updated_atstring date-time required

Example response

{
  "created_at": "2024-10-30T23:58:27.427722Z",
  "display_name": "prod-us-key",
  "geo": "us",
  "id": "ekey_01SDCCSbTxrXDpWc1phhtcfK",
  "provider_config": {
    "kms_arn": "arn:aws:kms:us-east-1:111122223333:key/abcd1234-5678-90ab-cdef-000011112222",
    "region": "us-east-1",
    "role_arn": "arn:aws:iam::111122223333:role/anthropic-cmek"
  },
  "updated_at": "2024-10-30T23:58:27.427722Z"
}

Changes