Claude Platform Docs

Validate External Key

beta.organization.external_keys.validate(strexternal_key_id) -> ExternalKeyValidateResponse
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.

Parameters
external_key_id: str

ID of the External Key.

maxLength2048
Returns
class ExternalKeyValidateResponse: …

Result of a validation roundtrip against the customer's KMS.

HTTP 200 for both outcomes — the operation completed; status says whether the key works.

error: Optional[str]

Error message when status is failure. Null otherwise.

status: Literal["failure", "success"]

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

One of the following:
"failure"
"success"
type: Literal["external_key_validation"]
defaultexternal_key_validation

Validate External Key

import os
from anthropic import Anthropic

client = Anthropic(
    api_key=os.environ.get(
        "ANTHROPIC_API_KEY"
    ),  # This is the default and can be omitted
)
response = client.beta.organization.external_keys.validate(
    "external_key_id",
)
print(response.error)
{
  "error": "error",
  "status": "failure",
  "type": "external_key_validation"
}
Returns Examples
{
  "error": "error",
  "status": "failure",
  "type": "external_key_validation"
}