Skip to main content

getImagesList

This method lists all images available on a [SandboxAnalyzer] instance.

Parameters

Parameter

Type

Optional

Description

sandboxId

String

No

The ID of the Sandbox Analyzer instance for which the images list will be returned.

page

Number

Yes

The results page number. Default value: 1.

perPage

Number

Yes

The number of items displayed in a page. The upper limit is 100 items per page. Default value: 30.

Return value

This method returns an Object containing information regarding the images. The object has the following structure:

  • page - the current page displayed

  • pagesCount - the total number of available pages

  • perPage - the total number of returned items per page

  • items - the list of images. Each item in the list has the following fields:

    • id, the ID of the image.

    • name, the name of the image.

    • status, the status of the image. It can have one of the following values:

      • 1 - New

      • 2 - Failed

      • 3 - Ready

    • operatingSystem, the operating system of the image.

    • dateAdded, the date on which the image was added.

    • isDefault, a Boolean which has the value True when the image is set as default. False otherwise.

    • actionInProgress, a Boolean which has the value True when there is an action in progress for this image.

  • total - the total number of items

Example

Request:

  {
     "method": "getImagesList",
     "params": {
        "sandboxId": "5c419e6e26df3d367c49de18",
        "page": 1,
        "perPage": 20
     },
     "jsonrpc": "2.0",
     "id": "91d6430d-bfd4-494f-8d4d-4947406d21a7"
  }

Response:

  {
     "id": "91d6430d-bfd4-494f-8d4d-4947406d21a7",
     "jsonrpc": "2.0",
     "result": {
        "page": 1,
        "pagesCount": 1,
        "perPage": 20,
        "total": 1,
        "items": [
           {
               "id": "924cca0d49cc7e350a44502b0bb9026a",
               "name": "image1",
               "status": 1,
               "operatingSystem": "Windows 10",
               "dateAdded": "2019-01-18T09:20:50",
               "isDefault": true,
               "actionInProgress": false
           }
        ]
     }
  }
In this section: