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

  • Read only
  • Basic auth when API auth is on
  • Public API · since v20.8.0
  • Hub: needs owner approval
  • getProxyListByType
GET/api/v1/proxy_list/{port_type}

Path parameters

port_typestringrequired

Which port of each slot to list.

One of proxy, socks5, proxy_ipv6, socks5_ipv6, vless, vless_ipv6, ssExample proxy

Authentication

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.

Verified against XProxy v21.3.2 on Nov 17, 2026