Type to search...

Image: delete by tag

This method deletes every image which has the given tag. The process will not run immediately, depending on the system load and the count of images it will take time. It’s a fast and efficient way to delete unwanted images, it’s good practice to use when you need to delete a big amount of images.

Request

HTTP request

DELETE /image/v1/c/<cloudId>/t/<tag> HTTP/1.1

Parameters

Paramete name Value Description
Path parameters
cloudId String ID of cloud
tag String Delete all images in the tag.

Request Body

This method does not support request body.

Response

If successful, this method returns a job resource in the response body.

Response HTTP status code

HTTP status code Description
202 Delete request recieved

For more information about HTTP codes, click here.

Rate limit

Detailed information for image rate limitation is available on Shardimage developers.

SDK

use shardimage\shardimagephp\auth\Client;
 
$client = new Client([
    'apiKey' => '<apiKey>',
    'apiSecret' => '<apiSecret>',
    'imageSecret' => '<imageSecret>',
]);
 
$job = $client->getImageService()->deleteByTag([
    'cloudId' => '<cloudId>',
    'tag' => '<tag>',
]);
 
Table of contents