API Reference
Dashboard
  1. API Reference
  2. Box API
  3. VPS forwarding

Read whether the proxy ports are reachable from the internet (cached)

Returns the last known reachability of every listening proxy port and the box's public and LAN IP, without probing. Ports are unknown (open: null) until POST /v2/proxy/public_reach/check has run. Detects the public IP once if it is not known yet.

  • Read only
  • Basic auth
  • Panel API · since v21.2.34
  • Hub: routine call
  • getProxyPublicReach
GET/v2/proxy/public_reach

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

Reachability view.

statusbooleanoptional
dataobjectoptional

Public reachability of the proxy ports. open is null (unknown) until the probe server answered for that port.

data.public_ipstringoptional
data.lan_ipstringoptional

Address the router must forward to.

data.checked_atstring | nulloptional

ISO time (UTC) of the last probe.

data.portsobject[]optional
data.ports[].portintegeroptional
data.ports[].kindstringoptional
One of http, socks, http6, socks6, dual, vless, vless6, ss, ss6
data.ports[].positioninteger | nulloptional
data.ports[].openboolean | nulloptional
data.unavailablebooleanoptional

True when the probe server could not be reached.

data.open_countintegeroptional

Slots whose ports are all open.

data.totalintegeroptional

Slots with listening proxy ports.

data.wanobject | nulloptional

Result of the latest WAN speed test, null if none ran.

Verified against XProxy v21.3.2 on Nov 17, 2026