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

Rotate the IP of every modem on the box at once

Use this to give all modems new IPs in one call. Starts a rotation on every slot (up to 20 in parallel) and returns the outcome per position in results, keyed by position. Each entry has the same msg codes as POST /v2/rotate_ip. Refused with need_upgrade when the license has no IP rotation.

  • Destructive · confirm first
  • Basic auth
  • Panel API · since v20.8.0
  • Hub: routine call
  • rotateIpAll
POST/v2/rotate_ip_all

Request body application/json

Authentication

Needs dashboard Basic credentials when dashboard authentication is enabled; trusted callers (loopback, LAN unless "force auth for local" is on, whitelisted IP, allowed Tailscale) pass without them.

Responses

Per-position outcome, or need_upgrade.

Errors returned in msg

msgMeaningWhat to do
need_upgradeThe license does not include IP rotation.Upgrade the license plan.
errorThe rotation of that position raised an error (per-position result).Retry that position with POST /v2/rotate_ip.
Verified against XProxy v21.3.2 on Nov 17, 2026