POST
/
api
/
deployments
/
{id}
/
schedules

Headers

x-prefect-api-version
string

Path Parameters

id
string
required

The deployment id

Body

application/json · object[]
active
boolean
default: true

Whether or not the schedule is active.

schedule
object
required

The schedule for the deployment.

max_scheduled_runs
integer | null

The maximum number of scheduled runs for the schedule.

Required range: x > 0

Response

201 - application/json
id
string
created
string | null
updated
string | null
deployment_id
string | null

The deployment id associated with this schedule.

schedule
object
required

The schedule for the deployment.

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