设置 — EasyXray

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

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

POST

/easyxray/api/v1/setting/all

Authorization

headerAuthorizationBearer <token>

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

Response Body

Successful response

application/json

response

success?boolean

msg?string

obj?unknown

curl -X POST "https://example.com/easyxray/api/v1/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

/easyxray/api/v1/setting/defaultSettings

Authorization

headerAuthorizationBearer <token>

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

Response Body

Successful response

application/json

response

success?boolean

msg?string

obj?unknown

curl -X POST "https://example.com/easyxray/api/v1/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

/easyxray/api/v1/setting/update

Authorization

headerAuthorizationBearer <token>

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

Request Body

application/json

body

Response Body

Successful response

application/json

response

success?boolean

msg?string

obj?unknown

curl -X POST "https://example.com/easyxray/api/v1/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

/easyxray/api/v1/setting/updateUser

Authorization

headerAuthorizationBearer <token>

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

Request Body

application/json

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

response

success?boolean

msg?string

obj?unknown

curl -X POST "https://example.com/easyxray/api/v1/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 EasyXray process after a 3-second grace period. The connection drops immediately; the panel comes back online ~5-10 seconds later.

POST

/easyxray/api/v1/setting/restartPanel

Authorization

headerAuthorizationBearer <token>

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

Response Body

Successful response

application/json

response

success?boolean

msg?string

obj?unknown

curl -X POST "https://example.com/easyxray/api/v1/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

/easyxray/api/v1/setting/testSmtp

Authorization

headerAuthorizationBearer <token>

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

Response Body

Successful response

application/json

response

success?boolean

msg?string

obj?unknown

curl -X POST "https://example.com/easyxray/api/v1/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

/easyxray/api/v1/setting/testTgBot

Authorization

headerAuthorizationBearer <token>

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

Response Body

Successful response

application/json

response

success?boolean

msg?string

obj?unknown

curl -X POST "https://example.com/easyxray/api/v1/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

/easyxray/api/v1/setting/getDefaultJsonConfig

Authorization

headerAuthorizationBearer <token>

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

Response Body

Successful response

application/json

response

success?boolean

msg?string

obj?unknown

curl -X GET "https://example.com/easyxray/api/v1/setting/getDefaultJsonConfig"

{  "success": true,  "msg": "string",  "obj": null}

设置

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

AuthorizationCopy Anchor Link

Response BodyCopy Anchor Link

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

AuthorizationCopy Anchor Link

Response BodyCopy Anchor Link

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.Copy Anchor Link

AuthorizationCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

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

AuthorizationCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

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

AuthorizationCopy Anchor Link

Response BodyCopy Anchor Link

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

AuthorizationCopy Anchor Link

Response BodyCopy Anchor Link

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

AuthorizationCopy Anchor Link

Response BodyCopy Anchor Link

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

AuthorizationCopy Anchor Link

Response BodyCopy Anchor Link

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

Authorization

Response Body

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

Authorization

Response Body

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.

Authorization

Request Body

Response Body

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

Authorization

Request Body

Response Body

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

Authorization

Response Body

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

Authorization

Response Body

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

Authorization

Response Body

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

Authorization

Response Body