Справочник API
Это справочник REST API контроллера ПЕРЕСВЕТ-СТ. Он нужен для интеграции внешних систем, автоматизации административных действий и получения данных о задачах, агентах, сетях, файлах, отчетах и настройках без обращения к пользовательскому интерфейсу.
Все запросы выполняются к контроллеру. К агентам напрямую обращаться не нужно: контроллер управляет агентами, передает им команды и собирает результаты выполнения. Поэтому внешний клиент работает с единым API контроллера, а DPDK-часть и агентские сетевые интерфейсы остаются за пределами публичного контракта.
Пути в карточках операций указаны относительно OpenAPI basePath: /v1. В рабочем запросе добавляйте этот префикс к адресу контроллера.
Как читать справочник
Раздел API начинается с этого интро и дальше ведет в коллекции: пользователи, задачи, агенты, сети, файлы и другие группы операций. Коллекции и операции отображаются в правой навигации, а основная область страницы показывает методы, пути, параметры и ответы выбранной операции.
Каждая операция содержит контракт запроса, таблицу параметров, список возможных ответов и пример структуры данных. Типы и описания берутся из Swagger-аннотаций контроллера, поэтому справочник отражает фактический контракт контроллера.
Базовый сценарий
Сначала создайте сессию через точку авторизации. При успешном ответе контроллер установит HttpOnly cookies, которые браузер или HTTP-клиент должен отправлять в следующих запросах.
POST /v1/auth/login HTTP/1.1
Host: controller.example
Content-Type: application/json
{"email":"admin@example.com","password":"password"}
После авторизации обращайтесь к нужным ресурсам контроллера с этой же сессией.
GET /v1/tasks?count=10&page=1&key=id&order=desc HTTP/1.1
Host: controller.example
Cookie: accessToken=...
Коллекции API
Раздел | Tag | Эндпоинтов |
|---|---|---|
| Служебные | meta | 3 |
| Аутентификация | auth | 4 |
| Пользователи | users | 11 |
| Группы | groups | 6 |
| Агенты | agents | 17 |
| Задачи | tasks | 38 |
| Сети | networks | 12 |
| Сертификаты | certificates | 6 |
| MAC-адреса | macs | 6 |
| Файлы | files | 15 |
| Туннели | tunnels | 9 |
| Приложения | applications | 10 |
| Malware | malware | 13 |
| CVE | cve | 10 |
| Уведомления | notifications | 3 |
| Настройки | settings | 2 |
| AI: администрирование | ai-admin | 5 |
| AI Gateway | ai-gateway | 29 |