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 2096) and is configured in Settings → Subscription. Fresh panels generate random path prefixes for each format; all paths remain configurable. Every subscription endpoint sets 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. 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>

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 the same status and subscription metadata headers as GET without a response body.

HEAD
/{subPath}{subid}

Authorization

headerAuthorizationBearer <token>

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

Path Parameters

subid*string

Client subscription ID.

subPath*string

Response Body

Subscription is available. Headers match GET; no response body.

curl -X HEAD "https://example.com/stringstring"
Empty

Return aggregate HWID device-slot usage for the subscription: whether an HWID limit is active, the limit, how many devices are registered and how many slots remain. Read-only — it never registers a device, so asking does not consume a slot. Counters only: no HWID value, email or device metadata. The path prefix is configured by subPath.

GET
/{subPath}{subid}/hwid-status

Authorization

headerAuthorizationBearer <token>

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

Path Parameters

subid*string

Client subscription ID.

subPath*string

Response Body

Device-slot counters for the subscription.

application/json
  1. response

HwidSlotStatus is the aggregate device-slot view exposed to subscribers: counters only, no hwid value or hash, no email, no device metadata.

active*boolean
full*boolean
limit*integer
registered*integer
remaining*integer
curl -X GET "https://example.com/stringstring/hwid-status"
{  "active": true,  "full": false,  "limit": 2,  "registered": 1,  "remaining": 1}

Return the HWID device-slot status code and headers as GET without a response body.

HEAD
/{subPath}{subid}/hwid-status

Authorization

headerAuthorizationBearer <token>

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

Path Parameters

subid*string

Client subscription ID.

subPath*string

Response Body

Headers match GET; no response body.

curl -X HEAD "https://example.com/stringstring/hwid-status"
Empty

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>

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 the JSON subscription status and metadata headers without a body. Registered only when JSON subscriptions are enabled.

HEAD
/{jsonPath}{subid}

Authorization

headerAuthorizationBearer <token>

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

Path Parameters

subid*string

Client subscription ID.

jsonPath*string

Response Body

Subscription is available. Headers match GET; no response body.

curl -X HEAD "https://example.com/stringstring"
Empty

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>

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}

Return the Clash subscription status and metadata headers without a body. Registered only when Clash subscriptions are enabled.

HEAD
/{clashPath}{subid}

Authorization

headerAuthorizationBearer <token>

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

Path Parameters

subid*string

Client subscription ID.

clashPath*string

Response Body

Subscription is available. Headers match GET; no response body.

curl -X HEAD "https://example.com/stringstring"
Empty