Kaspersky Research Sandbox provides an API to obtain information about files that were downloaded by the executed object.
Request
Request method: GET
Endpoint: https://<server name>/api/v1/sandbox/tasks/{task ID}/downloads
Parameters
Obtaining information about downloaded files
Parameter |
Data type |
Occurrence |
Description |
---|---|---|---|
|
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>/downloads' 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 downloaded files.
200 OK
Information about downloaded files obtained successfully.
200 OK response parameters
Parameter |
Data type |
Description |
---|---|---|
|
string |
Danger level of downloaded file (for example, Red). |
|
string |
MD5 hash function of downloaded file. |
|
string |
SHA1 hash of downloaded file. |
|
string |
SHA256 hash of downloaded file. |
|
array |
Name of detected object (for example, Trojan-Downloader.Script.Generic). |
|
string |
File name of downloaded file (for example, sample.exe). |
|
integer |
Downloaded file size (bytes). |
|
string |
Downloaded file type. |
|
boolean |
Indicates whether traffic that the downloaded file was extracted from is HTTPS. |
|
array |
List of triggered YARA rules. |
200 OK response example: { "Zone": "Grey", "Md5": "string", "Sha1": "string", "Sha256": "string", "DetectionNames": [], "Name": "string", "Size": 0, "Type": "string", "IsHttpsTraffic": false, "TriggeredYaraRules": [] } |
400 Bad Request
Failed to obtain information about downloaded files 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 downloaded files due to incorrect user credentials.
404 Not Found
Task with specified ID not found.
500 Internal Server Error
Failed to obtain information about downloaded files due to an internal server error.
Page top