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

Schedule automatic IP rotation every N seconds/minutes/hours for slots

Use this to make slots rotate on a timer. One job is created and started per position. run_per_day forever runs all day (start/end ignored); range runs only between start_time and end_time. specific_time must not be null. Jobs add up: call rotation_jobs first to avoid duplicates and rotation_remove_job to replace a job.

  • Destructive · confirm first
  • Basic auth
  • Public API · since v20.8.0
  • Hub: routine call
  • addRotationScheduleJob
POST/v2/schedule/rotation_add_job

Request body application/json · required

positionsinteger[]required
intervalintegerrequired
unitstringrequired
One of seconds, minutes, hours
run_per_daystringrequired
One of forever, range
specific_timestringrequired

Time of day hh:mm the schedule is aligned to.

start_timestring | nullrequired

hh:mm:ss; required when run_per_day is range.

end_timestring | nullrequired

hh:mm:ss; required when run_per_day is range.

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
Should fill specific time on Only run option!specific_time is null.Send a time such as 00:00.
Should fill on the "from" field of Run every day in time range!run_per_day is range but start_time is null.Send start_time.
Should fill on the "to" field of Run every day in time range!run_per_day is range but end_time is null.Send end_time.
Schedule rotation failed to add!A field is missing or the job could not be stored.Send every required field and retry.
Verified against XProxy v21.3.2 on Nov 17, 2026