Validate External Key

ExternalKeyValidateResponse beta().organization().externalKeys().validate(, )

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

Validate an external key config against the customer's KMS.

Anthropic performs an encrypt/decrypt roundtrip against the configured KMS key and waits up to 30 seconds for the result. The response status is success if the roundtrip succeeded, or failure with an error message if it failed or timed out.

Parameters

ExternalKeyValidateParams params

Optional<String> externalKeyId

ID of the External Key.

maxLength2048

Returns

class ExternalKeyValidateResponse:

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

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

Optional<String> error

Error message when status is failure. Null otherwise.

Status status

success — encrypt/decrypt roundtrip succeeded. failure — the roundtrip failed or timed out; see error.

One of the following:

FAILURE("failure")

SUCCESS("success")

JsonValue type

Validate External Key

package com.anthropic.example;

import com.anthropic.client.AnthropicClient;
import com.anthropic.client.okhttp.AnthropicOkHttpClient;
import com.anthropic.models.beta.organization.externalkeys.ExternalKeyValidateParams;
import com.anthropic.models.beta.organization.externalkeys.ExternalKeyValidateResponse;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        AnthropicClient client = AnthropicOkHttpClient.fromEnv();

        ExternalKeyValidateResponse response = client.beta().organization().externalKeys().validate("external_key_id");
    }
}

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

Returns Examples

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