Add custom domain
add_custom_domainUse when the user wants the site on their own domain. Points a custom domain (e.g. "deck.acme.com") at SnapHost. With site_id the host serves exactly that one site (Pro). With target: "workspace" (a Pro workspace) the host becomes a full alias of the workspace’s own subdomain: one DNS record, and every site and folder path resolves on it, share.acme.com/, share.acme.com//, share.acme.com/~/. Returns the DNS records the owner must add at their registrar; the domain serves once those records resolve and it is verified.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| host | Yes | The domain or subdomain, e.g. deck.acme.com | |
| target | No | "site" (default) binds one site; "workspace" aliases the whole Pro workspace | |
| site_id | No | The site to bind the domain to. On target "workspace" it is optional and names the ROOT site served at the bare / of the domain. | |
| workspace_id | No | Optional: the workspace to act in, from list_workspaces (the connection reaches the person's personal space and every workspace they are a member of). Required on a write when the connection reaches more than one workspace. Omit to act in the personal space (for an older single-workspace connection, the one workspace it was authorized for). |