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

Обновление шаблона алерта

Запрос

Тип Метод
PUT /logmule_go_templates_alert/update

Описание: при выполнении запроса будет обновлена информация о шаблоне в соответствии с заданными параметрами.

Работает по принципу частичного обновления, т.е. будут обновлены только те поля модели которые были переданы в запросе.

Пример запроса

PUT
http://127.0.0.1/cruddy/v2/logmule_go_templates_alert/update

Тело запроса:

Параметр Тип Обязательность Описание
id string Required ID шаблона алерта
trace_id string Optional Идентификатор трассировки действия пользователя для аудита
name string Required Название шаблона алерта
create_incident boolean Required Флаг: cоздавать ли инцидент в результате сработки правила
assign_to_customer boolean Required Флаг: назначить ли инцидент пользователю
risk_level number Required Уровень риска. Допустимые значения от 0 до 10.
asset_ip string Required IP-адрес актива
asset_hostname string Required Hostname актива
asset_fqdn string Required FQDN актива
asset_mac string Required MAC-адрес актива
first_and_last_logs boolean Required Флаг: записывать ли в журнал первое и последнее событие
trim_logs integer Required Количество событий для записи в журнал
template string Required Описание шаблона
mitre string Optional Описание техник Mitre. Обычно это идентификаторы техник, используемых киберпреступниками, которые описаны в базе знаний компании Mitre (подробнее см. Techniques - Enterprise | MITRE ATT&CK®)
Пример тела запроса

{
  "id": "uuid",
  "trace_id": "uuid",
  "name": "string",
  "create_incident": true,
  "assign_to_customer": true,
  "risk_level": 5.35,
  "asset_ip": "string",
  "asset_hostname": "string",
  "asset_fqdn": "string",
  "asset_mac": "string",
  "first_and_last_logs": false,
  "trim_logs": 1,
  "template": "string",
  "mitre": ""
}

Успешный ответ

Статус код: 200 – успешное обновление информации о шаблоне.

Формат: JSON.

Тело ответа: модель обновленного шаблона.

Пример ответа

{
  "id": "uuid",
  "trace_id": "uuid",
  "name": "string",
  "create_incident": true,
  "assign_to_customer": true,
  "risk_level": 5.35,
  "asset_ip": "string",
  "asset_hostname": "string",
  "asset_fqdn": "string",
  "asset_mac": "string",
  "first_and_last_logs": false,
  "trim_logs": 1,
  "template": "string",
  "mitre": ""
}

Другие возможные ответы

Код Ответ Описание
400 Bad Request
name_already_used
Неверный тип параметра запроса, либо отсутствует обязательный параметр
Попытка присвоить объекту существующее уникальное значение атрибута
404 Not Found Редактируемый объект не найден в БД
409 name_already_used Попытка создать объект с существующим уникальным атрибутом
500 Internal Server Error Другие ошибки при редактировании объекта

Примечание: Текст ошибки не фиксированный, может изменяться в зависимости от фактического ответа получателя запроса.

Пример ответа

Код 400

{
  "error": "Bad Request",
  "error_code": 400
}

Код 404

{
  "error": "Not Found",
  "error_code": 404
}

Код 409

{
  "error": "name_already_used",
  "error_code": 409,
  "extra": {
    "fields": [
      "name"
    ]
  }
}

Код 500

{
  "error": "Internal Server Error",
  "error_code": 500
}