Sign in
DNS Providers

Preview the impact of switching a managed domain's hostname mode.

Changed on
get/dns-providers/{provider_id}/domains/{domain}/hostname-preview

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/dns-providers/{provider_id}/domains/{domain}/hostname-preview
  • Auth: HTTP bearer

Path parameters

provider_idinteger required
domainstring required

Query parameters

modestring required

Target mode: standard|flat

syncboolean

Include DNS record changes

Response

Hostname mode preview

totalinteger required
zone_access_okboolean nullable

Whether the provider token can manage this zone (None if not checked).

Example response

{
  "conflicts": [
    {
      "current_value": "203.0.113.10",
      "name": "pr-12.preview.example.com",
      "record_type": "A",
      "revision": "9f2c4e1ab3d5f6071829304a5b6c7d8e9f0a1b2c3d4e5f60718293a4b5c6d7e8",
      "value": "203.0.113.10"
    }
  ]
}

Changes