rebase workflow schedule

Manage workflow cron schedules.

Synopsis

rebase workflow schedule show <name> --project <project>
rebase workflow schedule set <name> --project <project> --cron "0 15 * * *" [--timezone <tz>] [--day-and] [--inactive]
rebase workflow schedule pause <name> --project <project>
rebase workflow schedule resume <name> --project <project>
rebase workflow schedule trigger <name> --project <project> [-p key=value] [--wait]
rebase workflow schedule clear <name> --project <project>
rebase workflow schedule list [--project <project>]

Name-based lookup requires --project; every subcommand also accepts --id <uuid> instead of a name.

Subcommands

SubcommandDescription
showShow a workflow's cron expression, timezone, active state, and next run time.
setSet or replace the workflow's cron schedule.
pauseStop the schedule from firing while keeping it registered.
resumeRe-activate a paused schedule.
triggerTrigger a run of the deployed workflow now, outside the schedule.
clearRemove the schedule.
listList all workflows that have schedules, with next run times.

Options for set

OptionTypeDescription
--cronstrFive-field cron expression, e.g. "0 15 * * *". Required.
--timezonestrIANA timezone the expression is evaluated in, e.g. Europe/Stockholm.
--day-andboolRequire day-of-month AND day-of-week to match (default is standard cron OR).
--inactiveboolRegister the schedule paused.

Options for trigger

OptionTypeDescription
--param, -pname=valueRun parameter. Values are parsed as JSON when possible. Repeat for multiple parameters.
--parameters-jsonjsonJSON object with run parameters.
--wait / --no-waitboolFollow the run until it finishes. Defaults to --no-wait.
--timeoutintMaximum seconds to wait with --wait. Defaults to 600.

Behavior

Pausing sets the schedule's active flag to false — the Prefect deployment stays registered but no runs fire. Disabling the workflow itself (enabled=false) removes the schedule registration entirely. Schedule changes create (or reuse) a workflow version, so pause followed by resume returns to the original version.

Runs created by trigger carry trigger_source: "api"; runs fired by the cron schedule carry trigger_source: "schedule".

On this page