Purge cache with the Cloudflare API

Removes cached content of a zone from every Cloudflare data center; the next request for it goes to the origin. Send exactly one of files, tags, hosts, prefixes or purge_everything. A success means the request was accepted, not that anything was cached. How many items fit in one call depends on the plan.

Identifier
cloudflare_purge_cache

The request

POST https://connect.reportei.com/api/tools/cloudflare_purge_cache/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "zone_id": "<zone_id>"
  }
}

Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.

Parameters

ParameterTypeRequiredDescription
zone_idstringYesThe id of the zone, from List zones.
filesarrayNoFull URLs to purge, such as https://www.example.com/styles.css.
tagsarrayNoPurges all content whose Cache-Tag response header has one of these tags.
hostsarrayNoPurges all content cached for these hostnames, such as www.example.com.
prefixesarrayNoPurges all content whose URL starts with one of these prefixes, without the scheme, such as www.example.com/blog/.
purge_everythingbooleanNotrue purges all cached content of the zone.

Supported connections

Your customer connects their Cloudflare account once, with one of the modes below. The same connection serves every tool of the toolkit.

API key

Your customer pastes the app's key on a Connect screen, or your system sends the key with POST /api/customer-toolkits, with no screen.

The response

On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.

Ready for AI agents

This tool's input is a JSON Schema, available at GET /api/tools/cloudflare_purge_cache. It becomes your agent's tool definition with no conversion.

Other Cloudflare tools

See all 8 tools

Toolkits in the same category

See all 100 toolkits

See Connect applied to your product.

Try it for 15 days with no card, or walk our team through your use case.