Sign in
DNS Providers

Apply a hostname mode to a managed domain (persist + optional DNS sync + route reload).

Changed on
post/dns-providers/{provider_id}/domains/{domain}/apply-hostname-mode

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}/apply-hostname-mode
  • Auth: HTTP bearer

Path parameters

provider_idinteger required
domainstring required

Request body

modestring required

Target mode to apply: "standard" or "flat".

sync_dnsboolean

Also reconcile the provider's DNS zone for the affected hostnames.

Example request

{
  "adopt_records": [
    {
      "name": "pr-12.preview.example.com",
      "record_type": "A"
    }
  ],
  "skip_records": [
    {
      "name": "pr-12.preview.example.com",
      "record_type": "A"
    }
  ]
}

Response

Hostname mode applied

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

  • 4b228ebed583Revision changes
    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the required property to the response with the status

  • 1dc3e6788214Revision changes
    • breaking

      removed the required property from the response with the status

    • warning

      removed the request property

    • warning

      removed the request property

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status