- API Reference
- Box API
- Rotation settings
Save the global rotation settings (full replace of the main fields)
Use this to change rotation timing, collision handling, duplicate-IP rotation, Smart IP Guard or the IMEI/MAC changer. Read GET /v2/rotation_setting first and send the whole object back with your change: the timing fields, detect_collision_ip, imei_changer and mac_changer are required, and missing duplicate-IP fields are reset to their defaults (off, 30 seconds, 5 attempts). Smart IP Guard fields, never_change_ip_automatically and reconnect_ipv6_failure are saved only when present. Takes effect immediately for all slots. A missing required field or a non-numeric main value fails with HTTP 500 before anything is saved; a non-numeric Smart IP Guard value fails with HTTP 500 after the main fields were already saved.
/v2/rotation_settingRequest body application/json · required
true/false or 1/0, on/off.
false305false305Base IMEIs separated by new lines.
Base MAC addresses separated by new lines.
Responses
Saved.
A switch field has a value that is not true/false.
The caller is not trusted (not loopback, LAN, whitelisted or allowed Tailscale) and sent no valid Basic credentials. The body depends on whether "Basic auth for all API" is on. Routes that also use the panel login can answer a plain-text 401 "Unauthorized Access" instead.
Unhandled error, for example a non-integer position or a missing required parameter.
Error name, e.g. internal_server_error or bad_request.
Errors returned in msg
| msg | Meaning | What to do |
|---|---|---|
never_change_ip_automatically must be true or false | The switch value is not a boolean or a known spelling. | Send true or false. |
reconnect_ipv6_failure must be true or false | The switch value is not a boolean or a known spelling. | Send true or false. |