Invalidate
POST https://api.cloudimage.com/invalidate
scope
- original: invalidates original image and all transformations.
- all: invalidate the entire cache. Only use this scope if you know what you are doing ⚠️⚠️⚠️.
This endpoint will return an invalidation.uuid
that can be used for checking the status or restarting the invalidation task.
Statuses:
- RECEIVED: the request is received.
- PREPARING: the system prepares to start the invalidation process
- FLUSHINGCLOUDIMAGESERVER: the cache stored in the Cloudimage infra is flushing
- FLUSHINGCDNSERVERS: the cache of the CDN servers around the world is flushing
- DONE: the invalidation is completed
- ERROR: an error is thrown during the execution of the request. Please wait few minutes and try again or if the issue persists, contact our Support team for help.
Request Body
{"scope"=>"original", "urls"=>["http://sample.li/birds.jpg", "http://sample.li/car.jpg"]}
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
X-Client-Key | string | ||
Content-Type | string |
RESPONSES
status: Created
{"status":"success","msg":"Your invalidation request has been received","invalidation":{"status":"RECEIVED","uuid":"4fc96d31-9815-4021-830a-ca6d96c514a5","added_at":"2023-08-08 13:39:52.636426"}}