Domains

Add a domain

Changed on

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. Set is_satellite to true to add a satellite domain. To migrate a production instance from an active provider domain to its first custom primary domain, set is_satellite to false. The custom domain becomes active and the provider domain stays attached. Additional custom primary domains are not supported. If you're planning to configure the new satellite domain to run behind a proxy, pass the proxy_url parameter accordingly. Adding a custom primary domain returns 403 domain_managed_by_integration for applications in a Vercel-managed workspace; change the domain from the Vercel integration instead.

post/domains

Request

  • Base URL: https://api.clerk.com/v1
  • URL: https://api.clerk.com/v1/domains
  • Auth: HTTP bearer

Request body

namestring required

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

is_satelliteboolean required

Marks the new domain as satellite. Set to false only when migrating a production instance from an active provider domain to a custom domain.

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

Changes