Valider une clé externe

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

Validez une configuration de clé externe auprès du KMS du client.

Anthropic effectue un aller-retour chiffrement/déchiffrement avec la clé KMS configurée et attend le résultat jusqu'à 30 secondes. Le statut de la réponse est success si l'aller-retour a réussi, ou failure accompagné d'un message d'erreur s'il a échoué ou a expiré.

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

Valider une clé externe

cURL

curl https://api.anthropic.com/v1/organizations/external_keys/$EXTERNAL_KEY_ID/validate \
    -X POST \
    -H 'anthropic-version: 2023-06-01' \
    -H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN"

Response 200

{
  "error": null,
  "status": "success",
  "type": "external_key_validation"
}

Returns Examples

Response 200

{
  "error": null,
  "status": "success",
  "type": "external_key_validation"
}