Obtaining information about container contents

Kaspersky Research Sandbox provides an API to obtain information about the content (extracted files) of the executed packed object (container).

Request

Request method: GET

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

Parameters

Obtaining information about container's content

Parameter

Data type

Occurrence

Description

task_id

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>/container_files'

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 the extracted files of the executed packed object (container).

200 OK

Information about the contents of the container is obtained successfully.

200 OK response parameters

Parameter

Data type

Description

Zone

string

Danger level of the file (for example, Red).

Md5

string

MD5 hash function of the file.

Sha1

string

SHA1 hash of the file.

Sha256

string

SHA256 hash of the file.

Path

string

File name and path from the root of the uploaded object.

Packer

string

Name of the packer used to pack the uploaded object.

Type

string

Automatically detected file type.

DetectionNames

array

Name of the detected object (for example, Trojan-Downloader.Script.Generic).

200 OK response example:

{

"Zone": "Grey",

"MD5": "string",

"Sha1": "string",

"Sha256": "string",

"Path": "string",

"Packer": "string",

"Type": "string",

"DetectionNames": []

}

400 Bad Request

Failed to obtain information about the contents of the container 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 information about the contents of the container.

404 Not Found

Task with specified ID not found.

500 Internal Server Error

Failed to obtain information about the contents of the container due to an internal server error.

Page top