API Reference
Dashboard
  1. API Reference
  2. Box API
  3. 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.

  • Destructive · confirm first
  • Basic auth
  • Panel API · since v20.8.0
  • Hub: needs owner approval
  • setRenewMethods
POST/hilink_change_renew_method

Request body application/json · required

huawei_methodintegeroptional
legacy_android_methodintegeroptional
xh22_rotation_methodintegeroptional
offline_hold_secondsintegeroptional
offline_hold_cutstringoptional
One of radio, data
offline_hold_verify_ipbooleanoptional
offline_hold_retriesintegeroptional

Responses

Result.

statusbooleanrequired

True when the box accepted the request.

msgstringrequired

Outcome code or message (see the operation's error table).

Errors returned in msg

msgMeaningWhat to do
Please select right method for XH22xh22_rotation_method is not 1-5.Send a value from 1 to 5.
Please select right method for huawei hilinkhuawei_method is not 1-7.Send a value from 1 to 7.
Please select right method for legacy androidlegacy_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, dataUnknown cut mode.Send radio or data.
offline_hold_verify_ip must be true or falseNot a boolean.Send true or false.
Verified against XProxy v21.3.2 on Nov 17, 2026