Sign in
Deployments

Update Deployment Schedule

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

Path parameters

idstring uuid required

The deployment id

The deployment id

schedule_idstring uuid required

The schedule id

The schedule id

Headers

x-prefect-api-versionstring

Request body

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.

Example request

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

Response

Successful Response

Changes

Changed in 3 of the 50 revisions of this API.5

  • e3ee4e0af3973See the full diff
    • ○

      added the new optional request property allOf[subschema #1: DeploymentScheduleUpdate]/catchup

      new-optional-request-property

    • ○

      added the new optional request property allOf[subschema #1: DeploymentScheduleUpdate]/max_active_runs

      new-optional-request-property

    • ○

      added the new optional request property allOf[subschema #1: DeploymentScheduleUpdate]/max_scheduled_runs

      new-optional-request-property

  • 1300477de63f1See the full diff
    • ○

      the active request property default value true was removed

      request-property-default-value-removed

  • f5e6e917c9241See the full diff
    • ○

      endpoint added

      endpoint-added