Valider une clé externe

$ ant beta:organization:external-keys validate

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é.

Parameters

--external-key-id: string

ID of the External Key.

maxLength2048

Returns

BetaOrganizationExternalKeyValidateResponse: object{ error, status, type }

Result of a validation roundtrip against the customer's KMS.

HTTP 200 for both outcomes — the operation completed; status says whether the key works.

error: string

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"

Valider une clé externe

ant beta:organization:external-keys validate \
  --api-key my-anthropic-api-key \
  --external-key-id external_key_id

Response 200

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

Returns Examples

Response 200

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