Obtaining container contents

Kaspersky Research Sandbox provides an API to obtain the contents (extracted files) of the executed packed object (container) in tar.gz format.

Before running this request, make sure the required task is not deleted.
In the cURL command, use the verbose mode (-v).
In case of a request error, the tar.gz archive will be empty, but will be a plain text file containing an error message.

Request

Request method: GET

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

Parameters

Obtaining container content

Parameter

Data type

Occurrence

Description

task_id

string

Required

Object execution task ID (GUID).

cURL command sample:

$ curl -v --user <user name> --request GET 'https://<server name>/api/v1/sandbox/tasks/<task ID>/container_files/archive' --output <tar.gz archive name>

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

Responses

Endpoint returns an archive in tar.gz format that contains the extracted files of the executed packed object (container).

200 OK

Container contents are obtained successfully.

400 Bad Request

Failed to obtain container contents 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 container contents.

404 Not Found

Task with specified ID not found.

500 Internal Server Error

Failed to obtain container contents due to an internal server error.

Page top