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

  • Read only
  • Basic auth
  • Panel API · since v20.8.0
  • Hub: routine call
  • getVpsForwardingConfig
GET/v2/forwarding/get_vps_config

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

VPS settings and rules.

statusbooleanoptional
dataobjectoptional
data.vps_relay_adjust_proxy_portintegeroptional

Offset for proxy ports (also VLESS/Shadowsocks).

data.vps_relay_adjust_web_portintegeroptional

Offset for the dashboard port.

data.vps_relay_adjust_selling_portintegeroptional
data.vps_relay_adjust_group_portintegeroptional
data.vps_relay_adjust_vpn_portintegeroptional
data.vps_relay_adjust_ssh_portintegeroptional
data.vps_relay_enable_proxybooleanoptional
data.vps_relay_enable_sellingbooleanoptional
data.vps_relay_enable_groupbooleanoptional
data.vps_relay_enable_vpnbooleanoptional
data.vps_relay_enable_webbooleanoptional
data.vps_relay_enable_sshbooleanoptional
data.vps_net_isolate_enablebooleanoptional

Network isolation; needs the xrelay engine.

data.vps_proc_isolate_enablebooleanoptional
data.vps_socks5_udp_enablebooleanoptional
data.vps_relay_selling_access_logbooleanoptional
data.vps_starting_relay_portintegeroptional

First of the 4 relay tunnel ports on the VPS.

data.vps_relay_tunnelsintegeroptional

Parallel tunnels per port.

data.vps_tunnel_stackstringoptional
One of xrelay, wireguard
data.vps_relay_address_serverystring | nulloptional

VPS address (the key name has this spelling).

data.vps_relay_portintegeroptional
data.vps_relay_userstring | nulloptional
data.vps_relay_enablebooleanoptional
data.vps_relay_authen_methodstring | nulloptional
data.vps_relay_passstringoptional
data.vps_relay_pass_setbooleanoptional
data.vps_relay_key_setbooleanoptional
data.vps_relay_key_fingerprintstringoptional
data.vps_relay_sudo_pass_setbooleanoptional
data.vps_tunnel_stacksstring[]optional
data.vps_relay_host_key_fingerprintstringoptional
Verified against XProxy v21.3.2 on Nov 17, 2026