DNS Import & Export

Download schema

Endpoints for importing and exporting hosted DNS zones.

Import a DNS zone

POST

https://domain.chief.app/api/v1

/domains/{domainNameOrId}/dns/records/import

OpenID Connect

Bearer (ctp_*)

Bearer (ctt_*)

Import BIND zone file contents or upload a BIND, CSV, XLSX, or ODS zone export into a hosted DNS zone. The import may replace the complete zone or merge records using Domain Chief's DNS conflict rules.

A preview is optional. When you supply a preview fingerprint, the import is rejected if its records or the current zone have changed since that preview. The local records are updated before the response, and DNS publication continues afterwards.

Import a DNS zone › path Parameters

domainNameOrId

string · required

destination full domain name or ID

Import a DNS zone › Request Body

mode

string · enum · required

How imported records should interact with the current zone.

Enum values:

replace

merge

zone

string · maxLength: 1048576 · required

BIND zone file contents.

source_domain

string

The zone name used to interpret relative record names. Defaults to the destination domain.

fingerprint

string · pattern: ^[a-f0-9]{64}$

An opaque fingerprint returned by a previous preview.

Import a DNS zone › Responses

No content

No data returned

Preview a DNS zone import

POST

https://domain.chief.app/api/v1

/domains/{domainNameOrId}/dns/records/import/preview

OpenID Connect

Bearer (ctp_*)

Bearer (ctt_*)

Parse BIND zone file contents or an uploaded BIND, CSV, XLSX, or ODS zone export and return the changes that would be made. This endpoint does not change the zone.

Supply the returned fingerprint to the import endpoint to prevent applying the import when its records or the current zone have changed since this preview.

Preview a DNS zone import › path Parameters

domainNameOrId

string · required

destination full domain name or ID

Preview a DNS zone import › Request Body

mode

string · enum · required

How imported records should interact with the current zone.

Enum values:

replace

merge

zone

string · maxLength: 1048576 · required

BIND zone file contents.

source_domain

string

The zone name used to interpret relative record names. Defaults to the destination domain.

Preview a DNS zone import › Responses

DNSRecordImportPlan

DNSRecordImportPlan

source_domain

string · required

The zone name used to interpret relative record names in the imported data.

destination_domain

string · required

The hosted DNS domain targeted by the import.

mode

DNSRecordImportMode · required

The requested import behavior.


`replace` Replace the current zone with the imported records.
`merge` Keep non-conflicting records and replace only records that conflict with the import.

fingerprint

string · required

An opaque identifier for this imported data and the current destination zone.

object[] · required

DNS records the import would add.

object[] · required

DNS records the import would remove.

object[] · required

Existing DNS records the import would leave unchanged.

object[] · required

Conflicts that must be resolved before the import can be applied. The code is stable for client-side handling; the message is fallback display text.

POST/domains/{domainNameOrId}/dns/records/import/preview

curl https://domain.chief.app/api/v1/domains/:domainNameOrId/dns/records/import/preview \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "mode": "replace",
  "source_domain": "source_domain",
  "zone": "zone"
}'

Example Request Body

{
  "mode": "replace",
  "source_domain": "source_domain",
  "zone": "zone"
}

json

Example Responses

{
  "source_domain": "source_domain",
  "destination_domain": "destination_domain",
  "mode": "mode",
  "fingerprint": "fingerprint",
  "additions": [
    {
      "type": "type",
      "name": "name",
      "content": "content",
      "ttl": 0,
      "prio": 0,
      "comment": "comment"
    }
  ],
  "removals": [
    {
      "type": "type",
      "name": "name",
      "content": "content",
      "ttl": 0,
      "prio": 0,
      "comment": "comment"
    }
  ],
  "unchanged": [
    {
      "type": "type",
      "name": "name",
      "content": "content",
      "ttl": 0,
      "prio": 0,
      "comment": "comment"
    }
  ],
  "blockers": [
    {
      "code": "code",
      "message": "message"
    }
  ]
}

json

application/json

Export DNS zone

GET

https://domain.chief.app/api/v1

/domains/{domainNameOrId}/dns/records/export

OpenID Connect

Bearer (ctp_*)

Bearer (ctt_*)

Download every record in the hosted DNS zone as BIND-compatible plain text. The export includes records managed by Domain Chief features, but not record comments or metadata.

Export DNS zone › path Parameters

domainNameOrId

string · required

full domain name or ID

Export DNS zone › Responses

The DNS zone export.

string

DNS DNS History

Import a DNS zone

POST

https://domain.chief.app/api/v1

/domains/{domainNameOrId}/dns/records/import

OpenID Connect

Bearer (ctp_*)

Bearer (ctt_*)

Import a DNS zone › path Parameters

domainNameOrId

string · required

destination full domain name or ID

Import a DNS zone › Request Body

mode

string · enum · required

How imported records should interact with the current zone.

Enum values:

replace

merge

zone

string · maxLength: 1048576 · required

BIND zone file contents.

source_domain

string

The zone name used to interpret relative record names. Defaults to the destination domain.

fingerprint

string · pattern: ^[a-f0-9]{64}$

An opaque fingerprint returned by a previous preview.

Import a DNS zone › Responses

No content

No data returned

Preview a DNS zone import

POST

https://domain.chief.app/api/v1

/domains/{domainNameOrId}/dns/records/import/preview

OpenID Connect

Bearer (ctp_*)

Bearer (ctt_*)

Parse BIND zone file contents or an uploaded BIND, CSV, XLSX, or ODS zone export and return the changes that would be made. This endpoint does not change the zone.

Supply the returned fingerprint to the import endpoint to prevent applying the import when its records or the current zone have changed since this preview.

Preview a DNS zone import › path Parameters

domainNameOrId

string · required

destination full domain name or ID

Preview a DNS zone import › Request Body

mode

string · enum · required

How imported records should interact with the current zone.

Enum values:

replace

merge

zone

string · maxLength: 1048576 · required

BIND zone file contents.

source_domain

string

The zone name used to interpret relative record names. Defaults to the destination domain.

Preview a DNS zone import › Responses

DNSRecordImportPlan

DNSRecordImportPlan

source_domain

string · required

The zone name used to interpret relative record names in the imported data.

destination_domain

string · required

The hosted DNS domain targeted by the import.

mode

DNSRecordImportMode · required

The requested import behavior.


`replace` Replace the current zone with the imported records.
`merge` Keep non-conflicting records and replace only records that conflict with the import.

fingerprint

string · required

An opaque identifier for this imported data and the current destination zone.

object[] · required

DNS records the import would add.

object[] · required

DNS records the import would remove.

object[] · required

Existing DNS records the import would leave unchanged.

object[] · required

Conflicts that must be resolved before the import can be applied. The code is stable for client-side handling; the message is fallback display text.

Export DNS zone

GET

https://domain.chief.app/api/v1

/domains/{domainNameOrId}/dns/records/export

OpenID Connect

Bearer (ctp_*)

Bearer (ctt_*)

Download every record in the hosted DNS zone as BIND-compatible plain text. The export includes records managed by Domain Chief features, but not record comments or metadata.

Export DNS zone › path Parameters

domainNameOrId

string · required

full domain name or ID

Export DNS zone › Responses

The DNS zone export.

string