Prefect Server REST API

The Prefect Server REST API is the self-hosted variant of the Prefect orchestration API for managing workflows, flow runs, task runs, deployments, and work pools. When running Prefect server locally, the API is available at http://localhost:4200/api and interactive documentation is served at the /docs endpoint. The API can be fully described with an OpenAPI 3.0 compliant document generated from the running server.

API entry from apis.yml

apis.yml Raw ↑
aid: prefect:prefect-server-rest-api
name: Prefect Server REST API
description: The Prefect Server REST API is the self-hosted variant of the Prefect orchestration API for
  managing workflows, flow runs, task runs, deployments, and work pools. When running Prefect server locally,
  the API is available at http://localhost:4200/api and interactive documentation is served at the /docs
  endpoint. The API can be fully described with an OpenAPI 3.0 compliant document generated from the running
  server.
humanURL: https://docs.prefect.io/v3/api-ref/rest-api
tags:
- Open Source
- Orchestration
- REST API
- Self-Hosted
- Workflows
properties:
- type: Documentation
  url: https://docs.prefect.io/v3/api-ref/rest-api
- type: API Reference
  url: https://docs.prefect.io/latest/api-ref/rest-api-reference/
- type: Getting Started
  url: https://docs.prefect.io/v3/get-started/quickstart
- type: GitHub Repository
  url: https://github.com/PrefectHQ/prefect