- API Reference
- Box API
- 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.
GET
/v2/forwarding/vps_healthAuthentication
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
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.
Errors returned in msg
| msg | Meaning | What to do |
|---|---|---|
Failed to read VPS health: ... | Building the view failed. | Retry; check the controller log. |