3x-ui3x-ui
СправочникСправочник по API

Сервер подписок

Отдельный HTTP/HTTPS-сервер, который отдаёт клиентам ссылки на подписки прокси (стандартные, JSON и Clash). Сервер слушает на собственном порту (по умолчанию 2096) и настраивается в разделе Settings → Subscription. Новые панели генерируют случайные префиксы путей для каждого формата; все пути можно изменить. Все конечные точки подписок устанавливают заголовки ответа, по которым клиентские приложения считывают информацию о трафике и сроке действия.

Return base64-encoded subscription links for all enabled clients matching the subscription ID. When the request has an Accept: text/html header or ?html=1, renders a styled info page instead. With ?format=info, returns the page view-model as JSON (traffic, expiry, online status; no links) for live polling. The path prefix is configured by subPath.

GET
/{subPath}{subid}

Authorization

headerAuthorizationBearer <token>

Scoped API token from Settings → Security → API Token. Send as Authorization: Bearer <token>.

Path Parameters

subid*string

Client subscription ID.

subPath*string

Query Parameters

format?string

Set to "info" to get the subscription status view-model as JSON instead of the links.

Response Body

Successful response

application/json
  1. response
success?boolean
msg?string
obj?unknown
curl -X GET "https://example.com/stringstring"
{  "success": true,  "msg": "string",  "obj": null}

Return subscription as a JSON array of proxy configs (one per enabled client). Only when JSON subscription is enabled in settings. The path prefix is configured by subJsonPath.

GET
/{jsonPath}{subid}

Authorization

headerAuthorizationBearer <token>

Scoped API token from Settings → Security → API Token. Send as Authorization: Bearer <token>.

Path Parameters

subid*string

Client subscription ID.

jsonPath*string

Response Body

Successful response

application/json
  1. response
success?boolean
msg?string
obj?unknown
curl -X GET "https://example.com/stringstring"
{  "success": true,  "msg": "string",  "obj": null}

Return subscription as a Clash/Mihomo-compatible YAML config, including configured global Clash routing rules. Only when Clash subscription is enabled in settings. The path prefix is configured by subClashPath.

GET
/{clashPath}{subid}

Authorization

headerAuthorizationBearer <token>

Scoped API token from Settings → Security → API Token. Send as Authorization: Bearer <token>.

Path Parameters

subid*string

Client subscription ID.

clashPath*string

Response Body

Successful response

application/json
  1. response
success?boolean
msg?string
obj?unknown
curl -X GET "https://example.com/stringstring"
{  "success": true,  "msg": "string",  "obj": null}

Настройки Xray

Шаблон конфигурации Xray, управление исходящими подключениями, интеграция с Warp/Nord и тестирование конфигурации. Все эндпоинты находятся в /panel/api/xray.

Хосты

Эндпоинты переопределений на уровне отдельного входящего подключения. Каждый включённый хост добавляет одну дополнительную ссылку подписки/прокси с собственными адресом/портом/TLS, заменяя устаревший массив externalProxy. Все эндпоинты находятся в /panel/api/hosts.