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

Обзор

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

Характеристика Значение
Наименование agents
Компоненты Cruddy
Появился в версии 4.1.0
Доступен в версиях 4.1.0 и выше
Авторизация по токену Security scheme type: http
Bearer format: JWT
Авторизация по APIkey Security scheme type: apiKey
Header parameter name: PgrApiKey
Версия API v2

Описание: Ресурс agent отвечает за управление агентами сбора. Подробнее см. раздел Лог-коллектор.

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

Тип Метод Описание
POST /agents/params_meta/search Поиск параметров профилей подходящих версии агента
POST /agents/modules_meta/search Поиск профилей сбора подходящих версии агента
POST /agents/search Поиск агентов
GET /agents/{id} Получение агента по ID
GET /agents/{agent_id}/config Получение конфигурации Агента сбора по ID
POST /agents/{id}/apply_config Публикация конфигурации Агента сбора
POST /agents/{id}/metrics Обновление метрик модулей агента сбора
POST /agent_statuses/search Получение статусов профилей сбора
GET /agents/_meta Получение свойств полей агентов сбора и действий пользователей

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

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

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

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