Purge Environment Cache

POST

https://api.servebolt.io/v1/environments/{id}/purge_cache

Purge an environment's HTTP and CloudFlare cache by prefix, host, cache tag or file path.

It is important to note that Servebolt CDN users can only purge by Tags, or by Host. For full access to all types of purging, the website must be setup on the Accelerated Domains CDN.

Use only the correct CDN

Servebolt CDN and Accelerated Domains use different Zones inside Cloudflare, sending requests to the wrong zone will fail. Make sure to set the Type to be 'serveboltcdn' when on Servebolt CDN.

Add uniquness to your cache tags

To confirm uniqueness of the cache tags, make sure to use a prefix when adding them to HTTP headers on reponses, and again when requesting a purge. In the example the Environment ID has been used as a prefix. On Servebolt hosted services, the enviroment.json file can be found in the ~/ home of the SSH/FTP user on the server. In this file there is both the API bearer key and the Environment ID.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

string

required

the Environement id can be found in the ~/environment.json file under the key id

Example:

1234

Header Params

string

required

Example:

application/json

Content-Type

string

required

Example:

application/json

Authorization

string

required

The API token can be found in the ~/environement.json file on servebolt hosting

Example:

Bearer 2f68dbbf-519d-4f01-9636-e2421b68f379

Body Params application/json

files

array[string]

optional

prefixes

array[string]

optional

Hosts

array[string]

optional

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.servebolt.io/v1/environments/1234/purge_cache' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer 2f68dbbf-519d-4f01-9636-e2421b68f379' \
--header 'Content-Type: application/json' \
--data-raw '{
    "files": ["https://example.com/image.jpg", "https://example.com/article/about-caching", "https://example.com/"],
    "prefixes" : ["https://example.com/static/files/", "https://example.com/product/release/micro-site/"],
    "hosts" : ["staging.example.com", "acceptance.example.com"],
    "tags" : ["1234-home", "1234-post-archive", "1234-term-caching" , "1234-term-performance"]    
}'

Responses

🟢200Success

application/json

Body

object {0}

Example

{}

Modified at 2024-11-26 12:58:12

Delete Environment

List Environment Cronjobs

Purge Environment Cache

Purge an environment's HTTP and CloudFlare cache by prefix, host, cache tag or file path.#

Use only the correct CDN#

Add uniquness to your cache tags#

Request

Request samples

Responses

Purge an environment's HTTP and CloudFlare cache by prefix, host, cache tag or file path.

Use only the correct CDN

Add uniquness to your cache tags