- API Reference
- Box API
- 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.
/get_proxies_settingsAuthentication
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.
Error text when status is false.
Settings. Field names match the data keys accepted by /update_proxies_settings.
Global proxy password (secret).
Scheduled rotation table, one rule per line.
Whitelisted client IPs or subnets, one per line.
Highest start port that still leaves room for every port band.
REALITY public key (secret-like; share only with your clients).
aes-128-gcm, aes-256-gcm, chacha20-ietf-poly13050, 46, 64none, whitelist, blacklist, nullJSON text of the proxy-list export options.
UUID of the WAN VLESS listener (secret).
Shared Shadowsocks password (secret).
The caller is not trusted (not loopback, LAN, whitelisted or allowed Tailscale) and sent no valid Basic credentials. The body depends on whether "Basic auth for all API" is on. Routes that also use the panel login can answer a plain-text 401 "Unauthorized Access" instead.
Errors returned in msg
| msg | Meaning | What 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. |