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

Read the VPN server settings of every slot

Returns a map from slot position to its VPN settings, or data: null when no slot has a VPN configured. This response returns secrets (vpn_pass, vpn_rotation_token).

  • Read only
  • Basic auth
  • Panel API · since v20.8.0
  • Hub: routine call
  • getVpnConfig
GET/vpn_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

VPN settings per slot.

statusbooleanoptional
dataobject | nulloptional
Verified against XProxy v21.3.2 on Nov 17, 2026