- API Reference
- Box API
- Rotation settings
Remove one scheduled rotation job, or all system jobs of the given slots
Use this to stop automatic rotation. With a job id it removes that job from each listed position; with an empty or null id it removes every system job of those positions. Selling-port interval jobs are not touched.
POST
/v2/schedule/rotation_remove_jobRequest body application/json · required
positionsinteger[]required
idinteger | nullrequired
Job id from rotation_jobs; null removes all system jobs of the positions.
Responses
Result.
statusbooleanrequired
True when the box accepted the request.
msgstringrequired
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 |
|---|---|---|
Missing param "positions"! | positions is empty. | Send at least one position. |
Remove schedule rotation failed! | positions or id is missing from the body or removal failed. | Send both fields (id may be null). |