DnsRecordPaginatedListResponse

Successful response with a page of DnsRecord

errorintegerrequired

Always 0 in a successful response

Constant value: 0

messagestring | nullnullablerequired

Always null in a successful response

data object[]required

Items of the page: an empty list beyond the last page

Array [

record_idstringrequired

typestringrequired

Type of the record, for example A, CNAME, MX or TXT

hoststringrequired

Name of the record relative to the zone, @ for the domain itself; for SRV and TLSA records, without the service and the protocol

servicestring | nullnullablerequired

Service of SRV records (for example _sip) and port of TLSA records (for example _443), with the underscore; null for the other types

protocolstring | nullnullablerequired

Protocol of SRV and TLSA records: _tcp, _udp or _tls; null for the other types

destinationstringrequired

Value of the record: the IPv4 address for A, the IPv6 address for AAAA, the target hostname for CNAME, MX, NS, PTR and SRV, the text for TXT and SPF, the value of the tag for CAA, the certificate association data for TLSA

portstring | nullnullablerequired

Port of the service, for SRV records; null for the other types

weightinteger | nullnullablerequired

Weight of SRV records; 0 for the other types

priorityinteger | nullnullablerequired

Priority of MX and SRV records; null for the other types and, with the standard and external nameservers, when it is 0

ttlinteger | nullnullablerequired

TTL of the record, in seconds: with Cloudflare null means automatic, with the standard and external nameservers it is the TTL of the zone (PATCH /api/v3/domains/{domain_id}/dns)

proxiedbooleanrequired

Whether the traffic of the record goes through the Cloudflare proxy; always false with the other nameserver types

caa_data objectrequired

Data of CAA records; null for the other types

anyOf

• DnsRecordCaaData
• null

flaginteger | nullnullablerequired

Flags of the CAA record; the API writes only 0

tag_valuestring | nullnullablerequired

Tag of the CAA record, for example issue or issuewild

can_sign_http_exchangesboolean | nullnullablerequired

Whether the value of the tag has the parameter cansignhttpexchanges=yes; null when the parameter is missing

tlsa_data objectrequired

Data of TLSA records; null for the other types

anyOf

• DnsRecordTlsaData
• null

usagestring | nullnullablerequired

Certificate usage: 0 (PKIX-TA), 1 (PKIX-EE), 2 (DANE-TA) or 3 (DANE-EE)

selectorstring | nullnullablerequired

Selector: 0 for the full certificate, 1 for its public key (SubjectPublicKeyInfo)

matching_typestring | nullnullablerequired

Matching type: 0 for the data without hashing, 1 for SHA-256, 2 for SHA-512

]

meta objectrequired

Pagination of the list, without the totals

countintegerrequired

Number of items in this page: 0 beyond the last page

pageintegerrequired

Number of this page, starting from 1

per_pageintegerrequired

Maximum number of items in a page

nextbooleanrequired

Tells if there is another page after this one

DnsRecordPaginatedListResponse

{
  "error": 0,
  "message": "string",
  "data": [
    {
      "record_id": "string",
      "type": "string",
      "host": "string",
      "service": "string",
      "protocol": "string",
      "destination": "string",
      "port": "string",
      "weight": 0,
      "priority": 0,
      "ttl": 0,
      "proxied": true,
      "caa_data": {
        "flag": 0,
        "tag_value": "string",
        "can_sign_http_exchanges": true
      },
      "tlsa_data": {
        "usage": "string",
        "selector": "string",
        "matching_type": "string"
      }
    }
  ],
  "meta": {
    "count": 0,
    "page": 0,
    "per_page": 0,
    "next": true
  }
}