Validate External Key

POST/v1/organizations/external_keys/{external_key_id}/validate

Validate an external key config against the customer's KMS.

Anthropic performs an encrypt/decrypt roundtrip against the configured KMS key and waits up to 30 seconds for the result. The response status is success if the roundtrip succeeded, or failure with an error message if it failed or timed out.

Path parameters

external_key_id: string

ID of the External Key.

maxLength2048

Returns

error: string or null

Error message when status is failure. Null otherwise.

status: "failure" or "success"

success — encrypt/decrypt roundtrip succeeded. failure — the roundtrip failed or timed out; see error.

One of the following:

"failure"

"success"

type: "external_key_validation"

defaultexternal_key_validation

Validate External Key

curl https://api.anthropic.com/v1/organizations/external_keys/$EXTERNAL_KEY_ID/validate \
    -X POST \
    -H 'anthropic-version: 2023-06-01' \
    -H "X-Api-Key: $ANTHROPIC_API_KEY"

{
  "error": "error",
  "status": "failure",
  "type": "external_key_validation"
}

Returns Examples

{
  "error": "error",
  "status": "failure",
  "type": "external_key_validation"
}