clerk.add_domain
Add a custom domain to a connected Clerk instance.
Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.
Returns the created domain with CNAME targets for DNS setup.
Cost = 10 tokens.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | Domain hostname to add. | |
| proxy_url | No | Proxy URL when using a satellite domain behind a reverse proxy. | |
| is_satellite | Yes | Whether this is a satellite domain. | |
| clerk_instance_id | No | Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| domain | No | Created Clerk domain from the Backend API. |