Remove the www companion domain
remove_www_domain
Detaches only the www companion of one custom domain, leaving that domain and every other domain of the site connected.
Scopeconfig:writeDestructive
It permanently deletes the companion and its TLS certificate, so visitors who type that www address stop reaching the site straight away, and adding it back starts the DNS and certificate work again from scratch. The tool tells the client to confirm with you before calling it.
When the domain is itself the www hostname, because its root was removed, its companion is the root, so this removes the root. A domain without a companion is refused with example.com does not have a WWW variant! It needs the Manage domains permission in the workspace. See Removing one of them.
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 whose www companion to remove, as get_domain_status or add_custom_domain returned it. |