deploy.domains.remove

Detach a custom domain

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

Request syntax

DELETE /deploy/api/apps/{id}/domains/{domainId}

Path parameters

  • idRequired

    string

    Constraints: uuid

  • domainIdRequired

    string

    Constraints: uuid

Response

200 with `data`: { id } of the removed domain. A record the platform made for it in a hosted zone is removed too.

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

Fields of data

  • idAlways

    string

    The removed domain

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 remove id domainId

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