Массив объектов JSON, которые представляют устройства.
Поля ответа:
Имя
Тип
Обязательный или необязательный
Описание
content / error
Строка
Обязательно
Если запрос выполнен успешно, возвращается свойство content. В противном случае возвращается свойство error.
Возможные значения содержимого:
Код состояния
Сообщение
Описание
200
Alert update request finished successfully.
Запрос обновления оповещения выполнен успешно. Нет комментариев.
200
Alert was already handled (handle).
На момент получения запроса на обработку оповещения это оповещение уже было обработано. Оповещение остается в состоянии handled (обработано).
200
Alert was already handled and learned (handleAndLearn).
На момент получения запроса handleAndLearn это оповещение уже было обработано и проанализировано. Оповещение остается в состоянии handledAndLearn (обработано и проанализировано).
200
Alert was already handled (handle). Handle and learn (handleAndLearn) was performed on the alert.
На момент получения запроса handleAndLearn это оповещение уже было обработано. Оповещение получает состояние handleAndLearn (обработано и проанализировано).
200
Alert was already handled and learned (handleAndLearn). Ignored handle request.
На момент получения запроса на обработку это оповещение уже было обработано и проанализировано (handleAndLearn). Оповещение остается в состоянии handleAndLearn (обработано и изучено).
500
Invalid action.
Отправленное действие не является допустимым для выполнения с этим оповещением.
500
Произошла непредвиденная ошибка.
Произошла непредвиденная ошибка. Чтобы устранить такую проблему, обратитесь в службу технической поддержки.
500
Couldn't execute request because no alert was found for this UUID.
Управляет периодами обслуживания, в которых оповещения не отправляются. Используйте этот API для определения и обновления времени остановки и запуска, устройств или подсетей, которые должны быть исключены при активации оповещений, или определения и обновления обработчиков Defender для Интернета вещей, которые должны быть исключены.
Например, вы можете отключить доставку оповещений на период обслуживания, за исключением оповещений о вредоносном ПО на критически важных устройствах.
Окна обслуживания, которые определяются с помощью maintenanceWindow API, отображаются в окне Исключения оповещений локальной консоли управления в виде правила исключения только для чтения с именем со следующим синтаксисом: Maintenance-{token name}-{ticket ID}.
Важно!
Этот API поддерживается только в целях обслуживания и в течение ограниченного периода времени и не предназначен для использования вместо правил исключения оповещений. Используйте этот API только для одноразовых временных операций обслуживания.
Строка. Определяет идентификатор билета на обслуживание в системах пользователя. Следите за тем, чтобы не использовать идентификаторы запроса, уже сопоставленные с существующими периодами обслуживания.
2987345p98234
Обязательно
ttl
Положительное целое число. Определяет срок жизни (срок жизни), который представляет собой продолжительность периода обслуживания в минутах. После завершения заданного периода времени период обслуживания закончится, и система снова будет работать нормально.
180
Обязательно
engines
Массив строк JSON. Определяет подсистему, из которой следует подавлять оповещения во время периода обслуживания. Возможные значения:
Массив строк JSON. Определяет датчики, с которых следует подавлять оповещения в течение периода обслуживания. Эти идентификаторы датчиков можно получить из API устройств (управление датчиками OT).
1,35,63
Необязательно
Подсети
Массив строк JSON. Определяет подсети для подавления оповещений во время периода обслуживания. Определите каждую подсеть в нотации CIDR.
192.168.0.0/16,138.136.80.0/14,112.138.10.0/8
Необязательно
Код состояния
Сообщение
Описание
201 (создано)
-
Действие успешно завершено.
400 (недопустимый запрос)
Нет TicketId
В запросе ticketId API отсутствует значение.
400 (недопустимый запрос)
Недопустимый срок жизни
Запрос API включал не положительное или нечисловое значение срока жизни.
400 (недопустимый запрос)
Не удалось проанализировать запрос.
Проблема с анализом текста, например неверные параметры или недопустимые значения.
400 (недопустимый запрос)
Период обслуживания с теми же параметрами уже существует.
Отображается, когда уже существует существующий период обслуживания с теми же сведениями.
404 (не найдено)
Неизвестный идентификатор датчика
Один из датчиков, перечисленных в запросе, не существует.
409 (конфликт)
У идентификатора билета уже есть открытое окно.
Идентификатор билета связан с другим открытым периодом обслуживания.
Определяет идентификатор билета на обслуживание в системах пользователя. Убедитесь, что идентификатор запроса связан с существующим открытым периодом обслуживания.
2987345p98234
Обязательно
Коды ошибок:
Код
Сообщение
Описание
200 (ОК)
-
Действие успешно завершено.
400 (недопустимый запрос)
Нет TicketId
Параметр ticketId отсутствует в запросе.
404 (не найдено):
Период обслуживания не найден.
Идентификатор билета не связан с открытым периодом обслуживания.
Получение журнала всех открытых действий (POST), закрытия (DELETE) и обновления (PUT), выполненных с помощью этого API для обработки периодов обслуживания. T
Фильтрует журналы от предопределенной даты и более поздних версий. Формат — YYYY-MM-DD.
2022-08-10
Необязательно
toDate
Фильтрует журналы до предопределенной даты. Формат — YYYY-MM-DD.
2022-08-10
Необязательно
ticketId
Фильтрует журналы, связанные с определенным идентификатором билета.
9a5fe99c-d914-4bda-9332-307384fe40bf
Необязательно
tokenName
Фильтрует журналы, связанные с определенным именем маркера.
ежеквартально-sanity-window
Необязательно
Коды ошибок:
Код
Сообщение
Описание
200
ОК
Действие успешно завершено.
204:
Нет содержимого
Нет данных для отображения.
400
Ошибка запроса
Неправильный формат даты.
500
Внутренняя ошибка сервера
Любая другая непредвиденная ошибка.
Тип: JSON
Массив объектов JSON, которые представляют операции периода обслуживания.
Структура ответа:
Имя
Тип
Допускающее значение NULL или не допускающее значение NULL
Список значений
id
Long integer
Не допускает значения NULL
Внутренний идентификатор текущего журнала
dateTime
Строка
Не допускает значения NULL
Время выполнения действия, например: 2022-04-23T18:25:43.511Z
ticketId
Строка
Не допускает значения NULL
Идентификатор периода обслуживания. Пример: 9a5fe99c-d914-4bda-9332-307384fe40bf
tokenName
Строка
Не допускает значения NULL
Имя маркера периода обслуживания. Пример: quarterly-sanity-window
engines
Массив строк
Допускает значения NULL
Подсистемы, к которым применяется период обслуживания, предоставленные во время создания периода обслуживания: Protocol Violation, Policy Violation, Malware, Anomalyили Operational
sensorIds
Массив строк
Допускает значения NULL
Датчики, к которым применяется период обслуживания, предоставляемые во время создания периода обслуживания.
Подсети
Массив строк
Допускает значения NULL
Подсети, к которым применяется период обслуживания, предоставленные во время создания периода обслуживания.
ttl
Числовой
Допускает значения NULL
Срок жизни (TTL) периода обслуживания, предоставленный во время создания или обновления периода обслуживания.
Позволяет обновить длительность периода обслуживания после запуска процесса обслуживания, изменив ttl параметр . Новое определение длительности переопределяет предыдущее.
Этот метод полезен в тех случаях, когда вы желаете указать более долгий период обслуживания, чем был определен ранее. Например, если вы изначально определили 180 минут, прошло 90 минут и хотите добавить еще 30 минут, измените ttl значение на минуту 120 , чтобы сбросить количество длительности.