deploy.domains.verify

Check that a custom domain points at the app, and record it

POST /deploy/api/apps/{id}/domains/{domainId}/verifyIAM deploy:ManageDomainChanges stateDestructive

Request syntax

POST /deploy/api/apps/{id}/domains/{domainId}/verify

Path parameters

  • idRequired

    string

    Constraints: uuid

  • domainIdRequired

    string

    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

  • hostAlways

    string

    Hostname
  • urlAlways

    string

    URL the app answers at
  • kindAlways

    one of default, custom

    default: the platform name; custom: a domain
  • wildcardAlways

    boolean

    A *.host domain covering every name one label below
  • domainIdAlways

    string, may be null

    The custom domain’s id; null for the default host
  • isPrimaryAlways

    boolean

    Whether it is the primary domain
  • platformManagedAlways

    boolean

    True when the platform nameservers answer for it with no action from you
  • hostedZoneAlways

    object, may be null

    Your hosted zone that answers for the name; null outside every zone
  • hostedZone.​zoneIdAlways

    string

    Hosted zone id
  • hostedZone.​zoneNameAlways

    string

    Zone name
  • hostedZone.​answersForAppAlways

    boolean

    Whether the zone holds a record pointing at the app
  • hostedZone.​delegationAlways

    object, may be null

    Whether the zone is delegated; null when you may not read the zone
  • hostedZone.​delegation.​statusAlways

    one of delegated, elsewhere, pending

    Delegation state
  • hostedZone.​delegation.​detailAlways

    string

    One sentence about it
  • hostedZone.​delegation.​checkedAtAlways

    string, may be null

    When it was last checked; null if never
  • requiredRecordAlways

    object, may be null

    The DNS record to create; null when the platform answers for the name
  • requiredRecord.​typeAlways

    one of A, CNAME, ALIAS

    Record type
  • requiredRecord.​nameAlways

    string

    Record name
  • requiredRecord.​valueAlways

    string

    Record value
  • requiredRecord.​noteAlways

    string

    Why this record
  • dnsAlways

    object

    DNS, resolved live
  • dns.​stateAlways

    one of ok, mismatch, missing, unknown

    What DNS answers now
  • dns.​observedAlways

    array of string

    Addresses or CNAME targets DNS returned
  • dns.​expectedIpAlways

    string, may be null

    Address the name should resolve to; null before the first deployment
  • dns.​detailAlways

    string

    One sentence about it
  • tlsAlways

    object

    The certificate
  • tls.​stateAlways

    one of active, pending, failed, unavailable, on-demand

    Certificate state; on-demand for a wildcard, one per name on first request
  • tls.​detailAlways

    string

    Why, in one sentence
  • tls.​reportedAtAlways

    string, 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 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_verify.