Claude Platform Docs

Externen Schlüssel validieren

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

Validiert eine externe Schlüsselkonfiguration gegen das KMS des Kunden.

Anthropic führt einen Encrypt/Decrypt-Roundtrip gegen den konfigurierten KMS-Schlüssel durch und wartet bis zu 30 Sekunden auf das Ergebnis. Der Antwortstatus ist success, wenn der Roundtrip erfolgreich war, oder failure mit einer Fehlermeldung, wenn er fehlgeschlagen ist oder das Zeitlimit überschritten wurde.

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
Externen Schlüssel validieren
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"
Returns Examples
Response 200
{
  "error": null,
  "status": "success",
  "type": "external_key_validation"
}