API REFERENCE

Get DNS snapshot and compare-and-replace signatures

GET/api/v1/domains/{id}/dns

Operates on your account only. Send your API key in the Authorization header. Responses use JSON.

Request

Set BASE_URL to this website’s HTTPS origin and API_KEY to your private key. Replace RESOURCE_ID with the ID returned by the API.

cURL

curl --request GET "${BASE_URL}/api/v1/domains/RESOURCE_ID/dns" \
  --header "Authorization: Bearer $API_KEY"

Headers & parameters

Authorizationrequired

Bearer YOUR_API_KEY

idpath · stringrequired

Numeric domain ID; UUID for an order, operation or request.

Response

202 means accepted, not completed. Poll the order or operation. If the outcome is unknown, do not issue another purchase. Amounts are decimal strings in USD; dates use ISO 8601.

request_idstringrequired

Identifier used to recover an outcome after a network failure.

backendstring

delegationstring

snapshotobject

const: true

itemsarrayrequired

items[].idinteger

items[].record_typestring

DNS record type, such as A, AAAA, CNAME, TXT, MX or SRV.

items[].namestring

@ for the apex, * for wildcard, or a record name.

items[].contentstring

Record value matching its type.

items[].priorityinteger | null

MX priority: lower values are preferred.

items[].ttlinteger

DNS cache lifetime in seconds; 1 means automatic.

items[].proxiedboolean

Proxy a compatible record through Cloudflare.

items[].commentstring

Record note; not published in DNS.

rrsetsarrayrequired

rrsets[].namestring

@ for the apex, * for wildcard, or a record name.

rrsets[].record_typestring

DNS record type, such as A, AAAA, CNAME, TXT, MX or SRV.

rrsets[].expectedstring

Current RRset signature from GET DNS. Prevents overwriting concurrent changes.

empty_rrset_expectedstringrequired

Response structure example · illustrative values

JSON

{
  "request_id": "00000000-0000-4000-8000-000000000001",
  "backend": "string",
  "delegation": "string",
  "snapshot": true,
  "items": [
    {
      "id": 1,
      "record_type": "string",
      "name": "example.com",
      "content": "string",
      "priority": 1,
      "ttl": 1,
      "proxied": false,
      "comment": "string"
    }
  ],
  "rrsets": [
    {
      "name": "example.com",
      "record_type": "string",
      "expected": "string"
    }
  ],
  "empty_rrset_expected": "string"
}

Errors & statuses

error.code · error.message · request_id

401

Invalid or revoked key.

404

Resource not found in your account.

409

Idempotency conflict or request in progress.

422

Invalid parameters or business rule, including balance.

500

Outcome may be uncertain. Poll the request.

503

Temporarily unavailable. Respect Retry-After.