Validar clave externa

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

Valida una configuración de clave externa contra el KMS del cliente.

Anthropic realiza un ciclo de cifrado/descifrado contra la clave de KMS configurada y espera hasta 30 segundos el resultado. El estado de la respuesta es success si el ciclo tuvo éxito, o failure con un mensaje de error si falló o se agotó el tiempo de espera.

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

Validar clave externa

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