Domains

Update a domain

Changed on

The proxy_url can be updated only for production instances. Update one of the instance's domains. Both primary and satellite domains can be updated. If you choose to use Clerk via proxy, use this endpoint to specify the proxy_url. Whenever you decide you'd rather switch to DNS setup for Clerk, simply set proxy_url to null for the domain. When you update a production instance's primary domain name, you have to make sure that you've completed all the necessary setup steps for DNS and emails to work. Expect downtime otherwise. Updating a primary domain's name will also update the instance's home origin, affecting the default application paths. Updating the name or is_secondary of a primary domain returns 403 domain_managed_by_integration for applications in a Vercel-managed workspace; change the domain from the Vercel integration instead.

patch/domains/{domain_id}

Request

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

Path parameters

domain_idstring required

The ID of the domain that will be updated.

Request body

namestring nullable

The new domain name. For development instances, can contain the port, i.e myhostname:3000. For production instances, must be a valid FQDN, i.e mysite.com. Cannot contain protocol scheme.

proxy_urlstring nullable

The full URL of the proxy that will forward requests to Clerk's Frontend API. Can only be updated for production instances.

is_secondaryboolean nullable

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

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