How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Prefect

Prefect Deployments API

Interact with a Workspace's Deployments.

Documentation Provider Profile APIs.io OpenAPI GitHub

Prefect Deployments API is one of 63 APIs that Prefect publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Deployment. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, authentication docs, a getting-started guide, and an AsyncAPI specification.

This API exposes 32 operations across 26 paths, and defines 127 schemas. It is described by OpenAPI 3.2.0, at version 0.8.4.

32 operations 26 paths 127 schemas 3 DELETE6 GET2 PATCH20 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
0.8.4
Resource Areas
1

Paths & Operations 32

Across 26 paths, the API surfaces 32 operations — 3 DELETE, 6 GET, 2 PATCH, 20 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Deployments 32

Interact with a Workspace's Deployments.

POST
/api/accounts/{account_id}/workspaces/{workspace_id}/deployments/
Create Deployment
create_deployment_api_accounts__account_id__workspaces__workspace_id__deployments__post 3 params body → 200422
POST
/api/accounts/{account_id}/workspaces/{workspace_id}/deployments/{id}/branch
Branch From Deployment
branch_from_deployment_api_accounts__account_id__workspaces__workspace_id__deployments__id__branch_post 4 params body → 200422
PATCH
/api/accounts/{account_id}/workspaces/{workspace_id}/deployments/{id}
Update Deployment
update_deployment_api_accounts__account_id__workspaces__workspace_id__deployments__id__patch 4 params body → 204422
GET
/api/accounts/{account_id}/workspaces/{workspace_id}/deployments/{id}
Read Deployment
read_deployment_api_accounts__account_id__workspaces__workspace_id__deployments__id__get 4 params → 200422
DELETE
/api/accounts/{account_id}/workspaces/{workspace_id}/deployments/{id}
Delete Deployment
delete_deployment_api_accounts__account_id__workspaces__workspace_id__deployments__id__delete 4 params → 204422
GET
/api/accounts/{account_id}/workspaces/{workspace_id}/deployments/name/{flow_name}/{deployment_name}
Read Deployment By Name
read_deployment_by_name_api_accounts__account_id__workspaces__workspace_id__deployments_name__flow_name___deployment_name__get 5 params → 200422
POST
/api/accounts/{account_id}/workspaces/{workspace_id}/deployments/filter
Read Deployments
read_deployments_api_accounts__account_id__workspaces__workspace_id__deployments_filter_post 3 params body → 200422
POST
/api/accounts/{account_id}/workspaces/{workspace_id}/deployments/paginate
Paginate Deployments
paginate_deployments_api_accounts__account_id__workspaces__workspace_id__deployments_paginate_post 3 params body → 200422
POST
/api/accounts/{account_id}/workspaces/{workspace_id}/deployments/get_scheduled_flow_runs
Get Scheduled Flow Runs For Deployments
get_scheduled_flow_runs_for_deployments_api_accounts__account_id__workspaces__workspace_id__deployments_get_scheduled_flow_runs_post 3 params body → 200422
POST
/api/accounts/{account_id}/workspaces/{workspace_id}/deployments/count
Count Deployments
count_deployments_api_accounts__account_id__workspaces__workspace_id__deployments_count_post 3 params body → 200422
POST
/api/accounts/{account_id}/workspaces/{workspace_id}/deployments/bulk_delete
Bulk Delete Deployments
bulk_delete_deployments_api_accounts__account_id__workspaces__workspace_id__deployments_bulk_delete_post 3 params body → 200422
POST
/api/accounts/{account_id}/workspaces/{workspace_id}/deployments/{id}/schedule
Schedule Deployment
schedule_deployment_api_accounts__account_id__workspaces__workspace_id__deployments__id__schedule_post 4 params body → 200422
POST
/api/accounts/{account_id}/workspaces/{workspace_id}/deployments/{id}/resume_deployment
Resume Deployment
resume_deployment_api_accounts__account_id__workspaces__workspace_id__deployments__id__resume_deployment_post 4 params → 200422
POST
/api/accounts/{account_id}/workspaces/{workspace_id}/deployments/{id}/set_schedule_active
Resume Deployment
resume_deployment_api_accounts__account_id__workspaces__workspace_id__deployments__id__set_schedule_active_post 4 params → 200422
POST
/api/accounts/{account_id}/workspaces/{workspace_id}/deployments/{id}/pause_deployment
Pause Deployment
pause_deployment_api_accounts__account_id__workspaces__workspace_id__deployments__id__pause_deployment_post 4 params → 200422
POST
/api/accounts/{account_id}/workspaces/{workspace_id}/deployments/{id}/set_schedule_inactive
Pause Deployment
pause_deployment_api_accounts__account_id__workspaces__workspace_id__deployments__id__set_schedule_inactive_post 4 params → 200422
POST
/api/accounts/{account_id}/workspaces/{workspace_id}/deployments/{id}/create_flow_run
Create Flow Run From Deployment
create_flow_run_from_deployment_api_accounts__account_id__workspaces__workspace_id__deployments__id__create_flow_run_post 4 params body → 200422
POST
/api/accounts/{account_id}/workspaces/{workspace_id}/deployments/{id}/create_flow_run/bulk
Bulk Create Flow Runs From Deployment
bulk_create_flow_runs_from_deployment_api_accounts__account_id__workspaces__workspace_id__deployments__id__create_flow_run_bulk_post 4 params body → 200422
GET
/api/accounts/{account_id}/workspaces/{workspace_id}/deployments/{id}/access
Read Deployment Access
read_deployment_access_api_accounts__account_id__workspaces__workspace_id__deployments__id__access_get 4 params → 200422
PUT
/api/accounts/{account_id}/workspaces/{workspace_id}/deployments/{id}/access
Set Deployment Access
set_deployment_access_api_accounts__account_id__workspaces__workspace_id__deployments__id__access_put 4 params body → 204422
POST
/api/accounts/{account_id}/workspaces/{workspace_id}/deployments/my-access
Read Actors Deployment Access
read_actors_deployment_access_api_accounts__account_id__workspaces__workspace_id__deployments_my_access_post 3 params body → 200422
GET
/api/accounts/{account_id}/workspaces/{workspace_id}/deployments/{id}/work_queue_checkdeprecated
Work Queue Check For Deployment
work_queue_check_for_deployment_api_accounts__account_id__workspaces__workspace_id__deployments__id__work_queue_check_get 4 params → 200422
GET
/api/accounts/{account_id}/workspaces/{workspace_id}/deployments/{id}/schedules
Read Deployment Schedules
read_deployment_schedules_api_accounts__account_id__workspaces__workspace_id__deployments__id__schedules_get 4 params → 200422
POST
/api/accounts/{account_id}/workspaces/{workspace_id}/deployments/{id}/schedules
Create Deployment Schedules
create_deployment_schedules_api_accounts__account_id__workspaces__workspace_id__deployments__id__schedules_post 4 params body → 201422
PATCH
/api/accounts/{account_id}/workspaces/{workspace_id}/deployments/{id}/schedules/{schedule_id}
Update Deployment Schedule
update_deployment_schedule_api_accounts__account_id__workspaces__workspace_id__deployments__id__schedules__schedule_id__patch 5 params body → 204422
DELETE
/api/accounts/{account_id}/workspaces/{workspace_id}/deployments/{id}/schedules/{schedule_id}
Delete Deployment Schedule
delete_deployment_schedule_api_accounts__account_id__workspaces__workspace_id__deployments__id__schedules__schedule_id__delete 5 params → 204422
POST
/api/accounts/{account_id}/workspaces/{workspace_id}/deployments/{id}/disable
Disable Deployment
disable_deployment_api_accounts__account_id__workspaces__workspace_id__deployments__id__disable_post 4 params → 200422
POST
/api/accounts/{account_id}/workspaces/{workspace_id}/deployments/{id}/enable
Enable Deployment
enable_deployment_api_accounts__account_id__workspaces__workspace_id__deployments__id__enable_post 4 params → 200422
POST
/api/accounts/{account_id}/workspaces/{workspace_id}/deployments/{id}/versions/paginate
Paginate Deployment Versions
paginate_deployment_versions_api_accounts__account_id__workspaces__workspace_id__deployments__id__versions_paginate_post 4 params body → 200422
GET
/api/accounts/{account_id}/workspaces/{workspace_id}/deployments/{id}/versions/{version_id}
Read Deployment Version
read_deployment_version_api_accounts__account_id__workspaces__workspace_id__deployments__id__versions__version_id__get 5 params → 200422
DELETE
/api/accounts/{account_id}/workspaces/{workspace_id}/deployments/{id}/versions/{version_id}
Delete Deployment Version
delete_deployment_version_api_accounts__account_id__workspaces__workspace_id__deployments__id__versions__version_id__delete 5 params → 204422
POST
/api/accounts/{account_id}/workspaces/{workspace_id}/deployments/{id}/versions/{version_id}/promote
Promote Deployment Version
promote_deployment_version_api_accounts__account_id__workspaces__workspace_id__deployments__id__versions__version_id__promote_post 5 params body → 200422

Schemas 127

The contract defines 127 schemas that model the data the API accepts and returns. The most detailed are DeploymentResponse (40 properties), FlowRunResponse (39 properties), DeploymentCreate (31 properties), DeploymentUpdate (25 properties). Each schema is shown below with its type and property counts.

WorkPoolFilterType
object
Filter by WorkPool.type.
1 property
Body_paginate_deployments_api_accounts__account_id__workspaces__workspace_id__deployments_paginate_post
object
9 properties
FlowRunFilterTags
object
Filter by FlowRun.tags.
4 properties
CreatedBy
object
3 properties
WorkQueue
object
An ORM representation of a work queue
15 properties 1 required
FlowFilterCreatedBy
object
Filter by Flow.createdby.
4 properties
FlowRunFilterIdempotencyKey
object
Filter by FlowRun.idempotencykey.
2 properties
FlowRunFilterState
object
3 properties
DeploymentScheduleUpdate
object
8 properties
WorkPool
object
An ORM representation of a work pool
17 properties 3 required
FlowRunFilterEndTime
object
Filter by FlowRun.endtime.
3 properties
DeploymentOrFlowNameFilter
object
Filter by Deployment.name or Flow.name with a single input string for ilike filtering.
1 property
FlowRunFilterDeploymentVersionInfo
object
Filter by FlowRun.deploymentversioninfo.
3 properties 1 required
FlowRunFilterFlowId
object
Filter by FlowRun.flowid.
2 properties
WorkPoolStatus
string
Enumeration of work pool statuses.
WorkPoolFilterId
object
Filter by WorkPool.id.
1 property
DeploymentSchedule
object
14 properties 1 required
State
object
Represents the state of a run.
7 properties 1 required
DeploymentCreate
object
Data used by the Orion API to create a deployment.
31 properties 2 required
Body_read_deployments_api_accounts__account_id__workspaces__workspace_id__deployments_filter_post
object
9 properties
DeploymentResponse
object
40 properties 2 required
DeploymentFilterCreatedBy
object
Filter by Deployment.createdby.
4 properties
FlowRunFilterId
object
Filter by FlowRun.id.
2 properties
WorkPoolFilter
object
8 properties
TaskRunFilterExpectedStartTime
object
Filter by TaskRun.expectedstarttime.
2 properties
DeploymentBranchingOptions
object
1 property
StateCreate
object
Data used by the Orion API to create a new state.
5 properties 1 required
FlowRunFilterStateName
object
2 properties
FlowRunFilterCreatedBy
object
Filter by FlowRun.createdby.
4 properties
TaskRunFilterEndTime
object
Filter by TaskRun.endtime.
3 properties
FlowRunFilterDeploymentId
object
Filter by FlowRun.deploymentid.
3 properties
IntervalSchedule
object
A schedule formed by adding interval increments to an anchordate. If no anchordate is supplied, the current UTC time is used. If a timezone-naive datetime is p…
3 properties 1 required
DeploymentStatus
string
Enumeration of deployment statuses.
Body_schedule_deployment_api_accounts__account_id__workspaces__workspace_id__deployments__id__schedule_post
object
5 properties
FlowRunFilterWorkQueueId
object
Filter by FlowRun.workqueueid.
3 properties
FlowRunFilterDeploymentVersionId
object
Filter by FlowRun.deploymentversionid.
3 properties 1 required
DeploymentVersionPaginationResponse
object
5 properties 5 required
WorkPoolFilterPaused
object
Filter by WorkPool.ispaused.
1 property
Body_read_actors_deployment_access_api_accounts__account_id__workspaces__workspace_id__deployments_my_access_post
object
1 property 1 required
FlowRunFilterWorkQueueName
object
Filter by FlowRun.workqueuename.
3 properties
FlowRunCreateResult
object
Result for a single flow run in bulk create operation.
4 properties 1 required
FlowFilterTags
object
Filter by Flow.tags.
3 properties
DeploymentFilterWorkQueueId
object
Filter by Deployment.workqueueid
1 property
DeploymentUpdate
object
Data used by the Orion API to update a deployment.
25 properties
DeploymentPaginationResponse
object
5 properties 5 required
DeploymentFilterName
object
Filter by Deployment.name.
2 properties
FlowRunPolicy
object
Defines of how a flow run should retry.
7 properties
TaskRunFilter
object
Filter task runs. Only task runs matching all criteria will be returned
10 properties
ObjectActorAccess
object
Data describing an actor with object-level access.
4 properties 4 required
TaskRunFilterName
object
Filter by TaskRun.name.
2 properties
FlowFilterDeployment
object
Filter by flows by deployment
2 properties
Body_promote_deployment_version_api_accounts__account_id__workspaces__workspace_id__deployments__id__versions__version_id__promote_post
object
1 property
WorkQueueFilterCreatedBy
object
Filter by WorkQueue.createdby.
4 properties
FlowRunFilterNextScheduledStartTime
object
Filter by FlowRun.nextscheduledstarttime.
2 properties
TaskRunFilterTags
object
Filter by TaskRun.tags.
3 properties
TaskRunFilterStateType
object
Filter by TaskRun.statetype.
1 property
DeploymentFilterConcurrencyLimit
object
DEPRECATED: Prefer Deployment.concurrencylimitid over Deployment.concurrencylimit.
3 properties
FlowRunBulkCreateResponse
object
Response from bulk flow run creation.
1 property
DeploymentFilter
object
Filter for deployments. Only deployments matching all criteria will be returned.
17 properties
TaskRunFilterStateName
object
1 property
Body_set_deployment_access_api_accounts__account_id__workspaces__workspace_id__deployments__id__access_put
object
1 property 1 required
DeploymentFilterBranch
object
Filter by Deployment.branch.
3 properties
FlowRunFilterStateType
object
Filter by FlowRun.statetype.
2 properties
WorkPoolFilterStatus
object
Filter by WorkPool.status.
1 property
WorkPoolStorageConfiguration
object
A representation of a work pool's storage configuration
3 properties
DeploymentFilterId
object
Filter by Deployment.id.
2 properties
TaskRunFilterId
object
Filter by TaskRun.id.
1 property
TaskRunFilterFlowRunId
object
Filter by TaskRun.flowrunid.
3 properties
WorkQueueFilterName
object
Filter by WorkQueue.name.
2 properties
DeploymentScheduleCreate
object
8 properties 1 required
DeploymentFilterFlowId
object
Filter by Deployment.flowid.
1 property
CronSchedule
object
Cron schedule NOTE: If the timezone is a DST-observing one, then the schedule will adjust itself appropriately. Cron's rules for DST are based on schedule time…
3 properties 1 required
FlowRunFilterParentTaskRunId
object
Filter by FlowRun.parenttaskrunid.
3 properties
WorkQueueFilterId
object
Filter by WorkQueue.id.
1 property
FlowRunFilterExpectedStartTime
object
Filter by FlowRun.expectedstarttime.
2 properties
WorkQueueStatus
string
Enumeration of work queue statuses.
FlowFilterId
object
Filter by Flow.id.
2 properties
FlowRunFilterStartTime
object
Filter by FlowRun.starttime.
3 properties
UpdatedBy
object
3 properties
QueueFilter
object
Filter criteria definition for a work queue.
2 properties
FlowFilterName
object
Filter by Flow.name.
2 properties
DeploymentVersionResponse
object
21 properties 2 required
ConcurrencyOptions
object
Class for storing the concurrency config in database.
2 properties 1 required
GlobalConcurrencyLimitResponse
object
A response object for global concurrency limits.
8 properties 3 required
TaskRunFilterSubFlowRuns
object
Filter by TaskRun.subflowrun.
1 property
DeploymentAccessControl
object
A representation of the access control for a deployment.
3 properties
DeploymentFilterTags
object
Filter by Deployment.tags.
4 properties
DeploymentFilterUpdatedBy
object
Filter by Deployment.updatedby.
4 properties
BulkDeleteResponse
object
Response from a bulk deletion operation.
1 property
DeploymentSort
string
Defines deployment sorting options.
DeploymentFilterPaused
object
Filter by Deployment.paused.
1 property
FlowRunFilterName
object
Filter by FlowRun.name.
2 properties
DeploymentScheduleResponse
object
9 properties 1 required
StateType
string
Enumeration of state types.
WorkPoolFilterCreatedBy
object
Filter by WorkPool.createdby.
4 properties
FlowFilter
object
Filter for flows. Only flows matching all criteria will be returned.
7 properties
DeploymentFilterIsScheduleActive
object
Legacy filter to filter by Deployment.isscheduleactive which is always the opposite of Deployment.paused.
1 property
WorkPoolFilterName
object
Filter by WorkPool.name.
2 properties
StateDetails
object
18 properties
DeploymentFilterBase
object
Filter by Deployment.base.
2 properties
TaskRunFilterState
object
3 properties
FlowRunFilterParentFlowRunId
object
2 properties
ReplaceDeploymentAccess
object
Data used to replace the existing deployment access.
6 properties 3 required
FlowRunFilter
object
Filter flow runs. Only flow runs matching all criteria will be returned
20 properties
Body_count_deployments_api_accounts__account_id__workspaces__workspace_id__deployments_count_post
object
6 properties
Body_bulk_delete_deployments_api_accounts__account_id__workspaces__workspace_id__deployments_bulk_delete_post
object
2 properties 1 required
FlowRunResponse
object
39 properties 1 required
WorkPoolFilterUpdatedBy
object
Filter by WorkPool.updatedby.
4 properties
WorkQueueFilterUpdatedBy
object
Filter by WorkQueue.updatedby.
4 properties
TaskRunFilterStartTime
object
Filter by TaskRun.starttime.
3 properties
HTTPValidationError
object
1 property
WorkQueueFilter
object
Filter work queues. Only work queues matching all criteria will be returned
5 properties
Body_paginate_deployment_versions_api_accounts__account_id__workspaces__workspace_id__deployments__id__versions_paginate_post
object
2 properties
VersionInfo
object
2 properties 2 required
DeploymentBranch
object
3 properties 1 required
FlowRunFilterFlowVersion
object
Filter by FlowRun.flowversion.
1 property
prefect_cloud__orion__schemas__filters__Operator
string
Operators for combining filter criteria.
ConcurrencyLimitStrategy
string
Enumeration of concurrency collision strategies.
DeploymentFlowRunCreate
object
Data used by the Orion API to create a flow run from a deployment.
13 properties
DeploymentFilterRoot
object
Filter by Deployment.root.
2 properties
FlowFilterUpdatedBy
object
Filter by Flow.updatedby.
4 properties
BranchingScheduleHandling
string
DeploymentFilterStatus
object
Filter by Deployment.status.
1 property
Body_get_scheduled_flow_runs_for_deployments_api_accounts__account_id__workspaces__workspace_id__deployments_get_scheduled_flow_runs_post
object
3 properties 1 required
RRuleSchedule
object
RRule schedule, based on the iCalendar standard ([RFC 5545](https://datatracker.ietf.org/doc/html/rfc5545)) as implemented in dateutils.rrule. RRules are appro…
2 properties 1 required
ValidationError
object
3 properties 3 required
DeploymentFilterWorkQueueName
object
Filter by Deployment.workqueuename.
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

prefect-deployments-api-openapi.yml Raw ↑

Other APIs Prefect publishes across the network.

Prefect Server REST API
AE Profile APIs.io
Prefect Python SDK
AE Profile APIs.io
Prefect Account Billing API
AE Profile APIs.io
Prefect Account Images API
AE Profile APIs.io
Prefect Account Memberships API
AE Profile APIs.io
Prefect Account Roles API
AE Profile APIs.io
Prefect Account SSO API
AE Profile APIs.io
Prefect Accounts API
AE Profile APIs.io
Prefect AI API
AE Profile APIs.io
Prefect Artifacts API
AE Profile APIs.io
Prefect Asset Publications API
AE Profile APIs.io
Prefect Asset Subscriptions API
AE Profile APIs.io
#Deployment
← Back to P APIs
API Details
ID
prefect:prefect-deployments-api
Docs
https://docs.prefect.io/v3/api-ref/rest-api
Provider
Prefect
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=prefect-deployments-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/prefect-deployments-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Prefect Deployments API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.