- API Reference
- Box API
- Proxy settings
List the proxy groups (one port that spreads traffic over several slots)
Returns every configured proxy group. Each group includes its proxy username and password, so the response can contain secrets.
/proxy_group_configAuthentication
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
Groups.
Port of the group proxy. Identifies the group.
Slots (positions) that serve the group.
0 HTTP over IPv4, 1 SOCKS5 over IPv4, 2 HTTP over IPv6, 3 SOCKS5 over IPv6.
0, 1, 2, 3Proxy username of the group (empty for none).
Proxy password of the group (empty for none).
Client IPs allowed without a password, comma separated.
When true, each new connection picks a random slot instead of the next one.
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.