wihan/dev

docs /clerk / resources

markdown
browse the clerk docs

clerk_domain (Resource)

A satellite domain of the instance. The Backend API creates satellite domains only; use the Clerk dashboard for a primary-domain change. Use the clerk_domains data source for the DNS records.

Example Usage

resource "clerk_domain" "satellite" {
  name      = "satellite.example.com"
  proxy_url = "https://satellite.example.com/__clerk"
}

Schema

Required

  • name (String) Domain name, for example satellite.example.com.

Optional

  • proxy_url (String) Proxy URL for the Frontend API on this domain, for example https://satellite.example.com/__clerk.

Read-Only

  • development_origin (String) Origin of the development instance.
  • frontend_api_url (String) Frontend API URL for this domain.
  • id (String) Domain id.
  • is_satellite (Boolean) Always true: the API creates satellite domains only.

Import

Import is supported using the following syntax:

The terraform import command can be used, for example:

terraform import clerk_domain.satellite dmn_2abcDEFghiJKLmnoPQRstuVWXyz