驗證外部金鑰

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 https://api.anthropic.com/v1/organizations/external_keys/$EXTERNAL_KEY_ID/validate \
    -X POST \
    -H 'anthropic-version: 2023-06-01' \
    -H "X-Api-Key: $ANTHROPIC_API_KEY"

Response 200

{
  "error": "error",
  "status": "failure",
  "type": "external_key_validation"
}

Returns Examples

Response 200

{
  "error": "error",
  "status": "failure",
  "type": "external_key_validation"
}