Add a Site to Cloudflare
Adds a domain to one of your Cloudflare accounts as a new zone and returns the Cloudflare name servers to set at your registrar.
- 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_zoneAuth: 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_zone with the same body (free).
Example request
curl -sS -X POST "https://api.primaryapi.com/v1/run/cloudflare.create_zone" \
-H "Authorization: Bearer $PRIMARYAPI_API_KEY" \
-H "Content-Type: application/json" \
-d '{"name":"example.com","account":"01a7362d577a6c3019a474fd6f485823"}'const res = await fetch('https://api.primaryapi.com/v1/run/cloudflare.create_zone', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.PRIMARYAPI_API_KEY}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
name: 'example.com',
account: '01a7362d577a6c3019a474fd6f485823',
}),
});
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_zone",
headers={"Authorization": f"Bearer {os.environ['PRIMARYAPI_API_KEY']}"},
json={
"name": "example.com",
"account": "01a7362d577a6c3019a474fd6f485823",
},
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_zone",
"input": {
"name": "example.com",
"account": "01a7362d577a6c3019a474fd6f485823"
}
}
}Price this exact input first (free)
curl -sS -X POST "https://api.primaryapi.com/v1/quote/cloudflare.create_zone" \
-H "Authorization: Bearer $PRIMARYAPI_API_KEY" \
-H "Content-Type: application/json" \
-d '{"name":"example.com","account":"01a7362d577a6c3019a474fd6f485823"}'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.
namestringrequired- The domain to add, for example "example.com" (usually the registered domain, not a subdomain).max 254 chars
accountstring- The Cloudflare account to add it to (its 32-character id from cloudflare.accounts). Optional when the connection can see exactly one account.pattern: ^[0-9a-f]{32}$
typeenumdefault"full"- full (default): Cloudflare hosts the DNS, and you point the domain’s name servers at Cloudflare. partial: a CNAME setup that keeps DNS elsewhere (Business and Enterprise plans).one of: full, partial
jump_startbooleandefaultfalse- true = ask Cloudflare to scan the domain’s current DNS records and copy them in. Default false.
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.
idstring- Zone id: pass it as `zone` to the other Cloudflare APIs
namestring- Domain name
statusstring | null- initializing, pending, active or moved
pausedboolean | null- True when Cloudflare only answers DNS (no proxy, security or performance)
typestring | null- full (DNS hosted on Cloudflare), partial (CNAME setup), secondary or internal
planobject | nullplan.idstring | nullplan.namestring | nullplan.legacyIdstring | null- Short plan id, for example "free"
accountobjectaccount.idstring | nullaccount.namestring | nullnameServersstring[]- Cloudflare name servers assigned to the zone
originalNameServersstring[] | null- Name servers before the move to Cloudflare
originalRegistrarstring | nullcreatedAtstring | nullmodifiedAtstring | nullactivatedAtstring | null- When the zone became active (ownership proven)
nextStepstring | null- What to do to activate the zone, for example which name servers to set at the registrar
TypeScript type
/** output.data when output.found is true */
type CloudflareCreateZone = {
/** Zone id: pass it as `zone` to the other Cloudflare APIs */
id: string;
/** Domain name */
name: string;
/** initializing, pending, active or moved */
status: string | null;
/** True when Cloudflare only answers DNS (no proxy, security or performance) */
paused: boolean | null;
/** full (DNS hosted on Cloudflare), partial (CNAME setup), secondary or internal */
type: string | null;
plan: {
id: string | null;
name: string | null;
/** Short plan id, for example "free" */
legacyId: string | null;
} | null;
account: {
id: string | null;
name: string | null;
};
/** Cloudflare name servers assigned to the zone */
nameServers: string[];
/** Name servers before the move to Cloudflare */
originalNameServers: string[] | null;
originalRegistrar: string | null;
createdAt: string | null;
modifiedAt: string | null;
/** When the zone became active (ownership proven) */
activatedAt: string | null;
/** What to do to activate the zone, for example which name servers to set at the registrar */
nextStep: 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": {
"id": "023e105f4ecef8ad9ca31a8372d0c353",
"name": "example.com",
"status": "pending",
"paused": false,
"type": "full",
"plan": {
"id": "023e105f4ecef8ad9ca31a8372d0c353",
"name": "Example Org",
"legacyId": "free"
},
"account": {
"id": "01a7362d577a6c3019a474fd6f485823",
"name": "Example Account Name"
},
"nameServers": [
"bob.ns.cloudflare.com",
"lola.ns.cloudflare.com"
],
"originalNameServers": [
"ns1.originaldnshost.com",
"ns2.originaldnshost.com"
],
"originalRegistrar": "GoDaddy",
"createdAt": "2014-01-01T05:20:00.123Z",
"modifiedAt": "2014-01-01T05:20:00.123Z",
"activatedAt": null,
"nextStep": "At the domain’s registrar, replace its name servers with bob.ns.cloudflare.com and lola.ns.cloudflare.com. Cloudflare activates the zone once it sees them."
}
},
"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 "Add and remove sites" permission. It changes your Cloudflare account right away: confirm the domain and the account with the person first. Leave out `account` when the connection sees one account; with several, pass one from cloudflare.accounts. A domain that is already a zone in the account answers invalid_input (Cloudflare error 1061): find it with cloudflare.zones. The new zone starts as pending: it becomes active once the domain’s name servers point at the ones returned in nameServers. Repeating the call with the same Idempotency-Key and input returns the first result instead of adding the zone again.
More Cloudflare endpoints
Generated from the PrimaryAPI catalog. Machine-readable contract: GET https://api.primaryapi.com/v1/apis/cloudflare.create_zone.