- API Reference
- Box API
- 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.
/v2/forwarding/doctorAuthentication
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.
True when a failed item needs support.
ok, warning, failedThe 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 |
|---|---|---|
Doctor failed: ... | The diagnosis crashed. | Check the controller log. |