deploy.domains.verifyCheck that a custom domain points at the app, and record it
Request syntax
POST /deploy/api/apps/{id}/domains/{domainId}/verifyPath parameters
idRequiredstring
Constraints: uuid
domainIdRequiredstring
Constraints: uuid
Response
200 with `data`: the domain’s routing entry as routing returns it (dns and tls state, the record it needs). When dns.state is ok, dnsVerifiedAt is set on the domain.
A JSON response is wrapped as { "success": true, "data": … }; the CLI prints the whole body with --json.
Fields of data
hostAlwaysstring
HostnameurlAlwaysstring
URL the app answers atkindAlwaysone of default, custom
default: the platform name; custom: a domainwildcardAlwaysboolean
A *.host domain covering every name one label belowdomainIdAlwaysstring, may be null
The custom domain’s id; null for the default hostisPrimaryAlwaysboolean
Whether it is the primary domainplatformManagedAlwaysboolean
True when the platform nameservers answer for it with no action from youhostedZoneAlwaysobject, may be null
Your hosted zone that answers for the name; null outside every zonehostedZone.zoneIdAlwaysstring
Hosted zone idhostedZone.zoneNameAlwaysstring
Zone namehostedZone.answersForAppAlwaysboolean
Whether the zone holds a record pointing at the apphostedZone.delegationAlwaysobject, may be null
Whether the zone is delegated; null when you may not read the zonehostedZone.delegation.statusAlwaysone of delegated, elsewhere, pending
Delegation statehostedZone.delegation.detailAlwaysstring
One sentence about ithostedZone.delegation.checkedAtAlwaysstring, may be null
When it was last checked; null if neverrequiredRecordAlwaysobject, may be null
The DNS record to create; null when the platform answers for the namerequiredRecord.typeAlwaysone of A, CNAME, ALIAS
Record typerequiredRecord.nameAlwaysstring
Record namerequiredRecord.valueAlwaysstring
Record valuerequiredRecord.noteAlwaysstring
Why this recorddnsAlwaysobject
DNS, resolved livedns.stateAlwaysone of ok, mismatch, missing, unknown
What DNS answers nowdns.observedAlwaysarray of string
Addresses or CNAME targets DNS returneddns.expectedIpAlwaysstring, may be null
Address the name should resolve to; null before the first deploymentdns.detailAlwaysstring
One sentence about ittlsAlwaysobject
The certificatetls.stateAlwaysone of active, pending, failed, unavailable, on-demand
Certificate state; on-demand for a wildcard, one per name on first requesttls.detailAlwaysstring
Why, in one sentencetls.reportedAtAlwaysstring, may be null
When the machine last reported on it; null if never
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 verify id domainIdcurl -X POST "https://console.platform-development.deutschecloud.app/deploy/api/apps/id/domains/domainId/verify" \
-H "Authorization: EWS-ACCESS-KEY $ACCESS_KEY"Generated from the API description, the same one the API checks requests against and the CLI is built from. MCP tool: dcloud_deploy_domains_verify.