Purge Files by Cache-Tags, Host, or Prefix

Granularly removes one or more files from Cloudflare's cache either by specifying the host, the associated Cache-Tag, or a Prefix.

NB: Cache-Tag, host, and prefix purging each have a rate limit of 30,000 purge API calls in every 24 hour period. You may purge up to 30 tags, hosts, or prefixes in one API call. This rate limit can be raised for customers who need to purge at higher volume.

Request

Path Params

identifier

string

required

Body Params application/json

hosts

array[string]

optional

Any assets at URLs with a host that matches one of the provided values will be purged from the Cloudflare cache.

Example:

["www.example.com","images.example.com"]

prefixes

array[string]

optional

Any assets at URLs that match the prefix will be purged from the Cloudflare cache. For example, a.com/b will purge a.com/b/c/d.png but not a.com/bc.png. The prefixes a.com/b and a.com/b/c are redundant.

Example:

["www.example.com/foo","images.example.com/bar/baz"]

tags

array[string]

optional

Any assets served with a Cache-Tag header that matches one of the provided values will be purged from the Cloudflare cache.

Example:

["some-tag","another-tag"]

Example

{
    "hosts": [
        "www.example.com",
        "images.example.com"
    ],
    "prefixes": [
        "www.example.com/foo",
        "images.example.com/bar/baz"
    ],
    "tags": [
        "some-tag",
        "another-tag"
    ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Purge Files by Cache-Tags, Host, or Prefix response

application/json

Body

errors

array [object {2}]

messages

required

Example:

[]

code

integer

required

>= 1000

message

string

required

messages

array [object {2}]

messages

required

Example:

[]

code

integer

required

>= 1000

message

string

required

result

required

Any of

object

allOf {2}

string

common_components-schemas-identifier

read-onlyrequired

Identifier

<= 32 characters

Example:

023e105f4ecef8ad9ca31a8372d0c353

success

enum<boolean>

required

Whether the API call was successful

Allowed value:

true

Example:

true

Example

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

🟢200Purge Files by Cache-Tags, Host, or Prefix response failure