deployment_domain_add

Tool

deployment_domain_add

Attach a custom domain to an environment.

Behavior

Returns: The domain record plus the CNAME and TXT DNS entries to publish.

Arguments

Name	Type	Required	Description
environmentId	uuid	•	Environment to attach the domain to.
hostname	string	•	The custom hostname, e.g. app.example.com (3–253 chars).
defaultServiceId	uuid	•	Service that serves traffic for this hostname by default.
pathPrefix	string	—	Path prefix, starting with /. Use letters, digits, slashes, underscores, or hyphens; at most 200 characters.
redirectWww	boolean	—	Boolean setting for www redirection.

Try it

Attach app.example.com to my production environment, routing to the web service.

When to use

Register a custom domain for an environment and return the CNAME + TXT DNS records to publish. After publishing the records, verification runs automatically; check status via the domain's record.

Example

Ask your agent something like this:

Attach app.example.com to my production environment, routing to the web service.

The agent will invoke deployment_domain_add with these arguments:

{
  "environmentId": "env-uuid",
  "hostname": "app.example.com",
  "defaultServiceId": "svc-uuid"
}