3x-ui3x-ui

Subscription Balancers

Client-side balancers for the JSON subscription: each enabled balancer is emitted as one extra config document whose members are the proxy outbounds of the selected inbounds (routing.balancers + burstObservatory). Managed in Settings → Sub Balancers.

List all subscription balancers in sort order (sort_order asc, id asc).

GET
/panel/api/sub-balancers

Authorization

AuthorizationBearer <token>

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

In: header

Response Body

application/json

curl -X GET "https://example.com/panel/api/sub-balancers"
{  "success": true,  "obj": [    {      "createdAt": 1710000000000,      "enabled": true,      "id": 1,      "inboundIds": [        1,        3      ],      "memberWeights": {},      "remark": "auto-fastest",      "sortOrder": 1,      "strategy": "random",      "updatedAt": 1710000000000    }  ]}

Create a subscription balancer. It appears in the JSON subscription of every client that sits on at least one selected inbound.

POST
/panel/api/sub-balancers

Authorization

AuthorizationBearer <token>

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

In: header

Request Body

application/x-www-form-urlencoded

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://example.com/panel/api/sub-balancers" \  -H "Content-Type: application/x-www-form-urlencoded" \  -d 'remark=string&inboundIds=0'
{  "success": true,  "obj": {    "createdAt": 1710000000000,    "enabled": true,    "id": 1,    "inboundIds": [      1,      3    ],    "memberWeights": {},    "remark": "auto-fastest",    "sortOrder": 1,    "strategy": "random",    "updatedAt": 1710000000000  }}

Update a balancer by id. Accepts the same form fields as create (full-row update); omitting memberWeights clears stored weights, while omitting enabled keeps its current value.

POST
/panel/api/sub-balancers/{id}

Authorization

AuthorizationBearer <token>

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

In: header

Path Parameters

id*integer

Balancer id.

Request Body

application/x-www-form-urlencoded

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://example.com/panel/api/sub-balancers/0" \  -H "Content-Type: application/x-www-form-urlencoded" \  -d 'remark=string&inboundIds=0'
{  "success": true,  "obj": {    "createdAt": 1710000000000,    "enabled": true,    "id": 1,    "inboundIds": [      1,      3    ],    "memberWeights": {},    "remark": "auto-fastest",    "sortOrder": 1,    "strategy": "random",    "updatedAt": 1710000000000  }}

Delete a balancer by id.

DELETE
/panel/api/sub-balancers/{id}

Authorization

AuthorizationBearer <token>

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

In: header

Path Parameters

id*integer

Balancer id.

Response Body

application/json

curl -X DELETE "https://example.com/panel/api/sub-balancers/0"
{  "success": true,  "obj": {    "createdAt": 1710000000000,    "enabled": true,    "id": 1,    "inboundIds": [      1,      3    ],    "memberWeights": {},    "remark": "auto-fastest",    "sortOrder": 1,    "strategy": "random",    "updatedAt": 1710000000000  }}

Delete a balancer by id (POST alias of DELETE for clients that cannot send DELETE).

POST
/panel/api/sub-balancers/{id}/del

Authorization

AuthorizationBearer <token>

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

In: header

Path Parameters

id*integer

Balancer id.

Response Body

application/json

curl -X POST "https://example.com/panel/api/sub-balancers/0/del"
{  "success": true,  "obj": {    "createdAt": 1710000000000,    "enabled": true,    "id": 1,    "inboundIds": [      1,      3    ],    "memberWeights": {},    "remark": "auto-fastest",    "sortOrder": 1,    "strategy": "random",    "updatedAt": 1710000000000  }}