Purge Cache

Please refer to Purge Cache page to have a better understanding of cache purging.

Purges files from Global Caches & Internal Caches

POST https://api.imagemash.io/v1/storage/purgeCache

Headers

Name	Type	Description
apikey*	String	Your API Key

Request Body

Name	Type	Description
paths*	Array	Array of paths. Could be a complete path or a incomplete path. Consider as a search string. Please refer to Purge Cache to understand requirements of paths.
domain	String	Domain name. Eg. john.imagemash.io

200: OK requestId. To check status of request.

I26JPCNTSVM8DB

400: Bad Request Error

{
    msg: "error details"
    details: "..."
}   // Explanation of error

401: Unauthorized Unauthorized. Check your API Key

Unauthorized

500: Internal Server Error Server Error

{
    // Please contact support if you are getting this error constantly.
}

Example Codes

cURL

curl --location 'https://api.imagemash.io/v1/storage/purgeCache' \
--header 'apikey: your_api_key' \
--header 'Content-Type: application/json' \
--data '{
    "domain": "john.imagemash.io",
    "paths": [
        "/logo.png",
        "/img/big/my_"
    ]
}'

Node.js

var axios = require('axios');
var data = JSON.stringify({
  "domain": "john.imagemash.io",
  "paths": [
    "/logo.png",
    "/img/big/my_"
  ]
});

var config = {
  method: 'post',
maxBodyLength: Infinity,
  url: 'https://api.imagemash.io/v1/storage/purgeCache',
  headers: { 
    'apikey': 'your_api_key', 
    'Content-Type': 'application/json'
  },
  data : data
};

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

Python

import requests
import json

url = "https://api.imagemash.io/v1/storage/purgeCache"

payload = json.dumps({
  "domain": "john.imagemash.io",
  "paths": [
    "/logo.png",
    "/img/big/my_"
  ]
})
headers = {
  'apikey': 'your_api_key',
  'Content-Type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

Ruby

require "uri"
require "json"
require "net/http"

url = URI("https://api.imagemash.io/v1/storage/purgeCache")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["apikey"] = "your_api_key"
request["Content-Type"] = "application/json"
request.body = JSON.dump({
  "domain": "john.imagemash.io",
  "paths": [
    "/logo.png",
    "/img/big/my_"
  ]
})

response = https.request(request)
puts response.read_body

Get list of your Purge requests

POST https://api.imagemash.io/v1/storage/purgeCache

Headers

Name	Type	Description
apikey*		Your API Key

200: OK Array of your purge requests

[
    {
        "createdAt": "2022-09-22T14:25:30.995Z",
        "requestId": "I26JPCNTSVM8DB",
        "status": "InProgress",
        "paths": [
            "/eg1.png",
            "/img/big/my_",
            "/my_image_repository/"
        ]
    },
    {
        "createdAt": "2022-08-22T14:22:05.877Z",
        "requestId": "IVSU919KZECQH",
        "status": "Completed",
        "paths": [
            "/companies/my_company"
        ]
    }
]

400: Bad Request Error

{
    msg: "error details"
    details: "..."
}   // Explanation of error

401: Unauthorized Unauthorized. Check your API Key

Unauthorized

500: Internal Server Error Server Error

{
    // Please contact support if you are getting this error constantly.
}

Example Codes

cURL

curl --location --request POST 'https://api.imagemash.io/v1/storage/getPurgeList' \
--header 'apikey: your_api_key'

Node.js

var axios = require('axios');

var config = {
  method: 'post',
maxBodyLength: Infinity,
  url: 'https://api.imagemash.io/v1/storage/getPurgeList',
  headers: { 
    'apikey': 'your_api_key'
  }
};

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

Python

import requests

url = "https://api.imagemash.io/v1/storage/getPurgeList"

payload={}
headers = {
  'apikey': 'your_api_key'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

Ruby

require "uri"
require "net/http"

url = URI("https://api.imagemash.io/v1/storage/getPurgeList")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["apikey"] = "your_api_key"

response = https.request(request)
puts response.read_body