Deployments

Read Deployment Schedules

get/api/deployments/{id}/schedules

Request

idstring uuid required

The deployment id

x-prefect-api-versionstring

Successful Response

idstring uuid

createdstring date-time

updatedstring date-time

deployment_idstring uuid

The deployment id associated with this schedule.

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"
    }
  }
]