Модель
IntegrationType
Тип интеграции (тип интеграционного подключения):
| Параметр | Тип | Обязательность | Описание |
|---|---|---|---|
| id | string |
Required | Идентификатор типа интеграции в формате uuid |
| name | string |
Required | Наименование типа интеграции. Обычно наименование сторонней системы, с которой выполняется взаимодействие |
| state | boolean |
Required | Состояние типа интеграции. Возможные значения: - true - тип интеграции активирован в платформе; - false - тип интеграции неактивен. |
| ## ParameterMeta |
Параметры типа интеграции:
| Параметр | Тип | Обязательность | Описание |
|---|---|---|---|
| id | string |
Required | Идентификатор параметра в формате uuid |
| integration_type_id | string |
Required | Идентификатор типа интеграции в формате uuid |
| parameter_order | integer |
Required | Порядок параметра в веб-интерфейсе платформы |
| parameter_name | string |
Required | Название параметра с учётом вложенности по структуре конфигурации |
| value_type | string |
Required | Тип переменной. Допустимые значения: - boolean - integer - string - number - array |
| required_field | boolean |
Required | Является ли параметр обязательным к заполнению |
| value_params | object |
Required | Объект, содержащий информацию о значении параметра |
| value_params{title} | string |
Required | Наименование параметра в веб-интерфейсе платформы |
| value_params{description} | string |
Optional | Описание параметра в веб-интерфейсе платформы |
| value_params{min_value} | integer |
Optional | Минимальное значение (используется для параметров с типом int) |
| value_params{max_value} | integer |
Optional | Максимальное значение (используется для параметров с типом int) |
| value_params{example} | string |
Optional | Пример |
Integration
Экземпляр интеграции:
| Параметр | Тип | Обязательность | Описание |
|---|---|---|---|
| id | string |
Required | Идентификатор экземпляра интеграции в формате uuid |
| created_at | string |
Required | Дата создания в формате date-time |
| updated_at | string |
Required | Дата изменения в формате date-time |
| integration_type_id | string |
Required | Идентификатор типа интеграции |
| integration_name | string |
Required | Наименование экземпляра интеграции |
| state | boolean |
Required | Состояние экземпляра интеграции. Возможные значения: - true - тип интеграции активирован в платформе; - false - тип интеграции неактивен. |
| params | Array<Params> |
Required | Параметры интеграции |
Params
Параметры экземпляра интеграции. Набор параметров зависит от типа интеграции.
Поддерживаются следующие структуры параметров:
- ParamsEDR — RT Protect EDR;
- ParamsKSC — Kaspersky Security Center;
- ParamsAD — Active Directory;
- ParamsGitCorrelation — внешний контроль версий Git для правил корреляции;
- ParamsGitParsing — внешний контроль версий Git для правил разбора.
ParamsEDR
Параметры интеграции RT Protect EDR:
| Параметр | Тип | Обязательность | Описание |
|---|---|---|---|
| host | string |
Required | Адрес API сервера |
| port | string |
Required | Порт |
| auth_token | string |
Optional | Токен авторизации. Если указан, используется в приоритете перед login и password |
| login | string |
Optional | Логин. Используется, если не передан auth_token |
| password | string |
Optional | Пароль. Используется, если не передан auth_token |
| is_jobs_active | string |
Optional | Активировать периодические задачи. Возможные значения: "true", "false" |
| is_actions_active | string |
Optional | Активировать активные действия. Возможные значения: "true", "false" |
ParamsKSC
Параметры интеграции Kaspersky Security Center:
| Параметр | Тип | Обязательность | Описание |
|---|---|---|---|
| host | string |
Required | Адрес сервера Kaspersky Security Center |
| user | string |
Required | Логин пользователя |
| password | string |
Required | Пароль пользователя |
| domain | string |
Optional | Домен |
ParamsAD
Параметры интеграции Active Directory:
| Параметр | Тип | Обязательность | Описание |
|---|---|---|---|
| ad_controller_address | Array<string> |
Optional | Список адресов контроллеров Active Directory |
| port | integer |
Optional | Порт. Значение по умолчанию — 389 |
| is_use_tls | boolean |
Optional | Использование защищённого соединения с Active Directory |
| domain_name | string |
Optional | Домен |
| login | string |
Optional | Логин для подключения |
| password | string |
Optional | Пароль для подключения |
| ldap_user_filter | string |
Optional | Пользовательский фильтр для LDAP-запроса |
| scan_dn_list | Array<string> |
Optional | Список DN для сканирования |
| scan_level_deep | boolean |
Optional | Определяет выполнение поиска в глубину по поддереву или на одном уровне |
| import_active_hosts_outdated | integer |
Optional | Импортировать только узлы, у которых lastLogon новее указанного количества дней. Значение 0 — политика не применяется |
| sync_freq | string |
Optional | Cron-выражение для автоматической синхронизации активов |
Примечание: Для интеграции Active Directory параметр
sync_freqдолжен быть указан и содержать корректное cron-выражение. После создания или обновления интеграции расписание задачи «Синхронизация активов» синхронизируется с этим значением.
ParamsGitCorrelation
Параметры внешнего контроля версий Git для правил корреляции:
| Параметр | Тип | Обязательность | Описание |
|---|---|---|---|
| server_address | string |
Required | Адрес Git-репозитория |
| login | string |
Required | Логин |
| key | string |
Optional | SSH-ключ. Используется как альтернатива password |
| password | string |
Optional | Пароль. Используется как альтернатива key |
| pull_enabled | string |
Optional | Получение правил корреляции из Git. Возможные значения: "true", "false" |
| pull_branch | string |
Optional | Ветка для получения данных. Обязательна при pull_enabled = "true" |
| pull_interval_minutes | string |
Optional | Периодичность получения данных в минутах. Значение по умолчанию — 15 |
| pull_auto_apply | string |
Optional | Автоматическое применение полученных правил. Возможные значения: "true", "false" |
| push_enabled | string |
Optional | Отправка правил корреляции в Git. Возможные значения: "true", "false" |
| push_branch | string |
Optional | Ветка для отправки данных. Обязательна при push_enabled = "true" |
| push_mode | string |
Optional | Режим отправки. Возможные значения: accumulative, event. Обязателен при push_enabled = "true" |
| push_interval_minutes | string |
Optional | Периодичность отправки в минутах для режима accumulative |
| push_rule_statuses | string |
Optional | Статусы правил для отправки. Обязателен при push_enabled = "true" |
| push_comment_template | string |
Optional | Шаблон комментария к отправке. Поддерживаются плейсхолдеры branch, integration_name, rule_kind, rule_name, entity_id, action |
Для авторизации необходимо передать password или key.
В ответах API параметры password и key не возвращаются.
ParamsGitParsing
Параметры внешнего контроля версий Git для правил разбора:
| Параметр | Тип | Обязательность | Описание |
|---|---|---|---|
| server_address | string |
Required | Адрес Git-репозитория |
| login | string |
Required | Логин |
| key | string |
Optional | SSH-ключ. Используется как альтернатива password |
| password | string |
Optional | Пароль. Используется как альтернатива key |
| pull_enabled | string |
Optional | Получение правил разбора из Git. Возможные значения: "true", "false" |
| pull_branch | string |
Optional | Ветка для получения данных. Обязательна при pull_enabled = "true" |
| pull_interval_minutes | string |
Optional | Периодичность получения данных в минутах. Значение по умолчанию — 15 |
| pull_auto_apply | string |
Optional | Автоматическое применение полученных правил. Возможные значения: "true", "false" |
| push_enabled | string |
Optional | Отправка правил разбора в Git. Возможные значения: "true", "false" |
| push_branch | string |
Optional | Ветка для отправки данных. Обязательна при push_enabled = "true" |
| push_mode | string |
Optional | Режим отправки. Возможные значения: accumulative, event. Обязателен при push_enabled = "true" |
| push_interval_minutes | string |
Optional | Периодичность отправки в минутах для режима accumulative |
| push_rule_statuses | string |
Optional | Статусы правил для отправки. Обязателен при push_enabled = "true" |
| push_comment_template | string |
Optional | Шаблон комментария к отправке. Поддерживаются плейсхолдеры branch, integration_name, rule_kind, rule_name, entity_id, action |
Для авторизации необходимо передать password или key.
В ответах API параметры password и key не возвращаются.
IntegrationJob
Периодическая задача экземпляра интеграции
| Параметр | Тип | Обязательность | Описание |
|---|---|---|---|
| id | string |
Required | Идентификатор задачи в формате uuid |
| created_at | string |
Required | Дата создания в формате date-time |
| updated_at | string |
Required | Дата изменения в формате date-time |
| integration_type_id | string |
Required | Идентификатор типа интеграции |
| integration_id | string |
Required | Идентификатор экземпляра интеграции, в которой исполняется задача |
| state | boolean |
Required | Состояние задачи: - true - задача активна; - false - задача неактивна. |
| cron | string |
Required | CRON-выражение, описывающее периодичность выполнения задачи |
IntegrationJobsMeta
Периодические задачи типа интеграции
| Параметр | Тип | Обязательность | Описание |
|---|---|---|---|
| id | string |
Required | Идентификатор задачи в формате uuid |
| integration_type_id | string |
Required | Идентификатор типа интеграции в формате uuid |
| name | string |
Required | Название задачи |
| command | string |
Required | Текст запускаемой команды |
| state | boolean |
Required | Глобальное состояние задачи: - true - задача активна; - false - задача неактивна. |
| mappings | Array<object> |
Required | Массив передаваемых параметров |
| mappings{parameter_name} | string |
Required | Имя передаваемого параметра |
| mappings{parameter_type} | string |
Required | Тип передаваемого параметра |
IntegrationAction
Активное действие:
| Параметр | Тип | Обязательность | Описание |
|---|---|---|---|
| id | string |
Required | Идентификатор активного действия в формате uuid |
| integration_id | string |
Required | Идентификатор экземпляра интеграции в формате uuid |
| created_at | string |
Required | Дата создания в формате date-time |
| updated_at | string |
Required | Дата изменения в формате date-time |
| state | boolean |
Required | Состояние скрипта Вкл/выкл |
| integration_type_id | string |
Required | Идентификатор типа интеграции в формате uuid |
| name | string |
Required | Название активного действия |
| script_lin | string |
Optional | Скрипт активного действия для ОС Linux |
| script_win | string |
Optional | Скрипт активного действия для ОС Windows |
| state | boolean |
Required | Глобальное состояние скрипта (вкл/выкл) для всех экземпляров платформы |
| params | Array<object> |
Required | Список параметров для запуска скрипта |
| params{parameter_name} | string |
Required | Имя передаваемого для запуска скрипта параметра |
| params{parameter_value} | string |
Required | Что необходимо передать в качестве значения параметра (поле события) |
| params{from_event} | boolean |
Required | Берётся ли значение параметра из поля события или ручной ввод значения |
IntegrationActionMeta
Активное действие типа интеграции:
| Параметр | Тип | Обязательность | Описание |
|---|---|---|---|
| id | string |
Required | Идентификатор активного действия в формате uuid |
| integration_type_id | string |
Required | Идентификатор типа интеграции в формате uuid |
| name | string |
Required | Название активного действия |
| params | Array<object> |
Required | Список параметров для запуска скрипта |
| params{parameter_name} | string |
Required | Имя передаваемого для запуска скрипта параметра |
| params{parameter_value} | string |
Required | Что необходимо передать в качестве значения параметра (поле события) |
| params{from_event} | boolean |
Required | Берётся ли значение параметра из поля события или ручной ввод значения |
| script_lin | string |
Optional | Скрипт активного действия для ОС Linux |
| script_win | string |
Optional | Скрипт активного действия для ОС Windows |
| created_at | string |
Required | Дата создания в формате date-time |
| updated_at | string |
Required | Дата изменения в формате date-time |
IntegrationActionsLog
Журнал работы активных действий:
| Параметр | Тип | Обязательность | Описание |
|---|---|---|---|
| id | string |
Required | Идентификатор записи в формате uuid |
| integration_id | string |
Required | Идентификатор экземпляра интеграции в формате uuid |
| integration_action_id | string |
Required | Идентификатор активного действия в формате uuid |
| integration_script_id | string |
Required | Идентификатор скрипта |
| incident_id | string |
Required | Идентификатор связанного инцидента |
| service_asset_id | string |
Required | Идентификатор актива |
| rule_id | string |
Required | Идентификатор сработавшего правила корреляции |
| executed_at | string |
Required | Дата и время запуска команды от активного действия |
| result_at | string |
Required | Дата и время получения ответа после выполнения команды |
| executed_by | string |
Required | Инициатор запуска команды (пользователь или система на основе правила) |
| params | object |
Required | Объект с параметрами запуска |
| result | string |
Required | Результат выполнения команды |
| return_code | integer |
Required | Код ответа команды |
| integration | string |
Required | |
| integration_action | string |
Required | |
| integration_script | string |
Required | |
| service_asset | string |
Required | |
| logmule_go_rule | string |
Required | |
| _relations | object |
Required | Словарь, описывающий связанные сущности через идентификаторы |
ActionsHistoryRecord
Запись истории выполнения активного действия на активе:
| Параметр | Тип | Обязательность | Описание |
|---|---|---|---|
| id | integer |
Required | Идентификатор записи |
| integration_id | string |
Required | Идентификатор экземпляра интеграции |
| integration_script_id | integer |
Required | Идентификатор отработавшей команды активного действия |
| name | string |
Required | Название активного действия |
| params | Array<object> |
Required | Параметры запуска команды |
| params{parameter_name} | string |
Required | Имя параметра, передаваемого для запуска команды |
| params{parameter_value} | string |
Required | Что необходимо передать в качестве значения параметра (поле события) |
| executed_at | string |
Required | Время запуска команды |
| result_at | string |
Required | Время получения ответа команды |
| result | string |
Required | Ответ после выполнения команды |
| executed_by | string |
Required | Инициатор запуска команды: пользователь или правило корреляции |
| rule_id | string |
Required | Правило корреляции в рамках которого выполнилась команда |
| incident_id | string |
Optional | Если был создан инцидент, его ИД |
| service_assets_id | string |
Required | Идентификатора актива, на котором была выполнена команда |
LogmuleGoRulesIntegrationAction
Активное действие интеграции в правиле корреляции:
| Параметр | Тип | Обязательность | Описание |
|---|---|---|---|
| id | string |
Required | Идентификатор активного действия в формате uuid |
| created_at | string |
Required | Дата создания в формате date-time |
| updated_at | string |
Required | Дата изменения в формате date-time |
| rule_id | string |
Required | Идентификатор правила корреляции в формате uuid |
| integration_script_id | string |
Required | Идентификатор команды (скрипта) интеграции в формате uuid |
| params | Array<object> |
Required | Список параметров для запуска команды (скрипта) интеграции |
| params{parameter_name} | string |
Required | Имя передаваемого параметра |
| params{parameter_value} | string |
Required | Значение параметра |
| params{from_logline} | boolean |
Required | Флаг для получения значения параметра из логлайна (события). Если true, поле parameter_value должно содержать название поля логлайна (может содержать . для полей вложенных объектов) |
| params{strategy} | string |
Required | Стратегия выбора логлайна из массива. Поддерживаемые значения: - first — выбора первого логлайна,- last — выбора последнего логлайна. |
| state | boolean |
Required | Состояние активного действия в интеграции: вкл/выкл |
| logmule_go_rule | Array<object> |
Required | Модель связанного правила корреляции |
| integration_script | Array<object> |
Required | Связанная команда (скрипт) интеграции |
| integration_script{id} | string |
Required | Идентификатор команды (скрипта) |
| integration_script{created_at} | string |
Required | Дата создания в формате date-time |
| integration_script{updated_at} | string |
Required | Дата изменения в формате date-time |
GitIntegrationEntity
Содержит данные сущности, полученные из Git-репозитория до или после применения в Платформе:
| Параметр | Тип | Обязательность | Описание |
|---|---|---|---|
| id | string |
Required | Идентификатор в формате uuid |
| integration_id | string |
Required | Идентификатор экземпляра Git-интеграции в формате uuid |
| entity_id | string |
Required | Идентификатор целевой сущности в формате uuid |
| entity_type | string |
Required | Тип сущности. Возможные значения: - logmule_go_rule — правило корреляции;- sources_pipeline — источник и конвейеры разбора |
| content | object |
Required | Содержимое сущности в формате JSON, полученное из Git |
| view_data | object |
Required | Краткие данные сущности для отображения в веб-интерфейсе Платформы |
| applied | boolean |
Required | Состояние применения сущности: - false — ожидает применения;- true — записана в БД Платформы |
| created_at | string |
Required | Дата создания staging-записи в формате date-time |
| updated_at | string |
Required | Дата изменения staging-записи в формате date-time |
ServiceAssetIntegration
Данные обогащения актива, полученные из интеграции:
| Параметр | Тип | Обязательность | Описание |
|---|---|---|---|
| id | string |
Optional | Идентификатор записи в формате uuid |
| service_asset_id | string |
Optional | Идентификатор актива в формате uuid |
| integration_id | string |
Optional | Идентификатор экземпляра интеграции в формате uuid |
| data | object |
Optional | Данные обогащения актива |
| data{agent_id} | string |
Optional | Идентификатор агента в EDR в формате uuid |
| data{timezone} | string |
Optional | Часовой пояс |
| data{domain} | string |
Optional | Домен |
| data{edr_uri} | string |
Optional | URI объекта в EDR |
| created_at | string |
Optional | Дата и время создания записи в формате date-time |
| updated_at | string |
Optional | Дата и время изменения записи в формате date-time |