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

Обзор

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

Характеристика Значение
Наименование logmule_go_modules
Компоненты 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_modules отвечает за управление макросами. Макросы - это подключаемые общие модули к правилам корреляции, которые могут содержать как и переменные, так и расширять функционал с помощью функций.

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

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

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

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

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

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