Type to search...

Image: get

Returns the specified image.


HTTP request

HEAD /image/v1/c/<cloudId>/o/<publicId> HTTP/1.1


Paramete name Value Description
Path parameters
cloudId string ID of cloud
publicId string Public ID of image
Optional query parameters
projection string Projection settings; comma separeted string see

Request Body

This method does not support request body.


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

Response HTTP status code

HTTP status code Description
200 Data of image
404 Image does not exist
423 Image record is locked (for example it’s being renamed or deleted at the moment)

For more information about HTTP codes, click here.

Rate limit

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


use shardimage\shardimagephp\auth\Client;
use shardimage\shardimagephp\models\image\ViewParams;
$client = new Client([
    'apiKey' => '<apiKey>',
    'apiSecret' => '<apiSecret>',
    'imageSecret' => '<imageSecret>',
$viewParams = new ViewParams();
$viewParams->projection = [
$image = $client->getImageService()->view([
    'cloudId' => '<cloudId>',
    'publicId' => '<publicId>',
], $viewParams);
Table of contents