Schedule

schedule service triggers an inbound on a recurring schedule.

Each trigger performs one scan of the inbound. Entries are routed by Route rules, the same as for any other inbound.

Structure

{
  "type": "schedule",
  "tag": "daily-backup",
  "cron": "0 3 * * *",
  "inbound": "local-in"
}

Fields

cron

The cron expression for the schedule.

Standard 5-field cron format: minute hour day-of-month month day-of-week.

Exactly one of cron and every must be set.

every

Run at a fixed interval.

Accepts a duration string, e.g., "6h", "30m".

Exactly one of cron and every must be set.

inbound

Required

The tag of the inbound to trigger.

The referenced inbound must be a one-shot inbound such as Local, S3, SFTP, or Remote in connect mode. Live inbounds such as FSWatch run continuously and cannot be scheduled.

Rotation

Backup rotation is configured on the destination, not on the schedule. See the keep field of the Archive outbound.