Update External Key
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
be changed once any workspace references this config, because previously
encrypted data requires the original key identity to decrypt.
Path parameters
Headers
Body
Returns
Errors
Any method can also return the general HTTP errors.
Each code below is the value of error.details.error_code in the response body.
Update External Key
curl https://api.anthropic.com/v1/organizations/external_keys/$EXTERNAL_KEY_ID \
-H 'Content-Type: application/json' \
-H 'anthropic-version: 2026-10-21' \
-H "Authorization: Bearer $ANTHROPIC_API_KEY" \
-d '{}'Response 200
{
"id": "ekey_01SDCCSbTxrXDpWc1phhtcfK",
"attachment": {
"type": "attached"
},
"created_at": "2024-10-30T23:58:27.427722Z",
"display_name": "prod-us-key",
"geo": "us",
"provider_config": {
"kms_arn": "arn:aws:kms:us-east-1:111122223333:key/abcd1234-5678-90ab-cdef-000011112222",
"type": "aws",
"region": "us-east-1",
"role_arn": "arn:aws:iam::111122223333:role/anthropic-cmek"
},
"type": "external_key",
"updated_at": "2024-10-30T23:58:27.427722Z",
"user_profile_id": "uprof_01SDCCSbTxrXDpWc1phhtcfK"
}Returns Examples
Response 200
{
"id": "ekey_01SDCCSbTxrXDpWc1phhtcfK",
"attachment": {
"type": "attached"
},
"created_at": "2024-10-30T23:58:27.427722Z",
"display_name": "prod-us-key",
"geo": "us",
"provider_config": {
"kms_arn": "arn:aws:kms:us-east-1:111122223333:key/abcd1234-5678-90ab-cdef-000011112222",
"type": "aws",
"region": "us-east-1",
"role_arn": "arn:aws:iam::111122223333:role/anthropic-cmek"
},
"type": "external_key",
"updated_at": "2024-10-30T23:58:27.427722Z",
"user_profile_id": "uprof_01SDCCSbTxrXDpWc1phhtcfK"
}