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

Get a new public IP for one proxy

Use this to rotate the IP of the slot behind a proxy port. The call starts the rotation and returns at once; poll the status operation until it reports MODEM_READY. When a rotation delay is configured on the box, the answer is status: true with an empty msg and the rotation starts after the delay. For IPv6-multiple ports the IPv6 address is rotated.

  • Action · reversible
  • Basic auth when API auth is on
  • Public API · since v20.8.0
  • Hub: needs owner approval
  • rotateIpForProxy
GET/api/v1/rotate_ip/proxy/{proxy}

Path parameters

proxystringrequired

Proxy address as HOST:PORT. Only the port is used to find the slot; the host part is ignored (any non-empty text without a colon works). Use the HTTP or SOCKS5 port shown in the panel or in /api/v1/info_list.

Example 192.0.2.10:4001

Authentication

Open by default: with "Basic auth for all API" (api_auth_check) off, anyone who can reach the box can call it. When it is on, the caller must be trusted (loopback, LAN unless "force auth for local" is on, whitelisted IP, allowed Tailscale) or send dashboard Basic credentials, which are checked only when dashboard authentication (dashboard_disable_auth off) is enabled.

Responses

Rotation accepted or refused.

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
command_sentWith status true, the rotation started. With status false, the modem did not accept the command.On status false wait a few seconds and check the slot status before retrying.
modem_resettingA rotation is already running on this slot.Wait for MODEM_READY before rotating again.
reset_too_muchThe last rotation was less than the minimum interval ago (5 seconds by default).Wait and retry.
modem_disconnectedThe modem type cannot rotate (not detected as a router or AT stick).Check the modem in the panel.
need_upgradeThe license does not include IP rotation.Upgrade the license.
slot_not_foundNo slot matches the port or position.Use a port or position from /api/v1/info_list.
invalid_format_proxyThe proxy value is not HOST:PORT.Send it as HOST:PORT, for example 192.0.2.10:4001.
Verified against XProxy v21.3.2 on Nov 17, 2026