Schedule Deployment

curl --request POST \
  --url https://api.example.com/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>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

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

deployments

{id}

schedule

Schedule Deployment

curl --request POST \
  --url https://api.example.com/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>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Headers

x-prefect-api-version

string

Path Parameters

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

Bulk Delete Deployments Resume Deployment

⌘I

Documentation Index

Headers

Path Parameters

Body

Response