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

ID of the External Key.

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

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

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

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"
type: "external_key_validation"
驗證外部金鑰
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"
}