Kaspersky Research Sandbox предоставляет API для получения списка задач выполнения файлов и просмотра веб-адресов, а также их параметров.
Запрос
Метод запроса: GET
Конечная точка: https://<server name>/api/v1/sandbox/tasks/
Параметры
Параметры получения списка задач песочницы
Параметр |
Тип данных |
Вхождение |
Описание |
---|---|---|---|
|
целое число |
Необязательно |
Указывает количество записей, которые следует пропустить в возвращаемом списке задач. Значение по умолчанию: |
|
целое число |
Необязательно |
Максимальное количество возвращаемых записей. Доступные значения: Значение по умолчанию: |
|
строка |
Необязательно |
Фильтрует записи по состоянию задачи. Доступные значения:
|
|
строка |
Необязательно |
Фильтрует записи по используемой среде выполнения. |
|
строка |
Необязательно |
Сортирует записи по следующим параметрам. Доступные значения:
|
|
логический |
Необязательно |
Сортирует записи в порядке убывания или возрастания:
|
|
строка |
Необязательно |
Фильтрует записи по зоне образца. Доступные значения:
|
|
логический |
Необязательно |
Фильтрует записи по наличию загруженного файла YARA. Доступные значения:
|
|
логический |
Необязательно |
Фильтрует записи по наличию загруженного файла Suricata. Доступные значения:
|
|
логический |
Необязательно |
Фильтрует записи по использованию режима VNC. Доступные значения:
|
|
строка |
Необязательно |
Фильтрует записи по расширению образца (точное совпадение). Длина параметра должна составлять от 1 до 100 символов. |
|
целое число |
Необязательно |
Фильтрует записи по минимальному размеру образца (в байтах). |
|
целое число |
Необязательно |
Фильтрует записи по максимальному размеру образца (в байтах). |
|
целое число |
Необязательно |
Фильтрует записи по минимальной дате создания задачи. Дата должна быть указана в системе меток времени UNIX. |
|
целое число |
Необязательно |
Фильтрует записи по максимальной дате создания задачи. Дата должна быть указана в системе меток времени UNIX. |
|
строка |
Необязательно |
Ищет определенные строки в образце (file_name, URL, md5, sha1, sha256). |
Пример команды cURL: $ curl --user <user name> --request GET 'https://<server name>/api/v1/sandbox/tasks?from=<from tasks>&count=<count tasks>' Вам будет предложено ввести пароль. Пароль не отображается во время ввода. |
Ответы
Конечная точка возвращает объект JSON, содержащий параметры задачи.
200 OK
Список задач песочницы успешно получен.
Параметры ответа 200 OK
Параметр |
Тип данных |
Описание |
|
---|---|---|---|
|
целое число |
Общее количество задач. |
|
|
массив объектов |
Подробности задачи выполнения файла или просмотра веб-адреса. |
|
|
строка <дата-время> |
Дата и время создания задачи, указанные в формате ISO 8601:2004 (ГГГГ-ММ-ДДTчч:мм:ссZ). |
|
|
строка <дата-время> |
Дата и время завершения анализа результатов, указанные в формате ISO 8601:2004 (ГГГГ-ММ-ДДTчч:мм:ссZ). |
|
|
строка |
Статус выполняемого файла или веб-адреса. Доступные значения:
Для задач со статусом, отличным от |
|
|
строка |
Цвет зоны файла или веб-адреса ( |
|
|
строка <дата-время> |
Дата и время последнего обновления антивирусных баз, указанные в формате ISO 8601:2004 (ГГГГ-ММ-ДДTчч:мм:ссZ). |
|
|
строка |
Идентификатор задачи (GUID). |
|
|
строка |
Идентификатор результата. |
|
|
строка |
Состояние задачи выполнения файла или просмотра веб-адреса. Доступные значения:
|
|
|
строка |
Код ошибки. Доступные значения:
|
|
|
строка |
Сообщение об ошибке. |
|
|
строка |
Исходное имя загруженного файла. |
|
|
строка |
Имя загруженного файла. |
|
|
строка |
Веб-адрес, просмотренный в песочнице. |
|
|
строка |
Имя загруженного архива. |
|
|
строка |
Расширение выполняемого файла (например |
|
|
строка |
Автоматически определяемый тип выполняемого файла. |
|
|
строка |
MD5-хеш исполняемого файла. |
|
|
строка |
SHA1-хеш исполняемого файла. |
|
|
строка |
SHA256-хеш исполняемого файла. |
|
|
строка |
SSDeep-хеш выполняемого объекта. |
|
|
строка |
Операционная система, которая использовалась в качестве среды выполнения. |
|
|
строка |
Пароль для архива. |
|
|
целое число |
Размер исполняемого файла в байтах. |
|
|
целое число |
Время выполнения файла или просмотра веб-адреса в секундах. |
|
|
массив |
Список обнаруженных объектов:
|
|
|
массив |
Список созданных снимков экрана. |
|
|
логический |
Указывает, был ли расшифрован HTTPS-трафик, сгенерированный выполняемым файлом или веб-ресурсом. Доступные значения:
|
|
|
логический |
Указывает, был ли выполнен полный (статический и динамический) анализ объекта, включая выполнение в песочнице. Доступные значения:
|
|
|
логический |
Состояние этапа статического анализа:
|
|
|
строка |
Имя сетевого канала, который использовался объектом для доступа в интернет. Доступные значения:
|
|
|
строка |
Имя сетевого канала, который объект фактически использовал для доступа в интернет (например, US). |
|
|
логический |
Указывает, имеются ли данные отчета для задачи. |
|
|
логический |
Указывает, был ли создан отчет об отладке. Доступные значения:
|
|
|
строка |
Параметры командной строки, которые использовались для выполнения объекта в песочнице. |
|
|
логический |
Указывает, просматривало ли приложение Kaspersky Research Sandbox ссылки в открытых документах. Доступные значения:
Этот параметр доступен только в том случае, если выбрана среда выполнения на базе Microsoft Windows. Если вы указали среду выполнения на базе Android (включая пользовательские среды), то значение этого параметра игнорируется во время выполнения файла. Однако результаты задачи содержат указанное вами значение |
|
|
строка |
Пароль для защищенного документа. Если пароль не указан, значение этого параметра равно |
|
|
строка |
Тип образца. |
|
|
массив объектов |
Автоматически рассчитанные параметры выполнения:
|
|
|
целое число |
Оценка угрозы объектов, основанная на показателях и данных, полученных в ходе выполнения задачи. |
|
|
целое число |
Время ожидания в секундах, по истечении которого приложение, в котором был открыт документ Microsoft Office, будет закрыто. Доступные значения: Актуально только для документов Microsoft Office, отправляемых в среды выполнения Windows. |
|
|
массив объектов |
Статус задачи проверки YARA и Suricata для объекта и его извлеченных файлов:
Возможные значения параметра
|
|
|
логический |
Указывает, использовался ли для задачи доступ к VNC. Доступные значения:
|
|
|
логический |
Указывает, был ли включен автоматический запуск образца в режиме VNC. Доступные значения:
|
|
|
string |
Дата и время запуска VNC для задачи. |
|
|
string |
Время до отключения доступа к VNC, в секундах. |
|
|
логический |
Указывает, активен ли в данный момент VNC для задачи. Доступные значения:
|
|
|
логический |
Указывает, был ли отключен кликер в режиме VNC. Доступные значения:
|
|
Пример ответа 200 OK: { "Created": "2024-11-07T12:07:01.782394Z", "Processed": null, "Status": "Unknown", "Zone": "Grey", "AvBasesVersion": "2024-11-06T10:41:00Z", "TaskId": "f84e985f-...-94d83721a465", "ResultID": "", "TaskState": "Processing", "ErrorCode": "", "ErrorMessage": "", "OriginalFileName": "original-file.rar", "FileName": "original-file.exe", "ArchiveSampleName": "original-file", "FileExtension": "exe", "FileType": "exe x32", "Md5": "86f...a2df", "Sha1": "252...530a7", "Sha256": "a6e226fa06...fd0b988", "SSDeep": "3072:yM...pcs...GQkxVj:yHv...Vj", "VirtualMachineId": "Win10_x64", "UnpackPassword": "", "FileSize": 135705, "EmulationTimeSeconds": 1800, "Detects": [], "Screenshots": null, "DecryptHttps": true, "PreScan": false, "PreScanState": { "CalcParam": true, "AvsScan": true, "StatPars": true }, "Channel": "", "UsedChannel": { "ID": 0, "Name": "", "Available": false, "Description": "" }, "IsDataAvailable": true, "DebugReport": false, "Url": "", "CmdLineParams": "", "ClickLinks": false, "DocsPassword": "", "SampleType": "single_file_arch", "CalculatedParams": { "ExecEnv": "Win10_x64", "ExecTime": 1800 }, "ThreatScore": 0, "AppsCloseTimeout": 0, "Userscan": { "Yara": { "Status": "not scanned", "Filename": "", "ScanningTime": null }, "Suricata": { "Status": "not scanned", "Filename": "", "ScanningTime": null } }, "VncAccess": true, "VncSampleAutostart": false, "VncStarted": null, "VncTimeLeft": 0, "VncStatus": 0, "DisableClicker": true } |
400 Bad Request
Не удалось получить список задач песочницы из-за неверного запроса.
Параметры ответа 400 Bad Request
Параметр |
Тип данных |
Описание |
---|---|---|
|
строка |
Идентификатор ошибки. |
|
строка |
Описание ошибки. |
|
строка |
Дополнительная информация, если таковая имеется. |
Примеры ошибок: Неверный параметр {"code":42,"message":"invalid value","meta":"count"} Неверный параметр {"code":42,"message":"invalid value","meta":"from"} |
401 Unauthorized
Не удалось получить список задач песочницы из-за неверных учетных данных пользователя.
500 Internal Server Error
Не удалось получить список задач песочницы из-за внутренней ошибки сервера.
В начало