Beta Features

Update production instance domain

Changed on

Change the domain of a production instance.

Changing the domain requires updating the DNS records accordingly, deploying new SSL certificates, updating your Social Connection's redirect URLs and setting the new keys in your code.

WARNING: Changing your domain will invalidate all current user sessions (i.e. users will be logged out). Also, while your application is being deployed, a small downtime is expected to occur.

Returns 403 domain_managed_by_integration for applications in a Vercel-managed workspace; change the domain from the Vercel integration instead.

post/instance/change_domain

Request

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

Request body

home_urlstring

The new home URL of the production instance e.g. https://www.example.com

is_secondaryboolean

Whether this is a domain for a secondary app, meaning that any subdomain provided is significant and will be stored as part of the domain. This is useful for supporting multiple apps (one primary and multiple secondaries) on the same root domain (eTLD+1).

Response

Accepted

Changes