Links

Purge cache status

get
https://api.imagekit.io
/v1/files/purge/:requestId
Purge cache status API

Response structure and status code (application/JSON)

In case of an error, you will get an error code along with the error message. On success, you will receive a 200 status code with the purge request status in a JSON-encoded response body.

Understanding the response

The JSON-encoded response will have status property.
Field
Description
status
The current status of a submitted purge request. It can be either:
  • Pending - The request has been successfully submitted, and purging is in progress.
  • Completed - The purge request has been successfully completed. And now you should get a fresh object. Check the Age header in response to confirm this.

Examples

Here are some example requests to understand the API usage.
# request_id is the requestId returned in response of purge cache API.
curl -X GET "https://api.imagekit.io/v1/files/purge/request_id" \
-u your_private_key:
var ImageKit = require("imagekit");
​
var imagekit = new ImageKit({
publicKey : "your_public_api_key",
privateKey : "your_private_api_key",
urlEndpoint : "https://ik.imagekit.io/your_imagekit_id/"
});
​
imagekit.getPurgeCacheStatus("request_id", function(error, result) {
if(error) console.log(error);
else console.log(result);
});
from imagekitio import ImageKit
​
imagekit = ImageKit(
public_key='your_public_api_key',
private_key='your_private_api_key',
url_endpoint = 'https://ik.imagekit.io/your_imagekit_id/'
)
​
purge_cache_status = imagekit.get_purge_cache_status(purge_cache_id="request_id")
​
print("Cache status-", purge_cache_status)
​
# Raw Response
print(purge_cache_status.response_metadata.raw)
​
# print the purge file cache status
print(purge_cache_status.status)
use ImageKit\ImageKit;
​
$public_key = "your_public_api_key";
$your_private_key = "your_private_api_key";
$url_end_point = "https://ik.imagekit.io/your_imagekit_id";
​
$imageKit = new ImageKit(
$public_key,
$your_private_key,
$url_end_point
);
​
// The requestId returned in the response of purge cache API.
$requestId = 'request_id';
​
$purgeCacheStatus = $imageKit->purgeCacheApiStatus("request_id");
​
echo("Purge cache status : " . json_encode($purgeCacheStatus));
ResultCacheStatus result=ImageKit.getInstance().getPurgeCacheStatus("request_id");
imagekitio = ImageKitIo::Client.new("your_private_key", "your_public_key", "your_url_endpoint")
purge_cache_status = imagekitio.purge_file_cache_status(request_id: "request_id")
var imagekit = new ImageKit({
publicKey : "your_public_api_key",
privateKey : "your_private_api_key",
urlEndpoint : "https://ik.imagekit.io/your_imagekit_id/"
});
ResultCacheStatus resultCacheStatus = imagekit.PurgeStatus("request_Id");