deploy.domains.addAttach a custom domain to an app
Request syntax
POST /deploy/api/apps/{id}/domains
{
"domain": "string",
"isPrimary": "boolean"
}Path parameters
idRequiredstring
Constraints: uuid
Request body
domainRequiredstring
Hostname to serve the app on, or *.host for every subdomain of host
Constraints: 1-253 chars, /^(\*\.)?[a-z0-9.-]+$/i
isPrimaryOptionalboolean
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
idAlwaysstring
Domain idappIdAlwaysstring
The app it servesdomainAlwaysstring
Hostname, or *.host for every subdomainisPrimaryAlwaysboolean
Whether it is the app’s primary domaintlsStatusAlwaysone of pending, active, failed
Certificate statednsVerifiedAtAlwaysstring, may be null
When it was last seen pointing at the app; null if nevercreatedAtAlwaysstring
When it was addedupdatedAtAlwaysstring
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 examplecurl -X POST "https://console.platform-development.deutschecloud.app/deploy/api/apps/id/domains" \
-H "Authorization: EWS-ACCESS-KEY $ACCESS_KEY" \
-H "Content-Type: application/json" \
-d '{"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.