外部キーを検証

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