Schedules

chain objectrequired

startTimestringrequired

Local time the chain starts (default 02:00).

Possible values: Value must match regular expression ^([01][0-9]|2[0-3]):[0-5][0-9]$

weeklyScrubDayWeekdayrequired

Day of week, 0=Sunday through 6=Saturday.

Possible values: >= 0 and <= 6

schedulePreviewstringrequired

Human-readable summary, e.g. "every day at 02:00".

nextRunstring<date-time>required

steps object[]required

Order: mover, diff_guard, sync, scrub, config_backup.

Array [

idMaintenanceChainStepIdrequired

One step in the fixed nightly maintenance chain order.

Possible values: [mover, diff_guard, sync, scrub, config_backup]

enabledbooleanrequired

]

otherJobs object[]required

Array [

idOtherScheduleJobIdrequired

A recurring job scheduled outside the nightly chain.

Possible values: [smart_self_test, appdata_backup, restore_drill, container_update_check]

enabledbooleanrequired

frequencyScheduleFrequencyrequired

Possible values: [daily, weekly, monthly]

timestringrequired

Possible values: Value must match regular expression ^([01][0-9]|2[0-3]):[0-5][0-9]$

schedulePreviewstringrequired

nextRunstring<date-time>required

]

conflicts object[]required

Array [

jobAstringrequired

Identifier of the first colliding schedule — maintenance_chain or an OtherScheduleJobId value.

jobBstringrequired

Identifier of the second colliding schedule.

]

Schedules

{
  "chain": {
    "startTime": "string",
    "weeklyScrubDay": 0,
    "schedulePreview": "string",
    "nextRun": "2024-07-29T15:51:28.071Z",
    "steps": [
      {
        "id": "mover",
        "enabled": true
      }
    ]
  },
  "otherJobs": [
    {
      "id": "smart_self_test",
      "enabled": true,
      "frequency": "daily",
      "time": "string",
      "schedulePreview": "string",
      "nextRun": "2024-07-29T15:51:28.071Z"
    }
  ],
  "conflicts": [
    {
      "jobA": "string",
      "jobB": "string"
    }
  ]
}