Obtaining dump files

Kaspersky Research Sandbox provides an API to obtain a tar.gz archive that contains dump files (snapshots) of the file execution process and loaded modules.

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

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}/dumps/archive

Parameters

Obtaining dump files

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>/dumps/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 a tar.gz archive that contains dump files.

200 OK

Archive with dump files is obtained successfully.

400 Bad Request

Failed to obtain archive with dump files 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 archive with dump files 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 archive with dump files due to an internal server error.

Page top