Connect the user's own domain (or check it)
connect_domainUse when the user wants their own domain (e.g. "bakery.com") on a site, or asks whether it works yet: with domain it connects it (bakery.com shows the site, www.bakery.com redirects to it) and returns the exact DNS steps for their provider to relay (a record for the domain, a CNAME for www, and a TXT record proving the domain is theirs: the site is not served until it is seen); without domain it checks the status (pending, verifying, active) and whether https://bakery.com opens.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| domain | No | The domain, e.g. "bakery.com" or "shop.bakery.com". Omit to check the current one. | |
| site_id | Yes | The site id: the first part of the site URL, e.g. "bella-roma" for https://bella-roma.ginta.page (see list_sites). | |
| with_www | No | Only if the user wants www.bakery.com as the main address (bakery.com then redirects to it). Default: bakery.com is the main address. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| text | Yes | The answer in words, the same as the text content: read it (for get_guide the whole guide, for get_site the files' contents). | |
| domain | No | The domain: state (pending, verifying, active, error), records and the steps for its DNS provider; null = none. | |
| enabled | No | Whether connecting domains is open. |