Sign in
DNS Providers

Update a managed domain's settings (hostname mode, sync opt-in, auto-manage).

Changed on
patch/dns-providers/{provider_id}/domains/{domain}

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}
  • Auth: HTTP bearer

Path parameters

provider_idinteger required
domainstring required

Request body

auto_manageboolean nullable

Toggle automatic DNS management for this domain.

generated_hostname_modestring nullable

"standard" or "flat". Persisted as-is; switching to "flat" does not recompute existing hostnames — use the apply endpoint for that.

proxied_by_defaultboolean nullable

Default proxy mode for newly managed records; false is an explicit override.

sync_generated_recordsboolean nullable

Toggle DNS record sync for this domain.

Response

Managed domain updated

auto_manageboolean required
created_atstring required
domainstring required
generated_hostname_modestring required

Generated hostname layout: "standard" or "flat".

idinteger required
provider_idinteger required
proxied_by_defaultboolean required
sync_generated_recordsboolean required

Whether generated hostnames are reconciled into the provider's DNS zone.

updated_atstring required
verification_errorstring nullable
verifiedboolean required
verified_atstring nullable
zone_access_errorstring nullable

Detail for a failed zone-access check.

zone_access_okboolean nullable

Last token zone-access check: Some(true)/Some(false)/None (unchecked).

zone_idstring nullable

Changes

  • 4b228ebed583Revision changes
    • info

      added the new optional request property

    • 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

    • info

      removed the non-success response with the status