Skip to main content
POST
/
api
/
deployments
/
{id}
/
schedules
[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created": "2023-11-07T05:31:56Z",
    "updated": "2023-11-07T05:31:56Z",
    "schedule": {
      "interval": 123,
      "anchor_date": "2023-11-07T05:31:56Z",
      "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

The schedule for the deployment.

  • IntervalSchedule
  • CronSchedule
  • RRuleSchedule
​
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.

Response

Successful Response

​
id
string<uuid>
required
​
created
string<date-time> | null
required
​
updated
string<date-time> | null
required
​
schedule
IntervalSchedule · object
required

The schedule for the deployment.

  • IntervalSchedule
  • CronSchedule
  • RRuleSchedule
​
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.