Change a backup schedule
Replaces the cron expression, the target, the tiers and the on/off flag. The archives of the schedule stay on the old target.
/api/v1/console-backup/schedules/{id}tse_sessionAPI key · cookierequiredidstringrequiredapplication/jsoncronstringrequiredA cron expression of 5 fields (minute hour day-of-month month day-of-week), in UTC. No descriptor such as @daily and no time zone
enabledbooleanrequiredfalse: the schedule does not run
keep_countinteger<int64>requiredAfter each successful run, keep the newest archives of the schedule on its target. 0: no count limit. The retention never deletes the newest successful archive, a manual archive or an archive of another console
max_age_daysinteger<int64>requiredAfter each successful run, delete the archives of the schedule on its target that are older. 0: no age limit. Not 0 together with keep_count
target_idstringrequiredtiersstring[]requiredThe tiers of the archives. core is always in. logs adds the logs of the finished workflows. packs adds the loaded server packs, not the packs of the image. metrics adds the Prometheus data. A tier that this release cannot back up gives 422 (size-estimate shows the available tiers)
OK
created_atstring<date-time>requiredcronstringrequiredA cron expression of 5 fields (minute hour day-of-month month day-of-week), in UTC
enabledbooleanrequiredidstringrequiredkeep_countinteger<int64>requiredThe retention keeps the newest archives of the schedule on its target. 0: no count limit
max_age_daysinteger<int64>requiredThe retention deletes the archives of the schedule that are older. 0: no age limit
next_runsstring<date-time>[]requiredThe next three runs, in UTC. Empty when the schedule is off
target_idstringrequiredtiersstring[]requiredupdated_atstring<date-time>requiredError
codestringStable code of the refusal, when the route has codes
detailsstring[]Additional detail, e.g. per-field validation failures
errorstringrequiredHuman-readable error message