PRprefecthq
Deployments

Update Deployment Schedule

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

Request

  • The document declares no server URL.
  • Auth
    none declared

Path parameters

idstring uuid required

The deployment id

schedule_idstring uuid required

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

  • e3ee4e0af397Revision changes
    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property /

  • 1300477de63fRevision changes
    • info

      the request property default value true was removed