ANanthropics

Validate External Key

Changed on

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.

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

Request

  • Base URL
    https://api.anthropic.com
  • Auth
    none declared

Path parameters

external_key_idstring required

ID of the External Key.

Headers

anthropic-versionstring

The version of the Claude API you want to use.

Read more about versioning and our version history here.

Response

Successful Response

errorstring nullable required

Error message when status is failure. Null otherwise.

status'failure' | 'success' required

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

type'external_key_validation' required

Changes