Перейти к содержанию

Обзор

Основные характеристики

Характеристика Значение
Наименование logmule_go_templates_alert
Компоненты Cruddy
Появился в версии 3.7.0
Доступен в версиях 3.7.0 и выше
Авторизация по токену Security scheme type: http
Bearer format: JWT
Авторизация по APIkey Security scheme type: apiKey
Header parameter name: PgrApiKey
Версия API v2

Описание: Ресурс logmule_go_templates_alert отвечает за управление шаблонами алертов. Алерты являются частью правила корреляции и отвечают за поведение платформы при "сработке" привила. В шаблонах алертов можно настроить следующее поведение при "сработке" правила корреляции:

  • присвоение уровня риска;
  • автоматическое создание инцидента;
  • автоматическое назначение инцидента пользователю.

Список методов для работы с ресурсом

Тип Метод Описание
POST /logmule_go_templates_alert/create Создание шаблона алерта
PUT /logmule_go_templates_alert/update Обновление информации о шаблоне алерта
POST /logmule_go_templates_alert/search Поиск шаблонов алертов
GET /logmule_go_templates_alert/{id} Получение шаблона алерта по ID
DELETE /logmule_go_templates_alert/{id} Удаление шаблона алерта
POST /logmule_go_templates_alert/group Группировка шаблонов алертов
POST /logmule_go_templates_alert/mass_create Массовое создание шаблонов алертов
POST /logmule_go_templates_alert/mass_update Массовое обновление шаблонов алертов
POST /logmule_go_templates_alert/mass_delete Массовое удаление шаблонов алертов
DELETE /logmule_go_templates_alert/all Удаление шаблонов алертов по фильтру или всех шаблонов
GET /logmule_go_templates_alert/_meta Получение свойств полей и доступных действий для шаблонов алертов

Ответы методов

Статус код Описание
200 Успех
201 Успешное создание объекта
204 Успешный ответ. Пустое тело ответа
400 Неверный тип параметра запроса, либо отсутствует обязательный параметр
401 Невозможно аутентифицировать пользователя
404 Ресурс не найден
409 Попытка присвоить объекту существующее уникальное значение атрибута
422 Внутренняя ошибка удаления
500 Ошибка сервера

Модели объектов

Название Описание
AlertTemplate Модель данных ресурса logmule_go_templates_alert