Invalidate Cached Content

cache.invalidate() -> CacheInvalidateResponse

POST/zones/{zone_id}/invalidate_cache

Marks cached content as stale in every Cloudflare data center and cache tier, including Cache Reserve. The content stays in cache. The next request for it makes Cloudflare revalidate it with your origin, using the ETag and Last-Modified values it was cached with:

If your origin answers 304 Not Modified, Cloudflare serves the cached copy without downloading it again, and CF-Cache-Status is REVALIDATED.
If your origin sends a full response, Cloudflare serves and caches the new content, and CF-Cache-Status is EXPIRED.

With Tiered Cache, each tier revalidates with the tier above it, so a visitor can see EXPIRED even when your origin answered 304.

Until content is revalidated, your stale-while-revalidate and stale-if-error directives still apply, counted from the time you invalidated it. For example, if your origin fails during revalidation, Cloudflare can keep serving the stale copy for the stale-if-error window.

Invalidate or purge?

Invalidate when content may not have changed, for example after a deploy. Unchanged content costs your origin a 304 instead of a full response. That saving needs an origin that sends ETag or Last-Modified and answers conditional requests. Otherwise, every revalidation downloads the full response.
Purge, with POST /zones/{zone_id}/purge_cache, when content must not be served again, for example content you removed for legal or security reasons.

Invalidating takes the same request bodies as purging, needs the same permission, and counts against the same rate limits. After a broad invalidation, such as purge_everything, expect more conditional requests to your origin while visitors request the invalidated content again.

Choose what to invalidate

Send one of these fields in the request body:

files: specific URLs. If your cache key includes request headers, send each URL with the header values it was cached with.
tags: all content whose Cache-Tag response header contains one of the tags.
hosts: all content cached for the hostnames.
prefixes: all content whose URL starts with one of the prefixes.
purge_everything: all cached content in the zone.

Check the result

A 200 response with success: true means Cloudflare accepted the request. To check, request an invalidated URL and confirm that the CF-Cache-Status response header is REVALIDATED or EXPIRED.

Availability and limits

Rate limits and the number of items you can send in one request depend on your plan. See Purge cache: availability and limits.

Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

ParametersExpand Collapse

zone_id: str

maxLength32

tags: Optional[Sequence[str]]

Cache tags. Targets all content whose Cache-Tag response header contains at least one of these tags. See Purge cache by cache-tags.

ReturnsExpand Collapse

class CacheInvalidateResponse: …

id: str

maxLength32

Invalidate Cached Content

import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
response = client.cache.invalidate(
    zone_id="023e105f4ecef8ad9ca31a8372d0c353",
    tags=["product-1234", "homepage"],
)
print(response.id)

{
  "errors": [],
  "messages": [],
  "result": {
    "id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "success": true
}

{
  "errors": [
    {
      "code": 1092,
      "message": "Request cannot contain \"purge_everything\" and any of \"files\", \"tags\", \"hosts\" or \"prefixes\""
    }
  ],
  "messages": [],
  "result": null,
  "success": false
}

{
  "errors": [
    {
      "code": 1134,
      "message": "Unable to purge, rate limit reached. Please wait and consider throttling your request speed"
    }
  ],
  "messages": [],
  "result": null,
  "success": false
}

Returns Examples

{
  "errors": [],
  "messages": [],
  "result": {
    "id": "023e105f4ecef8ad9ca31a8372d0c353"
  },
  "success": true
}

{
  "errors": [
    {
      "code": 1092,
      "message": "Request cannot contain \"purge_everything\" and any of \"files\", \"tags\", \"hosts\" or \"prefixes\""
    }
  ],
  "messages": [],
  "result": null,
  "success": false
}

{
  "errors": [
    {
      "code": 1134,
      "message": "Unable to purge, rate limit reached. Please wait and consider throttling your request speed"
    }
  ],
  "messages": [],
  "result": null,
  "success": false
}