API Reference
Dashboard
  1. API Reference
  2. Box API
  3. Rotation settings

Read the global rotation, duplicate-IP, Smart IP Guard and IMEI/MAC changer settings

Use this before changing rotation behaviour, and to build the full body that POST /v2/rotation_setting needs. Base IMEIs and MAC addresses are joined with new lines.

  • Read only
  • Basic auth
  • Panel API · since v20.8.0
  • Hub: routine call
  • getRotationSettings
GET/v2/rotation_setting

Responses

Current settings.

statusbooleanoptional
dataobjectoptional

Global rotation settings as the Rotation settings page reads and writes them.

data.rotation_delay_before_processnumberoptional

Seconds to wait before a rotation starts.

data.prevent_time_each_portintegeroptional

Minimum seconds between two rotations of the same slot.

data.delay_rotation_timenumberoptional
data.delay_rotation_android_timenumberoptional
data.reconnect_isp_failure_timeintegeroptional
data.reconnect_isp_failure_max_retryintegeroptional
data.reconnect_ipv6_failurebooleanoptional
data.detect_collision_ipbooleanoptional
data.never_change_ip_automaticallybooleanoptional

When true the box never rotates a slot on its own (no automatic recovery rotations).

data.duplicate_ip_rotate_individual_enabledbooleanoptional
data.duplicate_ip_rotate_individual_wait_secondsintegeroptional
data.duplicate_ip_rotate_individual_max_attemptsintegeroptional
data.duplicate_ip_rotate_all_modems_enabledbooleanoptional
data.duplicate_ip_rotate_all_modems_wait_secondsintegeroptional
data.duplicate_ip_rotate_all_modems_max_attemptsintegeroptional
data.ip_history_guard_enabledbooleanoptional

Smart IP Guard on or off.

data.ip_history_guard_time_window_hoursintegeroptional
data.ip_history_guard_max_retriesintegeroptional
data.ip_history_guard_backoff_delayintegeroptional
data.ip_history_guard_score_thresholdintegeroptional
data.ip_history_guard_fresh_scoreintegeroptional
data.ip_history_guard_auto_stop_enabledbooleanoptional
data.ip_history_guard_auto_resume_secondsintegeroptional
data.ip_rotation_log_retention_daysintegeroptional

Days of rotation history kept (default 60).

data.imei_tc_listobject[]optional

Phone models available for IMEI generation (TAC code as key).

data.imei_tc_list[].keyintegeroptional
data.imei_tc_list[].labelstringoptional
data.imei_changer_phone_modelsany[]optional
data.imei_changer_based_imeistringoptional

Base IMEIs used by the IMEI changer (one per line).

data.imei_changer_optionintegeroptional
data.mac_changer_based_addressesstringoptional

Base MAC addresses (one per line).

data.mac_changer_optionintegeroptional
Verified against XProxy v21.3.2 on Nov 17, 2026