API Reference
Dashboard
  1. API Reference
  2. Box API
  3. 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.

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

Query parameters

enable_webstringoptional

Draft value for exposing the dashboard (true/false, 1/0).

Example true
enable_proxystringoptional

Draft value for exposing the proxies (true/false, 1/0).

Example true

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

Checklist, or a failure.

statusbooleanoptional
msgstringoptional
dataobjectoptional

Security checklist. blocking is true when an item has level error; forwarding cannot go live then.

data.client_ipstringoptional
data.license_okbooleanoptional
data.servicesobjectoptional
data.services.webbooleanoptional
data.services.proxybooleanoptional
data.dashboardobjectoptional
data.dashboard.password_setbooleanoptional
data.dashboard.userstringoptional
data.proxyobjectoptional
data.proxy.password_setbooleanoptional
data.proxy.userstringoptional
data.blockingbooleanrequired
data.itemsobject[]required
data.items[].idstringoptional
One of license, dash_password, dash_not_exposed, proxy_password, proxy_not_exposed
data.items[].scopestringoptional
One of global, dashboard, proxy
data.items[].levelstringoptional
One of ok, info, error
data.items[].fixstring | nulloptional

secure_setup when the panel can fix it.

data.items[].titlestringoptional
data.items[].msgstringoptional

Errors returned in msg

msgMeaningWhat to do
Failed to evaluate VPS forwarding securityThe checklist could not be built.Retry; check the controller log.
Verified against XProxy v21.3.2 on Nov 17, 2026