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

Change how the box detects each modem's public IP

Saves the IP-check servers, method, period and timeout. pubip_period and pubip_timedout must be integers from 2 to 99999. A wrong IP server makes every modem look disconnected.

  • Destructive · confirm first
  • Basic auth
  • Panel API · since v20.8.0
  • Hub: needs owner approval
  • setPublicIpCheckerConfig
POST/xproxy_config_public_ipchecker

Request body application/json · required

methodstringrequired
ip_serverstringrequired
ipv6_serverstringrequired
pubip_periodintegerrequired
pubip_timedoutintegerrequired
only_http_status_checkbooleanrequired
native_async_http_check_enabledbooleanoptional

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

Result.

statusbooleanrequired

True when the box accepted the request.

msgstringrequired

Outcome code or message (see the operation's error table).

Errors returned in msg

msgMeaningWhat to do
The period option must greater than 1pubip_period is below 2 or above 99999.Send 2–99999.
The timed out option must greater than 1pubip_timedout is below 2 or above 99999.Send 2–99999.
Please input valid valueA field is missing or not a number.Send every required field with valid values.
Verified against XProxy v21.3.2 on Nov 17, 2026