- API Reference
- Box API
- Proxies
Get a plain-text list of proxy addresses of one type, one per line
Use this to import all online proxies into a tool that reads one proxy per line. Lists every slot with an active data connection as HOST:PORT for proxy, socks5, proxy_ipv6 and socks5_ipv6. vless and vless_ipv6 return VLESS REALITY share links and ss returns Shadowsocks links; those lines appear only when the license includes the protocol and the slot has the port. An unknown type returns an empty body. The body is plain text even though the box labels it text/html.
/api/v1/proxy_list/{port_type}Path parameters
Which port of each slot to list.
proxy, socks5, proxy_ipv6, socks5_ipv6, vless, vless_ipv6, ssExample proxyAuthentication
Always 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
One proxy per line, each line ending with a newline. Empty when no slot is online.
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.