- API Reference
- Box API
- 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.
/v2/schedule/rotation_add_jobRequest body application/json · required
seconds, minutes, hoursforever, rangeTime of day hh:mm the schedule is aligned to.
hh:mm:ss; required when run_per_day is range.
hh:mm:ss; required when run_per_day is range.
Responses
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 |
|---|---|---|
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. |