- API Reference
- Box API
- Rotation settings
Change the IP rotation method of Hilink, legacy Android or XH22 modems and the offline-hold settings
Use this to switch how a modem family gets a new IP. Every field is optional; only the ones sent are checked and saved. Offline-hold values are all validated first and one bad value saves none of them; an invalid method is refused, but fields saved earlier in the same call stay saved (order: XH22 method, offline hold, Huawei, legacy Android). Applies to the next rotation of every modem of that type.
/hilink_change_renew_methodRequest body application/json · required
radio, dataResponses
Result.
True when the box accepted the request.
Outcome code or message (see the operation's error table).
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.
Errors returned in msg
| msg | Meaning | What to do |
|---|---|---|
Please select right method for XH22 | xh22_rotation_method is not 1-5. | Send a value from 1 to 5. |
Please select right method for huawei hilink | huawei_method is not 1-7. | Send a value from 1 to 7. |
Please select right method for legacy android | legacy_android_method is not 1-4. | Send a value from 1 to 4. |
offline_hold_seconds must be 0-600 (integer) | Hold time out of range. | Send an integer from 0 to 600. |
offline_hold_retries must be 0-3 (integer) | Retry count out of range. | Send an integer from 0 to 3. |
offline_hold_cut must be one of radio, data | Unknown cut mode. | Send radio or data. |
offline_hold_verify_ip must be true or false | Not a boolean. | Send true or false. |