Create a Cloudflare DNS Record
Adds a DNS record (A, AAAA, CNAME, MX, TXT, NS, CAA or SRV) to one of your Cloudflare zones.
- 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. create_dns_recordAuth: 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.create_dns_record with the same body (free).
Example request
curl -sS -X POST "https://api.primaryapi.com/v1/run/cloudflare.create_dns_record" \
-H "Authorization: Bearer $PRIMARYAPI_API_KEY" \
-H "Content-Type: application/json" \
-d '{"zone":"example.com","type":"A","name":"api","content":"198.51.100.4","ttl":3600}'const res = await fetch('https://api.primaryapi.com/v1/run/cloudflare.create_dns_record', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.PRIMARYAPI_API_KEY}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
zone: 'example.com',
type: 'A',
name: 'api',
content: '198.51.100.4',
ttl: 3600,
}),
});
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.create_dns_record",
headers={"Authorization": f"Bearer {os.environ['PRIMARYAPI_API_KEY']}"},
json={
"zone": "example.com",
"type": "A",
"name": "api",
"content": "198.51.100.4",
"ttl": 3600,
},
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.create_dns_record",
"input": {
"zone": "example.com",
"type": "A",
"name": "api",
"content": "198.51.100.4",
"ttl": 3600
}
}
}Price this exact input first (free)
curl -sS -X POST "https://api.primaryapi.com/v1/quote/cloudflare.create_dns_record" \
-H "Authorization: Bearer $PRIMARYAPI_API_KEY" \
-H "Content-Type: application/json" \
-d '{"zone":"example.com","type":"A","name":"api","content":"198.51.100.4","ttl":3600}'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
typeenumrequired- Record type: A, AAAA, CNAME, MX, TXT, NS, CAA or SRV.one of: A, AAAA, CNAME, MX, TXT, NS, CAA, SRV
namestringrequired- Record name: "@" for the zone apex, a single label such as "www" or "_dmarc" (placed inside the zone), or the full name ending in the zone, for example "www.example.com". Wildcards: "*.example.com". Punycode for non-ASCII names.max 255 chars
contentstring- The value. A: an IPv4 address. AAAA: an IPv6 address. CNAME: the target host name. MX: the mail server host name. NS: the name server. TXT: the text (Cloudflare adds the quotes). Not used for CAA and SRV (use `data`).max 4000 chars
priorityinteger- MX only: the preference, 0-65535 (lower is preferred).0–65535
dataobject- CAA and SRV records only: their parts. CAA: flags, tag, value. SRV: priority, weight, port, target (the record name must start with _service._protocol, for example "_sip._tcp.example.com").
data.flagsinteger- CAA: flags, 0-255 (usually 0).0–255
data.tagstring- CAA: the property, for example issue, issuewild or iodef.max 15 chars
data.valuestring- CAA: the value, for example letsencrypt.org.max 1000 chars
data.priorityinteger- SRV: priority, 0-65535.0–65535
data.weightinteger- SRV: weight, 0-65535.0–65535
data.portinteger- SRV: port, 0-65535.0–65535
data.targetstring- SRV: the target host name.max 253 chars
ttl1 | integerdefault1- Time to live in seconds: 1 = automatic (300 seconds), or 60-86400 (Enterprise zones may go down to 30). Proxied records always use 1. Default 1.
proxiedbooleandefaultfalse- Send the traffic through Cloudflare (orange cloud). Only A, AAAA and CNAME records can be proxied; their TTL is then automatic. Default false (DNS only).
commentstring- Your note on the record (not served in DNS). Up to 100 characters on the Free plan, 500 on other plans; no line breaks.max 500 chars
tagsstring[]- Tags as name:value, for example "team:web" (not served in DNS). Not available on the Free plan; up to 20 per record.max 20 items · items pattern: ^[A-Za-z0-9_-]{1,32}:[^\r\n]{0,100}$
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.
zoneIdstring- Cloudflare zone id
zonestring- The zone’s domain name
recordobject- The record as Cloudflare stored it
record.idstring- DNS record id (use it to update or delete the record)
record.typestring- A, AAAA, CNAME, MX, TXT, NS, CAA, SRV …
record.namestring- Full record name, in Punycode
record.contentstring | null- The value; for CAA and SRV a formatted summary of `data`
record.proxiedboolean- Traffic goes through Cloudflare (orange cloud)
record.proxiableboolean | null- Whether the record can be proxied
record.ttlinteger- Seconds; 1 = automatic
record.priorityinteger | null- MX (and URI) preference
record.dataobject | null- The parts of CAA, SRV and other structured records
record.commentstring | nullrecord.tagsstring[]record.createdAtstring | nullrecord.modifiedAtstring | null
TypeScript type
/** output.data when output.found is true */
type CloudflareCreateDnsRecord = {
/** Cloudflare zone id */
zoneId: string;
/** The zone’s domain name */
zone: string;
/** The record as Cloudflare stored it */
record: {
/** 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;
};
};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.
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": {
"zoneId": "023e105f4ecef8ad9ca31a8372d0c353",
"zone": "example.com",
"record": {
"id": "372e67954025e0ba6aaa6d586b9e0b59",
"type": "A",
"name": "api.example.com",
"content": "198.51.100.4",
"proxied": false,
"proxiable": true,
"ttl": 3600,
"priority": null,
"data": null,
"comment": null,
"tags": [],
"createdAt": "2014-01-01T05:20:00.123Z",
"modifiedAt": "2014-01-01T05:20:00.123Z"
}
}
},
"provider": "PrimaryAPI",
"credits": 1,
"items": 1,
"requestId": "req_01JBXK6Y2N9V8T4R3Q2P1M0A7Z"
}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 and needs the "Manage DNS" permission. This changes the live configuration of your Cloudflare zone right away: there is no undo, no preview and no automatic retry. A call that times out may still have gone through, so read the current state (cloudflare.dns_records) before trying again. An Idempotency-Key does not protect it: results of private APIs are never stored, so a repeated key runs the change again. Cloudflare refuses an A or AAAA record on a name that has a CNAME (and the reverse), any record next to an NS record of the same name, and an exact duplicate; those come back as invalid input. Comments longer than 100 characters and tags need a paid plan.
More Cloudflare endpoints
Generated from the PrimaryAPI catalog. Machine-readable contract: GET https://api.primaryapi.com/v1/apis/cloudflare.create_dns_record.