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
Path parameters
idstring uuid required
The deployment id
The deployment id
Headers
x-prefect-api-versionstring
Request body
Response
Successful Response
{"stackTrail":"paths:/api/deployments/{id}/schedule:post:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}