Sign in
Deployments

Create Deployment Schedules

post/api/deployments/{id}/schedules

Path parameters

idstring uuid required

The deployment id

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

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

  • e3ee4e0af3976See the full diff
    • ○

      added the new optional request property items/catchup

      new-optional-request-property

    • ○

      added the new optional request property items/max_active_runs

      new-optional-request-property

    • ○

      added the new optional request property items/max_scheduled_runs

      new-optional-request-property

    • ○

      added the optional property items/catchup to the response with the 201 status

      response-optional-property-added

    • ○

      added the optional property items/max_active_runs to the response with the 201 status

      response-optional-property-added

    • ○

      added the optional property items/max_scheduled_runs to the response with the 201 status

      response-optional-property-added

  • 1300477de63f1See the full diff
    • ▲

      the request property items/schedule became required

      request-property-became-required

  • f5e6e917c9241See the full diff
    • ○

      endpoint added

      endpoint-added