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
Headers
x-prefect-api-version
string
Path Parameters
id
string
requiredThe deployment id
Body
application/json
start_time
string
The earliest date to schedule
end_time
string
The latest date to schedule
min_time
number
Runs will be scheduled until at least this long after the start_time
min_runs
integer
The minimum number of runs to schedule
max_runs
integer
The maximum number of runs to schedule
Response
200 - application/json
The response is of type any
.
Was this page helpful?