- API Reference
- Box API
- VPS forwarding
List every forwarded port with its VPS port and state
Returns one row per forwarding service (relay tunnels and per-port forwards) with the local port, public VPS port, status and the last error with its diagnosed cause.
/v2/forwarding/get_mapping_portsAuthentication
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
Rows, or the error text.
Unit name, e.g. xlocal@4001 or xwg@20000.
e.g. running, starting, relay_down.
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 get mapping ports: ... | Reading the service table failed. | Retry; check the controller log. |