Sign in
DNS Providers

Add a managed domain to a provider

Changed on
post/dns-providers/{id}/domains

Request

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

Path parameters

idinteger required

Request body

auto_manageboolean
domainstring required
generated_hostname_modestring nullable

Generated hostname layout: "standard" (default) or "flat".

proxied_by_defaultboolean
sync_generated_recordsboolean

Opt in to reconciling generated hostnames into this domain's DNS zone.

Example request

{
  "domain": "example.com"
}

Response

Managed domain added

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 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