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

Read the WAN (PPPoE) setup and its connection log

Returns whether the box's own WAN service is on, the interface and method, the saved PPPoE settings (config), the box's interfaces and, for PPPoE, the tail of the connection log. This response can return secrets: config.password is the PPPoE password.

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

WAN settings.

statusbooleanoptional
dataobjectoptional
data.enablebooleanoptional
data.interfacestring | nulloptional
data.methodstring | nulloptional

e.g. pppoe.

data.configobjectoptional

PPPoE settings (username, password, vlan, mtu, mac); empty for other methods.

data.interface_listobject[]optional
data.interface_list[].valuestringoptional
data.interface_list[].labelstringoptional
data.wan_logstringoptional
Verified against XProxy v21.3.2 on Nov 17, 2026