PATCH
/
api
/
deployments
/
{id}
/
schedules
/
{schedule_id}

Headers

x-prefect-api-version
string

Path Parameters

id
string
required

The deployment id

schedule_id
string
required

The schedule id

Body

application/json
active
boolean | null

Whether or not the schedule is active.

schedule
object | null

The schedule for the deployment.

max_active_runs
integer | null

The maximum number of active runs for the schedule.

max_scheduled_runs
integer | null

The maximum number of scheduled runs for the schedule.

catchup
boolean | null

Whether or not a worker should catch up on Late runs for the schedule.