Kaspersky Research Sandbox provides an API to obtain the object execution map (information about sequence of file activities and relationships between them).
Request
Request method: GET
Endpoint for Windows and Linux environments: https://<server name>/api/v1/sandbox/tasks/{task ID}/activity-tree
Endpoint for Android environments: https://<server name>/api/v1/sandbox/tasks/{task ID}/executionmap-proc
Parameters
Obtaining execution map
Parameter |
Data type |
Occurrence |
Description |
---|---|---|---|
|
string |
Required |
Object execution task ID (GUID). |
cURL command sample for Windows and Linux: $ curl --user <user name> --request GET 'https://<server name>/api/v1/sandbox/tasks/<task ID>/activity-tree' cURL command sample for Android: $ curl --user <user name> --request GET 'https://<server name>/api/v1/sandbox/tasks/<task ID>/executionmap-proc' 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 the object execution map.
200 OK
Object execution map obtained successfully.
200 OK response parameters for Windows and Linux
Parameter |
Data type |
Description |
---|---|---|
|
integer |
Object ID. |
|
integer |
ID of the object parent. For the root (executed) object, |
|
string |
Name of object. For the root (executed) object, |
|
string |
Type of event ( |
|
integer |
Parameter required to build a tree. If |
|
integer |
Numerical value for the danger level of the registered activity (integer 1–1500). |
|
string |
Danger zone (level) of the object. |
|
string |
Object description. For the root (executed) object, this field is not displayed. |
|
array |
Array of fields that are displayed on the execution map in the Kaspersky Research Sandbox web interface. |
|
array |
Array of fields and their values that are displayed on the execution map in the Kaspersky Research Sandbox web interface. |
|
integer |
Techniques, sub techniques, and tactics in MITRE classification. |
|
array |
General process parameters. |
|
array |
Detailed description of child objects. For each child object, parameters described in this table are displayed. |
200 OK response parameters for Android
Parameter |
Data type |
Description |
---|---|---|
|
array |
Array containing data about objects in the execution map. Parameters are described in the table below. |
|
integer |
Object ID. |
|
string |
Type of event. |
|
string |
Object name. |
|
string |
Date and time the event task was registered, specified in the ISO 8601:2004 format (YYYY-MM-DDThh:mm:ssZ). |
|
array |
Description of the event. |
|
integer |
Numerical value of the danger level of the registered activity (integer 1–1000). |
|
string |
Value of the danger level of the registered activity. |
|
string |
Class of component. |
|
string |
Type of component. |
|
string |
Detailed description. |
|
array |
Description template. |
|
integer |
Total number of objects. |
|
integer |
Limit. |
400 Bad Request
Failed to obtain information about the object execution map due to incorrect query.
400 Bad Request response parameters
Parameter |
Data type |
Description |
---|---|---|
|
string |
Error ID. |
|
string |
Error description. |
|
string |
Additional information, if available. |
Error examples: Incorrect {"code":6,"message":"task not found"} Incorrect {"code":29,"message":"bad task id"} |
401 Unauthorized
Failed to obtain information about the object execution map due to incorrect user credentials.
404 Not Found
Task with specified ID not found.
Error example: The {"code":35, "message":"task section not found"} |
500 Internal Server Error
Failed to obtain information about the object execution map due to an internal server error.
Page top