Get a one-click DNS link
get_domain_connect_url
Returns a link that has the DNS provider add the records one custom domain needs automatically, where the provider supports it.
Scopeconfig:readRead only
The link covers that domain and its www companion, never the site's other domains, so each domain needs its own link. The tool tells the client to hand you the link rather than follow it itself.
The link comes back in applyUrl. When the provider does not support one-click setup, the answer carries supported false and no link, and the records have to be added by hand. It needs the Manage domains permission in the workspace. See One click setup.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
projectId |
string | Yes | The site id. |
workspaceId |
string | Yes | The workspace the site belongs to. |
domainId |
string | Yes | The _id of the custom domain to configure, as get_domain_status or add_custom_domain returned it. |