Sign in

v13

latestOpenAPI 3.0.3MITraw.githubusercontent.com2026-08-04237161688.6 KB
Proxy Checks

Verify the proxy configuration for your domain

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.

post/proxy_checks

Request body

domain_idstring

The ID of the domain that will be updated.

proxy_urlstring

The full URL of the proxy which will forward requests to the Clerk Frontend API for this domain. e.g. https://example.com/__clerk

Response

Health check information about a domain's proxy configuration validation attempt.

object'proxy_check' required
idstring required
domain_idstring required
last_run_atinteger nullable required

Unix timestamp of last run.

proxy_urlstring required
successfulboolean required
created_atinteger required

Unix timestamp of creation.

updated_atinteger required

Unix timestamp of last update.