purge-cache-status.md

Purge cache status

{% swagger baseUrl="https://api.imagekit.io" path="/v1/files/purge/:requestId" method="get" summary="Purge cache status API" %} {% swagger-description %} Get the status of the submitted purge request. {% endswagger-description %}

{% swagger-parameter in="path" name="requestId" type="string" %} The requestId returned in the response of purge cache API. {% endswagger-parameter %}

{% swagger-parameter in="header" name="Authorization" type="string" %} base64 encoding of your_private_api_key:

Note the colon in the end. {% endswagger-parameter %}

{% swagger-response status="200" description="The status can be either Pending or Completed" %}

{
    status : "Pending" // or "Completed"
}

{% endswagger-response %} {% endswagger %}

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.

{% tabs %} {% tab title="cURL" %}

# 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:

{% endtab %}

{% tab title="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("request_id", function(error, result) {
    if(error) console.log(error);
    else console.log(result);
});

{% endtab %}

{% tab title="Python" %}

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)

{% endtab %}

{% tab title="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
);

// 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));

{% endtab %}

{% tab title="Java" %}

ResultCacheStatus result=ImageKit.getInstance().getPurgeCacheStatus("request_id");

{% endtab %}

{% tab title="Ruby" %}

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")

{% endtab %}

{% tab title=".Net" %}

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");

{% endtabs %}