3x-ui3x-ui

Subscription Server

A separate HTTP/HTTPS server that serves proxy subscription links (standard, JSON, and Clash) to clients. The server listens on its own port (default 10882) and is configured in Settings → Subscription. Paths are configurable; defaults are shown below. All subscription endpoints set response headers for client apps to read traffic/expiry info.

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. Default path: /sub/:subid.

GET
/{subPath}{subid}

Authorization

AuthorizationBearer <token>

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

In: header

Path Parameters

subid*string

Client subscription ID.

subPath*string

Response Body

application/json

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. Default path: /json/:subid.

GET
/{jsonPath}{subid}

Authorization

AuthorizationBearer <token>

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

In: header

Path Parameters

subid*string

Client subscription ID.

jsonPath*string

Response Body

application/json

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. Default path: /clash/:subid.

GET
/{clashPath}{subid}

Authorization

AuthorizationBearer <token>

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

In: header

Path Parameters

subid*string

Client subscription ID.

clashPath*string

Response Body

application/json

curl -X GET "https://example.com/stringstring"
{  "success": true,  "msg": "string",  "obj": null}