PRprefecthq
Deployments

Create Deployment Schedules

Changed on
post/api/deployments/{id}/schedules

Request

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

Path parameters

idstring uuid required

The deployment 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

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.

Example response

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

Changes

  • e3ee4e0af397Revision changes
    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

  • 1300477de63fRevision changes
    • breaking

      the request property / became required