v13

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

Domains

Add a domain

Add a new domain for your instance. Useful in the case of multi-domain instances, allows adding satellite domains to an instance. The new domain must have a name. The domain name can contain the port for development instances, like localhost:3000. At the moment, instances can have only one primary domain, so the is_satellite parameter must be set to true. If you're planning to configure the new satellite domain to run behind a proxy, pass the proxy_url parameter accordingly.

post/domains

Request body

namestring required

The new domain name. Can contain the port for development instances.

is_satellitetrue required

Marks the new domain as satellite. Only true is accepted at the moment.

proxy_urlstring nullable

The full URL of the proxy which will forward requests to the Clerk Frontend API for this domain. Applicable only to production instances.

Response

A domain

object'domain' required

idstring required

namestring required

is_satelliteboolean required

frontend_api_urlstring required

accounts_portal_urlstring nullable

Null for satellite domains.

proxy_urlstring nullable

development_originstring required