Перейти к основному содержанию
Эта страница — сгруппированный по разделам справочник основных методов, с которыми работает оператор панели. Он покрывает административный API, публичные методы и методы агента.
Для кого: разработчик, интегрирующийся с Axottle; администратор, автоматизирующий рутину. Требуемые права: действующая сессия администратора для методов с доступом «Сессия». Начните с Обзора API, Аутентификации и Соглашений.
Это курируемый список главных методов, а не исчерпывающий машинный список OpenAPI. Машиночитаемая спецификация OpenAPI запланирована, но пока не публикуется. Если метода нет в таблицах ниже — это не значит, что его не существует; здесь собрано то, что чаще всего нужно оператору.

Как читать таблицы

  • Базовый адрес. Все пути с префиксом /api/v1 располагаются на адресе вашей панели, например https://panel.example.com/api/v1. Пути, начинающиеся с /agent, /s, /health или /install, живут в корне (без /api/v1).
  • Параметры пути записаны в фигурных скобках: {id}, {token}, {node_id}.
  • Колонка «Доступ» принимает значения:
    • Публичный — аутентификация не требуется.
    • Сессия — нужен токен сессии администратора (Authorization: Bearer <session-token>).
    • Токен агента — метод вызывает агент ноды своим токеном, а не сессией администратора; вручную не вызывается.
    • Публичный (троттлинг) — публичный метод с ограничением частоты запросов (429 + Retry-After).
Все методы /api/v1 с доступом «Сессия» дополнительно подчиняются проверке лицензии: в деградированном режиме («только чтение») изменяющие запросы отклоняются с 403, а чтение продолжает работать. Исключение — методы восстановления: лицензия (/api/v1/license/*), самообновление панели (/api/v1/panel/*), маршруты агента (/api/v1/agent/*) и аутентификация (/api/v1/auth/*) остаются доступными для записи. Подробнее — Лицензия.
Во всех примерах используются плейсхолдеры (panel.example.com, {id}, axt_xxxxxxxx...).

Аутентификация и сессии

МетодПутьДоступНазначение
POST/api/v1/auth/loginПубличныйВход по {username, password}; возвращает токен сессии и срок действия
POST/api/v1/auth/logoutСессияЗавершить текущую сессию (работает и в режиме «только чтение»)
GET/api/v1/auth/meСессияТекущий администратор: id, имя, роль
GET/api/v1/setup/statusПубличныйФлаги шагов первичной установки
POST/api/v1/setup/modeПубличныйРежим панели: с Remnawave или автономный
POST/api/v1/setup/adminПубличный (до создания администратора)Создать единственного администратора; пароль не короче 8 символов
POST/api/v1/setup/licenseПубличныйАктивировать лицензионный ключ
POST/api/v1/setup/domainПубличныйЗадать домен и режим SSL
POST/api/v1/setup/domain/checkПубличныйПроверить DNS-запись домена
POST/api/v1/setup/remnawave/bootstrapПубличныйАвто-подключение совместно установленной Remnawave (только для таких установок)
Методы /api/v1/setup/* доступны только во время первичной установки; создание администратора отклоняется после появления первого администратора. Подробнее: Аутентификация, Доступ и сессии.

Система и статус

МетодПутьДоступНазначение
GET/healthПубличныйПроверка живости: статус, метка времени, версия
GET/pingПубличныйПростой ответ 200 (используется скриптом обновления)
GET/api/v1/system/statusПубличныйСтатус панели, подключение к БД, setup_done, uptime
GET/api/v1/panel/versionПубличныйТекущая и доступная версия панели
POST/api/v1/panel/checkСессияПринудительная проверка обновлений панели
GET/api/v1/panel/checksСессияИстория проверок обновлений
GET/PUT/api/v1/panel/update-configСессияИсточник обновлений панели (секреты скрыты)
POST/api/v1/panel/upgradeСессияЗапустить обновление панели (отдельным процессом)
GET/api/v1/panel/upgrade/statusСессияСостояние обновления, восстановленное с диска
Подробнее: Обновления панели.

Connection Units

МетодПутьДоступНазначение
GET/POST/api/v1/connection-unitsСессияСписок / создать схему подключения
GET/api/v1/connection-units/node-occupanciesСессияКарта «нода → использующие её Connection Units»
GET/PATCH/DELETE/api/v1/connection-units/{id}СессияЧтение / изменение / удаление схемы (удаление чистит управляемые ресурсы)
GET/api/v1/connection-units/{id}/delete-previewСессияЧто именно удалит удаление
GET/PUT/api/v1/connection-units/{id}/graphСессияЧтение / сохранение черновика холста
POST/api/v1/connection-units/{id}/autosaveСессияАвтосохранение холста
POST/api/v1/connection-units/{id}/discard-draftСессияСбросить черновик до применённого снимка
GET/api/v1/connection-units/{id}/versionsСессияИстория версий
GET/api/v1/connection-units/{id}/versions/{versionId}СессияСнимок одной версии (для отката)
POST/api/v1/connection-units/{id}/compileСессияСкомпилировать черновик в план
GET/api/v1/connection-units/{id}/compile-planСессияПоследний план компиляции
POST/api/v1/connection-units/{id}/lintСессияСтатический аудит конфигурации
POST/api/v1/connection-units/{id}/preflightСессияЛинтер + план компиляции одним ответом
POST/api/v1/connection-units/{id}/applyСессияПрименить план (развернуть)
Подробнее: Connection Units.

Ноды и агенты

Методы управления нодами и агентами вызываются с сессией администратора. Методы /agent/v1/* — исключение: их вызывает сам агент ноды своим токеном.
МетодПутьДоступНазначение
GET/POST/api/v1/nodesСессияСписок / создать ноду (создание запускает установку)
GET/PATCH/DELETE/api/v1/nodes/{id}СессияЧтение / частичное обновление / удаление (409 при связях со схемами)
POST/api/v1/nodes/{id}/preflightСессияПроверка доступности и аутентификации по SSH
POST/api/v1/nodes/{id}/installСессияЗапустить установку
GET/api/v1/nodes/{id}/operationsСессияЛог операций ноды
GET/POST/api/v1/nodes/{id}/eventsСессияОперационный журнал ноды (POST — телеметрия UI, секреты вычищаются)
GET/api/v1/nodes/{id}/agentСессияЗапись агента ноды (или пусто)
POST/api/v1/nodes/{id}/agent/enrollment-tokenСессияВыпустить одноразовый токен привязки (TTL 30 минут)
GET/DELETE/api/v1/nodes/{id}/agent/enrollment-tokens/{token_id}СессияСписок / отзыв токенов привязки
POST/api/v1/nodes/{id}/agent/ssh-checkСессияРазовая SSH-проверка пригодности
POST/api/v1/nodes/{id}/agent/ssh-installСессияУстановка агента по SSH (поток SSE)
GET/api/v1/nodes/{id}/agent/metricsСессияВременной ряд метрик (?since=)
GET/api/v1/nodes/{id}/agent/servicesСессияСнимок статусов служб (?refresh=1)
GET/POST/api/v1/nodes/{id}/agent/tasksСессияСписок / постановка задачи из белого списка
POST/api/v1/nodes/{id}/agent/tasks/syncСессияСинхронное выполнение (отдельный, более узкий белый список)
POST/api/v1/nodes/{id}/agent/updateСессияПоставить задание самообновления агента (409, если уже на версии)
GET/api/v1/nodes/{id}/agent/update-jobsСессияИстория заданий обновления агента
GET/api/v1/agent/releases/latestСессияМетаданные последнего релиза агента
POST/api/v1/agent/releases/refreshСессияПринудительно перечитать релиз
GET/PUT/api/v1/agent/update-configСессияИсточник обновлений агента (токен скрыт)
GET/install/axottle-agent.shПубличныйСкрипт установки агента
GET/install/axottle-agent-linux-{arch}ПубличныйГотовый бинарник агента (amd64/arm64)
GET/install/agent/{version}/{filename}ПубличныйПроверенный по SHA-256 кэш бинарника
POST/agent/v1/enrollПубличный (одноразовый токен)Привязка агента
POST/agent/v1/heartbeatТокен агентаЖивость и метаданные хоста
POST/agent/v1/metricsТокен агентаПриём метрик
POST/agent/v1/servicesТокен агентаПриём статусов служб
GET/agent/v1/tasks/pollТокен агентаВзять задачу (204, если задач нет)
POST/agent/v1/tasks/{id}/resultТокен агентаОтправить результат задачи
GET/agent/v1/qos-overridesТокен агентаАктивные ограничения скорости
POST/agent/v1/abuse-signalsТокен агентаЛокально замеченный сигнал абьюза
POST/agent/v1/session-diversityТокен агентаСнимки разнообразия сессий
Подробнее: Ноды, Привязка агента.

CDN и DNS

МетодПутьДоступНазначение
GET/api/v1/cdn-providersСессияПровайдеры + схема полей учётных данных и признак автоматизации
GET/POST/api/v1/cdn-provider-accountsСессияСписок / подключить аккаунт провайдера
GET/PATCH/DELETE/api/v1/cdn-provider-accounts/{id}СессияЧтение / изменение / удаление аккаунта (409, если используется)
POST/api/v1/cdn-provider-accounts/{id}/revalidateСессияПовторно проверить учётные данные
GET/POST/api/v1/admin/cdn/dns-connectionsСессияDNS-подключения для CDN
GET/POST/PATCH/api/v1/admin/cdn/domain-poolsСессияПулы доменов доставки
GET/POST/PATCH/api/v1/admin/cdn/automation-policiesСессияПолитики автоматизации CDN
GET/api/v1/cdn/operations/{id}СессияСтатус, план и шаг операции CDN
POST/api/v1/cdn/operations/{id}/rollbackСессияОткат операции (для READY запрещён — 409)
GET/api/v1/cdn/resourcesСессияСписок созданных ресурсов CDN
GET/PUT/api/v1/integrations/cloudflareСессияСписок / создание привязки зоны Cloudflare (AutoDNS; токен только для записи)
DELETE/api/v1/integrations/cloudflare/{id}СессияУдалить привязку (существующие DNS-записи остаются)
POST/api/v1/integrations/cloudflare/{id}/testСессияПроверить токен, доступ к зоне и права DNS
Само провизионирование CDN выполняется внутри POST /api/v1/connection-units/{id}/apply — отдельного метода у него нет. Подробнее: CDN, DNS.

Здоровье и self-heal

МетодПутьДоступНазначение
GET/api/v1/health/summaryСессияКарточки дашборда + скрытое подавлением
GET/api/v1/health/dashboardСессияСводка, таблицы и инциденты одним ответом
GET/api/v1/health/nodesСессияТаблица нод (фильтры: статус, страна, провайдер)
GET/api/v1/health/connection-unitsСессияТаблица схем подключения
GET/api/v1/health/routesСессияТаблица маршрутов
GET/api/v1/health/incidentsСессияЛента инцидентов (since, limit, include_suppressed)
POST/api/v1/health/recheckСессияПерепроверить все применённые Connection Units
GET/PUT/api/v1/health/settingsСессияПолитика мониторинга (интервалы, каналы, ИИ-триггер)
GET/api/v1/health/connection-units/{id}СессияКэш-сводка по схеме
POST/api/v1/health/connection-units/{id}/checkСессияСвежая полная проверка (одна попытка дозвона)
GET/api/v1/health/connection-units/{id}/probesСессияИстория проб (≤ 500)
GET/api/v1/health/connection-units/{id}/diagnosticsСессияДиагностический пакет доказательств
POST/api/v1/health/connection-units/{id}/diagnostics/logsСессияСбор логов нод (обрезаны и отредактированы)
GET/api/v1/health/connection-units/{id}/dependency-treeСессияДерево зависимостей схемы
GET/POST/api/v1/health/connection-units/{id}/entry-blocks/{blockId}/external-probeСессияВнешние региональные пробы L5
GET/POST/api/v1/health/nodes/{id}СессияСводка ноды / запуск проверки
GET/api/v1/health/nodes/{id}/probesСессияИстория проб ноды
GET/PUT/DELETE/api/v1/health/external-providersСессияРеестр внешних провайдеров L5 и их методы
POST/api/v1/nodes/status-refreshСессияОбновить снимок Remnawave + проверка здоровья по всему парку
POST/api/v1/nodes/{id}/status-refreshСессияТо же для одной ноды
GET/POST/DELETE/api/v1/nodes/{id}/suppressionСессияПросмотр / создать-заменить / снять «заглушку» ноды
Подробнее: Здоровье, Self-heal.

Remnawave

МетодПутьДоступНазначение
POST/api/v1/remnawave/testСессияПроверить URL и токен без сохранения
GET/POST/api/v1/remnawave/connectionsСессияСписок / создать подключение к панели
GET/api/v1/remnawave/connections/{id}СессияОдно подключение
POST/api/v1/remnawave/connections/{id}/testСессияПроверить сохранённое подключение (обновляет статус)
POST/api/v1/remnawave/connections/{id}/syncСессияСинхронизировать локальные снимки (вручную)
DELETE/api/v1/remnawave/connections/{id}СессияУдалить подключение и его снимки
GET/api/v1/remnawave/connections/{id}/diagnosticsСессияЖивая диагностика панели
GET/api/v1/remnawave/usersСессияЛокальный снимок пользователей
GET/api/v1/remnawave/nodesСессияЛокальный снимок нод
GET/api/v1/remnawave/hostsСессияЛокальный снимок хостов
GET/api/v1/remnawave/config-profilesСессияЛокальный снимок конфиг-профилей
GET/api/v1/remnawave/internal-squadsСессияЖивой список сквадов панели
GET/POST/api/v1/remnawave/connections/{id}/backup-profilesСессия + лицензияПрофили резервных копий БД Remnawave
GET/PATCH/DELETE/api/v1/remnawave/backup-profiles/{profileId}Сессия + лицензияУправление профилем копий
POST/api/v1/remnawave/backup-profiles/{profileId}/testСессия + лицензияПроверить доступ к цели резервного копирования
GET/POST/api/v1/remnawave/backup-profiles/{profileId}/backupsСессия + лицензияСписок / запуск копий
GET/api/v1/remnawave/backups/{backupId}Сессия + лицензияЗапись прогона копии
POST/api/v1/remnawave/backups/{backupId}/verifyСессия + лицензияПроверка целостности
GET/api/v1/remnawave/backups/{backupId}/restore-planСессия + лицензияПредпросмотр восстановления
POST/api/v1/remnawave/backups/{backupId}/restoreСессия + лицензияВосстановление (требует confirm: true)
DELETE/api/v1/remnawave/backups/{backupId}Сессия + лицензияУдалить запись копии
Подробнее: Remnawave.

Защита от абьюза

МетодПутьДоступНазначение
GET/api/v1/abuse/summaryСессияСводка дашборда абьюза
GET/POST/api/v1/abuse/incidentsСессияСписок / ручное открытие инцидента
GET/api/v1/abuse/incidents/{id}СессияИнцидент с сигналами, таймлайном, ограничениями
POST/api/v1/abuse/incidents/{id}/eventСессияДобавить заметку или сменить статус
POST/api/v1/abuse/incidents/{id}/closeСессияЗакрыть как resolved или false_positive (нужна причина)
POST/api/v1/abuse/incidents/{id}/statusСессияПереход статуса
POST/api/v1/abuse/incidents/{id}/evidenceСессияСобрать и прикрепить доказательства
GET/POST/api/v1/abuse/qos-overridesСессияСписок / применить временное замедление
DELETE/api/v1/abuse/qos-overrides/{id}СессияСнять замедление вручную
GET/api/v1/abuse/service-identitiesСессияЗащищённые инфраструктурные аккаунты
GET/api/v1/abuse/signalsСессияСырые сигналы детекторов
POST/api/v1/abuse/detectСессияЗапустить один проход детекции сейчас
GET/PUT/api/v1/abuse/policyСессияЧтение / сохранение политики
GET/PUT/api/v1/abuse/telegramСессияМаршрутизация Telegram (токен маскирован)
POST/api/v1/abuse/telegram/testСессияОтправить тестовое уведомление
GET/api/v1/abuse/apply-statusСессияБейдж «применено/отсутствует» по ноде (?node=)
GET/api/v1/abuse/user-profileСессияПрофиль абьюза по пользователю (?user=)
Агент дополнительно поставляет телеметрию через POST /agent/v1/abuse-signals и POST /agent/v1/session-diversity (см. раздел «Ноды и агенты»). Подробнее: Защита от абьюза.

Axosun — ассистент

МетодПутьДоступНазначение
Управление ассистентом — через панельСессияРаздел Axosun в панели: профили, политика, каталог действий, сессии, история
Прямые пути API ассистента здесь намеренно не публикуются: они содержат внутреннее имя, которое мы не раскрываем в публичной документации. Управляйте ассистентом через раздел Axosun в панели. Возможности, права и порядок подтверждения действий описаны отдельно.
Подробнее: Axosun.

Безопасность

МетодПутьДоступНазначение
GET/POST/api/v1/security-profilesСессияСписок / создать профиль безопасности
GET/api/v1/security-profiles/{id}СессияПолучить профиль
GET/POST/api/v1/nodes/{id}/security-services/complianceСессияЧтение / запуск проверки соответствия (CrowdSec, Fail2Ban, UFW)
GET/api/v1/security/detectors/statusСессияСтатус детекторов по всем нодам
GET/api/v1/security/detectors/status/{nodeId}СессияСтатус детекторов одной ноды
GET/api/v1/security/dangerous-ports/catalogСессияФиксированный каталог опасных портов
GET/PUT/api/v1/security/egressСессияЧтение / сохранение политики egress («сохранено» ≠ «применено»)
GET/api/v1/security/egress/statusСессияЖелаемое vs применённое по нодам
POST/api/v1/security/egress/reconcileСессияПовторно применить желаемое состояние
GET/api/v1/decoy/templatesСессияКаталог шаблонов маскировочных сайтов
GET/POST/api/v1/decoy/templates/{id}/previewСессияПредпросмотр шаблона в песочнице
GET/POST/api/v1/decoy/deploymentsСессияСписок / создать развёртывание маскировки
GET/PATCH/DELETE/api/v1/decoy/deployments/{id}СессияУправление развёртыванием
POST/api/v1/decoy/deployments/{id}/install · /verify · /removeСессияДействия агента: 202 + task_id
GET/POST/PATCH/DELETE/api/v1/nodes/{id}/selfstealСессияМаскировочный сайт (selfsteal) на ноде: статус, включение, деплой, проверка
GET/api/v1/audit-logСессияЖурнал аудита (limit ≤ 500, offset, фильтр q)
Подробнее: Безопасность, Аудит и соответствие.

Операционные разделы

Резервные копии, лицензия, уведомления, гео-ассеты и провайдеры. Все методы ниже — с доступом «Сессия», если не указано иное.

Резервные копии панели

МетодПутьДоступНазначение
POST/GET/api/v1/backups/profilesСессияСоздать / список профилей резервных копий
GET/PATCH/DELETE/api/v1/backups/profiles/{id}СессияУправление профилем
POST/api/v1/backups/profiles/{id}/testСессияПроверить цель хранения (локально/S3)
POST/GET/api/v1/backups/runsСессияЗапустить сейчас / список прогонов
GET/api/v1/backups/runs/{id}СессияДетали прогона
POST/api/v1/backups/runs/{id}/verifyСессияПроверка целостности (SHA-256)
GET/api/v1/backups/runs/{id}/restore-previewСессияПредпросмотр восстановления
POST/api/v1/backups/runs/{id}/restoreСессияВосстановление (требует confirm: true, разрушающая операция)
Подробнее: Резервные копии.

Лицензия

МетодПутьДоступНазначение
GET/api/v1/license/statusСессияСтатус лицензии (ключ маскирован) + использование
GET/api/v1/license/summaryСессияТекстовая сводка для обращения в поддержку
GET/api/v1/license/featuresСессияПлоская карта «функция → включена»
POST/api/v1/license/activateСессияАктивировать ключ
POST/api/v1/license/refreshСессияПринудительно перепроверить (может включить льготный период)
POST/api/v1/license/removeСессияДеактивировать установку
Подробнее: Лицензия.

Уведомления

МетодПутьДоступНазначение
GET/PUT/api/v1/notifications/telegramСессияМаршрутизация + каталог категорий (токен маскирован)
POST/api/v1/notifications/telegram/testСессияОтправить тестовое сообщение (реальная ошибка возвращается)
GET/api/v1/notifications/telegram/helper/sessionСессияSSE-сессия бота-помощника (получить chat id / topic id)
POST/api/v1/notifications/telegram/helper/stopСессияОстановить сессию помощника
Подробнее: Уведомления.

Гео-ассеты

МетодПутьДоступНазначение
GET/POST/api/v1/geo-assets/filesСессияСписок / загрузка гео-файлов
DELETE/api/v1/geo-assets/files/{id}СессияУдалить файл
GET/POST/api/v1/geo-assets/profilesСессияСписок / создать профиль
GET/DELETE/api/v1/geo-assets/profiles/{id}СессияЧтение / удаление профиля
GET/POST/api/v1/geo-assets/profiles/{id}/setsСессияGeoSet-карточки профиля
GET/PATCH/PUT/DELETE/api/v1/geo-assets/profiles/{id}/sets/{set_id}СессияУправление GeoSet
POST/api/v1/geo-assets/sets/{set_id}/validateСессияПроверить (пере-хешировать/скачать) набор
POST/api/v1/geo-assets/profiles/{id}/validateСессияПроверить весь профиль
POST/api/v1/geo-assets/profiles/{id}/assign-bulkСессияМассовое назначение профиля нодам
POST/DELETE/api/v1/nodes/{node_id}/geo-asset-assignmentСессияНазначить / снять профиль с ноды
GET/api/v1/nodes/{node_id}/geo-asset-stateСессияСостояние гео-файлов на ноде (по хешам)
POST/api/v1/nodes/{node_id}/geo-asset-syncСессияСинхронизировать гео-данные на ноду
GET/POST/api/v1/nodes/{node_id}/geo-asset-rollbackСессияНаличие снимка / откат к предыдущему набору
GET/install/geo/{id}ПубличныйОтдача гео-файла агенту (безопасность — проверка SHA-256 на ноде)
Подробнее: Гео-ассеты.

Провайдеры хостинга

МетодПутьДоступНазначение
GET/POST/api/v1/providers/bundlesСессияСписок / установка адаптеров провайдеров (манифест)
GET/DELETE/api/v1/providers/bundles/{id}СессияЧтение / удаление адаптера
GET/POST/api/v1/providers/accountsСессияСписок / создание аккаунта провайдера
DELETE/api/v1/providers/accounts/{id}СессияУдалить аккаунт
POST/api/v1/providers/accounts/{id}/testСессияПроверить учётные данные
GET/api/v1/providers/accounts/{id}/regionsСессияЖивой список регионов
GET/api/v1/providers/accounts/{id}/plansСессияЖивой список тарифов
Подробнее: Провайдеры.
Проверено для версии Axottle текущей ветки. Дата проверки: 2026-07-11.