Skip to content

README.md

Latest commit

 

History

History
64 lines (43 loc) · 3.08 KB

README.md

File metadata and controls

64 lines (43 loc) · 3.08 KB
Raw

ProxyChecks

Overview

Available Operations

  • verify - Verify the proxy configuration for your domain

verify

This endpoint can be used to validate that a proxy-enabled domain is operational. It tries to verify that the proxy URL provided in the parameters maps to a functional proxy that can reach the Clerk Frontend API.

You can use this endpoint before you set a proxy URL for a domain. This way you can ensure that switching to proxy-based configuration will not lead to downtime for your instance.

The proxy_url parameter allows for testing proxy configurations for domains that don't have a proxy URL yet, or operate on a different proxy URL than the one provided. It can also be used to re-validate a domain that is already configured to work with a proxy.

Example Usage

package hello.world;

import com.clerk.backend_api.Clerk;
import com.clerk.backend_api.models.errors.ClerkErrors;
import com.clerk.backend_api.models.operations.VerifyDomainProxyResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws ClerkErrors, Exception {

        Clerk sdk = Clerk.builder()
                .bearerAuth(System.getenv().getOrDefault("BEARER_AUTH", ""))
            .build();

        VerifyDomainProxyResponse res = sdk.proxyChecks().verify()
                .call();

        if (res.proxyCheck().isPresent()) {
            System.out.println(res.proxyCheck().get());
        }
    }
}

Parameters

Parameter Type Required Description
request VerifyDomainProxyRequestBody ✔️ The request object to use for the request.

Response

VerifyDomainProxyResponse

Errors

Error Type Status Code Content Type
models/errors/ClerkErrors 400, 422 application/json
models/errors/SDKError 4XX, 5XX */*