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

Обзор

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

Характеристика Значение
Наименование integration
Компоненты Development server: https://development.gigantic-server.com
Staging server: https://staging.gigantic-server.com
Cruddy
Появился в версии 4.1.0
Доступен в версиях 4.1.0 и выше
Авторизация по токену Security scheme type: https
Bearer format: JWT
Авторизация по APIkey Security scheme type: apiKey
Header parameter name: PgrApiKey
Версия API v1, v2

Описание: Ресурс integration отвечает за работу с типами и экземплярами интеграций, которые поддерживает Платформа Радар.

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

Integration Meta

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

Тип Метод Описание
POST /integration_types/search Поиск типов интеграций
POST /integration_params/search Получение списка параметров типа интеграции
POST /integration_jobs/search Получение списка заданий типа интеграции
POST /integration_scripts_search Получение списка активных действий доступных для типа интеграции
POST /integration_scripts_create Создание активного действия для типа интеграции

Integrations

Конечная точка для работы с экземплярами интеграции.

Тип Метод Описание
POST /integrations/create Создание экземпляра интеграции
PUT /integrations/update Обновление информации об экземпляре интеграции
POST /integrations/search Поиск экземпляров интеграции
GET /integrations/{integration_id} Получение экземпляра интеграции
DELETE /integrations/{integration_id} Удаление экземпляра интеграции
POST /integrations/mass_delete Массовое удаление экземпляров интеграции
DELETE /integrations/all Удаление всех экземпляров интеграции
POST /integrations/test_connection Проверка подключения

Integration Jobs

Конечная точка для работы с периодическими задачами экземпляра интеграции

Тип Метод Описание
POST /integration_schedulers/create Создание периодической задачи для экземпляра интеграции
PUT /integration_schedulers/update Обновление периодической задачи экземпляра интеграции
POST /integration_schedulers/search Поиск периодических задач экземпляра интеграции
POST /integration_schedulers/action Массовое действие над периодическими задачами
GET /integration_schedulers/{job_id} Получение периодической задачи экземпляра интеграции по ID
DELETE /integration_schedulers/{job_id} Удаление периодической задачи экземпляра интеграции
POST /integration_schedulers/mass_delete Массовое удаление периодических задач
DELETE /integration_schedulers/all Удаление всех периодических задач экземпляра интеграции
POST /integration_schedulers/{job_id}/exec Запуск периодической задачи

Integration Actions

Конечная точка для работы с активными действиями:

Тип Метод Описание
POST /integration_actions/create Добавление активного действия в экземпляр интеграции
PUT /integration_actions/update Обновление активного действия в экземпляре интеграции
POST /integration_actions/search Получение списка активных действий доступных в экземпляре интеграции
POST /integration_actions/action Массовое действие над активными действиями
GET /integration_actions/{action_id} Получение активного действия экземпляра интеграции по ID
POST /integration_actions/mass_delete Массовое удаление активных действий из экземпляра интеграции
POST /integration_actions/{action_id}/exec Запуск выбранного активного действия для экземпляра интеграции

Integration Actions Logs

Конечная точка для работы с журналами выполнения активных действий:

Тип Метод Описание
POST /integration_actions_logs/search Поиск журналов активных действий для типа интеграции
GET /integration_actions/{active_id}/log Получение журнала активных действий для актива и экземпляра интеграции

Integration Service Asset

Конечная точка для работы с активами в рамках экземпляра интеграции:

Тип Метод Описание
POST /service_asset_integrations/create Обогащение актива информацией, полученной из сторонней системы
POST /service_asset_integrations/update Обновление данных обогащения актива
POST /service_asset_integrations/search Поиск данных обогащения актива из экземпляра интеграции
GET /service_asset_integrations/{service_asset_id} Получение данных обогащения актива из экземпляра интеграции

Logmule Go Rules Integration Action

Конечная точка для работы с правилами корреляции в рамках экземпляра интеграции:

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

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

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

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

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