外部キーを検証

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

Headers

"anthropic-version": optional string

The version of the Claude API you want to use.

Read more about versioning and our version history here.

Returns

type: "external_key_validation"

defaultexternal_key_validation

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"

外部キーを検証

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