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

Настройки

Конфигурация панели и учётные данные пользователя. Все эндпоинты находятся под /panel/api/setting и требуют активной сессии или токена Bearer.

POST
/panel/api/setting/all

Authorization

AuthorizationBearer <token>

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

In: header

Response Body

application/json

curl -X POST "https://example.com/panel/api/setting/all"
{  "success": true,  "msg": "string",  "obj": null}
POST
/panel/api/setting/defaultSettings

Authorization

AuthorizationBearer <token>

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

In: header

Response Body

application/json

curl -X POST "https://example.com/panel/api/setting/defaultSettings"
{  "success": true,  "msg": "string",  "obj": null}
POST
/panel/api/setting/update

Authorization

AuthorizationBearer <token>

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

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

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

Authorization

AuthorizationBearer <token>

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

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

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}
POST
/panel/api/setting/restartPanel

Authorization

AuthorizationBearer <token>

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

In: header

Response Body

application/json

curl -X POST "https://example.com/panel/api/setting/restartPanel"
{  "success": true,  "msg": "string",  "obj": null}
POST
/panel/api/setting/testSmtp

Authorization

AuthorizationBearer <token>

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

In: header

Response Body

application/json

curl -X POST "https://example.com/panel/api/setting/testSmtp"
{  "success": true,  "stage": "send",  "msg": "Test email sent successfully"}
POST
/panel/api/setting/testTgBot

Authorization

AuthorizationBearer <token>

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

In: header

Response Body

application/json

curl -X POST "https://example.com/panel/api/setting/testTgBot"
{  "success": true,  "msg": "Test message sent to Telegram"}
GET
/panel/api/setting/getDefaultJsonConfig

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/setting/getDefaultJsonConfig"
{  "success": true,  "msg": "string",  "obj": null}