Cloudflare DNS Records
Lists the DNS records of one of your Cloudflare zones, filtered by type, name, content or proxy status.
- Price per call
- 1 credit
- per successful call
- Price ceiling
- 1 credit
- every call, same price
- Failed calls
- Free
- retried automatically
- Billed
- Per call
- only on success
Endpoint
api.primaryapi.com/ v1/ run/ cloudflare. dns_recordsAuth: API key with run or full access, or a dashboard session
Send the input below as a JSON body. The call is routed to a healthy upstream; if an attempt fails, it is retried automatically inside the same request and you pay only for the answer you get. To check an input and see the exact price without running anything, call POST /v1/quote/cloudflare.dns_records with the same body (free).
Example request
curl -sS -X POST "https://api.primaryapi.com/v1/run/cloudflare.dns_records" \
-H "Authorization: Bearer $PRIMARYAPI_API_KEY" \
-H "Content-Type: application/json" \
-d '{"zone":"example.com","limit":2}'const res = await fetch('https://api.primaryapi.com/v1/run/cloudflare.dns_records', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.PRIMARYAPI_API_KEY}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
zone: 'example.com',
limit: 2,
}),
});
const body = await res.json();
if (!res.ok) throw new Error(`${body.code}: ${body.error}`);
// found:false is a successful answer ("does not exist"), not an error
console.log(body.output.found ? body.output.data : body.output.reason, body.credits);import os
import requests
res = requests.post(
"https://api.primaryapi.com/v1/run/cloudflare.dns_records",
headers={"Authorization": f"Bearer {os.environ['PRIMARYAPI_API_KEY']}"},
json={
"zone": "example.com",
"limit": 2,
},
timeout=60,
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['code']}: {body['error']}")
# found=False is a successful answer ("does not exist"), not an error
print(body["output"]["data"] if body["output"]["found"] else body["output"]["reason"], body["credits"]){
"name": "run_api",
"arguments": {
"sku": "cloudflare.dns_records",
"input": {
"zone": "example.com",
"limit": 2
}
}
}Price this exact input first (free)
curl -sS -X POST "https://api.primaryapi.com/v1/quote/cloudflare.dns_records" \
-H "Authorization: Bearer $PRIMARYAPI_API_KEY" \
-H "Content-Type: application/json" \
-d '{"zone":"example.com","limit":2}'Returns credits (what the call is expected to cost) and maxCredits (the most it can cost, which is set aside while it runs). Invalid input fails here the same way it would on run.
Input
JSON body fields. Unknown fields are rejected with 400 invalid_input (never silently ignored). You may add the routing controls preferLatencyUnderMs and maxCredits to the same object.
zonestringrequired- The zone (domain) on Cloudflare: its domain name, for example "example.com", or its 32-character zone id from cloudflare.zones.max 253 chars
typeenum- Only records of this type, for example "A", "CNAME", "MX" or "TXT".one of: A, AAAA, CAA, CERT, CNAME, DNSKEY, DS, HTTPS, LOC, MX, NAPTR, NS, OPENPGPKEY, PTR, SMIMEA, SRV, SSHFP, SVCB, TLSA, TXT, URI
namestring- Only records with this name: "@" for the zone apex, a single label such as "www" (inside the zone), or the full name "www.example.com".max 255 chars
contentstring- Only records with exactly this content (case-insensitive), for example an IP address.max 4000 chars
proxiedboolean- Only proxied (true) or DNS-only (false) records.
orderenumdefault"type"- Sort field (default type).one of: type, name, content, ttl, proxied
directionenumdefault"asc"- Sort direction (default asc).one of: asc, desc
limitintegerdefault100- Maximum number of results to return (1-500, default 100).1–500
cursorstring- Opaque pagination cursor: pass the previous response's nextCursor.
connectionstring- Which connected account to use when the workspace has several for this provider: the customId you gave it (exact), its connection id ("con_…"), its handle (login, email or @handle) or its name. Optional; prefer the customId or id, which never match two accounts.max 200 chars
Output
When output.found is true, output.data has these fields (a list under records, billed per item returned).
recordsobject[]records[].idstring- DNS record id (use it to update or delete the record)
records[].typestring- A, AAAA, CNAME, MX, TXT, NS, CAA, SRV …
records[].namestring- Full record name, in Punycode
records[].contentstring | null- The value; for CAA and SRV a formatted summary of `data`
records[].proxiedboolean- Traffic goes through Cloudflare (orange cloud)
records[].proxiableboolean | null- Whether the record can be proxied
records[].ttlinteger- Seconds; 1 = automatic
records[].priorityinteger | null- MX (and URI) preference
records[].dataobject | null- The parts of CAA, SRV and other structured records
records[].commentstring | nullrecords[].tagsstring[]records[].createdAtstring | nullrecords[].modifiedAtstring | nullzoneIdstring- Cloudflare zone id
zonestring- The zone’s domain name
nextCursorstring | null
TypeScript type
/** output.data when output.found is true */
type CloudflareDnsRecords = {
records: {
/** DNS record id (use it to update or delete the record) */
id: string;
/** A, AAAA, CNAME, MX, TXT, NS, CAA, SRV … */
type: string;
/** Full record name, in Punycode */
name: string;
/** The value; for CAA and SRV a formatted summary of `data` */
content: string | null;
/** Traffic goes through Cloudflare (orange cloud) */
proxied: boolean;
/** Whether the record can be proxied */
proxiable: boolean | null;
/** Seconds; 1 = automatic */
ttl: number;
/** MX (and URI) preference */
priority: number | null;
/** The parts of CAA, SRV and other structured records */
data: Record<string, unknown> | null;
comment: string | null;
tags: string[];
createdAt: string | null;
modifiedAt: string | null;
}[];
/** Cloudflare zone id */
zoneId: string;
/** The zone’s domain name */
zone: string;
nextCursor: string | null;
};If what you asked about does not exist, is private, or a search matches nothing, the call still succeeds: output.found is false, output.data is null and output.reason says why. Such misses are free unless the notes below say misses are billed, in which case a miss costs the price of one call.
Pagination. Pass the previous response’s nextCursor as cursor to get the next page. nextCursor: null means there is nothing more. See Pagination.
Example response
Values are placeholders that follow the output schema (strings as "string", numbers as 0); credits shows what this call would cost at the usual price.
{
"output": {
"found": true,
"data": {
"records": [
{
"id": "372e67954025e0ba6aaa6d586b9e0b59",
"type": "A",
"name": "www.example.com",
"content": "198.51.100.4",
"proxied": true,
"proxiable": true,
"ttl": 1,
"priority": null,
"data": null,
"comment": "Web server",
"tags": [],
"createdAt": "2014-01-01T05:20:00.123Z",
"modifiedAt": "2014-01-01T05:20:00.123Z"
},
{
"id": "9a7806061c88ada191ed06f989cc3dac",
"type": "SRV",
"name": "_xmpp._tcp.example.com",
"content": "5 5223 server.example.com",
"proxied": false,
"proxiable": false,
"ttl": 1,
"priority": 10,
"data": {
"port": 5223,
"priority": 10,
"target": "server.example.com",
"weight": 5
},
"comment": null,
"tags": [],
"createdAt": "2022-11-08T15:57:39.585Z",
"modifiedAt": "2022-11-08T15:57:39.585Z"
}
],
"zoneId": "023e105f4ecef8ad9ca31a8372d0c353",
"zone": "example.com",
"nextCursor": null
}
},
"provider": "PrimaryAPI",
"credits": 1,
"items": 2,
"requestId": "req_01JBXK6Y2N9V8T4R3Q2P1M0A7Z",
"nextCursor": null
}Pricing and reliability
Calls go only to upstreams that are healthy right now. If an attempt fails, the call is retried automatically inside the same request; a failed attempt costs nothing, and a call never costs more than its quote’s maxCredits. Live figures below are measured on real traffic.
Success rate, uptime, latency and call counts are measured live from real traffic over 30 days and show “—” until there is data.
Errors
Errors are JSON { code, error, requestId } and are never charged. The ones to handle for this endpoint:
- invalid_inputThe request failed validation before anything ran.
- unauthorizedNo valid API key or session was presented.
- insufficient_balanceThe balance cannot cover the most this call could cost.
- key_limit_reachedThe key’s own spend limit is used up for the current window.
- trial_cap_reachedAn agent trial key has used its whole trial budget.
- forbiddenThe credential is valid but may not do this.
- not_foundThe thing addressed by the URL does not exist for you.
- idempotency_conflictThe
Idempotency-Keyis already bound to a different request. - rate_limitedToo many requests in the current window.
- all_sources_failedThe call could not be answered, even after automatic retries.
- service_unavailableThis API cannot run in this deployment right now.
- timeoutThe request passed its deadline before it finished.
Notes
Runs as your connected Cloudflare account (read-only). Pass the zone by domain name or zone id. A ttl of 1 means automatic. A zone the account cannot see is a miss (found: false, reason zone_not_found), not an error. Record ids from here feed cloudflare.update_dns_record and cloudflare.delete_dns_record. Results are never stored.
More Cloudflare endpoints
Generated from the PrimaryAPI catalog. Machine-readable contract: GET https://api.primaryapi.com/v1/apis/cloudflare.dns_records.