EasyXrayСправочник по API
REST API панели EasyXray — пространство имён, аутентификация, входящие подключения, клиенты, статистика сервера и многое другое, сгенерировано из спецификации OpenAPI.
Панель EasyXray предоставляет REST API для автоматизации. Страницы этого раздела сгенерированы из спецификации OpenAPI самой панели, поэтому они всегда соответствуют схеме, которую панель действительно отдаёт.
Пространство имён
Всё, что отдаёт панель, находится под настроенным базовым путём веб-интерфейса
(webBasePath), за которым следует easyxray:
| Поверхность | Путь |
|---|---|
| Интерфейс панели | <basePath>/easyxray/… |
| REST API | <basePath>/easyxray/api/v1/… |
| WebSocket | <basePath>/easyxray/ws |
| Спецификация OpenAPI | <basePath>/easyxray/api/v1/openapi.json |
С базовым путём по умолчанию (/) это означает, например:
GET /easyxray/api/v1/inbounds/list
POST /easyxray/api/v1/clients/add
GET /easyxray/api/v1/server/status
GET /easyxray/api/v1/openapi.jsonУ пространства имён easyxray нет алиасов. Прежние версии панели
X-UI/3x-ui отдавали эти эндпоинты под /panel/api/…; EasyXray не отвечает
на этом префиксе, и совместимый редирект не установлен. Любой скрипт, бот или
дашборд, написанный под старые пути, придётся перевести на маршруты
/easyxray/api/v1/… выше.
Аутентификация
Запросы аутентифицируются либо с помощью сессионной cookie — она ставится при
входе в панель и называется easyxray — либо с помощью Bearer-токена:
Authorization: Bearer <token>Создавайте API-токены в разделе Настройки → Безопасность → API-токен; они дают права полного администратора, поэтому храните их так же бережно, как пароль панели. См. API-токены.
Сформируйте аутентифицированный запрос для любого эндпоинта из этого раздела:
API request builder
Build an authenticated cURL command or fetch() snippet for any EasyXray panel API endpoint under /easyxray/api/v1/*.
curl -X GET 'https://panel.example.com:2053/easyxray/api/v1/inbounds/list' \
-H 'Authorization: Bearer <token>'await fetch('https://panel.example.com:2053/easyxray/api/v1/inbounds/list', {
method: 'GET',
headers: { 'Authorization': 'Bearer <token>' },
});Просмотр по разделам
Страницы по разделам заново генерируются из зафиксированной спецификации
public/openapi.json командой pnpm gen:api (саму спецификацию публикует
frontend/scripts/build-openapi.mjs из репозитория панели). Не редактируйте
сгенерированные страницы тегов вручную — измените источник спецификации и
перегенерируйте.
Порты и брандмауэр
Порты, которые EasyXray использует по умолчанию, и готовые правила ufw / nftables для их открытия.
Аутентификация
Поддерживаются два режима аутентификации. Сессии веб-интерфейса используют cookie, устанавливаемый эндпоинтом входа. Программные клиенты (боты, скрипты, удалённые панели) аутентифицируются с помощью Bearer-токена, взятого из Settings → Security → API Token. Оба способа работают для всех эндпоинтов под /easyxray/api/v1/*.