PRprefecthq
Deployments

Schedule Deployment

Schedule runs for a deployment. For backfills, provide start/end times in the past.

This function will generate the minimum number of runs that satisfy the min and max times, and the min and max counts. Specifically, the following order will be respected.

- Runs will be generated starting on or after the `start_time`
- No more than `max_runs` runs will be generated
- No runs will be generated after `end_time` is reached
- At least `min_runs` runs will be generated
- Runs will be generated until at least `start_time + min_time` is reached
post/api/deployments/{id}/schedule

Request

  • The document declares no server URL.
  • Auth
    none declared

Path parameters

idstring uuid required

The deployment id

Headers

x-prefect-api-versionstring

Request body

start_timestring date-time

The earliest date to schedule

end_timestring date-time

The latest date to schedule

min_timenumber

Runs will be scheduled until at least this long after the start_time

min_runsinteger

The minimum number of runs to schedule

max_runsinteger

The maximum number of runs to schedule

Response

Successful Response

unknown required

Changes

No recorded changes to this operation across all 1 revision of this API.