API Reference
- Overview
- Settings reference
- REST API overview
- Server API Overview
- POSTCreate Deployment
- GETRead Deployment
- DELDelete Deployment
- PATCHUpdate Deployment
- GETRead Deployment By Name
- POSTRead Deployments
- POSTPaginate Deployments
- POSTGet Scheduled Flow Runs For Deployments
- POSTCount Deployments
- POSTSchedule Deployment
- POSTResume Deployment
- POSTPause Deployment
- POSTCreate Flow Run From Deployment
- GETWork Queue Check For Deployment
- GETRead Deployment Schedules
- POSTCreate Deployment Schedules
- DELDelete Deployment Schedule
- PATCHUpdate Deployment Schedule
- POST
- GETCreate Csrf Token
[
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created": "2023-11-07T05:31:56Z",
"updated": "2023-11-07T05:31:56Z",
"name": "<string>",
"flow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"version": "<string>",
"description": "<string>",
"paused": false,
"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>"
}
],
"concurrency_limit": 123,
"global_concurrency_limit": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created": "2023-11-07T05:31:56Z",
"updated": "2023-11-07T05:31:56Z",
"name": "<string>",
"limit": 123,
"active_slots": 123,
"active": true,
"slot_decay_per_second": 2
},
"concurrency_options": {
"collision_strategy": "ENQUEUE",
"grace_period_seconds": 43230
},
"job_variables": {},
"parameters": {},
"tags": [
"<string>"
],
"labels": {},
"work_queue_name": "<string>",
"work_queue_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"last_polled": "2023-11-07T05:31:56Z",
"parameter_openapi_schema": {},
"path": "<string>",
"pull_steps": [
{}
],
"entrypoint": "<string>",
"storage_document_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"infrastructure_document_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_by": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "<string>",
"display_value": "<string>"
},
"updated_by": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "<string>",
"display_value": "<string>"
},
"work_pool_name": "<string>",
"status": "NOT_READY",
"enforce_parameter_schema": true
}
]Read Deployments
Query for deployments.
[
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created": "2023-11-07T05:31:56Z",
"updated": "2023-11-07T05:31:56Z",
"name": "<string>",
"flow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"version": "<string>",
"description": "<string>",
"paused": false,
"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>"
}
],
"concurrency_limit": 123,
"global_concurrency_limit": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created": "2023-11-07T05:31:56Z",
"updated": "2023-11-07T05:31:56Z",
"name": "<string>",
"limit": 123,
"active_slots": 123,
"active": true,
"slot_decay_per_second": 2
},
"concurrency_options": {
"collision_strategy": "ENQUEUE",
"grace_period_seconds": 43230
},
"job_variables": {},
"parameters": {},
"tags": [
"<string>"
],
"labels": {},
"work_queue_name": "<string>",
"work_queue_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"last_polled": "2023-11-07T05:31:56Z",
"parameter_openapi_schema": {},
"path": "<string>",
"pull_steps": [
{}
],
"entrypoint": "<string>",
"storage_document_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"infrastructure_document_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_by": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "<string>",
"display_value": "<string>"
},
"updated_by": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "<string>",
"display_value": "<string>"
},
"work_pool_name": "<string>",
"status": "NOT_READY",
"enforce_parameter_schema": true
}
]Headers
Body
x >= 0Filter for flows. Only flows matching all criteria will be returned.
Show child attributes
Show child attributes
Operator for combining filter criteria. Defaults to 'and_'.
and_, or_ Filter criteria for Flow.name
Filter criteria for Flow.tags
Show child attributes
Show child attributes
Operator for combining filter criteria. Defaults to 'and_'.
and_, or_ A list of tags. Flows will be returned only if their tags are a superset of the list
["tag-1", "tag-2"]If true, only include flows without tags
Filter flow runs. Only flow runs matching all criteria will be returned
Show child attributes
Show child attributes
Operator for combining filter criteria. Defaults to 'and_'.
and_, or_ Filter criteria for FlowRun.name
Show child attributes
Show child attributes
Filter criteria for FlowRun.tags
Show child attributes
Show child attributes
Operator for combining filter criteria. Defaults to 'and_'.
and_, or_ A list of tags. Flow runs will be returned only if their tags are a superset of the list
["tag-1", "tag-2"]A list of tags to include
["tag-1", "tag-2"]If true, only include flow runs without tags
Filter criteria for FlowRun.deployment_id
Show child attributes
Show child attributes
Operator for combining filter criteria. Defaults to 'and_'.
and_, or_ A list of flow run deployment ids to include
If true, only include flow runs without deployment ids
Filter criteria for `FlowRun.work_queue_name
Show child attributes
Show child attributes
Operator for combining filter criteria. Defaults to 'and_'.
and_, or_ A list of work queue names to include
["work_queue_1", "work_queue_2"]If true, only include flow runs without work queue names
Filter criteria for FlowRun.state
Show child attributes
Show child attributes
Operator for combining filter criteria. Defaults to 'and_'.
and_, or_ Filter criteria for FlowRun.state_type
Show child attributes
Show child attributes
A list of flow run state types to include
Enumeration of state types.
SCHEDULED, PENDING, RUNNING, COMPLETED, FAILED, CANCELLED, CRASHED, PAUSED, CANCELLING A list of flow run state types to exclude
Enumeration of state types.
SCHEDULED, PENDING, RUNNING, COMPLETED, FAILED, CANCELLED, CRASHED, PAUSED, CANCELLING Filter criteria for FlowRun.start_time
Show child attributes
Show child attributes
Only include flow runs starting at or before this time
Only include flow runs starting at or after this time
If true, only return flow runs without a start time
Filter criteria for FlowRun.end_time
Show child attributes
Show child attributes
Filter criteria for FlowRun.expected_start_time
Filter criteria for FlowRun.next_scheduled_start_time
Show child attributes
Show child attributes
Filter criteria for subflows of the given flow runs
Filter criteria for FlowRun.parent_task_run_id
Show child attributes
Show child attributes
Operator for combining filter criteria. Defaults to 'and_'.
and_, or_ A list of flow run parent_task_run_ids to include
If true, only include flow runs without parent_task_run_id
Filter task runs. Only task runs matching all criteria will be returned
Show child attributes
Show child attributes
Operator for combining filter criteria. Defaults to 'and_'.
and_, or_ Filter criteria for TaskRun.name
Show child attributes
Show child attributes
Filter criteria for TaskRun.tags
Show child attributes
Show child attributes
Operator for combining filter criteria. Defaults to 'and_'.
and_, or_ A list of tags. Task runs will be returned only if their tags are a superset of the list
["tag-1", "tag-2"]If true, only include task runs without tags
Filter criteria for TaskRun.state
Show child attributes
Show child attributes
Operator for combining filter criteria. Defaults to 'and_'.
and_, or_ Filter criteria for TaskRun.state_type
Show child attributes
Show child attributes
A list of task run state types to include
Enumeration of state types.
SCHEDULED, PENDING, RUNNING, COMPLETED, FAILED, CANCELLED, CRASHED, PAUSED, CANCELLING Filter criteria for TaskRun.start_time
Show child attributes
Show child attributes
Only include task runs starting at or before this time
Only include task runs starting at or after this time
If true, only return task runs without a start time
Filter criteria for TaskRun.expected_start_time
Filter criteria for TaskRun.flow_run_id
Show child attributes
Show child attributes
Operator for combining filter criteria. Defaults to 'and_'.
and_, or_ A list of task run flow run ids to include
Filter for task runs with None as their flow run id
Filter for deployments. Only deployments matching all criteria will be returned.
Show child attributes
Show child attributes
Operator for combining filter criteria. Defaults to 'and_'.
and_, or_ Filter criteria for Deployment.name
Show child attributes
Show child attributes
Filter criteria for Deployment.name or Flow.name
Show child attributes
Show child attributes
A case-insensitive partial match on deployment or flow names. For example, passing 'example' might match deployments or flows with 'example' in their names.
Filter criteria for Deployment.tags
Show child attributes
Show child attributes
Operator for combining filter criteria. Defaults to 'and_'.
and_, or_ A list of tags. Deployments will be returned only if their tags are a superset of the list
["tag-1", "tag-2"]A list of tags to include
["tag-1", "tag-2"]If true, only include deployments without tags
DEPRECATED: Prefer Deployment.concurrency_limit_id over Deployment.concurrency_limit. If provided, will be ignored for backwards-compatibility. Will be removed after December 2024.
Show child attributes
Show child attributes
Only include deployments with a concurrency limit greater than or equal to this value
Only include deployments with a concurrency limit less than or equal to this value
If true, only include deployments without a concurrency limit
Filter work pools. Only work pools matching all criteria will be returned
Show child attributes
Show child attributes
Operator for combining filter criteria. Defaults to 'and_'.
and_, or_ Filter work queues. Only work queues matching all criteria will be returned
Show child attributes
Show child attributes
Operator for combining filter criteria. Defaults to 'and_'.
and_, or_ Filter criteria for WorkQueue.name
Show child attributes
Show child attributes
A list of work queue names to include
["wq-1", "wq-2"]A list of case-insensitive starts-with matches. For example, passing 'marvin' will match 'marvin', and 'Marvin-robot', but not 'sad-marvin'.
["marvin", "Marvin-robot"]Defines deployment sorting options.
CREATED_DESC, UPDATED_DESC, NAME_ASC, NAME_DESC Defaults to PREFECT_API_DEFAULT_LIMIT if not provided.
Response
Successful Response
The name of the deployment.
The flow id associated with the deployment.
An optional version for the deployment.
A description for the deployment.
Whether or not the deployment is paused.
A list of schedules for the deployment.
Show child attributes
Show child attributes
The deployment id associated with this schedule.
Whether or not the schedule is active.
The maximum number of scheduled runs for the schedule.
x > 0A dictionary of parameter value overrides.
A unique slug for the schedule.
DEPRECATED: Prefer global_concurrency_limit. Will always be None for backwards compatibility. Will be removed after December 2024.
The global concurrency limit object for enforcing the maximum number of flow runs that can be active at once.
Show child attributes
Show child attributes
The name of the global concurrency limit.
The concurrency limit.
The number of active slots.
Whether the global concurrency limit is active.
The decay rate for active slots when used as a rate limit.
The concurrency options for the deployment.
Show child attributes
Show child attributes
Enumeration of concurrency collision strategies.
ENQUEUE, CANCEL_NEW Grace period in seconds for infrastructure to start before concurrency slots are revoked. If not set, falls back to server setting.
60 <= x <= 86400Overrides to apply to the base infrastructure block at runtime.
Parameters for flow runs scheduled by the deployment.
A list of tags for the deployment
The work queue for the deployment. If no work queue is set, work will not be scheduled.
The id of the work pool queue to which this deployment is assigned.
The last time the deployment was polled for status updates.
The parameter schema of the flow, including defaults.
The path to the working directory for the workflow, relative to remote storage or an absolute path.
Pull steps for cloning and running this deployment.
The path to the entrypoint for the workflow, relative to the path.
The block document defining storage used for this flow.
The block document defining infrastructure to use for flow runs.
The name of the deployment's work pool.
Whether the deployment is ready to run flows.
READY, NOT_READY Whether or not the deployment should enforce the parameter schema.
Was this page helpful?