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

Read how the box detects each modem's public IP

Returns the IP-check servers (IPv4 and IPv6), the check method, the check period and timeout in seconds, and the HTTP-status-only and native async check switches.

  • Read only
  • Basic auth
  • Panel API · since v20.8.0
  • Hub: routine call
  • getPublicIpCheckerConfig
GET/xproxy_config_public_ipchecker

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

IP checker settings.

statusbooleanoptional
dataobjectoptional
data.ip_serverstring | nulloptional
data.ipv6_serverstring | nulloptional
data.methodstring | nulloptional
data.only_http_status_checkbooleanoptional
data.pubip_periodintegeroptional
data.pubip_timedoutintegeroptional
data.native_async_http_check_enabledbooleanoptional
Verified against XProxy v21.3.2 on Nov 17, 2026