API Reference
Dashboard
  1. API Reference
  2. Box API
  3. VPN rotation

Get a new public IP for the slot behind a box VPN, using its rotation link

Use this to rotate the IP of the slot a VPN profile exits through, for example from a phone connected to the box VPN. The token is the rotation token shown on the box's VPN page. Token and VPN problems answer with message; the rotation itself answers with msg and the same codes as /api/v1/rotate_ip/position/{position}.

  • Action · reversible
  • VPN rotation token (?token=)
  • Public API · since v21.0.15
  • Hub: needs owner approval
  • rotateVpnIp
GET/vpn/rotate

Authentication

Authenticated only by the VPN rotation token; the dashboard login and "Basic auth for all API" do not apply.

Responses

Rotation result or token refusal.

Errors returned in msg

msgMeaningWhat to do
Token requiredtoken is missing or blank.Use the full rotation link from the VPN page.
Invalid tokenNo VPN profile has this rotation token.Copy the link again; it changes when the token is regenerated.
VPN is not enabledThe VPN profile is turned off.Enable the VPN on the box.
Try again laterUnexpected error on the box.Retry later; check the box logs if it persists.
MODEM_STOPPEDThe box stopped this slot.Clear the stop in the panel.
reset_too_muchRotated less than the minimum interval ago.Wait and retry.
need_upgradeThe license does not include IP rotation.Upgrade the license.
Verified against XProxy v21.3.2 on Nov 17, 2026