验证外部密钥

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

针对客户的 KMS 验证外部密钥配置。

Anthropic 会针对所配置的 KMS 密钥执行一次加密/解密往返，并最多等待 30 秒以获取结果。如果往返成功，响应状态为 success；如果失败或超时，则为 failure 并附带错误消息。

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

验证外部密钥

cURL

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_AUTH_TOKEN"

Response 200

{
  "error": null,
  "status": "success",
  "type": "external_key_validation"
}

Returns Examples

Response 200

{
  "error": null,
  "status": "success",
  "type": "external_key_validation"
}