Create Deployment Schedules

POST /deployments/{id}/schedules

Create Deployment Schedules

cURL

curl --request POST \
  --url https://api.example.com/deployments/{id}/schedules \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "schedule": {
      "interval": 1,
      "anchor_date": "2020-01-01T00:00:00Z",
      "timezone": "America/New_York"
    },
    "active": true,
    "max_scheduled_runs": 1,
    "parameters": {},
    "slug": "<string>",
    "replaces": "<string>"
  }
]
'

201

[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created": "2023-11-07T05:31:56Z",
    "updated": "2023-11-07T05:31:56Z",
    "schedule": {
      "interval": 123,
      "anchor_date": "2020-01-01T00:00:00Z",
      "timezone": "America/New_York"
    },
    "deployment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "active": true,
    "max_scheduled_runs": 1,
    "parameters": {},
    "slug": "<string>"
  }
]

Headers

x-prefect-api-version · string

Path Parameters

id · string<uuid> · required

The deployment id

Body

application/json

schedule · IntervalSchedule · object · required

A schedule formed by adding interval increments to an anchor_date. If no anchor_date is supplied, the current UTC time is used. If a timezone-naive datetime is provided for anchor_date, it is assumed to be in the schedule's timezone (or UTC). Even if supplied with an IANA timezone, anchor dates are always stored as UTC offsets, so a timezone can be provided to determine localization behaviors like DST boundary handling. If none is provided it will be inferred from the anchor date.

NOTE: If the IntervalSchedule anchor_date or timezone is provided in a DST-observing timezone, then the schedule will adjust itself appropriately. Intervals greater than 24 hours will follow DST conventions, while intervals of less than 24 hours will follow UTC intervals. For example, an hourly schedule will fire every UTC hour, even across DST boundaries. When clocks are set back, this will result in two runs that appear to both be scheduled for 1am local time, even though they are an hour apart in UTC time. For longer intervals, like a daily schedule, the interval schedule will adjust for DST boundaries so that the clock-hour remains constant. This means that a daily schedule that always fires at 9am will observe DST and continue to fire at 9am in the local time zone.

Args: interval (datetime.timedelta): an interval to schedule on. anchor_date (DateTime, optional): an anchor date to schedule increments against; if not provided, the current timestamp will be used. timezone (str, optional): a valid timezone string.

IntervalSchedule

CronSchedule

RRuleSchedule

Show child attributes

active · boolean · default: true

Whether or not the schedule is active.

max_scheduled_runs · integer | null

The maximum number of scheduled runs for the schedule.

Required range: x > 0

parameters · Parameters · object

A dictionary of parameter value overrides.

slug · string | null

A unique identifier for the schedule.

replaces · string | null

The slug of an existing schedule that this schedule replaces. Used for renaming slugs.

Response

201

application/json

Successful Response

id · string<uuid> · required

created · string<date-time> | null · required

updated · string<date-time> | null · required

schedule · IntervalSchedule · object · required

A schedule formed by adding interval increments to an anchor_date. If no anchor_date is supplied, the current UTC time is used. If a timezone-naive datetime is provided for anchor_date, it is assumed to be in the schedule's timezone (or UTC). Even if supplied with an IANA timezone, anchor dates are always stored as UTC offsets, so a timezone can be provided to determine localization behaviors like DST boundary handling. If none is provided it will be inferred from the anchor date.

NOTE: If the IntervalSchedule anchor_date or timezone is provided in a DST-observing timezone, then the schedule will adjust itself appropriately. Intervals greater than 24 hours will follow DST conventions, while intervals of less than 24 hours will follow UTC intervals. For example, an hourly schedule will fire every UTC hour, even across DST boundaries. When clocks are set back, this will result in two runs that appear to both be scheduled for 1am local time, even though they are an hour apart in UTC time. For longer intervals, like a daily schedule, the interval schedule will adjust for DST boundaries so that the clock-hour remains constant. This means that a daily schedule that always fires at 9am will observe DST and continue to fire at 9am in the local time zone.

Args: interval (datetime.timedelta): an interval to schedule on. anchor_date (DateTime, optional): an anchor date to schedule increments against; if not provided, the current timestamp will be used. timezone (str, optional): a valid timezone string.

IntervalSchedule

CronSchedule

RRuleSchedule

Show child attributes

deployment_id · string<uuid> | null

The deployment id associated with this schedule.

active · boolean · default: true

Whether or not the schedule is active.

max_scheduled_runs · integer | null

The maximum number of scheduled runs for the schedule.

Required range: x > 0

parameters · Parameters · object

A dictionary of parameter value overrides.

slug · string | null

A unique slug for the schedule.