Purge Cloudflare Cache
Clears cached content of one of your Cloudflare zones: everything, or by URLs, host names, cache tags or URL prefixes.
- 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. purge_cacheAuth: 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.purge_cache with the same body (free).
Example request
curl -sS -X POST "https://api.primaryapi.com/v1/run/cloudflare.purge_cache" \
-H "Authorization: Bearer $PRIMARYAPI_API_KEY" \
-H "Content-Type: application/json" \
-d '{"zone":"example.com","urls":["https://www.example.com/css/styles.css","https://www.example.com/js/index.js"]}'const res = await fetch('https://api.primaryapi.com/v1/run/cloudflare.purge_cache', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.PRIMARYAPI_API_KEY}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
zone: 'example.com',
urls: ['https://www.example.com/css/styles.css', 'https://www.example.com/js/index.js'],
}),
});
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.purge_cache",
headers={"Authorization": f"Bearer {os.environ['PRIMARYAPI_API_KEY']}"},
json={
"zone": "example.com",
"urls": ["https://www.example.com/css/styles.css", "https://www.example.com/js/index.js"],
},
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.purge_cache",
"input": {
"zone": "example.com",
"urls": [
"https://www.example.com/css/styles.css",
"https://www.example.com/js/index.js"
]
}
}
}Price this exact input first (free)
curl -sS -X POST "https://api.primaryapi.com/v1/quote/cloudflare.purge_cache" \
-H "Authorization: Bearer $PRIMARYAPI_API_KEY" \
-H "Content-Type: application/json" \
-d '{"zone":"example.com","urls":["https://www.example.com/css/styles.css","https://www.example.com/js/index.js"]}'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
everythingtrue- true = purge everything cached for the zone. Heavy: every visitor request goes to your origin until the cache refills. Use it alone.
urlsstring[]- Full URLs to purge, for example "https://www.example.com/css/styles.css" (1-100; no wildcards). UTF-8; the path is case-sensitive.min 1 items · max 100 items · items max 2048 chars
hostsstring[]- Host names whose cached content to purge, for example "images.example.com" (1-100).min 1 items · max 100 items · items max 2048 chars
tagsstring[]- Cache-Tag values whose content to purge (1-100; up to 1,024 characters each, no spaces; case-insensitive).min 1 items · max 100 items · items max 2048 chars
prefixesstring[]- URL prefixes without scheme, for example "www.example.com/blog/" (1-100; no query string or fragment; at most 31 "/").min 1 items · max 100 items · items max 2048 chars
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
purgedenum- What was purgedone of: everything, urls, hosts, tags, prefixes
countinteger- Items sent (0 for everything)
acceptedboolean- Cloudflare accepted the request. False when it refused some items (see errors); nothing is confirmed either way
purgeIdstring | null- Cloudflare’s id of the purge request
errorsobject[]- Items Cloudflare refused
errors[].codeintegererrors[].messagestring
TypeScript type
/** output.data when output.found is true */
type CloudflarePurgeCache = {
/** Cloudflare zone id */
zoneId: string;
/** The zone’s domain name */
zone: string;
/** What was purged */
purged: "everything" | "urls" | "hosts" | "tags" | "prefixes";
/** Items sent (0 for everything) */
count: number;
/** Cloudflare accepted the request. False when it refused some items (see errors); nothing is confirmed either way */
accepted: boolean;
/** Cloudflare’s id of the purge request */
purgeId: string | null;
/** Items Cloudflare refused */
errors: {
code: number;
message: string;
}[];
};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",
"purged": "urls",
"count": 2,
"accepted": true,
"purgeId": "023e105f4ecef8ad9ca31a8372d0c353",
"errors": []
}
},
"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 "Purge cache" permission. Purging changes what your live site serves: the next request for purged content goes to your origin, and Cloudflare does not serve purged content again even if the origin is down. Prefer URLs, tags, hosts or prefixes over everything. Every URL, host and prefix must belong to the zone. Accepted means Cloudflare took the request, not that anything was cached. Purge rate limits are per Cloudflare account and depend on its plan (the Free plan allows 5 host, tag, prefix or everything purges per minute); a limit comes back as rate_limited (with retryAfterSeconds when Cloudflare sends one). Not retried automatically; results are never stored.
More Cloudflare endpoints
Generated from the PrimaryAPI catalog. Machine-readable contract: GET https://api.primaryapi.com/v1/apis/cloudflare.purge_cache.