Add a custom domain to an Environment, such as www.example.com. Returns the DNS records to add.
Arguments
| Argument |
Type |
Description |
data |
object |
The domain, as in domain.yml from domain:init. Required. |
data.environment_id |
string |
Environment id. |
data.dns_name |
string |
Domain, such as www.example.com or *.example.com. |
data.mode |
string |
https_automated, or dns_wildcard for a wildcard. |
data.dns_provider_id |
string |
DNS provider for a wildcard. |
data.service_id |
string |
Public Service it routes to; web by default. |
data.main |
boolean |
The Environment’s main domain. |
Example
{"data":{"clone_url":"https://github.com/acme/shop","services":[{"name":"web","command":"web","port":3000,"publicly_exposed":true}]}}