API Reference
Dashboard
  1. API Reference
  2. Box API
  3. Proxy settings

Read every global proxy setting shown on the panel's Proxy settings page

Returns the global proxy configuration in one object: proxy login, IP whitelist, IPv6 options, per-port authentication, port layout, VLESS and Shadowsocks options, VPS relay summary, group health-check options, website white/blacklists, sticky IP, auto-reboot rules, WebRTC leak protection and the "proxy through WAN" listener. This response returns secrets (proxy password, VLESS public key, WAN VLESS UUID, WAN Shadowsocks password); do not log or share it. On an internal error the box answers status: false with the error text in msg.

  • Read only
  • Basic auth
  • Panel API · since v20.8.0
  • Hub: routine call
  • getProxiesSettings
GET/get_proxies_settings

Authentication

Needs a trusted caller (loopback, LAN unless "force auth for local" is on, whitelisted IP, allowed Tailscale) or valid dashboard Basic credentials, which are checked only when dashboard authentication is enabled.

Responses

Current settings, or status false with the error text.

statusbooleanrequired
msgstringoptional

Error text when status is false.

dataobjectoptional

Settings. Field names match the data keys accepted by /update_proxies_settings.

data.enableProxyAuthbooleanoptional
data.disableProxyCachebooleanoptional
data.proxyUserstringoptional
data.proxyPassstringoptional

Global proxy password (secret).

data.enableLoggingbooleanoptional
data.loggingMaxDayintegeroptional
data.ipRotationLogRetentionDaysintegeroptional
data.uptimeLogRetentionDaysintegeroptional
data.rotationConfigstringoptional

Scheduled rotation table, one rule per line.

data.enableIPAuthbooleanoptional
data.forceLocalAuthenbooleanoptional
data.allowTailscaleNoAuthbooleanoptional
data.ipListstringoptional

Whitelisted client IPs or subnets, one per line.

data.ipv6Configbooleanoptional
data.multipleIpv6Configbooleanoptional
data.enablePerPortAuthbooleanoptional
data.perPortAuthConfigstringoptional
data.proxyStartPortintegeroptional
data.proxyStartPortMaxintegeroptional

Highest start port that still leaves room for every port band.

data.autoPortbooleanoptional
data.vlessEnabledbooleanoptional
data.vlessLicenseAllowedbooleanoptional
data.vlessPublicKeystringoptional

REALITY public key (secret-like; share only with your clients).

data.vlessSnistringoptional
data.vlessShortIdstringoptional
data.vlessFlowstringoptional
data.vlessServerIpstringoptional
data.ssEnabledbooleanoptional
data.ssMethodstringoptional
One of aes-128-gcm, aes-256-gcm, chacha20-ietf-poly1305
data.ssLicenseAllowedbooleanoptional
data.ssStartPortOkbooleanoptional
data.vpsRelayEnabledbooleanoptional
data.vpsAddressstringoptional
data.vpsPortAdjustintegeroptional
data.ipv6Modestringoptional
One of 0, 46, 64
data.proxyWatchdogIntervalintegeroptional
data.group_hostnamestringoptional
data.group_pingCountintegeroptional
data.group_pingSizeintegeroptional
data.group_checkIntervalintegeroptional
data.group_checkTimeoutintegeroptional
data.enableWhiteListbooleanoptional
data.whitelistSettingstringoptional
data.enableBlackListbooleanoptional
data.blacklistSettingstringoptional
data.rotationDelayBeforeProcessnumberoptional
data.globalWebsiteAuthorizationModestring | nulloptional
One of none, whitelist, blacklist, null
data.globalWhitelistSettingstring | nulloptional
data.globalBlacklistSettingstring | nulloptional
data.stickyIPEnablebooleanoptional
data.stickyServerstring | nulloptional
data.s_intervalnumberoptional
data.s_timeoutnumberoptional
data.s_sizeintegeroptional
data.s_ttlintegeroptional
data.stickyIPMethodstringoptional
data.forceServerResolveDNSbooleanoptional
data.autoRebootIPUnchangedintegeroptional
data.autoRebootIPCheckFailintegeroptional
data.enable_webrtc_leakbooleanoptional
data.out_interfacesstringoptional
data.exportConfigstringoptional

JSON text of the proxy-list export options.

data.wanProxyEnabledbooleanoptional
data.wanProxyPortintegeroptional
data.wanProxyVlessEnabledbooleanoptional
data.wanProxyLicenseAllowedbooleanoptional
data.wanProxyVlessPortintegeroptional
data.wanProxyVlessUuidstringoptional

UUID of the WAN VLESS listener (secret).

data.wanProxySsEnabledbooleanoptional
data.wanProxySsPortintegeroptional
data.wanProxySsPasswordstringoptional

Shared Shadowsocks password (secret).

data.wanProxyHoststringoptional
data.wanProxyPublicIpstringoptional

Errors returned in msg

msgMeaningWhat to do
(exception text)Reading a setting failed (for example while the proxy engine is still starting).Retry after a few seconds; check the controller log if it persists.
Verified against XProxy v21.3.2 on Nov 17, 2026