Получение карты выполнения

Kaspersky Research Sandbox предоставляет API для получения карты выполнения объектов (информации о последовательности действий файлов и связях между ними).

Запрос

Метод запроса: GET

Конечная точка для сред выполнения Windows и Linux: https://<server name>/api/v1/sandbox/tasks/{task ID}/activity-tree

Конечная точка для сред выполнения Android: https://<server name>/api/v1/sandbox/tasks/{task ID}/executionmap-proc

Параметры

Получение карты выполнения

Параметр	Тип данных	Вхождение	Описание
`task_id`	строка	Обязательно	Идентификатор задачи выполнения объекта (GUID).

Образец команды cURL для Windows и Linux:

$ curl --user <user name> --request GET 'https://<server name>/api/v1/sandbox/tasks/<task ID>/activity-tree'

Образец команды cURL для Android:

$ curl --user <user name> --request GET 'https://<server name>/api/v1/sandbox/tasks/<task ID>/executionmap-proc'

Вам будет предложено ввести пароль. Пароль не отображается во время ввода.

Ответы

Конечная точка возвращает объект JSON, содержащий карту выполнения объекта.

200 OK

Карта выполнения объекта успешно получена.

Параметры ответа 200 OK для Windows и Linux

Параметр	Тип данных	Описание
`Id`	целое число	Идентификатор объекта.
`ParentId`	целое число	Идентификатор родителя объекта. Для корневого (выполняемого) объекта `ParentId=0`.
`Name`	строка	Название объекта. Для корневого (выполняемого) объекта `Name=ROOT`.
`Class`	строка	Тип события (`action` или `susp`).
`InterestLevel`	целое число	Параметр, необходимый для построения дерева. Если `InterestLevel=100`, это означает, что объект является узлом дерева.
`Severity`	целое число	Числовое значение уровня опасности зарегистрированного действия (целое число 1–1500).
`Zone`	строка	Зона (уровень) опасности объекта.
`Description`	строка	Описание объекта. Для корневого (выполняемого) объекта это поле не отображается.
`KeyFields`	массив	Массив полей, отображаемых на карте выполнения в веб-интерфейсе Kaspersky Research Sandbox.
`MainProps`	массив	Массив полей и их значений, отображаемых на карте выполнения в веб-интерфейсе Kaspersky Research Sandbox.
`Techniques`	целое число	Техники, субтехники и тактики в классификации MITRE.
`Props`	массив	Общие параметры процесса.
`Children`	массив	Подробное описание дочерних объектов. Для каждого дочернего объекта отображаются параметры, описанные в этой таблице.

Параметры ответа 200 OK для Android

Параметр	Тип данных	Описание
`execMap`	массив	Массив, содержащий данные об объектах в карте выполнения. Параметры описаны в таблице ниже.
`ID`	целое число	Идентификатор объекта.
`class`	строка	Тип события.
`name`	строка	Имя объекта.
`timestamp`	строка	Дата и время регистрации задачи события, указанные в формате ISO 8601:2004 (ГГГГ-ММ-ДДTчч:мм:ссZ).
`properties`	массив	Описание события.
`severity`	целое число	Числовое значение уровня опасности зарегистрированного действия (целое число 1–1000).
`severity_status`	строка	Значение уровня опасности зарегистрированного действия.
`component_class`	строка	Класс компонента.
`component_type`	строка	Тип компонента.
`ext_description`	строка	Подробное описание.
`Locale`	массив	Шаблон описания.
`total`	целое число	Общее количество объектов.
`limit`	целое число	Ограничение.

400 Bad Request

Не удалось получить информацию о карте выполнения объекта из-за некорректного запроса.

Параметры ответа 400 Bad Request

Параметр	Тип данных	Описание
`code`	строка	Идентификатор ошибки.
`message`	строка	Описание ошибки.
`meta`	строка	Дополнительная информация, если таковая имеется.

Примеры ошибок:

Неверный параметр task_id:

{"code":6,"message":"task not found"}

Неверный формат параметра task_id:

{"code":29,"message":"bad task id"}

401 Unauthorized

Не удалось получить информацию о карте выполнения объекта из-за неверных учетных данных пользователя.

404 Not Found

Задача с указанным идентификатором не найдена.

Пример ошибки:

Параметр task_id для задачи Windows был указан для конечной точки Android:

{"code":35, "message":"task section not found"}

500 Internal Server Error

Не удалось получить информацию о карте выполнения объекта из-за внутренней ошибки сервера.

В начало