- API Reference
- Box API
- 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}.
GET
/vpn/rotateAuthentication
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
| msg | Meaning | What to do |
|---|---|---|
Token required | token is missing or blank. | Use the full rotation link from the VPN page. |
Invalid token | No VPN profile has this rotation token. | Copy the link again; it changes when the token is regenerated. |
VPN is not enabled | The VPN profile is turned off. | Enable the VPN on the box. |
Try again later | Unexpected error on the box. | Retry later; check the box logs if it persists. |
MODEM_STOPPED | The box stopped this slot. | Clear the stop in the panel. |
reset_too_much | Rotated less than the minimum interval ago. | Wait and retry. |
need_upgrade | The license does not include IP rotation. | Upgrade the license. |