Параметры запроса
Параметр
|
Описание
|
Обязательный
|
action-adware
|
Действие при обнаружении рекламных программ.
Допустимые значения:
•ignore — игнорировать,
•delete — удалять,
•quarantine — перемещать в Карантин. |
нет
|
action-dialers
|
Действие при обнаружении программ дозвона
|
нет
|
action-hacktools
|
Действие при обнаружении программ взлома
|
нет
|
action-incurable-files
|
Действие при невозможности лечения зараженного объекта.
Допустимые значения:
•delete — удалять,
•quarantine — перемещать в Карантин. |
нет
|
action-infected-archive
|
Действие при обнаружении инфицированных архивов
|
нет
|
action-infected-boot
|
Действие при обнаружении инфицированных загрузочных секторов.
Допустимые значения:
•report — отправлять оповещение на Сервер Dr.Web,
•cure — лечить. |
нет
|
action-infected-container
|
Действие при обнаружении инфицированных файловых контейнеров
|
нет
|
action-infected-files
|
Действие при обнаружении инфицированных файлов.
Допустимые значения:
•cure — лечить,
•delete — удалять,
•quarantine — перемещать в Карантин. |
нет
|
action-infected-mail
|
Действие при обнаружении инфицированных почтовых файлов.
Допустимые значения:
•ignore — игнорировать,
•quarantine — перемещать в Карантин. |
нет
|
action-jokes
|
Действие при обнаружении программ-шуток
|
нет
|
action-riskware
|
Действие при обнаружении потенциально опасных программ
|
нет
|
action-suspicious-files
|
Действие при обнаружении подозрительных файлов.
Допустимые значения:
•ignore — игнорировать,
•delete — удалять,
•quarantine — перемещать в Карантин. |
нет
|
id
|
Идентификатор группы.
Параметр может быть указан в запросе неограниченное количество раз для запуска сканирования на станциях нескольких групп одновременно.
|
да
|
reboot
|
Задание автоматической перезагрузки компьютера пользователя после окончания сканирования, если в процессе проверки были обнаружены инфицированные объекты, для завершения лечения которых требуется перезагрузка операционной системы.
Допустимые значения: yes | no.
|
нет
|
type
|
Тип сканирования.
Допустимые значения:
•full — полное,
•quick — быстрое.
По умолчанию: quick.
|
нет
|
Пример запроса
https://192.168.1.1:9081/api/groups/start-scanner.ds?id=4
|
Ниже представлены примеры ответов в формате XML и в формате JSON.
Ответ в формате XML
<drweb-es-api api_version="4.3.2" timestamp="1558521918" server="192.168.1.1" srv_version="13.00.0.202005090" status="true">
<stations total="2">
<station id="e8702ab1-a176-4aef-8660-f01851fcae80" status="initiated"/>
<station id="1" status="failed"/>
</stations>
</drweb-es-api>
|
Описание параметров ответного XML
Элемент <stations /> содержит информацию о запуске сканирования в группах, указанных в запросе.
Атрибут элемента <stations />:
Атрибут
|
Описание
|
total
|
Общее количество станций в ответе
|
•Элемент <station /> содержит информацию о запуске сканирования конкретной станции.
Атрибуты элемента <station />:
Атрибут
|
Описание
|
id
|
Идентификатор станции
|
status
|
Статус запуска удаленного сканирования:
•delayed — запуск сканирования отложен,
•failed — запуск сканирования завершился с ошибкой,
•initiated — сканирование инициировано. |
Ответ в формате JSON
{ "head": {
"status": true,
"timestamp": 1558522001,
"api": {
"version": 40302,
"versionString": "4.3.2"},
"server": {
"name": "192.168.1.1",
"version": "13.00.0.202005090",
"uuid": "27671337-e0b0-4f60-aeb0-ab1f2ca47f77"}},
"data": {
"total": 2,
"list": {
"e8702ab1-a176-4aef-8660-f01851fcae80": "failed",
"1": "initiated"}}}
|
Описание параметров ответного JSON
Блок data содержит информацию о запуске сканирования в группах, указанных в запросе.
Элементы блока data:
Название поля
|
Описание
|
total
|
Общее количество станций в ответе
|
list
|
Блок с результатами запуска сканирования для каждой станции
|
•Элементы блока list:
Название поля
|
Описание
|
Идентификатор станции
|
Статус запуска удаленного сканирования:
•delayed — запуск сканирования отложен,
•failed — запуск сканирования завершился с ошибкой,
•initiated — сканирование инициировано. |
|