Purge cache by Pattern

Efficiently eliminate one or multiple files from iSmartFrame's cache by specifying a Pattern.

POST https://app.ismartframe.com/api/v1/cache/purge/pattern

Query Parameters

Name	Type	Description
api_key*	String	Your API Key

Request Body

Name	Type	Description
pattern*	String	The regular expression used to search for paths to be purged

200: OK Success

Cache purge successful. This operation may take a few minutes to propagate across all data centers.

400: Bad Request Bad Request format

{
    "result": false,
    "error": {
        "code": 400,
        "message": "Error: The given data was invalid."
    }
}

401: Unauthorized Not authorized

{
    "result": false,
    "error": {
        "code": 401,
        "message": "Invalid API Key"
    }
}

422: Unprocessable Entity The given regex did not pass some tests

{
    "result": false,
    "error": {
        "code": 422,
        "message": "The regex pattern is not valid."
    }
}

cURL

curl --location 'https://app.ismartframe.com/api/v1/cache/purge/pattern?api_key=YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
    "pattern": "#^\/test-url\/.+\\.html$#"
}'

Node.js

const axios = require('axios');
let data = JSON.stringify({
  "pattern": "#^\/test-url\/.+\\.html$#"
});

let config = {
  method: 'post',
  maxBodyLength: Infinity,
  url: 'https://app.ismartframe.com/api/v1/cache/purge/pattern?api_key=YOUR_API_KEY',
  headers: { 
    'Content-Type': 'application/json'
  },
  data : data
};

axios.request(config)
.then((response) => {
  console.log(JSON.stringify(response.data));
})
.catch((error) => {
  console.log(error);
});

How does it work?

This API accepts a pattern parameter as input, which is a string containing a JSON-escaped regular expression (regex). This regex is utilized to filter through paths stored in the cache, performing a purge on those that match. The process is designed to ensure that only specific cache entries, identified by the paths that conform to the provided regex pattern, are removed. This allows for precise control over the cache purging process, enabling users to selectively clear cached content based on complex criteria defined by the regex.

For instance, if the regex pattern provided matches a set of URLs within your website, the API will target and purge the cache for those specific URLs across all device types, without affecting the cache of other pages or resources. This capability is particularly useful for maintaining the freshness of your site's content by removing outdated or no longer relevant cache entries without the need to clear the entire cache.

It's important to note that the regex pattern should be carefully crafted to match the intended paths accurately, as the API operates strictly based on the regex criteria provided. Misconfigured patterns may lead to unintended cache purging. Additionally, users should ensure that the regex string is properly JSON-escaped to avoid parsing errors and to ensure the API processes the pattern correctly.