API Reference
Dashboard
  1. API Reference
  2. Box API
  3. VPN

Read the base ports of the WireGuard and OpenVPN servers

Returns the first port of the WireGuard range (wg_port) and of the OpenVPN range (opvn_port); each slot uses base + position.

  • Read only
  • Basic auth
  • Panel API · since v20.8.0
  • Hub: routine call
  • getVpnPort
GET/v2/get_vpn_port

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

Base ports.

statusbooleanoptional
dataobjectoptional
data.wg_portintegeroptional
data.opvn_portintegeroptional
Verified against XProxy v21.3.2 on Nov 17, 2026