Skip to main content
POST
/
api
/
deployments
/
{id}
/
schedule
Schedule Deployment
curl --request POST \
  --url https://api.example.com/api/deployments/{id}/schedule \
  --header 'Content-Type: application/json' \
  --data '
{
  "start_time": "2023-11-07T05:31:56Z",
  "end_time": "2023-11-07T05:31:56Z",
  "min_time": 123,
  "min_runs": 123,
  "max_runs": 123
}
'
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Headers

​
x-prefect-api-version
string

Path Parameters

​
id
string<uuid>
required

The deployment id

Body

application/json
​
start_time
string<date-time>

The earliest date to schedule

​
end_time
string<date-time>

The latest date to schedule

​
min_time
number<time-delta>

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

Successful Response