deploy.domains.update

Move a custom domain to another published service of a compose app

PATCH /deploy/api/apps/{id}/domains/{domainId}IAM deploy:ManageDomainChanges stateDestructive

Request syntax

PATCH /deploy/api/apps/{id}/domains/{domainId}
{
  "service": "string"
}

Path parameters

  • idRequired

    string

    Constraints: uuid

  • domainIdRequired

    string

    Constraints: uuid

Request body

  • serviceRequired

    string

    The published compose service the domain serves; null for the main one

    Constraints: 1-63 chars

    May be null.

Response

200 with `data`: the domain as list returns it. The app’s machines route it to the service on their next poll; no deployment needed.

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
  • serviceAlways

    string, may be null

    Compose apps: the published service it serves; null for the main one
  • 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 update id domainId --service 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_update.