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.
Request Body schema: application/json
| domain_id | string The ID of the domain that will be updated. |
| proxy_url | string The full URL of the proxy which will forward requests to the Clerk Frontend API for this domain. e.g. https://example.com/__clerk |
Health check information about a domain's proxy configuration validation attempt.
Request was not successful
Invalid request parameters
- Payload
{- "domain_id": "string",
- "proxy_url": "string"
}- 200
- 400
- 422
{- "object": "proxy_check",
- "id": "string",
- "domain_id": "string",
- "last_run_at": 0,
- "proxy_url": "string",
- "successful": true,
- "created_at": 0,
- "updated_at": 0
}