Purge Cached Content

client.cache.purge(, ?): CachePurgeResponse { id } | null

POST/zones/{zone_id}/purge_cache

Deletes cached content in every Cloudflare data center and cache tier, including Cache Reserve. The next request for purged content is a cache MISS: Cloudflare fetches the full response from your origin and caches it again. Cloudflare does not serve purged content from cache again, even if your origin is unavailable.

To keep content cached and have Cloudflare revalidate it with your origin instead, use POST /zones/{zone_id}/invalidate_cache.

Choose what to purge

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. It does not confirm that any content was cached or removed. To check, request a purged URL and confirm that the CF-Cache-Status response header is MISS.

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

Accepted Permissions (at least one required)

Cache Purge

ParametersExpand Collapse

CachePurgeParams = CachePurgeFlexPurgeByTags | CachePurgeFlexPurgeByHostnames | CachePurgeFlexPurgeByPrefixes | 3 more

CachePurgeParamsBase { zone_id, tags }

zone_id: string

Path param: The zone ID.

maxLength32

tags?: Array<string>

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

CachePurgeFlexPurgeByTags extends CachePurgeParamsBase { zone_id, tags }

CachePurgeFlexPurgeByHostnames extends CachePurgeParamsBase { zone_id, tags }

CachePurgeFlexPurgeByPrefixes extends CachePurgeParamsBase { zone_id, tags }

CachePurgeEverything extends CachePurgeParamsBase { zone_id, tags }

CachePurgeSingleFile extends CachePurgeParamsBase { zone_id, tags }

CachePurgeSingleFileWithURLAndHeaders extends CachePurgeParamsBase { zone_id, tags }

ReturnsExpand Collapse

CachePurgeResponse { id }

id: string

maxLength32

Purge Cached Content

import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});

const response = await client.cache.purge({
  zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
  tags: ['product-1234', 'homepage'],
});

console.log(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
}