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

Run the full VPS forwarding diagnosis

Checks security, SSH, the relay, the firewall, services and public ports, and returns a list of items with a status and, where possible, a one-click fix action for /v2/forwarding/doctor_fix. When forwarding is off it returns a single warning item. Opens SSH and probes ports, so it takes some seconds; it does not change the setup.

  • Action · reversible
  • Basic auth
  • Panel API · since v21.2.34
  • Hub: routine call
  • runVpsForwardingDoctor
POST/v2/forwarding/doctor

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

Report, or a failure.

statusbooleanoptional
msgstringoptional
dataobjectoptional
data.checked_atintegeroptional
data.duration_msintegeroptional
data.okbooleanoptional
data.supportbooleanoptional

True when a failed item needs support.

data.itemsobject[]optional
data.items[].idstringoptional
data.items[].titlestringoptional
data.items[].statusstringoptional
One of ok, warning, failed
data.items[].msgstringoptional
data.items[].hintstringoptional
data.items[].fixobject | nulloptional
data.items[].supportbooleanoptional

Errors returned in msg

msgMeaningWhat to do
Doctor failed: ...The diagnosis crashed.Check the controller log.
Verified against XProxy v21.3.2 on Nov 17, 2026