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

Headers

x-prefect-api-version
string

Path Parameters

id
string
required

The deployment id

Response

200
application/json
Successful Response
id
string
required
created
string | null
required
updated
string | null
required
schedule
object
required

The schedule for the deployment.

deployment_id
string | 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
object

A dictionary of parameter value overrides.

slug
string | null

A unique slug for the schedule.