- API Reference
- Box API
- 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.
/xproxy_config_public_ipcheckerRequest body application/json · required
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.
True when the box accepted the request.
Outcome code or message (see the operation's error table).
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.
Errors returned in msg
| msg | Meaning | What to do |
|---|---|---|
The period option must greater than 1 | pubip_period is below 2 or above 99999. | Send 2–99999. |
The timed out option must greater than 1 | pubip_timedout is below 2 or above 99999. | Send 2–99999. |
Please input valid value | A field is missing or not a number. | Send every required field with valid values. |