- API Reference
- Box API
- Proxy settings
Turn sticky IP on or off and set its keep-alive server
Sticky IP keeps each modem's session busy (by pinging sticky_server) so the carrier keeps the same public IP. Turning it off stops all sticky jobs; turning it on starts the sticky service with the saved settings. A non-empty sticky_server that differs from the saved one is pushed to the running service. Intervals, size and TTL are set through /update_proxies_settings type stickyIPEnable.
/sticky_ip_configRequest body application/json · required
Host to ping; empty keeps the saved one.
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
The posted data echoed back.
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.
Unhandled error, for example a non-integer position or a missing required parameter.
Error name, e.g. internal_server_error or bad_request.