Type to search...

Image: list

List images from cloud.


HTTP request

GET /image/v1/c/<cloudId> HTTP/1.1


Parameter name Value Description
Path parameters
cloudId String ID of cloud

Optional query parameters

Parameter name Value Description
maxResults unsigned int Maximum number of items in result, default: 100
projection string Projection settings; comma separeted string see
nextPageTokenType string Next page token type; shortTime token live only few minutes (default); longTime token live only a hour
order string Order by list items; latest: latest uploaded first; publicId: order by public ID (UTF-16 bytecode)
pageToken string Token for listing page; If specified, then order parameter is skipped
byTag string List by tag, the last uploaded image will be the first in the list; If specified, then order parameter is skipped
prefix string List by public ID prefix in alphabetical order (UTF-16 bytecode); If specified, then order parameter is skipped

Request Body

Do not supply a request body with this method.


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

Response HTTP status code

HTTP status code Description
200 Success, image list resource

For more information about HTTP codes, click here.

Rate limit

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


Paging guide »


use shardimage\shardimagephp\auth\Client;
use shardimage\shardimagephp\models\image\IndexParams;
$client = new Client([
    'apiKey' => '<apiKey>',
    'apiSecret' => '<apiSecret>',
    'imageSecret' => '<imageSecret>',
$index = new IndexParams();
$index->maxResults = 20;
$index->projection = [
$images = $client->getImageService()->index(['cloudId' => '<cloudId>'], $index);
Table of contents