Claude Platform Docs

验证外部密钥

$ ant beta:organization:external-keys validate
POST/v1/organizations/external_keys/{external_key_id}/validate

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

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

Parameters
--external-key-id: string⁠Path parameter

ID of the External Key.

maxLength2048
Returns
BetaOrganizationExternalKeyValidateResponse: object{ type: "external_key_validation", error, status }

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

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

type: "external_key_validation"
error: string

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"
验证外部密钥
ant beta:organization:external-keys validate \
  --api-key my-anthropic-api-key \
  --external-key-id external_key_id
Returns Examples
Response 200
{
  "error": "error",
  "status": "failure",
  "type": "external_key_validation"
}