DNS

Download schema

Endpoints for managing DNS.

List DNS records

GET

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

/domains/{domainNameOrId}/dns/records

OpenID Connect

Bearer (ctp_*)

Bearer (ctt_*)

List all DNS records for the domain.

You can only manage DNS records for domains that use hosted DNS.

List DNS records › path Parameters

domainNameOrId

string · required

full domain name or ID

List DNS records › query Parameters

query

string · minLength: 1

Search query.

sort

string[] · maxItems: 5 · style: form

Sort by up to five fields, separated by commas. Prefix a field with - for descending order.

Enum values:

type

-type

prio

-prio

name

-name

content

-content

Default: ["id"]

page

integer · min: 1

Default: 1

per_page

integer · min: 1 · max: 100

Default: 50

object

Search metadata key-value pairs. Only exact matches are supported.

List DNS records › Responses

Paginated set of DNSRecord

DNSRecord[] · required

object · required

GET/domains/{domainNameOrId}/dns/records

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

Example Responses

{
  "data": [
    {
      "id": "id",
      "type": "A",
      "name": "www",
      "content": "192.0.2.1",
      "ttl": 0,
      "prio": 0,
      "comment": "comment",
      "sync_error": "sync_error",
      "sync_error_at": "sync_error_at",
      "metadata": {
        "key": "string"
      }
    }
  ],
  "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

Create DNS record

POST

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

/domains/{domainNameOrId}/dns/records

OpenID Connect

Bearer (ctp_*)

Bearer (ctt_*)

Create a single DNS record for the domain.

You can only manage DNS records for domains that use hosted DNS.

Create DNS record › path Parameters

domainNameOrId

string · required

full domain name or ID

Create DNS record › Request Body

type

string · enum · required

Enum values:

AAAA

CNAME

TXT

ALIAS

CAA

SRV

content

string · required

ttl

integer · min: 60 · max: 2592000 · required

The record TTL in seconds. Supported values are 60, 300, 900, 1800, 3600, 21600, 43200, 86400, 172800, 259200, 604800, 1209600, and 2592000.

You may also pass any integer between 60 and 2592000. It will be adjusted to the closest supported TTL before the record is saved.

Example: 3600

name

string

prio

integer · min: 0 · max: 65535

comment

string | null · maxLength: 255

object

Optional metadata to attach to the record. Metadata keys must be strings and cannot exceed 40 characters or contain [ or ] characters. Metadata values must be strings and cannot exceed 500 characters. A record cannot have more than 50 metadata keys.

Example: {"key1":"value1","key2":"value2"}

Create DNS record › Responses

DNSRecord

DNSRecord · required

POST/domains/{domainNameOrId}/dns/records

curl https://domain.chief.app/api/v1/domains/:domainNameOrId/dns/records \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "type": "A",
  "name": "name",
  "content": "content",
  "ttl": 3600,
  "prio": 0,
  "comment": "comment",
  "metadata": {
    "key1": "value1",
    "key2": "value2"
  }
}'

Example Request Body

{
  "type": "A",
  "name": "name",
  "content": "content",
  "ttl": 3600,
  "prio": 0,
  "comment": "comment",
  "metadata": {
    "key1": "value1",
    "key2": "value2"
  }
}

json

Example Responses

{
  "data": {
    "id": "id",
    "type": "A",
    "name": "www",
    "content": "192.0.2.1",
    "ttl": 0,
    "prio": 0,
    "comment": "comment",
    "sync_error": "sync_error",
    "sync_error_at": "sync_error_at",
    "metadata": {
      "key": "string"
    }
  }
}

json

application/json

Show DNS record

GET

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

/domains/{domainNameOrId}/dns/records/{dnsRecordId}

OpenID Connect

Bearer (ctp_*)

Bearer (ctt_*)

Show a single DNS record for the domain.

You can only manage DNS records for domains that use hosted DNS.

Show DNS record › path Parameters

domainNameOrId

string · required

full domain name or ID

dnsRecordId

string · required

Show DNS record › Responses

DNSRecord

DNSRecord · required

Update DNS record

PUT

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

/domains/{domainNameOrId}/dns/records/{dnsRecordId}

OpenID Connect

Bearer (ctp_*)

Bearer (ctt_*)

Update a single DNS record for the domain.

You can only manage DNS records for domains that use hosted DNS.

Update DNS record › path Parameters

domainNameOrId

string · required

full domain name or ID

dnsRecordId

string · required

Update DNS record › Request Body

type

string · enum · required

Enum values:

AAAA

CNAME

TXT

ALIAS

CAA

SRV

content

string · required

ttl

integer · min: 60 · max: 2592000 · required

The record TTL in seconds. Supported values are 60, 300, 900, 1800, 3600, 21600, 43200, 86400, 172800, 259200, 604800, 1209600, and 2592000.

You may also pass any integer between 60 and 2592000. It will be adjusted to the closest supported TTL before the record is saved.

Example: 3600

name

string

prio

integer · min: 0 · max: 65535

comment

string | null · maxLength: 255

object

To remove a metadata key, set its value to an empty string. To remove all metadata, set the metadata field to an empty object: {}.

Example: {"key1":"value1","key2":"value2"}

Update DNS record › Responses

DNSRecord

DNSRecord · required

PUT/domains/{domainNameOrId}/dns/records/{dnsRecordId}

curl https://domain.chief.app/api/v1/domains/:domainNameOrId/dns/records/:dnsRecordId \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "type": "A",
  "name": "name",
  "content": "content",
  "ttl": 3600,
  "prio": 0,
  "comment": "comment",
  "metadata": {
    "key1": "value1",
    "key2": "value2"
  }
}'

Example Request Body

{
  "type": "A",
  "name": "name",
  "content": "content",
  "ttl": 3600,
  "prio": 0,
  "comment": "comment",
  "metadata": {
    "key1": "value1",
    "key2": "value2"
  }
}

json

Example Responses

{
  "data": {
    "id": "id",
    "type": "A",
    "name": "www",
    "content": "192.0.2.1",
    "ttl": 0,
    "prio": 0,
    "comment": "comment",
    "sync_error": "sync_error",
    "sync_error_at": "sync_error_at",
    "metadata": {
      "key": "string"
    }
  }
}

json

application/json

Delete DNS record

DELETE

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

/domains/{domainNameOrId}/dns/records/{dnsRecordId}

OpenID Connect

Bearer (ctp_*)

Bearer (ctt_*)

Deletes a single DNS record for the domain.

You can only manage DNS records for domains that use hosted DNS.

Delete DNS record › path Parameters

domainNameOrId

string · required

full domain name or ID

dnsRecordId

string · required

Delete DNS record › Responses

No data returned

Copy DNS records from another hosted zone

POST

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

/domains/{domainNameOrId}/dns/records/copy

OpenID Connect

Bearer (ctp_*)

Bearer (ctt_*)

Replace all DNS records for the destination domain with copies from another hosted DNS domain owned by the authenticated team. Only the record type, name, content, TTL, priority, and comment are copied. Hostname targets within the source zone are rewritten for the destination zone.

The records are replaced immediately. Allow time for the DNS changes to become visible.

This operation is irreversible and will replace all DNS records in the destination zone.

Copy DNS records from another hosted zone › path Parameters

domainNameOrId

string · required

destination full domain name or ID

Copy DNS records from another hosted zone › Request Body

source_domain

string · maxLength: 255 · required

The source full domain name or Domain Chief domain ID.

Copy DNS records from another hosted zone › Responses

The destination records were replaced and DNS publication was accepted.

copied_records

integer · required

source_domain

string · required

destination_domain

string · required

Clear DNS records

POST

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

/domains/{domainNameOrId}/dns/records/clear

OpenID Connect

Bearer (ctp_*)

Bearer (ctt_*)

Remove all DNS records for the domain.

If redirects (web or mail) are configured, their records will still be present after the reset.

You can only manage DNS records for domains that use hosted DNS.

This operation is irreversible and will remove all DNS records.

Clear DNS records › path Parameters

domainNameOrId

string · required

full domain name or ID

Clear DNS records › Responses

No content

No data returned

Reset DNS records

POST

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

/domains/{domainNameOrId}/dns/records/reset

OpenID Connect

Bearer (ctp_*)

Bearer (ctt_*)

Reset all DNS records for the domain to the default settings.

You can only manage DNS records for domains that use hosted DNS.

This operation is irreversible and will reset all DNS records the their Domain Chief default settings.

Reset DNS records › path Parameters

domainNameOrId

string · required

full domain name or ID

Reset DNS records › Responses

No content

No data returned

Domain Activity & Notices DNS Import & Export