Получение результатов задачи песочницы

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

Запрос

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

Конечная точка: https://<server name>/api/v1/sandbox/tasks/{task ID}/report

Параметры

Параметры получения результатов выполнения задачи

Параметр

Тип данных

Вхождение

Описание

task_id

строка

Обязательно

Идентификатор задачи выполнения объекта (GUID), результаты которой требуется получить.

format

строка

Обязательно

Формат отчета.

Доступные значения:

  • json – файлы результатов выполнения указанной задачи в формате JSON в виде архива .zip.
  • single-json – все результаты выполнения в одном файле JSON. Каждый объект JSON в файле ответа содержит данные соответствующего файла с результатами выполнения объекта.
  • stix – файлы результатов выполнения указанной задачи в формате stix (доступно только для задач выполнения файлов).
  • csv – файлы результатов выполнения указанной задачи в формате CSV в виде архива .zip.
  • pcap – файлы результатов выполнения указанной задачи в формате PCAP.
  • pdf – файлы результатов выполнения указанной задачи в формате PDF.

Значение по умолчанию: json.

matrix_format

строка

Необязательно

Формат отчета о классификации MITRE ATT&CK.

Доступные значения:

  • full – новые расширенные описания (в формате JSON) в виде архива .zip.
  • short – предыдущий формат отчета.

Значение по умолчанию: full.

Пример команды cURL:

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

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

Ответы

Конечная точка возвращает результаты выполнения задачи в указанном формате.

200 OK

Результаты задачи песочницы получены успешно.

Подробное описание содержимого файла см. в разделах Экспорт результатов выполнения в архив JSON и Экспорт результатов выполнения в архив CSV.

Если вы запрашиваете только результаты статического анализа (pre_scan=true), ответ содержит следующую информацию:

Обратите внимание, что в текущей версии Kaspersky Research Sandbox файлы loaded-pe-images.json и loaded-pe-images.csv переименованы в loaded-images.json и loaded-image.csv соответственно.

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

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

500 Internal Server Error

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

В начало