DNS History

Download schema

Endpoints for reviewing and restoring hosted DNS snapshots.

List DNS snapshots

GET

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

/domains/{domainNameOrId}/dns/snapshots

OpenID Connect

Bearer (ctp_*)

Bearer (ctt_*)

List snapshots saved before hosted DNS changes and snapshots saved manually.

List DNS snapshots › path Parameters

domainNameOrId

string · required

full domain name or ID

List DNS snapshots › query Parameters

kind

string · enum

Filter by the way the snapshot was created.

Enum values:

automatic

manual

page

integer · min: 1

Default: 1

per_page

integer · min: 1 · max: 100

Default: 50

List DNS snapshots › Responses

Paginated set of DNSZoneSnapshotSummary

DNSZoneSnapshotSummary[] · required

object · required

GET/domains/{domainNameOrId}/dns/snapshots

curl https://domain.chief.app/api/v1/domains/:domainNameOrId/dns/snapshots \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "data": [
    {
      "id": "id",
      "kind": "kind",
      "reason": "string",
      "name": "name",
      "display_name": "display_name",
      "causer": {
        "id": "id",
        "type": "type",
        "name": "name"
      },
      "record_count": 0,
      "created_at": "2024-08-25T15:00:00Z"
    }
  ],
  "links": {
    "first": "first",
    "last": "last",
    "prev": "prev",
    "next": "next"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "links": [
      {
        "url": "url",
        "label": "label",
        "active": true
      }
    ],
    "path": "path",
    "per_page": 0,
    "to": 1,
    "total": 0
  }
}

json

application/json

Save DNS snapshot

POST

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

/domains/{domainNameOrId}/dns/snapshots

OpenID Connect

Bearer (ctp_*)

Bearer (ctt_*)

Save the domain's current hosted DNS records under a name supplied by the caller.

Save DNS snapshot › path Parameters

domainNameOrId

string · required

full domain name or ID

Save DNS snapshot › Request Body

name

string · maxLength: 100 · required

A name that identifies the saved snapshot.

Save DNS snapshot › Responses

DNSZoneSnapshot

DNSZoneSnapshot · required

POST/domains/{domainNameOrId}/dns/snapshots

curl https://domain.chief.app/api/v1/domains/:domainNameOrId/dns/snapshots \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "name": "name"
}'

Example Request Body

{
  "name": "name"
}

json

Example Responses

{
  "data": {
    "id": "id",
    "kind": "kind",
    "reason": "string",
    "name": "name",
    "display_name": "display_name",
    "causer": {
      "id": "id",
      "type": "type",
      "name": "name"
    },
    "record_count": 0,
    "created_at": "2024-08-25T15:00:00Z",
    "records": [
      {
        "type": "type",
        "name": "name",
        "content": "content",
        "ttl": 0,
        "prio": 0,
        "comment": "comment",
        "metadata": {
          "key": "string"
        }
      }
    ]
  }
}

json

application/json

Show DNS snapshot

GET

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

/domains/{domainNameOrId}/dns/snapshots/{dnsZoneSnapshotId}

OpenID Connect

Bearer (ctp_*)

Bearer (ctt_*)

Show a snapshot and every DNS record stored in it.

Show DNS snapshot › path Parameters

domainNameOrId

string · required

full domain name or ID

dnsZoneSnapshotId

string · required

snapshot ID

Show DNS snapshot › Responses

DNSZoneSnapshot

DNSZoneSnapshot · required

Delete DNS snapshot

DELETE

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

/domains/{domainNameOrId}/dns/snapshots/{dnsZoneSnapshotId}

OpenID Connect

Bearer (ctp_*)

Bearer (ctt_*)

Delete a snapshot that was saved manually. Automatic snapshots cannot be deleted.

Delete DNS snapshot › path Parameters

domainNameOrId

string · required

full domain name or ID

dnsZoneSnapshotId

string · required

snapshot ID

Delete DNS snapshot › Responses

No content

No data returned

Export DNS snapshot

GET

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

/domains/{domainNameOrId}/dns/snapshots/{dnsZoneSnapshotId}/export

OpenID Connect

Bearer (ctp_*)

Bearer (ctt_*)

Download the records stored in a snapshot as BIND-compatible plain text. Comments and metadata are not included.

Export DNS snapshot › path Parameters

domainNameOrId

string · required

full domain name or ID

dnsZoneSnapshotId

string · required

snapshot ID

Export DNS snapshot › Responses

The DNS snapshot export.

string

Preview DNS snapshot restore

GET

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

/domains/{domainNameOrId}/dns/snapshots/{dnsZoneSnapshotId}/restore/preview

OpenID Connect

Bearer (ctp_*)

Bearer (ctt_*)

Return the changes that restoring a snapshot would make without changing the hosted DNS zone. Supply the returned fingerprint to the restore endpoint to reject the restore if the current zone changes after this preview.

Preview DNS snapshot restore › path Parameters

domainNameOrId

string · required

full domain name or ID

dnsZoneSnapshotId

string · required

snapshot ID

Preview DNS snapshot restore › Responses

DNSZoneSnapshotRestorePlan

DNSZoneSnapshotRestorePlan

snapshot_id

string · required

The snapshot that would be restored.

fingerprint

string · required

An opaque identifier for this snapshot and the current hosted DNS zone.

DNSZoneSnapshotRecord[] · required

DNS records the restore would add.

DNSZoneSnapshotRecord[] · required

DNS records the restore would remove.

DNSZoneSnapshotRecordChange[] · required

Existing DNS records the restore would change.

DNSZoneSnapshotRecord[] · required

Existing DNS records that already match the snapshot.

GET/domains/{domainNameOrId}/dns/snapshots/{dnsZoneSnapshotId}/restore/preview

curl https://domain.chief.app/api/v1/domains/:domainNameOrId/dns/snapshots/:dnsZoneSnapshotId/restore/preview \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "snapshot_id": "snapshot_id",
  "fingerprint": "fingerprint",
  "additions": [
    {
      "type": "type",
      "name": "name",
      "content": "content",
      "ttl": 0,
      "prio": 0,
      "comment": "comment",
      "metadata": {
        "key": "string"
      }
    }
  ],
  "removals": [
    {
      "type": "type",
      "name": "name",
      "content": "content",
      "ttl": 0,
      "prio": 0,
      "comment": "comment",
      "metadata": {
        "key": "string"
      }
    }
  ],
  "changes": [
    {
      "before": {
        "type": "type",
        "name": "name",
        "content": "content",
        "ttl": 0,
        "prio": 0,
        "comment": "comment",
        "metadata": {
          "key": "string"
        }
      },
      "after": {
        "type": "type",
        "name": "name",
        "content": "content",
        "ttl": 0,
        "prio": 0,
        "comment": "comment",
        "metadata": {
          "key": "string"
        }
      }
    }
  ],
  "unchanged": [
    {
      "type": "type",
      "name": "name",
      "content": "content",
      "ttl": 0,
      "prio": 0,
      "comment": "comment",
      "metadata": {
        "key": "string"
      }
    }
  ]
}

json

application/json

Restore DNS snapshot

POST

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

/domains/{domainNameOrId}/dns/snapshots/{dnsZoneSnapshotId}/restore

OpenID Connect

Bearer (ctp_*)

Bearer (ctt_*)

Replace the local hosted DNS zone with the records stored in a snapshot. Domain Chief saves the current zone first and publishes the restored records to hosted DNS after this request returns.

A preview is optional. When you supply a preview fingerprint, the restore is rejected if the current zone has changed since that preview.

Restore DNS snapshot › path Parameters

domainNameOrId

string · required

full domain name or ID

dnsZoneSnapshotId

string · required

snapshot ID

Restore DNS snapshot › Request Body

fingerprint

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

The opaque fingerprint returned by a previous restore preview.

Restore DNS snapshot › Responses

No content

No data returned

DNS Import & Export Web Redirects

Domain Chief API v1

DNS History

Download schema

Endpoints for reviewing and restoring hosted DNS snapshots.

List DNS snapshots

GET

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

/domains/{domainNameOrId}/dns/snapshots

OpenID Connect

Bearer (ctp_*)

Bearer (ctt_*)

List snapshots saved before hosted DNS changes and snapshots saved manually.

List DNS snapshots › path Parameters

domainNameOrId

string · required

full domain name or ID

List DNS snapshots › query Parameters

kind

string · enum

Filter by the way the snapshot was created.

Enum values:

automatic

manual

page

integer · min: 1

Default: 1

per_page

integer · min: 1 · max: 100

Default: 50

List DNS snapshots › Responses

Paginated set of DNSZoneSnapshotSummary

DNSZoneSnapshotSummary[] · required

object · required

GET/domains/{domainNameOrId}/dns/snapshots

curl https://domain.chief.app/api/v1/domains/:domainNameOrId/dns/snapshots \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "data": [
    {
      "id": "id",
      "kind": "kind",
      "reason": "string",
      "name": "name",
      "display_name": "display_name",
      "causer": {
        "id": "id",
        "type": "type",
        "name": "name"
      },
      "record_count": 0,
      "created_at": "2024-08-25T15:00:00Z"
    }
  ],
  "links": {
    "first": "first",
    "last": "last",
    "prev": "prev",
    "next": "next"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "links": [
      {
        "url": "url",
        "label": "label",
        "active": true
      }
    ],
    "path": "path",
    "per_page": 0,
    "to": 1,
    "total": 0
  }
}

json

application/json

Save DNS snapshot

POST

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

/domains/{domainNameOrId}/dns/snapshots

OpenID Connect

Bearer (ctp_*)

Bearer (ctt_*)

Save the domain's current hosted DNS records under a name supplied by the caller.

Save DNS snapshot › path Parameters

domainNameOrId

string · required

full domain name or ID

Save DNS snapshot › Request Body

name

string · maxLength: 100 · required

A name that identifies the saved snapshot.

Save DNS snapshot › Responses

DNSZoneSnapshot

DNSZoneSnapshot · required

POST/domains/{domainNameOrId}/dns/snapshots

curl https://domain.chief.app/api/v1/domains/:domainNameOrId/dns/snapshots \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "name": "name"
}'

Example Request Body

{
  "name": "name"
}

json

Example Responses

{
  "data": {
    "id": "id",
    "kind": "kind",
    "reason": "string",
    "name": "name",
    "display_name": "display_name",
    "causer": {
      "id": "id",
      "type": "type",
      "name": "name"
    },
    "record_count": 0,
    "created_at": "2024-08-25T15:00:00Z",
    "records": [
      {
        "type": "type",
        "name": "name",
        "content": "content",
        "ttl": 0,
        "prio": 0,
        "comment": "comment",
        "metadata": {
          "key": "string"
        }
      }
    ]
  }
}

json

application/json

Show DNS snapshot

GET

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

/domains/{domainNameOrId}/dns/snapshots/{dnsZoneSnapshotId}

OpenID Connect

Bearer (ctp_*)

Bearer (ctt_*)

Show a snapshot and every DNS record stored in it.

Show DNS snapshot › path Parameters

domainNameOrId

string · required

full domain name or ID

dnsZoneSnapshotId

string · required

snapshot ID

Show DNS snapshot › Responses

DNSZoneSnapshot

DNSZoneSnapshot · required

Delete DNS snapshot

DELETE

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

/domains/{domainNameOrId}/dns/snapshots/{dnsZoneSnapshotId}

OpenID Connect

Bearer (ctp_*)

Bearer (ctt_*)

Delete a snapshot that was saved manually. Automatic snapshots cannot be deleted.

Delete DNS snapshot › path Parameters

domainNameOrId

string · required

full domain name or ID

dnsZoneSnapshotId

string · required

snapshot ID

Delete DNS snapshot › Responses

No content

No data returned

Export DNS snapshot

GET

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

/domains/{domainNameOrId}/dns/snapshots/{dnsZoneSnapshotId}/export

OpenID Connect

Bearer (ctp_*)

Bearer (ctt_*)

Download the records stored in a snapshot as BIND-compatible plain text. Comments and metadata are not included.

Export DNS snapshot › path Parameters

domainNameOrId

string · required

full domain name or ID

dnsZoneSnapshotId

string · required

snapshot ID

Export DNS snapshot › Responses

The DNS snapshot export.

string

Preview DNS snapshot restore

GET

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

/domains/{domainNameOrId}/dns/snapshots/{dnsZoneSnapshotId}/restore/preview

OpenID Connect

Bearer (ctp_*)

Bearer (ctt_*)

Preview DNS snapshot restore › path Parameters

domainNameOrId

string · required

full domain name or ID

dnsZoneSnapshotId

string · required

snapshot ID

Preview DNS snapshot restore › Responses

DNSZoneSnapshotRestorePlan

DNSZoneSnapshotRestorePlan

snapshot_id

string · required

The snapshot that would be restored.

fingerprint

string · required

An opaque identifier for this snapshot and the current hosted DNS zone.

DNSZoneSnapshotRecord[] · required

DNS records the restore would add.

DNSZoneSnapshotRecord[] · required

DNS records the restore would remove.

DNSZoneSnapshotRecordChange[] · required

Existing DNS records the restore would change.

DNSZoneSnapshotRecord[] · required

Existing DNS records that already match the snapshot.

GET/domains/{domainNameOrId}/dns/snapshots/{dnsZoneSnapshotId}/restore/preview

curl https://domain.chief.app/api/v1/domains/:domainNameOrId/dns/snapshots/:dnsZoneSnapshotId/restore/preview \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "snapshot_id": "snapshot_id",
  "fingerprint": "fingerprint",
  "additions": [
    {
      "type": "type",
      "name": "name",
      "content": "content",
      "ttl": 0,
      "prio": 0,
      "comment": "comment",
      "metadata": {
        "key": "string"
      }
    }
  ],
  "removals": [
    {
      "type": "type",
      "name": "name",
      "content": "content",
      "ttl": 0,
      "prio": 0,
      "comment": "comment",
      "metadata": {
        "key": "string"
      }
    }
  ],
  "changes": [
    {
      "before": {
        "type": "type",
        "name": "name",
        "content": "content",
        "ttl": 0,
        "prio": 0,
        "comment": "comment",
        "metadata": {
          "key": "string"
        }
      },
      "after": {
        "type": "type",
        "name": "name",
        "content": "content",
        "ttl": 0,
        "prio": 0,
        "comment": "comment",
        "metadata": {
          "key": "string"
        }
      }
    }
  ],
  "unchanged": [
    {
      "type": "type",
      "name": "name",
      "content": "content",
      "ttl": 0,
      "prio": 0,
      "comment": "comment",
      "metadata": {
        "key": "string"
      }
    }
  ]
}

json

application/json

Restore DNS snapshot

POST

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

/domains/{domainNameOrId}/dns/snapshots/{dnsZoneSnapshotId}/restore

OpenID Connect

Bearer (ctp_*)

Bearer (ctt_*)

Replace the local hosted DNS zone with the records stored in a snapshot. Domain Chief saves the current zone first and publishes the restored records to hosted DNS after this request returns.

A preview is optional. When you supply a preview fingerprint, the restore is rejected if the current zone has changed since that preview.

Restore DNS snapshot › path Parameters

domainNameOrId

string · required

full domain name or ID

dnsZoneSnapshotId

string · required

snapshot ID

Restore DNS snapshot › Request Body

fingerprint

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

The opaque fingerprint returned by a previous restore preview.

Restore DNS snapshot › Responses

No content

No data returned

DNS Import & Export Web Redirects