GET STARTED WITH APIs
Overview
ENDPOINTS
Upload File
Digital Asset Management (DAM)
Caching
Purge cache
post
Get purge status
get
File Metadata
Account Management API
post
https://api.imagekit.io
/v1/files/purge

This API will purge CDN cache and ImageKit.io's internal cache for a file. Note: Purge cache is an asynchronous process and it may take some time to reflect the changes.

Request

Body

url
string
required

The full URL of the file to be purged.

Example:
https://ik.imagekit.io/your_imagekit_id/default-image.jpg
Auth
API key
:
Body
Note

Here, you can explore machine-generated code examples. For practical applications, refer to the examples section below, which includes detailed code snippets from the ImageKit SDKs.

curl --request POST \
  --url https://api.imagekit.io/v1/files/purge \
  --header 'Accept: application/json' \
  --header 'Authorization: Basic 123' \
  --header 'Content-Type: application/json' \
  --data '{
  "url": "https://ik.imagekit.io/your_imagekit_id/default-image.jpg"
}'

Responses

Purge request submitted successfully. A requestId will be returned.

Body

requestId
string

Unique identifier of the purge request. This can be used to check the status of the purge request.

1
{
2
  "requestId": "string"
3
}

Examples

Here are some examples to understand the API usage.

Copy
curl -X POST "https://api.imagekit.io/v1/files/purge" \
-H "content-type: application/json" \
-u your_private_key: -d'
{
    "url": "https://ik.imagekit.io/your_imagekit_id/default-image.jpg"
}
'

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.purgeCache("https://ik.imagekit.io/your_imagekit_id/default-image.jpg", 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 = imagekit.purge_cache(file_url="https://ik.imagekit.io/your_imagekit_id/default-image.jpg")

print("Purge cache-", purge_cache)

# Raw Response
print(purge_cache.response_metadata.raw)

# print the purge file cache request id
print(purge_cache.request_id)

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

$image_url = 'https://ik.imagekit.io/your_imagekit_id/default-image.jpg';
$purgeCache = $imageKit->purgeCache($image_url);

echo("File details : " . json_encode($purgeCache));

ResultCache result = ImageKit.getInstance().purgeCache("https://ik.imagekit.io/your_imagekit_id/default-image.jpg");

imagekitio = ImageKitIo::Client.new("your_private_key", "your_public_key", "your_url_endpoint")
purge_cache = imagekitio.purge_file_cache(file_url: "https://ik.imagekit.io/your_imagekit_id/default-image.jpg")

resp, err := ik.Media.PurgeCache(ctx, media.PurgeCacheParam{
    Url: "https://ik.imagekit.io/your_imagekit_id/default-image.jpg",
})

var imagekit = new ImageKit({
    publicKey : "your_public_api_key",
    privateKey : "your_private_api_key",
    urlEndpoint : "https://ik.imagekit.io/your_imagekit_id/"
});

ResultCache resultCache = imagekit.PurgeCache("https://ik.imagekit.io/your_imagekit_id/default-image.jpg");