You're viewing the docs for Prefect 2.17.1. Click here to view the latest docs.

Prefect Docs

Prefect server REST API reference

Initializing search

Try Prefect Cloud →

Prefect Docs

Getting Started
Getting Started
- Installation
- Quickstart
Tutorial
Tutorial
- Flows
- Tasks
- Deployments
- Work Pools
- Workers
How-to Guides
How-to Guides
- Development
  Development
- Execution
  Execution
- Work Pools
  Work Pools
Concepts
Concepts
- Flows
- Tasks
- Deployments
- Work Pools & Workers
- Schedules
- Results
- Artifacts
- States
- Blocks
- Task Runners
- Automations
- Block and Agent-Based Deployments
  Block and Agent-Based Deployments
Cloud
Cloud
Integrations
Integrations
- Using Integrations
- Contributing Integrations
API Reference
API Reference
- Python SDK
  Python SDK
  - prefect.agent
  - prefect.artifacts
  - prefect.blocks
    prefect.blocks
    
    core
    
    fields
    
    kubernetes
    
    notifications
    
    system
    
    webhook
  - prefect.client
    prefect.client
    
    base
    
    cloud
    
    orchestration
    
    schemas
    
    utilities
  - prefect.cli
    prefect.cli
    
    agent
    
    artifact
    
    block
    
    cloud
    
    cloud
    
    concurrency_limit
    
    config
    
    deploy
    
    deployment
    
    dev
    
    flow
    
    flow_run
    
    kubernetes
    
    profile
    
    project
    
    root
    
    server
    
    shell
    
    variable
    
    work_pool
    
    work_queue
    
    worker
  - prefect.context
  - prefect.concurrency
    prefect.concurrency
    
    asyncio
    
    common
    
    events
    
    services
    
    sync
  - prefect.deployments
    prefect.deployments
    
    deployments
    
    base
    
    runner
    
    schedules
    
    steps.core
    
    steps.pull
    
    steps.utility
  - prefect.engine
  - prefect.exceptions
  - prefect.events
  - prefect.filesystems
  - prefect.flows
  - prefect.flow_runs
  - prefect.futures
  - prefect.infrastructure
  - prefect.input
    prefect.input
    
    actions
    
    run_input
  - prefect.logging
    prefect.logging
    
    configuration
    
    formatters
    
    handlers
    
    highlighters
    
    loggers
  - prefect.manifests
  - prefect.runner
    prefect.runner
    
    runner
    
    server
    
    storage
    
    utils
  - prefect.runtime
    prefect.runtime
    
    flow_run
    
    deployment
    
    task_run
  - prefect.serializers
  - prefect.settings
  - prefect.software
  - prefect.states
  - prefect.task_runners
  - prefect.tasks
  - prefect.testing
  - prefect.utilities
    prefect.utilities
    
    annotations
    
    asyncutils
    
    callables
    
    collections
    
    compat
    
    context
    
    dispatch
    
    dockerutils
    
    filesystem
    
    hashing
    
    importtools
    
    math
    
    names
    
    processutils
    
    pydantic
    
    render_swagger
    
    services
    
    slugify
    
    templating
    
    text
    
    visualization
  - prefect.variables
  - prefect.workers
    prefect.workers
    
    base
    
    block
    
    process
    
    server
    
    utilities
- REST API
  REST API
  - Prefect Cloud REST API Reference
  - Prefect Server REST API Reference
- Server API
  Server API
  - API
    API
    
    server.api.admin
    
    server.api.csrf_token
    
    server.api.dependencies
    
    server.api.deployments
    
    server.api.flows
    
    server.api.flow_runs
    
    server.api.flow_run_states
    
    server.api.middleware
    
    server.api.run_history
    
    server.api.saved_searches
    
    server.api.server
    
    server.api.task_runs
    
    server.api.task_run_states
  - Models
    Models
    
    server.models.csrf_token
    
    server.models.flows
    
    server.models.flow_runs
    
    server.models.flow_run_states
    
    server.models.task_runs
    
    server.models.task_run_states
    
    server.models.deployments
    
    server.models.saved_searches
  - Orchestration
    Orchestration
    
    server.orchestration.rules
    
    server.orchestration.policies
    
    server.orchestration.core_policy
    
    server.orchestration.global_policy
  - Schemas
    Schemas
    
    server.schemas.actions
    
    server.schemas.core
    
    server.schemas.filters
    
    server.schemas.responses
    
    server.schemas.schedules
    
    server.schemas.sorting
    
    server.schemas.states
  - Services
    Services
    
    server.services.late_runs
    
    server.services.loop_service
    
    server.services.scheduler
  - Utilities
    Utilities
    
    server.utilities.database
    
    server.utilities.schemas
    
    server.utilities.server
Community
Community

API Reference
REST API

Prefect Server REST API Reference

Was this page helpful?

Thank you for your feedback!

Thank you for your feedback! Feel free to open an issue with more detail.