POST
/
v1
/
images
/
{image_id}
/
unpublish
Unpublish Image
curl --request POST \
  --url https://api.img-processing.com/v1/images/{image_id}/unpublish \
  --header 'x-api-key: <api-key>'
{
  "id": "image_etm0g3x5iap4cld1qcfsjvo2",
  "name": "Processed Image",
  "url": "https://storage.img-processing.com/images/image_etm0g3x5iap4cld1qcfsjvo2",
  "width": 460,
  "height": 460,
  "format": "jpeg",
  "size": 282000,
  "created_at": "2021-09-01T12:00:00.000Z"
}

​
Description

With this endpoint, you can unpublish an image that was previously published using the Publish Image endpoint. This will remove the image from the CDN and make it private again. After unpublishing an image, the url field of the image object will be updated with to null. You can still download the image using the Download Image endpoint.

Authorizations

​
x-api-key
string
header
required

API Key for authentication

Path Parameters

​
image_id
string
required

The unique identifier of the image. This identifier is used to reference the image in subsequent requests.

Response

201
application/json

The API will return the Image object in the response body.

The Image object represents an image processed using the IMG Processing API. The object contains information about the image, such as its URL, size, and format. The Image object is returned in the response body of all image processing requests.