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

Read the VPS's health (CPU, RAM, disk, relay) and service totals

Returns the latest health snapshot of the VPS collected over SSH plus counts of the forwarding services. When the VPS cannot be reached reachable is false with an error.

  • Read only
  • Basic auth
  • Panel API · since v21.2.34
  • Hub: routine call
  • getVpsForwardingHealth
GET/v2/forwarding/vps_health

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

Health view, or the error text.

statusbooleanoptional
msgstringoptional
dataobjectoptional
data.reachablebooleanoptional
data.errorstringoptional
data.checked_atintegeroptional
data.cpuobjectoptional
data.cpu.pctnumber | nulloptional
data.ramobjectoptional
data.ram.used_mbintegeroptional
data.ram.total_mbintegeroptional
data.ram.pctnumberoptional
data.diskobjectoptional
data.disk.used_gbnumberoptional
data.disk.total_gbnumberoptional
data.disk.pctnumberoptional
data.netobjectoptional
data.net.in_mbpsnumber | nulloptional
data.net.out_mbpsnumber | nulloptional
data.uptime_sinteger | nulloptional
data.connectionsintegeroptional
data.cpusintegeroptional
data.boxesintegeroptional

Boxes sharing this VPS.

data.relayobjectoptional
data.relay.statestringoptional
data.relay.memory_mbnumber | nulloptional
data.relay.versionstring | nulloptional
data.relay_issuestring | object | nulloptional
data.servicesobjectoptional
data.services.totalintegeroptional
data.services.runningintegeroptional
data.services.connsintegeroptional
data.services.up_mbpsnumberoptional
data.services.down_mbpsnumberoptional

Errors returned in msg

msgMeaningWhat to do
Failed to read VPS health: ...Building the view failed.Retry; check the controller log.
Verified against XProxy v21.3.2 on Nov 17, 2026