Загрузка файла YARA

Kaspersky Research Sandbox предоставляет API для загрузки файла YARA для указанной задачи.

Kaspersky Research Sandbox поддерживает только те модули правил YARA, которые используются в статическом анализе файла и его содержимого. Поведенческие характеристики не поддерживаются. В частности, модули cuckoo и console не поддерживаются.

Возможно, указанная задача уже выполнена. В этом случае после успешной загрузки или замены файла YARA автоматически начинается проверка (в соответствии с правилами YARA) загруженного файла.

Запрос

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

Конечная точка: https://<server name>/api/v1/sandbox/tasks/<task ID>/yara?file_name=<YARA file name>

Параметры

Параметры загрузки файла YARA

Параметр

Тип данных

Вхождение

Описание

task_id

строка

Обязательно

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

file_name

строка

Обязательно

Имя файла YARA.

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

$ curl --http1.1 --user <user name> --request POST --header "Content-Type:application/octet-stream" --data-binary '@<path to file>' 'https://<server name>/api/v1/sandbox/tasks/<task ID>/yara?file_name=<YARA file name>'

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

Ответы

Конечная точка загружает файл YARA.

200 OK

Файл YARA успешно загружен.

Параметры ответа 200 OK

Параметр

Тип данных

Описание

id

строка

Идентификатор (GUID) вновь создаваемой задачи.

Пример ответа 200 OK:

{

"id": "5cf8cbb4-1d50-492c-986b-86d5c7596535"

}

400 Bad Request

Не удалось загрузить файл YARA.

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

Параметр

Тип данных

Описание

code

строка

Идентификатор ошибки.

message

строка

Описание ошибки.

meta

строка

Дополнительная информация, если таковая имеется.

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

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

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

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

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

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

{"code":68,"message":"filename malformed"}

401 Unauthorized

Не удалось загрузить файл YARA из-за неверных учетных данных пользователя.

412 Precondition Failed

Не удалось загрузить файл YARA, так как задача все еще выполняется. Дождитесь завершения задачи и повторите попытку позднее.

500 Internal Server Error

Не удалось загрузить файл YARA из-за внутренней ошибки сервера.

В начало