Перейти к основному содержанию
Панель Axottle управляется через REST API. Тот же API использует встроенный веб-интерфейс, поэтому любое действие в панели доступно и программно.
Для кого: разработчик, интегрирующийся с Axottle; администратор, автоматизирующий рутину. Требуемые права: действующая сессия администратора (см. Аутентификация).

​
Базовый адрес и версия

Все административные методы располагаются под префиксом /api/v1 на адресе вашей панели: 
https://panel.example.com/api/v1
Версия API указывается в пути (v1). Несовместимые изменения будут выпускаться под новой версией пути.

​
Области API

Публичные методы

Не требуют аутентификации. Сюда относятся проверка здоровья (GET /health), скрипты и файлы установки агента (/install/...).

Административные методы

Всё под /api/v1/*. Требуют токен сессии администратора. Часть методов дополнительно проверяет статус лицензии.

Методы агента

Под /agent/v1/*. Используются агентами нод и аутентифицируются токеном агента, а не сессией администратора. Не предназначены для ручного вызова.

​
Режим «только чтение»

Если лицензия панели просрочена или отсутствует, административный API переходит в деградированный режим: методы, изменяющие состояние, отклоняются, а чтение продолжает работать. Методы восстановления (лицензия, аутентификация, обновление панели, маршруты агента) остаются доступными. Подробнее — Лицензия.

​
Формат

  • Тело запросов и ответов — JSON (Content-Type: application/json).
  • Ошибки возвращаются с соответствующим HTTP-статусом. Справочник — Коды ошибок.
  • Публичный шлюз применяет троттлинг: при превышении возвращается 429 с заголовком Retry-After.

​
Дальше

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

Как получить и использовать токен сессии.

Соглашения

Пагинация, фильтры, идемпотентность, подтверждения.

Методы

Справочник методов по разделам.
Проверено для версии Axottle текущей ветки. Дата проверки: 2026-07-11.