Validate External Key
api/admin/external_keys/validate
Nearest release: v2.1.245, published an hour after this site recorded the change. Shown because the two are within 24 hours of each other. Nothing here says the release caused the edit.
api/admin/external_keys/validate Changed · +10 / -13 lines
# Validate External Key ## Path parameters ## Returns ## Example ### Response (200) ## Validate External Key ### Path Parameters ### Returns ### Example #### Response
---- -title: Validate External Key -url: https://platform.claude.com/docs/en/api/admin/external_keys/validate ---- +# Validate External Key -## Validate External Key +**POST** `/v1/organizations/external_keys/{external_key_id}/validate` -**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
`success` if the roundtrip succeeded, or `failure` with an error message if it failed or timed out. -### Path Parameters +## Path parameters - `external_key_id: string` ID of the External Key. -### Returns + maxLength: 2048 +## Returns + - `error: string or null` Error message when status is `failure`. Null otherwise.
- `type: "external_key_validation"` - - `"external_key_validation"` + default: external_key_validation -### Example +## Example -```http +```bash curl https://api.anthropic.com/v1/organizations/external_keys/$EXTERNAL_KEY_ID/validate \ -X POST \ -H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN" ``` -#### Response +### Response (200) ```json {