API Reference
Dashboard
  1. API Reference
  2. Box API
  3. 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.

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

Request body application/json · required

sticky_enablebooleanrequired
sticky_serverstringrequired

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.

statusbooleanoptional
dataobjectoptional
Verified against XProxy v21.3.2 on Nov 17, 2026