- API Reference
- Box API
- VPS forwarding
Read the VPS connection and forwarding rules
Returns the VPS address, SSH port, user, whether forwarding is on, the auth method, the saved rules, the available tunnel engines and the VPS host-key fingerprint. Secrets are never returned: vps_relay_pass is always empty and only *_set flags and key fingerprints show whether a password, private key or sudo password is stored.
/v2/forwarding/get_vps_configAuthentication
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
VPS settings and rules.
Offset for proxy ports (also VLESS/Shadowsocks).
Offset for the dashboard port.
Network isolation; needs the xrelay engine.
First of the 4 relay tunnel ports on the VPS.
Parallel tunnels per port.
xrelay, wireguardVPS address (the key name has this spelling).
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.