API Reference
Dashboard
  1. API Reference
  2. Box API
  3. 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.

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

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

Groups.

statusbooleanoptional
dataobject[]optional
data[].primary_portintegerrequired

Port of the group proxy. Identifies the group.

data[].position_listinteger[]required

Slots (positions) that serve the group.

data[].proxy_typestringoptional

0 HTTP over IPv4, 1 SOCKS5 over IPv4, 2 HTTP over IPv6, 3 SOCKS5 over IPv6.

One of 0, 1, 2, 3
data[].user_groupstringoptional

Proxy username of the group (empty for none).

data[].pass_groupstringoptional

Proxy password of the group (empty for none).

data[].ip_groupstringoptional

Client IPs allowed without a password, comma separated.

data[].randomize_ip_groupbooleanoptional

When true, each new connection picks a random slot instead of the next one.

Verified against XProxy v21.3.2 on Nov 17, 2026