v1

latestOpenAPI 3.1.0raw.githubusercontent.com2024-11-08170291390.5 KB

Deployments

Update Deployment Schedule

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

idstring uuid required

The deployment id

schedule_idstring uuid required

The schedule id

x-prefect-api-versionstring

activeboolean

Whether or not the schedule is active.

max_active_runsinteger

The maximum number of active runs for the schedule.

max_scheduled_runsinteger

The maximum number of scheduled runs for the schedule.

catchupboolean

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

{
  "schedule": {
    "timezone": "America/New_York"
  }
}

Successful Response