- API Reference
- Box API
- 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.
GET
/v2/get_vpn_portAuthentication
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
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.