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

Обзор

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

Характеристика Значение
Наименование logmule_go_rules
Компоненты 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_rules отвечает за управление правилами корреляции.  

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

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

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

Статус код Описание
200 Успех
201 Успешное создание объекта
204 Успешный ответ. Пустое тело ответа
400 Неверный тип параметра запроса, либо отсутствует обязательный параметр
404 Ресурс не найден
409 Попытка присвоить объекту существующее уникальное значение атрибута
422 Внутрення ошибка удаления
500 Ошибка сервера
858 Ошибка валидации поля settings.max_alerts - max_alerts
859 Ошибка валидации поля settings.max_alerts_interval - max_alerts_interval
860 Ошибка валидации поля settings.max_rule_memory_mb - max_rule_memory_mb
861 Не задан тип инцидента для активного правила
862 Не заданы фильтры для активного правила
863 Тест правила не проходит

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

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