- API Reference
- Box API
- Proxy settings
Add a proxy group
Appends the posted group to the group list and reloads all proxies. Needs the proxy-group license feature. The handler does not reject a primary_port that already exists, so posting the same group twice creates a duplicate; check /proxy_group_config first and use /edit_proxy_group_config to change a group.
/proxy_group_configRequest body application/json · required
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.
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
The stored group echoed back, or a license refusal.
One proxy group: a single shared port (primary_port) that spreads clients over the listed slots.
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.
Unhandled error, for example a non-integer position or a missing required parameter.
Error name, e.g. internal_server_error or bad_request.
Errors returned in msg
| msg | Meaning | What to do |
|---|---|---|
This function is available on higher plan license only. Please contact Administrator! | The license has no proxy-group feature. | Upgrade the license. |