Purge cache status

get
Purge cache status API

https://api.imagekit.io/v1/files/purge/:requestId
Get the status of submitted purge request.
Request
Response
Request
Path Parameters
requestId
required
string
The requestId returned in response of purge cache API.
Headers
Authorization
required
string
base64 encoding of your_private_api_key: Note the colon in the end.
Response
200: OK
The status can be either Pending or Completed
{
status : "Pending"
}

Response structure and status code (application/JSON)

In case of 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 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.

  • Complete - 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.

cURL
Node.js
Python
PHP
cURL
# requestId returned in response of purge cache API.
curl -X GET "https://api.imagekit.io/v1/files/purge/requestId" \
-u your_private_key:
Node.js
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("cache_request_id", function(error, result) {
if(error) console.log(error);
else console.log(result);
});
Python
from imagekitio import ImageKit
imagekit = ImageKit(
private_key='your_public_api_key',
public_key='your_private_api_key',
url_endpoint = 'https://ik.imagekit.io/your_imagekit_id/'
)
purge_cache_status = imagekit.get_purge_cache_status("cache_request_id")
print("Cache status-", purge_cache_status)
PHP
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
);
$purgeCacheStatus = $imageKit->purgeCacheApiStatus("cache_request_id");
echo("Purge cache status : " . json_encode($purgeCacheStatus));