Obtaining information about bundle images

Kaspersky Research Sandbox provides an API to obtain information about bundle images.

This method is available only for objects that were executed in the mobile (Android) operating system environment.

Request

Request method: GET

Endpoint: https://<server name>/api/v1/sandbox/tasks/{task ID}/bundleimages

Parameters

Obtaining information about bundle images

Parameter	Data type	Occurrence	Description
`task_id`	string	Required	Object execution task ID (GUID).

cURL command sample:

$ curl --user <user name> --request GET 'https://<server name>/api/v1/sandbox/tasks/<task ID>/bundleimages'

You will be asked to enter your password. The password is not displayed while you type it.

Responses

Endpoint returns a JSON object that contains information about bundle images.

200 OK

JSON object with information about bundle images is obtained successfully.

200 OK response parameters

Parameter	Data type	Description
`name`	string	Name of an image.

400 Bad Request

Failed to obtain information about bundle images due to incorrect query.

400 Bad Request response parameters

Parameter	Data type	Description
`code`	string	Error ID.
`message`	string	Error description.
`meta`	string	Additional information, if available.

Error examples:

Incorrect task_id parameter:

{"code":6,"message":"task not found"}

Incorrect task_id parameter format:

{"code":29,"message":"bad task id"}

401 Unauthorized

Failed to obtain information about bundle images due to incorrect user credentials.

404 Not Found

Task with specified ID not found.

Error example:

The task_id parameter for a Windows task was specified for an Android endpoint:

{"code":35, "message":"task section not found"}

500 Internal Server Error

Failed to obtain information about bundle images due to an internal server error.