Validar chave externa

$ ant beta:organization:external-keys validate

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

Valide uma configuração de chave externa em relação ao KMS do cliente.

A Anthropic realiza um ciclo de criptografia/descriptografia com a chave KMS configurada e aguarda até 30 segundos pelo resultado. O status da resposta é success se o ciclo foi bem-sucedido, ou failure com uma mensagem de erro se falhou ou expirou.

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"

Validar chave externa

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