驗證外部金鑰

beta.organization.external_keys.validate(external_key_id) -> ExternalKeyValidateResponse

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

針對客戶的 KMS 驗證外部金鑰設定。

Anthropic 會對設定的 KMS 金鑰執行一次加密/解密往返，並最多等待 30 秒取得結果。若往返成功，回應狀態為 success；若失敗或逾時，則為 failure 並附帶錯誤訊息。

Parameters

external_key_id: String⁠Path

ID of the External Key.

maxLength2048

Returns

class ExternalKeyValidateResponse { 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 | :success

success — encrypt/decrypt roundtrip succeeded. failure — the roundtrip failed or timed out; see error.

One of the following:

:failure

:success

驗證外部金鑰

require "anthropic"

anthropic = Anthropic::Client.new(api_key: "my-anthropic-api-key")

response = anthropic.beta.organization.external_keys.validate("external_key_id")

puts(response)

Response 200

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

Returns Examples

Response 200

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