deploy.domains.add

Attach a custom domain to an app

POST /deploy/api/apps/{id}/domainsIAM deploy:ManageDomainChanges stateDestructive

Request syntax

POST /deploy/api/apps/{id}/domains
{
  "domain": "string",
  "isPrimary": "boolean"
}

Path parameters

  • idRequired

    string

    Constraints: uuid

Request body

  • domainRequired

    string

    Hostname to serve the app on, or *.host for every subdomain of host

    Constraints: 1-253 chars, /^(\*\.)?[a-z0-9.-]+$/i

  • isPrimaryOptional

    boolean

    Mark this as the app’s primary domain; default false

Response

201 with `data`: the domain as list returns it (tlsStatus pending, dnsVerifiedAt null). Inside one of the organization’s hosted zones it is pointed at the app at once; otherwise create the DNS record routing shows as its requiredRecord, then call verify.

A JSON response is wrapped as { "success": true, "data": … }; the CLI prints the whole body with --json.

Fields of data

  • idAlways

    string

    Domain id
  • appIdAlways

    string

    The app it serves
  • domainAlways

    string

    Hostname, or *.host for every subdomain
  • isPrimaryAlways

    boolean

    Whether it is the app’s primary domain
  • tlsStatusAlways

    one of pending, active, failed

    Certificate state
  • dnsVerifiedAtAlways

    string, may be null

    When it was last seen pointing at the app; null if never
  • createdAtAlways

    string

    When it was added
  • updatedAtAlways

    string

    When it was last changed

Checked against the handlers: every route test validates their answers against this schema.

Errors

  • 400The request does not pass the schema above. The body is { "error": …, "issues": […] }, one issue per field.
  • 401No credentials, or an access key that is unknown, revoked or expired.
  • 403The caller's policies do not allow deploy:ManageDomain on this resource. The body names the action and the resource, and the refusal is recorded in the audit log.
  • 404The resource does not exist in your organization.

Examples

The required parameters only, with example values. Replace id and the other placeholders with your own.

dcloud deploy domains add id --domain example

Generated from the API description, the same one the API checks requests against and the CLI is built from. MCP tool: dcloud_deploy_domains_add.