3x-uiСправочник по API
REST API панели 3x-ui — аутентификация, входящие подключения, клиенты, статистика сервера и многое другое, сгенерировано из спецификации OpenAPI.
Панель 3x-ui предоставляет REST API для автоматизации. Эти страницы сгенерированы из спецификации OpenAPI самой панели, поэтому они всегда соответствуют документированной схеме.
Аутентификация
Запросы аутентифицируются либо с помощью сессионной cookie (полученной через POST /login), либо
с помощью Bearer-токена:
Authorization: Bearer <token>Создавайте API-токены в панели; они дают права полного администратора, поэтому храните их в безопасности. См. API-токены.
Просмотр по разделам
Этот справочник повторно генерируется из public/openapi.json командой pnpm gen:api.
Не редактируйте сгенерированные страницы тегов вручную.
Порты и брандмауэр
Порты, которые 3x-ui использует по умолчанию, и готовые правила ufw / nftables для их открытия.
Аутентификация
Поддерживаются два режима аутентификации. Сессии веб-интерфейса используют cookie, устанавливаемый эндпоинтом входа. Программные клиенты (боты, скрипты, удалённые панели) аутентифицируются с помощью Bearer-токена, взятого из Settings → Security → API Token. Оба способа работают для всех эндпоинтов под /panel/api/*.