Validate External Key

Changed on Nov 6, 2026

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?beta=true

Request

Base URL
https://api.anthropic.com
Auth
none declared
TypeScript
https://skmtc.dev/anthropics/apis/anthropic-api/docs/v1/organizations/external_keys/:external_key_id/validate%3Fbeta=true/post.ts
A function with typed inputs. Its response is checked against the schema.

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

Nov 6, 20267ee042695927 Revision changes
- breaking
  the response's property type changed from no type to object for status
- info
  added the optional property / to the response with the status
- info
  removed discriminator from response property for the response status
- info
  removed from the response property oneOf list for the response status
- info
  added the required property / to the response with the status
- info
  added the required property / to the response with the status
Sep 4, 20264789294140a2 Revision changes
- info
  added the non-success response with the status
- info
  added the non-success response with the status
- info
  added the non-success response with the status
- info
  added the non-success response with the status
- info
  added the non-success response with the status
- info
  added the non-success response with the status
- info
  added the non-success response with the status
- info
  added the non-success response with the status
- info
  added the non-success response with the status
- info
  added the non-success response with the status
- info
  added the non-success response with the status
- info
  added the non-success response with the status
- info
  added the non-success response with the status
- info
  added the non-success response with the status
- info
  added the non-success response with the status
- info
  added the non-success response with the status

Operation history (3 revisions)