Prefect

Prefect Deployments API

Interact with a Workspace's Deployments.

GitHub OpenAPI

Operations 32

POST /api/accounts/{account_id}/workspaces/{workspace_id}/deployments/ Create Deployment #
POST /api/accounts/{account_id}/workspaces/{workspace_id}/deployments/{id}/branch Branch From Deployment #
PATCH /api/accounts/{account_id}/workspaces/{workspace_id}/deployments/{id} Update Deployment #
GET /api/accounts/{account_id}/workspaces/{workspace_id}/deployments/{id} Read Deployment #
DELETE /api/accounts/{account_id}/workspaces/{workspace_id}/deployments/{id} Delete Deployment #
GET /api/accounts/{account_id}/workspaces/{workspace_id}/deployments/name/{flow_name}/{deployment_name} Read Deployment By Name #
POST /api/accounts/{account_id}/workspaces/{workspace_id}/deployments/filter Read Deployments #
POST /api/accounts/{account_id}/workspaces/{workspace_id}/deployments/paginate Paginate Deployments #
POST /api/accounts/{account_id}/workspaces/{workspace_id}/deployments/get_scheduled_flow_runs Get Scheduled Flow Runs For Deployments #
POST /api/accounts/{account_id}/workspaces/{workspace_id}/deployments/count Count Deployments #
POST /api/accounts/{account_id}/workspaces/{workspace_id}/deployments/bulk_delete Bulk Delete Deployments #
POST /api/accounts/{account_id}/workspaces/{workspace_id}/deployments/{id}/schedule Schedule Deployment #
POST /api/accounts/{account_id}/workspaces/{workspace_id}/deployments/{id}/resume_deployment Resume Deployment #
POST /api/accounts/{account_id}/workspaces/{workspace_id}/deployments/{id}/set_schedule_active Resume Deployment #
POST /api/accounts/{account_id}/workspaces/{workspace_id}/deployments/{id}/pause_deployment Pause Deployment #
POST /api/accounts/{account_id}/workspaces/{workspace_id}/deployments/{id}/set_schedule_inactive Pause Deployment #
POST /api/accounts/{account_id}/workspaces/{workspace_id}/deployments/{id}/create_flow_run Create Flow Run From Deployment #
POST /api/accounts/{account_id}/workspaces/{workspace_id}/deployments/{id}/create_flow_run/bulk Bulk Create Flow Runs From Deployment #
GET /api/accounts/{account_id}/workspaces/{workspace_id}/deployments/{id}/access Read Deployment Access #
PUT /api/accounts/{account_id}/workspaces/{workspace_id}/deployments/{id}/access Set Deployment Access #
POST /api/accounts/{account_id}/workspaces/{workspace_id}/deployments/my-access Read Actors Deployment Access #
GET /api/accounts/{account_id}/workspaces/{workspace_id}/deployments/{id}/work_queue_check Work Queue Check For Deployment #
GET /api/accounts/{account_id}/workspaces/{workspace_id}/deployments/{id}/schedules Read Deployment Schedules #
POST /api/accounts/{account_id}/workspaces/{workspace_id}/deployments/{id}/schedules Create Deployment Schedules #
PATCH /api/accounts/{account_id}/workspaces/{workspace_id}/deployments/{id}/schedules/{schedule_id} Update Deployment Schedule #
DELETE /api/accounts/{account_id}/workspaces/{workspace_id}/deployments/{id}/schedules/{schedule_id} Delete Deployment Schedule #
POST /api/accounts/{account_id}/workspaces/{workspace_id}/deployments/{id}/disable Disable Deployment #
POST /api/accounts/{account_id}/workspaces/{workspace_id}/deployments/{id}/enable Enable Deployment #
POST /api/accounts/{account_id}/workspaces/{workspace_id}/deployments/{id}/versions/paginate Paginate Deployment Versions #
GET /api/accounts/{account_id}/workspaces/{workspace_id}/deployments/{id}/versions/{version_id} Read Deployment Version #
DELETE /api/accounts/{account_id}/workspaces/{workspace_id}/deployments/{id}/versions/{version_id} Delete Deployment Version #
POST /api/accounts/{account_id}/workspaces/{workspace_id}/deployments/{id}/versions/{version_id}/promote Promote Deployment Version #

Documentation

📖
Documentation
https://docs.prefect.io/v3/api-ref/rest-api
📖
APIReference
https://app.prefect.cloud/api/docs
📖
Authentication
https://docs.prefect.io/v3/manage/cloud/manage-users/api-keys
📖
GettingStarted
https://docs.prefect.io/v3/get-started/quickstart

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/prefect/refs/heads/main/openapi/prefect-deployments-api-openapi.yml
⚙
AsyncAPI
https://raw.githubusercontent.com/api-evangelist/prefect/refs/heads/main/asyncapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/prefect-deployments-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

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

OpenAPI Specification

prefect-deployments-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Prefect Cloud Deployments API
  description: Prefect Cloud REST API documentation.
  version: 0.8.4
tags:


# --- truncated at 32 KB (202 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/prefect/refs/heads/main/openapi/prefect-deployments-api-openapi.yml