- API Reference
- Box API
- VPS forwarding
Check whether the box is safe to expose through the VPS
Evaluates the security checklist (license, dashboard password when the dashboard is exposed, proxy login when proxies are exposed). enable_web and enable_proxy evaluate a draft service selection; when omitted the saved rules are used. The same check gates /v2/forwarding/config_rules.
/v2/forwarding/preflightQuery parameters
Draft value for exposing the dashboard (true/false, 1/0).
trueDraft value for exposing the proxies (true/false, 1/0).
trueAuthentication
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
Checklist, or a failure.
Security checklist. blocking is true when an item has level error; forwarding cannot go live then.
license, dash_password, dash_not_exposed, proxy_password, proxy_not_exposedglobal, dashboard, proxyok, info, errorsecure_setup when the panel can fix it.
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 evaluate VPS forwarding security | The checklist could not be built. | Retry; check the controller log. |