Clerk API (unofficial showcase)
POST/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.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

2 body fields
domain_idstringoptional
The ID of the domain that will be updated.
proxy_urlstringoptional
The full URL of the proxy which will forward requests to the Clerk Frontend API for this domain. e.g. https://example.com/__clerk

3 status codes
200Health check information about a domain's proxy configuration validation attempt.
objectstringrequired
Allowed:proxy_check
idstringrequired
domain_idstringrequired
last_run_atintegerrequired
Unix timestamp of last run.
proxy_urlstringrequired
successfulbooleanrequired
created_atintegerrequired
Unix timestamp of creation.
updated_atintegerrequired
Unix timestamp of last update.
400Request was not successful
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional
422Invalid request parameters
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional

Error handling

A 400 is returned: Request was not successful. A 422 is returned: Invalid request parameters.