Skip to content

Latest commit

 

History

History
61 lines (39 loc) · 2.83 KB

README.md

File metadata and controls

61 lines (39 loc) · 2.83 KB
Raw

ProxyChecks

(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

declare(strict_types=1);

require 'vendor/autoload.php';

use Clerk\Backend;
use Clerk\Backend\Models\Operations;

$security = '<YOUR_BEARER_TOKEN_HERE>';

$sdk = Backend\ClerkBackend::builder()->setSecurity($security)->build();

$request = new Operations\VerifyDomainProxyRequestBody();

$response = $sdk->proxyChecks->verify(
    request: $request
);

if ($response->proxyCheck !== null) {
    // handle response
}

Parameters

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

Response

?Operations\VerifyDomainProxyResponse

Errors

Error Type Status Code Content Type
Errors\ClerkErrors88 400, 422 application/json
Errors\SDKException 4XX, 5XX */*