Служебные и операционные маршруты

Помимо прикладных CRUD-эндпоинтов серверная документация описывает отдельный слой служебных API для проверки состояния, логов, сетевых операций и real-time событий.

Healthcheck

Метод	Путь	Назначение
GET	/liveness	Проверить, что процесс сервера жив.
GET	/readiness	Проверить готовность сервера обслуживать запросы.

Эти маршруты удобно использовать для инфраструктурного мониторинга, балансировщиков и CI smoke-checks.

Ping

Метод	Путь	Назначение
POST	/ping	Проверить IP, хост или сетевой диапазон.

Пример тела:

{
  "target": "192.168.20.0/24"
}

Логи

Метод	Путь	Назначение
GET	/logs	Получить логи с фильтрами.
GET	/logs/files	Получить список лог-файлов.
GET	/logs/{filename}	Получить содержимое конкретного лог-файла.

Поддерживаемые query-параметры в серверной документации:

• tail
• text
• start_time
• end_time
• log_level

Взаимодействие с агентами

Метод	Путь	Назначение
POST	/agents/inventory	Запустить инвентаризацию по IP.
POST	/hosts/{host_id}/agent	Запустить install/update/uninstall агента на хосте.

Пример для POST /agents/inventory:

{
  "ip": "192.168.1.10",
  "save": true
}

WebSocket-каналы

Канал	Путь	Назначение
tasks	/ws/tasks	Поток событий по задачам.
agents	/ws/agents	Поток событий по операциям с агентами.

Для ws/agents серверная документация отдельно показывает, что события включают:

• operation_id
• deployment_id
• asset_id
• task_id
• action
• target_ip
• os_family
• transport
• status
• error_message
• last_log
• started_at
• finished_at
• updated_at

Это полезно для интерфейсов, которые показывают прогресс установки и обслуживания агента в реальном времени.