Obtaining a debug report

Kaspersky Research Sandbox provides an API to obtain a debug report for the executed file as a .zip archive. The debug report is generated if you specified debug_report=true when creating or repeating the Sandbox task.

Diagnostic information about application performance is obtained separately.

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}/debug_report

Parameters

Obtaining debug report parameter

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>/debug_report' --output <archive name>

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

Responses

Endpoint returns a .zip archive that contains a debug report of the specified execution task.

200 OK

An archive that contains a debug report file was obtained successfully.

The .zip archive contains the following files:

internal_tracing.zip
network.pcap
report.zip
https_report.zip
ids_output.json

400 Bad Request

Failed to obtain a debug report 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:

The debug_report parameter was not specified during a task creation:

{ "code": 4,"message": "task artifacts disabled for this task"}

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 a debug report due to incorrect user credentials.

404 Not Found

A task with the specified ID not found.

500 Internal Server Error

Failed to create an execution task due to an internal server error.

Page top