Create Deployment Schedules

Headers

x-prefect-api-version

string

Path Parameters

id

string

required

The deployment id

Body

application/json · object[]

schedule

object

required

The schedule for the deployment.

• Schedule
• Schedule
• Schedule

Show child attributes

schedule.interval

number

required

schedule.anchor_date

string

schedule.timezone

string | null

active

boolean

default:

true

Whether or not the schedule is active.

max_scheduled_runs

integer | null

The maximum number of scheduled runs for the schedule.

Required range: x > 0

parameters

object

A dictionary of parameter value overrides.

Response

201 - application/json

created

string | null

required

id

string

required

schedule

object

required

The schedule for the deployment.

• Schedule
• Schedule
• Schedule

Show child attributes

schedule.interval

number

required

schedule.anchor_date

string

schedule.timezone

string | null

updated

string | null

required

active

boolean

default:

true

Whether or not the schedule is active.

deployment_id

string | null

The deployment id associated with this schedule.

max_scheduled_runs

integer | null

The maximum number of scheduled runs for the schedule.

Required range: x > 0

parameters

object

A dictionary of parameter value overrides.