3x-ui3x-ui
参考API 参考

设置

面板配置与用户凭据。所有端点均位于 /panel/api/setting 之下，需要已登录的会话或 Bearer 令牌。

Return every panel setting: web server, Telegram bot, subscription, security, LDAP. The full JSON blob that the Settings page edits.

POST
/panel/api/setting/all

Authorization

headerAuthorizationBearer <token>

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

Response Body

Successful response

application/json
  1. response
success?boolean
msg?string
obj?unknown
curl -X POST "https://example.com/panel/api/setting/all"
{  "success": true,  "msg": "string",  "obj": null}

Return the computed default settings based on the request host. Useful to preview what a fresh install would use.

POST
/panel/api/setting/defaultSettings

Authorization

headerAuthorizationBearer <token>

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

Response Body

Successful response

application/json
  1. response
success?boolean
msg?string
obj?unknown
curl -X POST "https://example.com/panel/api/setting/defaultSettings"
{  "success": true,  "msg": "string",  "obj": null}

Persist every setting at once. The body mirrors the shape returned by /all. Invalid values (bad ports, missing cert pairs, etc.) are rejected before write.

POST
/panel/api/setting/update

Authorization

headerAuthorizationBearer <token>

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

Request Body

application/json
  1. body

Response Body

Successful response

application/json
  1. response
success?boolean
msg?string
obj?unknown
curl -X POST "https://example.com/panel/api/setting/update" \  -H "Content-Type: application/json" \  -d '{}'
{  "success": true,  "msg": "string",  "obj": null}

Change the panel admin username and password. Requires the current credentials for verification. The session is refreshed with the new values on success.

POST
/panel/api/setting/updateUser

Authorization

headerAuthorizationBearer <token>

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

Request Body

application/json
  1. body
oldUsername*string

Current admin username.

oldPassword*string

Current admin password.

newUsername*string

Desired new username.

newPassword*string

Desired new password.

Response Body

Successful response

application/json
  1. response
success?boolean
msg?string
obj?unknown
curl -X POST "https://example.com/panel/api/setting/updateUser" \  -H "Content-Type: application/json" \  -d '{    "oldUsername": "admin",    "oldPassword": "admin",    "newUsername": "newadmin",    "newPassword": "newpass"  }'
{  "success": true,  "msg": "string",  "obj": null}

Restart the entire 3x-ui process after a 3-second grace period. The connection drops immediately; the panel comes back online ~5-10 seconds later.

POST
/panel/api/setting/restartPanel

Authorization

headerAuthorizationBearer <token>

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

Response Body

Successful response

application/json
  1. response
success?boolean
msg?string
obj?unknown
curl -X POST "https://example.com/panel/api/setting/restartPanel"
{  "success": true,  "msg": "string",  "obj": null}

Test SMTP connection with stage-by-stage reporting (connect, auth, send). Returns structured result with stage and message.

POST
/panel/api/setting/testSmtp

Authorization

headerAuthorizationBearer <token>

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

Response Body

Successful response

application/json
  1. response
success?boolean
msg?string
obj?unknown
curl -X POST "https://example.com/panel/api/setting/testSmtp"
{  "success": true,  "stage": "send",  "msg": "Test email sent successfully"}

Test Telegram bot connection by sending a test message to the configured chat.

POST
/panel/api/setting/testTgBot

Authorization

headerAuthorizationBearer <token>

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

Response Body

Successful response

application/json
  1. response
success?boolean
msg?string
obj?unknown
curl -X POST "https://example.com/panel/api/setting/testTgBot"
{  "success": true,  "msg": "Test message sent to Telegram"}

Return the built-in default Xray JSON config template that ships with this panel version.

GET
/panel/api/setting/getDefaultJsonConfig

Authorization

headerAuthorizationBearer <token>

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

Response Body

Successful response

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

服务器

系统状态、日志获取、证书生成器、Xray 二进制文件管理以及备份/恢复。所有接口均位于 /panel/api/server 下。

Xray 设置

Xray 配置模板、出站管理、Warp/Nord 集成以及配置测试。所有端点均位于 /panel/api/xray 下。