# Prefect: API Reference ## API Reference ### API Reference - [API & SDK References](https://docs.prefect.io/v3/api-ref/index.md): Explore Prefect's auto-generated API & SDK reference documentation. - [Settings reference](https://docs.prefect.io/v3/api-ref/settings-ref.md): Reference for all available settings for Prefect. #### REST API - [REST API overview](https://docs.prefect.io/v3/api-ref/rest-api/index.md): Prefect REST API for interacting with Prefect Cloud & self-hosted Prefect server. ##### Cloud API - [Cloud API Overview](https://docs.prefect.io/v3/api-ref/rest-api/cloud/index.md): The Prefect Cloud API enables you to interact programmatically with Prefect Cloud. ##### Server API - [Server API Overview](https://docs.prefect.io/v3/api-ref/rest-api/server/index.md): The Prefect server API enables you to interact programmatically with self-hosted Prefect server. - [Create Csrf Token](https://docs.prefect.io/v3/api-ref/rest-api/server/create-csrf-token.md): Create or update a CSRF token for a client ###### Root - [Health Check](https://docs.prefect.io/v3/api-ref/rest-api/server/root/health-check.md) - [Server Version](https://docs.prefect.io/v3/api-ref/rest-api/server/root/server-version.md) - [Hello](https://docs.prefect.io/v3/api-ref/rest-api/server/root/hello.md): Say hello! - [Perform Readiness Check](https://docs.prefect.io/v3/api-ref/rest-api/server/root/perform-readiness-check.md) ###### Flows - [Create Flow](https://docs.prefect.io/v3/api-ref/rest-api/server/flows/create-flow.md): Creates a new flow from the provided schema. If a flow with the same name already exists, the existing flow is returned. - [Read Flow](https://docs.prefect.io/v3/api-ref/rest-api/server/flows/read-flow.md): Get a flow by id. - [Delete Flow](https://docs.prefect.io/v3/api-ref/rest-api/server/flows/delete-flow.md): Delete a flow by id. - [Update Flow](https://docs.prefect.io/v3/api-ref/rest-api/server/flows/update-flow.md): Updates a flow. - [Count Flows](https://docs.prefect.io/v3/api-ref/rest-api/server/flows/count-flows.md): Count flows. - [Read Flow By Name](https://docs.prefect.io/v3/api-ref/rest-api/server/flows/read-flow-by-name.md): Get a flow by name. - [Read Flows](https://docs.prefect.io/v3/api-ref/rest-api/server/flows/read-flows.md): Query for flows. - [Bulk Delete Flows](https://docs.prefect.io/v3/api-ref/rest-api/server/flows/bulk-delete-flows.md): Bulk delete flows matching the specified filter criteria. - [Paginate Flows](https://docs.prefect.io/v3/api-ref/rest-api/server/flows/paginate-flows.md): Pagination query for flows. ###### Flow Runs - [Create Flow Run](https://docs.prefect.io/v3/api-ref/rest-api/server/flow-runs/create-flow-run.md): Create a flow run. If a flow run with the same flow_id and idempotency key already exists, the existing flow run will be returned. - [Read Flow Run](https://docs.prefect.io/v3/api-ref/rest-api/server/flow-runs/read-flow-run.md): Get a flow run by id. - [Delete Flow Run](https://docs.prefect.io/v3/api-ref/rest-api/server/flow-runs/delete-flow-run.md): Delete a flow run by id. - [Update Flow Run](https://docs.prefect.io/v3/api-ref/rest-api/server/flow-runs/update-flow-run.md): Updates a flow run. - [Count Flow Runs](https://docs.prefect.io/v3/api-ref/rest-api/server/flow-runs/count-flow-runs.md): Query for flow runs. - [Average Flow Run Lateness](https://docs.prefect.io/v3/api-ref/rest-api/server/flow-runs/average-flow-run-lateness.md): Query for average flow-run lateness in seconds. - [Flow Run History](https://docs.prefect.io/v3/api-ref/rest-api/server/flow-runs/flow-run-history.md): Query for flow run history data across a given range and interval. - [Read Flow Run Graph V1](https://docs.prefect.io/v3/api-ref/rest-api/server/flow-runs/read-flow-run-graph-v1.md): Get a task run dependency map for a given flow run. - [Read Flow Run Graph V2](https://docs.prefect.io/v3/api-ref/rest-api/server/flow-runs/read-flow-run-graph-v2.md): Get a graph of the tasks and subflow runs for the given flow run - [Resume Flow Run](https://docs.prefect.io/v3/api-ref/rest-api/server/flow-runs/resume-flow-run.md): Resume a paused flow run. - [Read Flow Runs](https://docs.prefect.io/v3/api-ref/rest-api/server/flow-runs/read-flow-runs.md): Query for flow runs. - [Bulk Delete Flow Runs](https://docs.prefect.io/v3/api-ref/rest-api/server/flow-runs/bulk-delete-flow-runs.md): Bulk delete flow runs matching the specified filter criteria. - [Bulk Set Flow Run State](https://docs.prefect.io/v3/api-ref/rest-api/server/flow-runs/bulk-set-flow-run-state.md): Bulk set state for flow runs matching the specified filter criteria. - [Set Flow Run State](https://docs.prefect.io/v3/api-ref/rest-api/server/flow-runs/set-flow-run-state.md): Set a flow run state, invoking any orchestration rules. - [Create Flow Run Input](https://docs.prefect.io/v3/api-ref/rest-api/server/flow-runs/create-flow-run-input.md): Create a key/value input for a flow run. - [Filter Flow Run Input](https://docs.prefect.io/v3/api-ref/rest-api/server/flow-runs/filter-flow-run-input.md): Filter flow run inputs by key prefix - [Read Flow Run Input](https://docs.prefect.io/v3/api-ref/rest-api/server/flow-runs/read-flow-run-input.md): Create a value from a flow run input - [Delete Flow Run Input](https://docs.prefect.io/v3/api-ref/rest-api/server/flow-runs/delete-flow-run-input.md): Delete a flow run input - [Read Flow Runs](https://docs.prefect.io/v3/api-ref/rest-api/server/flow-runs/paginate-flow-runs.md): Query for flow runs. - [Download Logs](https://docs.prefect.io/v3/api-ref/rest-api/server/flow-runs/download-logs.md): Download all flow run logs as a CSV file, collecting all logs until there are no more logs to retrieve. - [Update Flow Run Labels](https://docs.prefect.io/v3/api-ref/rest-api/server/flow-runs/update-flow-run-labels.md): Update the labels of a flow run. ###### Task Runs - [Create Task Run](https://docs.prefect.io/v3/api-ref/rest-api/server/task-runs/create-task-run.md): Create a task run. If a task run with the same flow_run_id, task_key, and dynamic_key already exists, the existing task run will be returned. - [Read Task Run](https://docs.prefect.io/v3/api-ref/rest-api/server/task-runs/read-task-run.md): Get a task run by id. - [Delete Task Run](https://docs.prefect.io/v3/api-ref/rest-api/server/task-runs/delete-task-run.md): Delete a task run by id. - [Update Task Run](https://docs.prefect.io/v3/api-ref/rest-api/server/task-runs/update-task-run.md): Updates a task run. - [Count Task Runs](https://docs.prefect.io/v3/api-ref/rest-api/server/task-runs/count-task-runs.md): Count task runs. - [Task Run History](https://docs.prefect.io/v3/api-ref/rest-api/server/task-runs/task-run-history.md): Query for task run history data across a given range and interval. - [Read Task Runs](https://docs.prefect.io/v3/api-ref/rest-api/server/task-runs/read-task-runs.md): Query for task runs. - [Paginate Task Runs](https://docs.prefect.io/v3/api-ref/rest-api/server/task-runs/paginate-task-runs.md): Pagination query for task runs. - [Set Task Run State](https://docs.prefect.io/v3/api-ref/rest-api/server/task-runs/set-task-run-state.md): Set a task run state, invoking any orchestration rules. ###### Flow Run States - [Read Flow Run State](https://docs.prefect.io/v3/api-ref/rest-api/server/flow-run-states/read-flow-run-state.md): Get a flow run state by id. - [Read Flow Run States](https://docs.prefect.io/v3/api-ref/rest-api/server/flow-run-states/read-flow-run-states.md): Get states associated with a flow run. ###### Task Run States - [Read Task Run State](https://docs.prefect.io/v3/api-ref/rest-api/server/task-run-states/read-task-run-state.md): Get a task run state by id. - [Read Task Run States](https://docs.prefect.io/v3/api-ref/rest-api/server/task-run-states/read-task-run-states.md): Get states associated with a task run. ###### Deployments - [Create Deployment](https://docs.prefect.io/v3/api-ref/rest-api/server/deployments/create-deployment.md): Creates a new deployment from the provided schema. If a deployment with the same name and flow_id already exists, the deployment is updated. - [Read Deployment](https://docs.prefect.io/v3/api-ref/rest-api/server/deployments/read-deployment.md): Get a deployment by id. - [Delete Deployment](https://docs.prefect.io/v3/api-ref/rest-api/server/deployments/delete-deployment.md): Delete a deployment by id. - [Update Deployment](https://docs.prefect.io/v3/api-ref/rest-api/server/deployments/update-deployment.md) - [Read Deployment By Name](https://docs.prefect.io/v3/api-ref/rest-api/server/deployments/read-deployment-by-name.md): Get a deployment using the name of the flow and the deployment. - [Read Deployments](https://docs.prefect.io/v3/api-ref/rest-api/server/deployments/read-deployments.md): Query for deployments. - [Paginate Deployments](https://docs.prefect.io/v3/api-ref/rest-api/server/deployments/paginate-deployments.md): Pagination query for flow runs. - [Get Scheduled Flow Runs For Deployments](https://docs.prefect.io/v3/api-ref/rest-api/server/deployments/get-scheduled-flow-runs-for-deployments.md): Get scheduled runs for a set of deployments. Used by a runner to poll for work. - [Count Deployments](https://docs.prefect.io/v3/api-ref/rest-api/server/deployments/count-deployments.md): Count deployments. - [Bulk Delete Deployments](https://docs.prefect.io/v3/api-ref/rest-api/server/deployments/bulk-delete-deployments.md): Bulk delete deployments matching the specified filter criteria. - [Schedule Deployment](https://docs.prefect.io/v3/api-ref/rest-api/server/deployments/schedule-deployment.md): Schedule runs for a deployment. For backfills, provide start/end times in the past. - [Resume Deployment](https://docs.prefect.io/v3/api-ref/rest-api/server/deployments/resume-deployment.md): Set a deployment schedule to active. Runs will be scheduled immediately. - [Pause Deployment](https://docs.prefect.io/v3/api-ref/rest-api/server/deployments/pause-deployment.md): Set a deployment schedule to inactive. Any auto-scheduled runs still in a Scheduled state will be deleted. - [Create Flow Run From Deployment](https://docs.prefect.io/v3/api-ref/rest-api/server/deployments/create-flow-run-from-deployment.md): Create a flow run from a deployment. - [Bulk Create Flow Runs From Deployment](https://docs.prefect.io/v3/api-ref/rest-api/server/deployments/bulk-create-flow-runs-from-deployment.md): Create multiple flow runs from a deployment. - [Work Queue Check For Deployment](https://docs.prefect.io/v3/api-ref/rest-api/server/deployments/work-queue-check-for-deployment.md): Get list of work-queues that are able to pick up the specified deployment. - [Read Deployment Schedules](https://docs.prefect.io/v3/api-ref/rest-api/server/deployments/read-deployment-schedules.md) - [Create Deployment Schedules](https://docs.prefect.io/v3/api-ref/rest-api/server/deployments/create-deployment-schedules.md) - [Delete Deployment Schedule](https://docs.prefect.io/v3/api-ref/rest-api/server/deployments/delete-deployment-schedule.md) - [Update Deployment Schedule](https://docs.prefect.io/v3/api-ref/rest-api/server/deployments/update-deployment-schedule.md) ###### SavedSearches - [Create Saved Search](https://docs.prefect.io/v3/api-ref/rest-api/server/savedsearches/create-saved-search.md): Creates a new saved search from the provided schema. - [Read Saved Search](https://docs.prefect.io/v3/api-ref/rest-api/server/savedsearches/read-saved-search.md): Get a saved search by id. - [Delete Saved Search](https://docs.prefect.io/v3/api-ref/rest-api/server/savedsearches/delete-saved-search.md): Delete a saved search by id. - [Read Saved Searches](https://docs.prefect.io/v3/api-ref/rest-api/server/savedsearches/read-saved-searches.md): Query for saved searches. ###### Logs - [Create Logs](https://docs.prefect.io/v3/api-ref/rest-api/server/logs/create-logs.md): Create new logs from the provided schema. - [Read Logs](https://docs.prefect.io/v3/api-ref/rest-api/server/logs/read-logs.md): Query for logs. ###### Concurrency Limits - [Create Concurrency Limit](https://docs.prefect.io/v3/api-ref/rest-api/server/concurrency-limits/create-concurrency-limit.md): Create a task run concurrency limit. - [Read Concurrency Limit](https://docs.prefect.io/v3/api-ref/rest-api/server/concurrency-limits/read-concurrency-limit.md): Get a concurrency limit by id. - [Delete Concurrency Limit](https://docs.prefect.io/v3/api-ref/rest-api/server/concurrency-limits/delete-concurrency-limit.md) - [Read Concurrency Limit By Tag](https://docs.prefect.io/v3/api-ref/rest-api/server/concurrency-limits/read-concurrency-limit-by-tag.md): Get a concurrency limit by tag. - [Delete Concurrency Limit By Tag](https://docs.prefect.io/v3/api-ref/rest-api/server/concurrency-limits/delete-concurrency-limit-by-tag.md) - [Read Concurrency Limits](https://docs.prefect.io/v3/api-ref/rest-api/server/concurrency-limits/read-concurrency-limits.md): Query for concurrency limits. - [Reset Concurrency Limit By Tag](https://docs.prefect.io/v3/api-ref/rest-api/server/concurrency-limits/reset-concurrency-limit-by-tag.md) - [Increment Concurrency Limits V1](https://docs.prefect.io/v3/api-ref/rest-api/server/concurrency-limits/increment-concurrency-limits-v1.md): Increment concurrency limits for the given tags. - [Decrement Concurrency Limits V1](https://docs.prefect.io/v3/api-ref/rest-api/server/concurrency-limits/decrement-concurrency-limits-v1.md): Decrement concurrency limits for the given tags. ###### Concurrency Limits V2 - [Create Concurrency Limit V2](https://docs.prefect.io/v3/api-ref/rest-api/server/concurrency-limits-v2/create-concurrency-limit-v2.md): Create a task run concurrency limit. - [Read Concurrency Limit V2](https://docs.prefect.io/v3/api-ref/rest-api/server/concurrency-limits-v2/read-concurrency-limit-v2.md) - [Delete Concurrency Limit V2](https://docs.prefect.io/v3/api-ref/rest-api/server/concurrency-limits-v2/delete-concurrency-limit-v2.md) - [Update Concurrency Limit V2](https://docs.prefect.io/v3/api-ref/rest-api/server/concurrency-limits-v2/update-concurrency-limit-v2.md) - [Read All Concurrency Limits V2](https://docs.prefect.io/v3/api-ref/rest-api/server/concurrency-limits-v2/read-all-concurrency-limits-v2.md) - [Bulk Increment Active Slots](https://docs.prefect.io/v3/api-ref/rest-api/server/concurrency-limits-v2/bulk-increment-active-slots.md) - [Bulk Increment Active Slots With Lease](https://docs.prefect.io/v3/api-ref/rest-api/server/concurrency-limits-v2/bulk-increment-active-slots-with-lease.md) - [Bulk Decrement Active Slots](https://docs.prefect.io/v3/api-ref/rest-api/server/concurrency-limits-v2/bulk-decrement-active-slots.md) - [Bulk Decrement Active Slots With Lease](https://docs.prefect.io/v3/api-ref/rest-api/server/concurrency-limits-v2/bulk-decrement-active-slots-with-lease.md) - [Renew Concurrency Lease](https://docs.prefect.io/v3/api-ref/rest-api/server/concurrency-limits-v2/renew-concurrency-lease.md) ###### Block types - [Create Block Type](https://docs.prefect.io/v3/api-ref/rest-api/server/block-types/create-block-type.md): Create a new block type. - [Read Block Type By Id](https://docs.prefect.io/v3/api-ref/rest-api/server/block-types/read-block-type-by-id.md): Get a block type by ID. - [Delete Block Type](https://docs.prefect.io/v3/api-ref/rest-api/server/block-types/delete-block-type.md) - [Update Block Type](https://docs.prefect.io/v3/api-ref/rest-api/server/block-types/update-block-type.md): Update a block type. - [Read Block Type By Slug](https://docs.prefect.io/v3/api-ref/rest-api/server/block-types/read-block-type-by-slug.md): Get a block type by name. - [Read Block Types](https://docs.prefect.io/v3/api-ref/rest-api/server/block-types/read-block-types.md): Gets all block types. Optionally limit return with limit and offset. - [Read Block Documents For Block Type](https://docs.prefect.io/v3/api-ref/rest-api/server/block-types/read-block-documents-for-block-type.md) - [Read Block Document By Name For Block Type](https://docs.prefect.io/v3/api-ref/rest-api/server/block-types/read-block-document-by-name-for-block-type.md) - [Install System Block Types](https://docs.prefect.io/v3/api-ref/rest-api/server/block-types/install-system-block-types.md) ###### Block documents - [Create Block Document](https://docs.prefect.io/v3/api-ref/rest-api/server/block-documents/create-block-document.md): Create a new block document. - [Read Block Documents](https://docs.prefect.io/v3/api-ref/rest-api/server/block-documents/read-block-documents.md): Query for block documents. - [Count Block Documents](https://docs.prefect.io/v3/api-ref/rest-api/server/block-documents/count-block-documents.md): Count block documents. - [Read Block Document By Id](https://docs.prefect.io/v3/api-ref/rest-api/server/block-documents/read-block-document-by-id.md) - [Delete Block Document](https://docs.prefect.io/v3/api-ref/rest-api/server/block-documents/delete-block-document.md) - [Update Block Document Data](https://docs.prefect.io/v3/api-ref/rest-api/server/block-documents/update-block-document-data.md) ###### Work Pools - [Create Work Pool](https://docs.prefect.io/v3/api-ref/rest-api/server/work-pools/create-work-pool.md): Creates a new work pool. If a work pool with the same name already exists, an error will be raised. - [Read Work Pool](https://docs.prefect.io/v3/api-ref/rest-api/server/work-pools/read-work-pool.md): Read a work pool by name - [Delete Work Pool](https://docs.prefect.io/v3/api-ref/rest-api/server/work-pools/delete-work-pool.md): Delete a work pool - [Update Work Pool](https://docs.prefect.io/v3/api-ref/rest-api/server/work-pools/update-work-pool.md): Update a work pool - [Read Work Pools](https://docs.prefect.io/v3/api-ref/rest-api/server/work-pools/read-work-pools.md): Read multiple work pools - [Count Work Pools](https://docs.prefect.io/v3/api-ref/rest-api/server/work-pools/count-work-pools.md): Count work pools - [Read Work Pool Concurrency Status](https://docs.prefect.io/v3/api-ref/rest-api/server/work-pools/read-work-pool-concurrency-status.md): Read concurrency status for a work pool, including per-queue breakdown with flow run summaries. Queues are paginated; flow runs per queue are capped by flow_run_limit. - [Get Scheduled Flow Runs](https://docs.prefect.io/v3/api-ref/rest-api/server/work-pools/get-scheduled-flow-runs.md): Load scheduled runs for a worker - [Create Work Queue](https://docs.prefect.io/v3/api-ref/rest-api/server/work-pools/create-work-queue.md): Creates a new work pool queue. If a work pool queue with the same name already exists, an error will be raised. - [Read Work Queue](https://docs.prefect.io/v3/api-ref/rest-api/server/work-pools/read-work-queue.md): Read a work pool queue - [Delete Work Queue](https://docs.prefect.io/v3/api-ref/rest-api/server/work-pools/delete-work-queue.md): Delete a work pool queue - [Update Work Queue](https://docs.prefect.io/v3/api-ref/rest-api/server/work-pools/update-work-queue.md): Update a work pool queue - [Read Work Queues](https://docs.prefect.io/v3/api-ref/rest-api/server/work-pools/read-work-queues.md): Read all work pool queues - [Worker Heartbeat](https://docs.prefect.io/v3/api-ref/rest-api/server/work-pools/worker-heartbeat.md) - [Read Workers](https://docs.prefect.io/v3/api-ref/rest-api/server/work-pools/read-workers.md): Read all worker processes - [Delete Worker](https://docs.prefect.io/v3/api-ref/rest-api/server/work-pools/delete-worker.md): Delete a work pool's worker ###### Task Workers - [Read Task Workers](https://docs.prefect.io/v3/api-ref/rest-api/server/task-workers/read-task-workers.md): Read active task workers. Optionally filter by task keys. ###### Work Queues - [Create Work Queue](https://docs.prefect.io/v3/api-ref/rest-api/server/work-queues/create-work-queue.md): Creates a new work queue. - [Read Work Queue](https://docs.prefect.io/v3/api-ref/rest-api/server/work-queues/read-work-queue.md): Get a work queue by id. - [Delete Work Queue](https://docs.prefect.io/v3/api-ref/rest-api/server/work-queues/delete-work-queue.md): Delete a work queue by id. - [Update Work Queue](https://docs.prefect.io/v3/api-ref/rest-api/server/work-queues/update-work-queue.md): Updates an existing work queue. - [Read Work Queue By Name](https://docs.prefect.io/v3/api-ref/rest-api/server/work-queues/read-work-queue-by-name.md): Get a work queue by id. - [Read Work Queue Runs](https://docs.prefect.io/v3/api-ref/rest-api/server/work-queues/read-work-queue-runs.md): Get flow runs from the work queue. - [Read Work Queues](https://docs.prefect.io/v3/api-ref/rest-api/server/work-queues/read-work-queues.md): Query for work queues. - [Read Work Queue Concurrency Status](https://docs.prefect.io/v3/api-ref/rest-api/server/work-queues/read-work-queue-concurrency-status.md): Read concurrency status for a work queue, including paginated flow run summaries. active_slots always reflects the total count. - [Read Work Queue Status](https://docs.prefect.io/v3/api-ref/rest-api/server/work-queues/read-work-queue-status.md): Get the status of a work queue. ###### Artifacts - [Create Artifact](https://docs.prefect.io/v3/api-ref/rest-api/server/artifacts/create-artifact.md): Create an artifact. - [Read Artifact](https://docs.prefect.io/v3/api-ref/rest-api/server/artifacts/read-artifact.md): Retrieve an artifact from the database. - [Delete Artifact](https://docs.prefect.io/v3/api-ref/rest-api/server/artifacts/delete-artifact.md): Delete an artifact from the database. - [Update Artifact](https://docs.prefect.io/v3/api-ref/rest-api/server/artifacts/update-artifact.md): Update an artifact in the database. - [Read Latest Artifact](https://docs.prefect.io/v3/api-ref/rest-api/server/artifacts/read-latest-artifact.md): Retrieve the latest artifact from the artifact table. - [Read Artifacts](https://docs.prefect.io/v3/api-ref/rest-api/server/artifacts/read-artifacts.md): Retrieve artifacts from the database. - [Read Latest Artifacts](https://docs.prefect.io/v3/api-ref/rest-api/server/artifacts/read-latest-artifacts.md): Retrieve artifacts from the database. - [Count Artifacts](https://docs.prefect.io/v3/api-ref/rest-api/server/artifacts/count-artifacts.md): Count artifacts from the database. - [Count Latest Artifacts](https://docs.prefect.io/v3/api-ref/rest-api/server/artifacts/count-latest-artifacts.md): Count artifacts from the database. ###### Block schemas - [Create Block Schema](https://docs.prefect.io/v3/api-ref/rest-api/server/block-schemas/create-block-schema.md): Create a block schema. - [Read Block Schema By Id](https://docs.prefect.io/v3/api-ref/rest-api/server/block-schemas/read-block-schema-by-id.md): Get a block schema by id. - [Delete Block Schema](https://docs.prefect.io/v3/api-ref/rest-api/server/block-schemas/delete-block-schema.md): Delete a block schema by id. - [Read Block Schemas](https://docs.prefect.io/v3/api-ref/rest-api/server/block-schemas/read-block-schemas.md): Read all block schemas, optionally filtered by type - [Read Block Schema By Checksum](https://docs.prefect.io/v3/api-ref/rest-api/server/block-schemas/read-block-schema-by-checksum.md) ###### Block capabilities - [Read Available Block Capabilities](https://docs.prefect.io/v3/api-ref/rest-api/server/block-capabilities/read-available-block-capabilities.md): Get available block capabilities. ###### Collections - [Read View Content](https://docs.prefect.io/v3/api-ref/rest-api/server/collections/read-view-content.md): Reads the content of a view from the prefect-collection-registry. ###### Variables - [Create Variable](https://docs.prefect.io/v3/api-ref/rest-api/server/variables/create-variable.md): Create a variable. - [Read Variable](https://docs.prefect.io/v3/api-ref/rest-api/server/variables/read-variable.md) - [Delete Variable](https://docs.prefect.io/v3/api-ref/rest-api/server/variables/delete-variable.md) - [Update Variable](https://docs.prefect.io/v3/api-ref/rest-api/server/variables/update-variable.md) - [Read Variable By Name](https://docs.prefect.io/v3/api-ref/rest-api/server/variables/read-variable-by-name.md) - [Delete Variable By Name](https://docs.prefect.io/v3/api-ref/rest-api/server/variables/delete-variable-by-name.md) - [Update Variable By Name](https://docs.prefect.io/v3/api-ref/rest-api/server/variables/update-variable-by-name.md) - [Read Variables](https://docs.prefect.io/v3/api-ref/rest-api/server/variables/read-variables.md) - [Count Variables](https://docs.prefect.io/v3/api-ref/rest-api/server/variables/count-variables.md) ###### Events - [Create Events](https://docs.prefect.io/v3/api-ref/rest-api/server/events/create-events.md): Record a batch of Events. - [Read Events](https://docs.prefect.io/v3/api-ref/rest-api/server/events/read-events.md): Queries for Events matching the given filter criteria in the given Account. Returns the first page of results, and the URL to request the next page (if there are more results). - [Read Account Events Page](https://docs.prefect.io/v3/api-ref/rest-api/server/events/read-account-events-page.md): Returns the next page of Events for a previous query against the given Account, and the URL to request the next page (if there are more results). - [Count Account Events](https://docs.prefect.io/v3/api-ref/rest-api/server/events/count-account-events.md): Returns distinct objects and the count of events associated with them. Objects that can be counted include the day the event occurred, the type of event, or the IDs of the resources associated with the event. ###### Automations - [Create Automation](https://docs.prefect.io/v3/api-ref/rest-api/server/automations/create-automation.md): Create an automation. - [Read Automation](https://docs.prefect.io/v3/api-ref/rest-api/server/automations/read-automation.md) - [Update Automation](https://docs.prefect.io/v3/api-ref/rest-api/server/automations/update-automation.md) - [Delete Automation](https://docs.prefect.io/v3/api-ref/rest-api/server/automations/delete-automation.md) - [Patch Automation](https://docs.prefect.io/v3/api-ref/rest-api/server/automations/patch-automation.md) - [Read Automations](https://docs.prefect.io/v3/api-ref/rest-api/server/automations/read-automations.md) - [Count Automations](https://docs.prefect.io/v3/api-ref/rest-api/server/automations/count-automations.md) - [Read Automations Related To Resource](https://docs.prefect.io/v3/api-ref/rest-api/server/automations/read-automations-related-to-resource.md) - [Delete Automations Owned By Resource](https://docs.prefect.io/v3/api-ref/rest-api/server/automations/delete-automations-owned-by-resource.md) - [Validate Template](https://docs.prefect.io/v3/api-ref/rest-api/server/automations/validate-template.md) - [Validate Template](https://docs.prefect.io/v3/api-ref/rest-api/server/automations/validate-template-1.md) ###### Admin - [Read Settings](https://docs.prefect.io/v3/api-ref/rest-api/server/admin/read-settings.md): Get the current Prefect REST API settings. - [Read Version](https://docs.prefect.io/v3/api-ref/rest-api/server/admin/read-version.md): Returns the Prefect version number - [Read Server Default Result Storage](https://docs.prefect.io/v3/api-ref/rest-api/server/admin/read-server-default-result-storage.md): Get the configured server default result storage block. - [Update Server Default Result Storage](https://docs.prefect.io/v3/api-ref/rest-api/server/admin/update-server-default-result-storage.md): Set the server default result storage block. - [Clear Server Default Result Storage](https://docs.prefect.io/v3/api-ref/rest-api/server/admin/clear-server-default-result-storage.md): Clear the configured server default result storage block. #### Events - [Events reference](https://docs.prefect.io/v3/api-ref/events/index.md): Reference for all events emitted by Prefect, Prefect Cloud, and integrations. - [Flow run events](https://docs.prefect.io/v3/api-ref/events/flow-run-events.md): Events emitted during flow run state transitions and heartbeats. - [Task run events](https://docs.prefect.io/v3/api-ref/events/task-run-events.md): Events emitted during task run state transitions. - [Deployment events](https://docs.prefect.io/v3/api-ref/events/deployment-events.md): Events emitted when deployments are created, updated, deleted, or change status. - [Work pool and work queue events](https://docs.prefect.io/v3/api-ref/events/work-pool-queue-events.md): Events emitted when work pools and work queues are created, deleted, change status, or are updated. - [Worker and runner events](https://docs.prefect.io/v3/api-ref/events/worker-runner-events.md): Events emitted by workers and runners during flow run execution. - [Artifact and asset events](https://docs.prefect.io/v3/api-ref/events/artifact-asset-events.md): Events emitted when artifacts and artifact collections are created or updated and when assets are referenced or materialized. - [Concurrency events](https://docs.prefect.io/v3/api-ref/events/concurrency-events.md): Events emitted when concurrency limits are created, updated, deleted, and when slots are acquired and released. - [Automation events](https://docs.prefect.io/v3/api-ref/events/automation-events.md): Events emitted when automations are created, updated, deleted, trigger, resolve, and execute actions. - [Infrastructure events](https://docs.prefect.io/v3/api-ref/events/infrastructure-events.md): Events emitted for blocks, deployment pull steps, workspace transfers, and integration infrastructure (Docker, Kubernetes, ECS). - [Prefect Cloud events](https://docs.prefect.io/v3/api-ref/events/cloud-events.md): Events emitted exclusively by Prefect Cloud for audit logging, security, billing, webhooks, and incidents. #### CLI Reference - [ ](https://docs.prefect.io/v3/api-ref/cli/artifact.md) - [ ](https://docs.prefect.io/v3/api-ref/cli/automation.md) - [ ](https://docs.prefect.io/v3/api-ref/cli/block.md) - [ ](https://docs.prefect.io/v3/api-ref/cli/concurrency-limit.md) - [ ](https://docs.prefect.io/v3/api-ref/cli/config.md) - [ ](https://docs.prefect.io/v3/api-ref/cli/dashboard.md) - [ ](https://docs.prefect.io/v3/api-ref/cli/deployment.md) - [ ](https://docs.prefect.io/v3/api-ref/cli/dev.md) - [ ](https://docs.prefect.io/v3/api-ref/cli/event.md) - [ ](https://docs.prefect.io/v3/api-ref/cli/flow-run.md) - [ ](https://docs.prefect.io/v3/api-ref/cli/flow.md) - [ ](https://docs.prefect.io/v3/api-ref/cli/global-concurrency-limit.md) - [ ](https://docs.prefect.io/v3/api-ref/cli/init.md) - [ ](https://docs.prefect.io/v3/api-ref/cli/plugins.md) - [ ](https://docs.prefect.io/v3/api-ref/cli/profile.md) - [ ](https://docs.prefect.io/v3/api-ref/cli/profiles.md) - [ ](https://docs.prefect.io/v3/api-ref/cli/sdk.md) - [ ](https://docs.prefect.io/v3/api-ref/cli/server.md) - [ ](https://docs.prefect.io/v3/api-ref/cli/shell.md) - [ ](https://docs.prefect.io/v3/api-ref/cli/task-run.md) - [ ](https://docs.prefect.io/v3/api-ref/cli/task.md) - [ ](https://docs.prefect.io/v3/api-ref/cli/variable.md) - [ ](https://docs.prefect.io/v3/api-ref/cli/version.md) - [ ](https://docs.prefect.io/v3/api-ref/cli/work-pool.md) - [ ](https://docs.prefect.io/v3/api-ref/cli/work-queue.md) - [ ](https://docs.prefect.io/v3/api-ref/cli/worker.md) #### Python SDK Reference - [artifacts](https://docs.prefect.io/v3/api-ref/python/prefect-artifacts.md) - [automations](https://docs.prefect.io/v3/api-ref/python/prefect-automations.md) - [cache_policies](https://docs.prefect.io/v3/api-ref/python/prefect-cache_policies.md) - [context](https://docs.prefect.io/v3/api-ref/python/prefect-context.md) - [engine](https://docs.prefect.io/v3/api-ref/python/prefect-engine.md) - [exceptions](https://docs.prefect.io/v3/api-ref/python/prefect-exceptions.md) - [filesystems](https://docs.prefect.io/v3/api-ref/python/prefect-filesystems.md) - [flow_engine](https://docs.prefect.io/v3/api-ref/python/prefect-flow_engine.md) - [flow_runs](https://docs.prefect.io/v3/api-ref/python/prefect-flow_runs.md) - [flows](https://docs.prefect.io/v3/api-ref/python/prefect-flows.md) - [futures](https://docs.prefect.io/v3/api-ref/python/prefect-futures.md) - [plugins](https://docs.prefect.io/v3/api-ref/python/prefect-plugins.md) - [results](https://docs.prefect.io/v3/api-ref/python/prefect-results.md) - [schedules](https://docs.prefect.io/v3/api-ref/python/prefect-schedules.md) - [serializers](https://docs.prefect.io/v3/api-ref/python/prefect-serializers.md) - [states](https://docs.prefect.io/v3/api-ref/python/prefect-states.md) - [task_engine](https://docs.prefect.io/v3/api-ref/python/prefect-task_engine.md) - [task_runners](https://docs.prefect.io/v3/api-ref/python/prefect-task_runners.md) - [task_runs](https://docs.prefect.io/v3/api-ref/python/prefect-task_runs.md) - [task_worker](https://docs.prefect.io/v3/api-ref/python/prefect-task_worker.md) - [tasks](https://docs.prefect.io/v3/api-ref/python/prefect-tasks.md) - [transactions](https://docs.prefect.io/v3/api-ref/python/prefect-transactions.md) - [variables](https://docs.prefect.io/v3/api-ref/python/prefect-variables.md) ##### prefect.assets - [core](https://docs.prefect.io/v3/api-ref/python/prefect-assets-core.md) - [materialize](https://docs.prefect.io/v3/api-ref/python/prefect-assets-materialize.md) ##### prefect.blocks - [abstract](https://docs.prefect.io/v3/api-ref/python/prefect-blocks-abstract.md) - [core](https://docs.prefect.io/v3/api-ref/python/prefect-blocks-core.md) - [notifications](https://docs.prefect.io/v3/api-ref/python/prefect-blocks-notifications.md) - [redis](https://docs.prefect.io/v3/api-ref/python/prefect-blocks-redis.md) - [system](https://docs.prefect.io/v3/api-ref/python/prefect-blocks-system.md) - [webhook](https://docs.prefect.io/v3/api-ref/python/prefect-blocks-webhook.md) ##### prefect.bundles - [__init__](https://docs.prefect.io/v3/api-ref/python/prefect-bundles-__init__.md) - [execute](https://docs.prefect.io/v3/api-ref/python/prefect-bundles-execute.md) ##### prefect.cli - [api](https://docs.prefect.io/v3/api-ref/python/prefect-cli-api.md) - [artifact](https://docs.prefect.io/v3/api-ref/python/prefect-cli-artifact.md) - [automation](https://docs.prefect.io/v3/api-ref/python/prefect-cli-automation.md) - [block](https://docs.prefect.io/v3/api-ref/python/prefect-cli-block.md) - [concurrency_limit](https://docs.prefect.io/v3/api-ref/python/prefect-cli-concurrency_limit.md) - [config](https://docs.prefect.io/v3/api-ref/python/prefect-cli-config.md) - [dashboard](https://docs.prefect.io/v3/api-ref/python/prefect-cli-dashboard.md) - [__init__](https://docs.prefect.io/v3/api-ref/python/prefect-cli-deploy-__init__.md) - [deployment](https://docs.prefect.io/v3/api-ref/python/prefect-cli-deployment.md) - [dev](https://docs.prefect.io/v3/api-ref/python/prefect-cli-dev.md) - [events](https://docs.prefect.io/v3/api-ref/python/prefect-cli-events.md) - [experimental](https://docs.prefect.io/v3/api-ref/python/prefect-cli-experimental.md) - [flow](https://docs.prefect.io/v3/api-ref/python/prefect-cli-flow.md) - [flow_run](https://docs.prefect.io/v3/api-ref/python/prefect-cli-flow_run.md) - [flow_runs_watching](https://docs.prefect.io/v3/api-ref/python/prefect-cli-flow_runs_watching.md) - [global_concurrency_limit](https://docs.prefect.io/v3/api-ref/python/prefect-cli-global_concurrency_limit.md) - [plugins](https://docs.prefect.io/v3/api-ref/python/prefect-cli-plugins.md) - [profile](https://docs.prefect.io/v3/api-ref/python/prefect-cli-profile.md) - [result_storage](https://docs.prefect.io/v3/api-ref/python/prefect-cli-result_storage.md) - [sdk](https://docs.prefect.io/v3/api-ref/python/prefect-cli-sdk.md) - [server](https://docs.prefect.io/v3/api-ref/python/prefect-cli-server.md) - [shell](https://docs.prefect.io/v3/api-ref/python/prefect-cli-shell.md) - [task](https://docs.prefect.io/v3/api-ref/python/prefect-cli-task.md) - [task_run](https://docs.prefect.io/v3/api-ref/python/prefect-cli-task_run.md) - [__init__](https://docs.prefect.io/v3/api-ref/python/prefect-cli-transfer-__init__.md) - [variable](https://docs.prefect.io/v3/api-ref/python/prefect-cli-variable.md) - [version](https://docs.prefect.io/v3/api-ref/python/prefect-cli-version.md) - [work_pool](https://docs.prefect.io/v3/api-ref/python/prefect-cli-work_pool.md) - [work_queue](https://docs.prefect.io/v3/api-ref/python/prefect-cli-work_queue.md) - [worker](https://docs.prefect.io/v3/api-ref/python/prefect-cli-worker.md) ###### cloud - [__init__](https://docs.prefect.io/v3/api-ref/python/prefect-cli-cloud-__init__.md) - [asset](https://docs.prefect.io/v3/api-ref/python/prefect-cli-cloud-asset.md) - [ip_allowlist](https://docs.prefect.io/v3/api-ref/python/prefect-cli-cloud-ip_allowlist.md) - [webhook](https://docs.prefect.io/v3/api-ref/python/prefect-cli-cloud-webhook.md) ##### prefect.client - [__init__](https://docs.prefect.io/v3/api-ref/python/prefect-client-__init__.md) - [attribution](https://docs.prefect.io/v3/api-ref/python/prefect-client-attribution.md) - [base](https://docs.prefect.io/v3/api-ref/python/prefect-client-base.md) - [cloud](https://docs.prefect.io/v3/api-ref/python/prefect-client-cloud.md) - [collections](https://docs.prefect.io/v3/api-ref/python/prefect-client-collections.md) - [subscriptions](https://docs.prefect.io/v3/api-ref/python/prefect-client-subscriptions.md) - [utilities](https://docs.prefect.io/v3/api-ref/python/prefect-client-utilities.md) ###### orchestration - [__init__](https://docs.prefect.io/v3/api-ref/python/prefect-client-orchestration-__init__.md) - [base](https://docs.prefect.io/v3/api-ref/python/prefect-client-orchestration-base.md) ###### schemas - [actions](https://docs.prefect.io/v3/api-ref/python/prefect-client-schemas-actions.md) - [events](https://docs.prefect.io/v3/api-ref/python/prefect-client-schemas-events.md) - [filters](https://docs.prefect.io/v3/api-ref/python/prefect-client-schemas-filters.md) - [objects](https://docs.prefect.io/v3/api-ref/python/prefect-client-schemas-objects.md) - [responses](https://docs.prefect.io/v3/api-ref/python/prefect-client-schemas-responses.md) - [schedules](https://docs.prefect.io/v3/api-ref/python/prefect-client-schemas-schedules.md) - [sorting](https://docs.prefect.io/v3/api-ref/python/prefect-client-schemas-sorting.md) - [worker_channel](https://docs.prefect.io/v3/api-ref/python/prefect-client-schemas-worker_channel.md) ##### prefect.concurrency - [asyncio](https://docs.prefect.io/v3/api-ref/python/prefect-concurrency-asyncio.md) - [context](https://docs.prefect.io/v3/api-ref/python/prefect-concurrency-context.md) - [services](https://docs.prefect.io/v3/api-ref/python/prefect-concurrency-services.md) - [sync](https://docs.prefect.io/v3/api-ref/python/prefect-concurrency-sync.md) ###### v1 - [asyncio](https://docs.prefect.io/v3/api-ref/python/prefect-concurrency-v1-asyncio.md) - [context](https://docs.prefect.io/v3/api-ref/python/prefect-concurrency-v1-context.md) - [services](https://docs.prefect.io/v3/api-ref/python/prefect-concurrency-v1-services.md) - [sync](https://docs.prefect.io/v3/api-ref/python/prefect-concurrency-v1-sync.md) ##### prefect.deployments - [base](https://docs.prefect.io/v3/api-ref/python/prefect-deployments-base.md) - [flow_runs](https://docs.prefect.io/v3/api-ref/python/prefect-deployments-flow_runs.md) - [runner](https://docs.prefect.io/v3/api-ref/python/prefect-deployments-runner.md) - [schedules](https://docs.prefect.io/v3/api-ref/python/prefect-deployments-schedules.md) ###### steps - [core](https://docs.prefect.io/v3/api-ref/python/prefect-deployments-steps-core.md) - [pull](https://docs.prefect.io/v3/api-ref/python/prefect-deployments-steps-pull.md) - [utility](https://docs.prefect.io/v3/api-ref/python/prefect-deployments-steps-utility.md) ##### prefect.docker - [docker_image](https://docs.prefect.io/v3/api-ref/python/prefect-docker-docker_image.md) ##### prefect.events - [actions](https://docs.prefect.io/v3/api-ref/python/prefect-events-actions.md) - [clients](https://docs.prefect.io/v3/api-ref/python/prefect-events-clients.md) - [filters](https://docs.prefect.io/v3/api-ref/python/prefect-events-filters.md) - [related](https://docs.prefect.io/v3/api-ref/python/prefect-events-related.md) - [subscribers](https://docs.prefect.io/v3/api-ref/python/prefect-events-subscribers.md) - [utilities](https://docs.prefect.io/v3/api-ref/python/prefect-events-utilities.md) - [worker](https://docs.prefect.io/v3/api-ref/python/prefect-events-worker.md) ###### schemas - [automations](https://docs.prefect.io/v3/api-ref/python/prefect-events-schemas-automations.md) - [deployment_triggers](https://docs.prefect.io/v3/api-ref/python/prefect-events-schemas-deployment_triggers.md) - [events](https://docs.prefect.io/v3/api-ref/python/prefect-events-schemas-events.md) - [labelling](https://docs.prefect.io/v3/api-ref/python/prefect-events-schemas-labelling.md) ##### prefect.infrastructure - [__init__](https://docs.prefect.io/v3/api-ref/python/prefect-infrastructure-__init__.md) - [base](https://docs.prefect.io/v3/api-ref/python/prefect-infrastructure-base.md) ###### provisioners - [__init__](https://docs.prefect.io/v3/api-ref/python/prefect-infrastructure-provisioners-__init__.md) - [cloud_run](https://docs.prefect.io/v3/api-ref/python/prefect-infrastructure-provisioners-cloud_run.md) - [coiled](https://docs.prefect.io/v3/api-ref/python/prefect-infrastructure-provisioners-coiled.md) - [container_instance](https://docs.prefect.io/v3/api-ref/python/prefect-infrastructure-provisioners-container_instance.md) - [ecs](https://docs.prefect.io/v3/api-ref/python/prefect-infrastructure-provisioners-ecs.md) - [modal](https://docs.prefect.io/v3/api-ref/python/prefect-infrastructure-provisioners-modal.md) ##### prefect.input - [actions](https://docs.prefect.io/v3/api-ref/python/prefect-input-actions.md) - [run_input](https://docs.prefect.io/v3/api-ref/python/prefect-input-run_input.md) ##### prefect.locking - [filesystem](https://docs.prefect.io/v3/api-ref/python/prefect-locking-filesystem.md) - [memory](https://docs.prefect.io/v3/api-ref/python/prefect-locking-memory.md) - [protocol](https://docs.prefect.io/v3/api-ref/python/prefect-locking-protocol.md) ##### prefect.logging - [clients](https://docs.prefect.io/v3/api-ref/python/prefect-logging-clients.md) - [configuration](https://docs.prefect.io/v3/api-ref/python/prefect-logging-configuration.md) - [filters](https://docs.prefect.io/v3/api-ref/python/prefect-logging-filters.md) - [formatters](https://docs.prefect.io/v3/api-ref/python/prefect-logging-formatters.md) - [handlers](https://docs.prefect.io/v3/api-ref/python/prefect-logging-handlers.md) - [highlighters](https://docs.prefect.io/v3/api-ref/python/prefect-logging-highlighters.md) - [loggers](https://docs.prefect.io/v3/api-ref/python/prefect-logging-loggers.md) ##### prefect.runner - [runner](https://docs.prefect.io/v3/api-ref/python/prefect-runner-runner.md) - [server](https://docs.prefect.io/v3/api-ref/python/prefect-runner-server.md) - [storage](https://docs.prefect.io/v3/api-ref/python/prefect-runner-storage.md) ##### prefect.runtime - [__init__](https://docs.prefect.io/v3/api-ref/python/prefect-runtime-__init__.md) - [deployment](https://docs.prefect.io/v3/api-ref/python/prefect-runtime-deployment.md) - [flow_run](https://docs.prefect.io/v3/api-ref/python/prefect-runtime-flow_run.md) - [task_run](https://docs.prefect.io/v3/api-ref/python/prefect-runtime-task_run.md) ##### prefect.server - [exceptions](https://docs.prefect.io/v3/api-ref/python/prefect-server-exceptions.md) - [task_queue](https://docs.prefect.io/v3/api-ref/python/prefect-server-task_queue.md) ###### api - [admin](https://docs.prefect.io/v3/api-ref/python/prefect-server-api-admin.md) - [artifacts](https://docs.prefect.io/v3/api-ref/python/prefect-server-api-artifacts.md) - [automations](https://docs.prefect.io/v3/api-ref/python/prefect-server-api-automations.md) - [background_workers](https://docs.prefect.io/v3/api-ref/python/prefect-server-api-background_workers.md) - [block_capabilities](https://docs.prefect.io/v3/api-ref/python/prefect-server-api-block_capabilities.md) - [block_documents](https://docs.prefect.io/v3/api-ref/python/prefect-server-api-block_documents.md) - [block_schemas](https://docs.prefect.io/v3/api-ref/python/prefect-server-api-block_schemas.md) - [block_types](https://docs.prefect.io/v3/api-ref/python/prefect-server-api-block_types.md) - [clients](https://docs.prefect.io/v3/api-ref/python/prefect-server-api-clients.md) - [collections](https://docs.prefect.io/v3/api-ref/python/prefect-server-api-collections.md) - [concurrency_limits](https://docs.prefect.io/v3/api-ref/python/prefect-server-api-concurrency_limits.md) - [concurrency_limits_v2](https://docs.prefect.io/v3/api-ref/python/prefect-server-api-concurrency_limits_v2.md) - [csrf_token](https://docs.prefect.io/v3/api-ref/python/prefect-server-api-csrf_token.md) - [dependencies](https://docs.prefect.io/v3/api-ref/python/prefect-server-api-dependencies.md) - [deployments](https://docs.prefect.io/v3/api-ref/python/prefect-server-api-deployments.md) - [events](https://docs.prefect.io/v3/api-ref/python/prefect-server-api-events.md) - [flow_run_states](https://docs.prefect.io/v3/api-ref/python/prefect-server-api-flow_run_states.md) - [flow_runs](https://docs.prefect.io/v3/api-ref/python/prefect-server-api-flow_runs.md) - [flows](https://docs.prefect.io/v3/api-ref/python/prefect-server-api-flows.md) - [logs](https://docs.prefect.io/v3/api-ref/python/prefect-server-api-logs.md) - [middleware](https://docs.prefect.io/v3/api-ref/python/prefect-server-api-middleware.md) - [root](https://docs.prefect.io/v3/api-ref/python/prefect-server-api-root.md) - [run_history](https://docs.prefect.io/v3/api-ref/python/prefect-server-api-run_history.md) - [saved_searches](https://docs.prefect.io/v3/api-ref/python/prefect-server-api-saved_searches.md) - [server](https://docs.prefect.io/v3/api-ref/python/prefect-server-api-server.md) - [task_run_states](https://docs.prefect.io/v3/api-ref/python/prefect-server-api-task_run_states.md) - [task_runs](https://docs.prefect.io/v3/api-ref/python/prefect-server-api-task_runs.md) - [task_workers](https://docs.prefect.io/v3/api-ref/python/prefect-server-api-task_workers.md) - [templates](https://docs.prefect.io/v3/api-ref/python/prefect-server-api-templates.md) - [validation](https://docs.prefect.io/v3/api-ref/python/prefect-server-api-validation.md) - [variables](https://docs.prefect.io/v3/api-ref/python/prefect-server-api-variables.md) - [work_queues](https://docs.prefect.io/v3/api-ref/python/prefect-server-api-work_queues.md) - [workers](https://docs.prefect.io/v3/api-ref/python/prefect-server-api-workers.md) ###### ui - [__init__](https://docs.prefect.io/v3/api-ref/python/prefect-server-api-ui-__init__.md) - [flow_runs](https://docs.prefect.io/v3/api-ref/python/prefect-server-api-ui-flow_runs.md) - [flows](https://docs.prefect.io/v3/api-ref/python/prefect-server-api-ui-flows.md) - [schemas](https://docs.prefect.io/v3/api-ref/python/prefect-server-api-ui-schemas.md) - [task_runs](https://docs.prefect.io/v3/api-ref/python/prefect-server-api-ui-task_runs.md) ###### database - [alembic_commands](https://docs.prefect.io/v3/api-ref/python/prefect-server-database-alembic_commands.md) - [configurations](https://docs.prefect.io/v3/api-ref/python/prefect-server-database-configurations.md) - [dependencies](https://docs.prefect.io/v3/api-ref/python/prefect-server-database-dependencies.md) - [interface](https://docs.prefect.io/v3/api-ref/python/prefect-server-database-interface.md) - [orm_models](https://docs.prefect.io/v3/api-ref/python/prefect-server-database-orm_models.md) - [query_components](https://docs.prefect.io/v3/api-ref/python/prefect-server-database-query_components.md) ###### events - [actions](https://docs.prefect.io/v3/api-ref/python/prefect-server-events-actions.md) - [clients](https://docs.prefect.io/v3/api-ref/python/prefect-server-events-clients.md) - [counting](https://docs.prefect.io/v3/api-ref/python/prefect-server-events-counting.md) - [filters](https://docs.prefect.io/v3/api-ref/python/prefect-server-events-filters.md) - [jinja_filters](https://docs.prefect.io/v3/api-ref/python/prefect-server-events-jinja_filters.md) - [messaging](https://docs.prefect.io/v3/api-ref/python/prefect-server-events-messaging.md) - [pipeline](https://docs.prefect.io/v3/api-ref/python/prefect-server-events-pipeline.md) - [stream](https://docs.prefect.io/v3/api-ref/python/prefect-server-events-stream.md) - [triggers](https://docs.prefect.io/v3/api-ref/python/prefect-server-events-triggers.md) ###### models - [automations](https://docs.prefect.io/v3/api-ref/python/prefect-server-events-models-automations.md) - [composite_trigger_child_firing](https://docs.prefect.io/v3/api-ref/python/prefect-server-events-models-composite_trigger_child_firing.md) ###### ordering - [__init__](https://docs.prefect.io/v3/api-ref/python/prefect-server-events-ordering-__init__.md) - [db](https://docs.prefect.io/v3/api-ref/python/prefect-server-events-ordering-db.md) - [memory](https://docs.prefect.io/v3/api-ref/python/prefect-server-events-ordering-memory.md) ###### schemas - [automations](https://docs.prefect.io/v3/api-ref/python/prefect-server-events-schemas-automations.md) - [events](https://docs.prefect.io/v3/api-ref/python/prefect-server-events-schemas-events.md) - [labelling](https://docs.prefect.io/v3/api-ref/python/prefect-server-events-schemas-labelling.md) - [lifecycle](https://docs.prefect.io/v3/api-ref/python/prefect-server-events-schemas-lifecycle.md) ###### services - [actions](https://docs.prefect.io/v3/api-ref/python/prefect-server-events-services-actions.md) - [event_logger](https://docs.prefect.io/v3/api-ref/python/prefect-server-events-services-event_logger.md) - [event_persister](https://docs.prefect.io/v3/api-ref/python/prefect-server-events-services-event_persister.md) - [triggers](https://docs.prefect.io/v3/api-ref/python/prefect-server-events-services-triggers.md) ###### storage - [__init__](https://docs.prefect.io/v3/api-ref/python/prefect-server-events-storage-__init__.md) - [database](https://docs.prefect.io/v3/api-ref/python/prefect-server-events-storage-database.md) ###### logs - [messaging](https://docs.prefect.io/v3/api-ref/python/prefect-server-logs-messaging.md) - [stream](https://docs.prefect.io/v3/api-ref/python/prefect-server-logs-stream.md) ###### models - [artifacts](https://docs.prefect.io/v3/api-ref/python/prefect-server-models-artifacts.md) - [block_documents](https://docs.prefect.io/v3/api-ref/python/prefect-server-models-block_documents.md) - [block_registration](https://docs.prefect.io/v3/api-ref/python/prefect-server-models-block_registration.md) - [block_schemas](https://docs.prefect.io/v3/api-ref/python/prefect-server-models-block_schemas.md) - [block_types](https://docs.prefect.io/v3/api-ref/python/prefect-server-models-block_types.md) - [concurrency_limits](https://docs.prefect.io/v3/api-ref/python/prefect-server-models-concurrency_limits.md) - [concurrency_limits_v2](https://docs.prefect.io/v3/api-ref/python/prefect-server-models-concurrency_limits_v2.md) - [configuration](https://docs.prefect.io/v3/api-ref/python/prefect-server-models-configuration.md) - [csrf_token](https://docs.prefect.io/v3/api-ref/python/prefect-server-models-csrf_token.md) - [deployments](https://docs.prefect.io/v3/api-ref/python/prefect-server-models-deployments.md) - [events](https://docs.prefect.io/v3/api-ref/python/prefect-server-models-events.md) - [flow_run_input](https://docs.prefect.io/v3/api-ref/python/prefect-server-models-flow_run_input.md) - [flow_run_states](https://docs.prefect.io/v3/api-ref/python/prefect-server-models-flow_run_states.md) - [flow_runs](https://docs.prefect.io/v3/api-ref/python/prefect-server-models-flow_runs.md) - [flows](https://docs.prefect.io/v3/api-ref/python/prefect-server-models-flows.md) - [logs](https://docs.prefect.io/v3/api-ref/python/prefect-server-models-logs.md) - [saved_searches](https://docs.prefect.io/v3/api-ref/python/prefect-server-models-saved_searches.md) - [storage_defaults](https://docs.prefect.io/v3/api-ref/python/prefect-server-models-storage_defaults.md) - [task_run_states](https://docs.prefect.io/v3/api-ref/python/prefect-server-models-task_run_states.md) - [task_runs](https://docs.prefect.io/v3/api-ref/python/prefect-server-models-task_runs.md) - [task_workers](https://docs.prefect.io/v3/api-ref/python/prefect-server-models-task_workers.md) - [variables](https://docs.prefect.io/v3/api-ref/python/prefect-server-models-variables.md) - [work_queues](https://docs.prefect.io/v3/api-ref/python/prefect-server-models-work_queues.md) - [workers](https://docs.prefect.io/v3/api-ref/python/prefect-server-models-workers.md) ###### orchestration - [core_policy](https://docs.prefect.io/v3/api-ref/python/prefect-server-orchestration-core_policy.md) - [dependencies](https://docs.prefect.io/v3/api-ref/python/prefect-server-orchestration-dependencies.md) - [global_policy](https://docs.prefect.io/v3/api-ref/python/prefect-server-orchestration-global_policy.md) - [instrumentation_policies](https://docs.prefect.io/v3/api-ref/python/prefect-server-orchestration-instrumentation_policies.md) - [policies](https://docs.prefect.io/v3/api-ref/python/prefect-server-orchestration-policies.md) - [rules](https://docs.prefect.io/v3/api-ref/python/prefect-server-orchestration-rules.md) ###### schemas - [actions](https://docs.prefect.io/v3/api-ref/python/prefect-server-schemas-actions.md) - [core](https://docs.prefect.io/v3/api-ref/python/prefect-server-schemas-core.md) - [filters](https://docs.prefect.io/v3/api-ref/python/prefect-server-schemas-filters.md) - [graph](https://docs.prefect.io/v3/api-ref/python/prefect-server-schemas-graph.md) - [internal](https://docs.prefect.io/v3/api-ref/python/prefect-server-schemas-internal.md) - [responses](https://docs.prefect.io/v3/api-ref/python/prefect-server-schemas-responses.md) - [schedules](https://docs.prefect.io/v3/api-ref/python/prefect-server-schemas-schedules.md) - [sorting](https://docs.prefect.io/v3/api-ref/python/prefect-server-schemas-sorting.md) - [states](https://docs.prefect.io/v3/api-ref/python/prefect-server-schemas-states.md) - [statuses](https://docs.prefect.io/v3/api-ref/python/prefect-server-schemas-statuses.md) - [ui](https://docs.prefect.io/v3/api-ref/python/prefect-server-schemas-ui.md) ###### services - [base](https://docs.prefect.io/v3/api-ref/python/prefect-server-services-base.md) - [cancellation_cleanup](https://docs.prefect.io/v3/api-ref/python/prefect-server-services-cancellation_cleanup.md) - [cleanup_reconciler](https://docs.prefect.io/v3/api-ref/python/prefect-server-services-cleanup_reconciler.md) - [db_vacuum](https://docs.prefect.io/v3/api-ref/python/prefect-server-services-db_vacuum.md) - [foreman](https://docs.prefect.io/v3/api-ref/python/prefect-server-services-foreman.md) - [late_runs](https://docs.prefect.io/v3/api-ref/python/prefect-server-services-late_runs.md) - [pause_expirations](https://docs.prefect.io/v3/api-ref/python/prefect-server-services-pause_expirations.md) - [perpetual_services](https://docs.prefect.io/v3/api-ref/python/prefect-server-services-perpetual_services.md) - [repossessor](https://docs.prefect.io/v3/api-ref/python/prefect-server-services-repossessor.md) - [scheduler](https://docs.prefect.io/v3/api-ref/python/prefect-server-services-scheduler.md) - [task_run_recorder](https://docs.prefect.io/v3/api-ref/python/prefect-server-services-task_run_recorder.md) - [telemetry](https://docs.prefect.io/v3/api-ref/python/prefect-server-services-telemetry.md) ###### utilities - [database](https://docs.prefect.io/v3/api-ref/python/prefect-server-utilities-database.md) - [encryption](https://docs.prefect.io/v3/api-ref/python/prefect-server-utilities-encryption.md) - [http](https://docs.prefect.io/v3/api-ref/python/prefect-server-utilities-http.md) - [leasing](https://docs.prefect.io/v3/api-ref/python/prefect-server-utilities-leasing.md) - [names](https://docs.prefect.io/v3/api-ref/python/prefect-server-utilities-names.md) - [postgres_listener](https://docs.prefect.io/v3/api-ref/python/prefect-server-utilities-postgres_listener.md) - [server](https://docs.prefect.io/v3/api-ref/python/prefect-server-utilities-server.md) - [subscriptions](https://docs.prefect.io/v3/api-ref/python/prefect-server-utilities-subscriptions.md) - [text_search_parser](https://docs.prefect.io/v3/api-ref/python/prefect-server-utilities-text_search_parser.md) - [user_templates](https://docs.prefect.io/v3/api-ref/python/prefect-server-utilities-user_templates.md) - [worker_channel](https://docs.prefect.io/v3/api-ref/python/prefect-server-utilities-worker_channel.md) - [worker_channel_cleanup](https://docs.prefect.io/v3/api-ref/python/prefect-server-utilities-worker_channel_cleanup.md) ###### messaging - [__init__](https://docs.prefect.io/v3/api-ref/python/prefect-server-utilities-messaging-__init__.md) - [memory](https://docs.prefect.io/v3/api-ref/python/prefect-server-utilities-messaging-memory.md) ###### schemas - [bases](https://docs.prefect.io/v3/api-ref/python/prefect-server-utilities-schemas-bases.md) - [serializers](https://docs.prefect.io/v3/api-ref/python/prefect-server-utilities-schemas-serializers.md) ###### worker_communication - [__init__](https://docs.prefect.io/v3/api-ref/python/prefect-server-worker_communication-__init__.md) ###### cleanup_queue - [__init__](https://docs.prefect.io/v3/api-ref/python/prefect-server-worker_communication-cleanup_queue-__init__.md) - [memory](https://docs.prefect.io/v3/api-ref/python/prefect-server-worker_communication-cleanup_queue-memory.md) ##### prefect.settings - [__init__](https://docs.prefect.io/v3/api-ref/python/prefect-settings-__init__.md) - [base](https://docs.prefect.io/v3/api-ref/python/prefect-settings-base.md) - [context](https://docs.prefect.io/v3/api-ref/python/prefect-settings-context.md) - [legacy](https://docs.prefect.io/v3/api-ref/python/prefect-settings-legacy.md) - [profiles](https://docs.prefect.io/v3/api-ref/python/prefect-settings-profiles.md) - [sources](https://docs.prefect.io/v3/api-ref/python/prefect-settings-sources.md) ###### models - [api](https://docs.prefect.io/v3/api-ref/python/prefect-settings-models-api.md) - [cli](https://docs.prefect.io/v3/api-ref/python/prefect-settings-models-cli.md) - [client](https://docs.prefect.io/v3/api-ref/python/prefect-settings-models-client.md) - [cloud](https://docs.prefect.io/v3/api-ref/python/prefect-settings-models-cloud.md) - [deployments](https://docs.prefect.io/v3/api-ref/python/prefect-settings-models-deployments.md) - [events](https://docs.prefect.io/v3/api-ref/python/prefect-settings-models-events.md) - [experiments](https://docs.prefect.io/v3/api-ref/python/prefect-settings-models-experiments.md) - [flows](https://docs.prefect.io/v3/api-ref/python/prefect-settings-models-flows.md) - [internal](https://docs.prefect.io/v3/api-ref/python/prefect-settings-models-internal.md) - [logging](https://docs.prefect.io/v3/api-ref/python/prefect-settings-models-logging.md) - [plugins](https://docs.prefect.io/v3/api-ref/python/prefect-settings-models-plugins.md) - [results](https://docs.prefect.io/v3/api-ref/python/prefect-settings-models-results.md) - [root](https://docs.prefect.io/v3/api-ref/python/prefect-settings-models-root.md) - [runner](https://docs.prefect.io/v3/api-ref/python/prefect-settings-models-runner.md) - [tasks](https://docs.prefect.io/v3/api-ref/python/prefect-settings-models-tasks.md) - [telemetry](https://docs.prefect.io/v3/api-ref/python/prefect-settings-models-telemetry.md) - [testing](https://docs.prefect.io/v3/api-ref/python/prefect-settings-models-testing.md) - [worker](https://docs.prefect.io/v3/api-ref/python/prefect-settings-models-worker.md) ###### server - [api](https://docs.prefect.io/v3/api-ref/python/prefect-settings-models-server-api.md) - [concurrency](https://docs.prefect.io/v3/api-ref/python/prefect-settings-models-server-concurrency.md) - [database](https://docs.prefect.io/v3/api-ref/python/prefect-settings-models-server-database.md) - [deployments](https://docs.prefect.io/v3/api-ref/python/prefect-settings-models-server-deployments.md) - [docket](https://docs.prefect.io/v3/api-ref/python/prefect-settings-models-server-docket.md) - [ephemeral](https://docs.prefect.io/v3/api-ref/python/prefect-settings-models-server-ephemeral.md) - [events](https://docs.prefect.io/v3/api-ref/python/prefect-settings-models-server-events.md) - [flow_run_graph](https://docs.prefect.io/v3/api-ref/python/prefect-settings-models-server-flow_run_graph.md) - [logs](https://docs.prefect.io/v3/api-ref/python/prefect-settings-models-server-logs.md) - [root](https://docs.prefect.io/v3/api-ref/python/prefect-settings-models-server-root.md) - [services](https://docs.prefect.io/v3/api-ref/python/prefect-settings-models-server-services.md) - [tasks](https://docs.prefect.io/v3/api-ref/python/prefect-settings-models-server-tasks.md) - [ui](https://docs.prefect.io/v3/api-ref/python/prefect-settings-models-server-ui.md) - [worker_channel](https://docs.prefect.io/v3/api-ref/python/prefect-settings-models-server-worker_channel.md) ##### prefect.telemetry - [run_telemetry](https://docs.prefect.io/v3/api-ref/python/prefect-telemetry-run_telemetry.md) ##### prefect.testing - [cli](https://docs.prefect.io/v3/api-ref/python/prefect-testing-cli.md) - [docker](https://docs.prefect.io/v3/api-ref/python/prefect-testing-docker.md) - [fixtures](https://docs.prefect.io/v3/api-ref/python/prefect-testing-fixtures.md) - [utilities](https://docs.prefect.io/v3/api-ref/python/prefect-testing-utilities.md) ##### prefect.types - [__init__](https://docs.prefect.io/v3/api-ref/python/prefect-types-__init__.md) - [entrypoint](https://docs.prefect.io/v3/api-ref/python/prefect-types-entrypoint.md) - [names](https://docs.prefect.io/v3/api-ref/python/prefect-types-names.md) ##### prefect.utilities - [annotations](https://docs.prefect.io/v3/api-ref/python/prefect-utilities-annotations.md) - [asyncutils](https://docs.prefect.io/v3/api-ref/python/prefect-utilities-asyncutils.md) - [callables](https://docs.prefect.io/v3/api-ref/python/prefect-utilities-callables.md) - [collections](https://docs.prefect.io/v3/api-ref/python/prefect-utilities-collections.md) - [compat](https://docs.prefect.io/v3/api-ref/python/prefect-utilities-compat.md) - [context](https://docs.prefect.io/v3/api-ref/python/prefect-utilities-context.md) - [dispatch](https://docs.prefect.io/v3/api-ref/python/prefect-utilities-dispatch.md) - [dockerutils](https://docs.prefect.io/v3/api-ref/python/prefect-utilities-dockerutils.md) - [engine](https://docs.prefect.io/v3/api-ref/python/prefect-utilities-engine.md) - [filesystem](https://docs.prefect.io/v3/api-ref/python/prefect-utilities-filesystem.md) - [generics](https://docs.prefect.io/v3/api-ref/python/prefect-utilities-generics.md) - [hashing](https://docs.prefect.io/v3/api-ref/python/prefect-utilities-hashing.md) - [importtools](https://docs.prefect.io/v3/api-ref/python/prefect-utilities-importtools.md) - [math](https://docs.prefect.io/v3/api-ref/python/prefect-utilities-math.md) - [names](https://docs.prefect.io/v3/api-ref/python/prefect-utilities-names.md) - [processutils](https://docs.prefect.io/v3/api-ref/python/prefect-utilities-processutils.md) - [pydantic](https://docs.prefect.io/v3/api-ref/python/prefect-utilities-pydantic.md) - [render_swagger](https://docs.prefect.io/v3/api-ref/python/prefect-utilities-render_swagger.md) - [services](https://docs.prefect.io/v3/api-ref/python/prefect-utilities-services.md) - [templating](https://docs.prefect.io/v3/api-ref/python/prefect-utilities-templating.md) - [text](https://docs.prefect.io/v3/api-ref/python/prefect-utilities-text.md) - [timeout](https://docs.prefect.io/v3/api-ref/python/prefect-utilities-timeout.md) - [urls](https://docs.prefect.io/v3/api-ref/python/prefect-utilities-urls.md) - [visualization](https://docs.prefect.io/v3/api-ref/python/prefect-utilities-visualization.md) ###### schema_tools - [hydration](https://docs.prefect.io/v3/api-ref/python/prefect-utilities-schema_tools-hydration.md) - [validation](https://docs.prefect.io/v3/api-ref/python/prefect-utilities-schema_tools-validation.md) ##### prefect.workers - [base](https://docs.prefect.io/v3/api-ref/python/prefect-workers-base.md) - [block](https://docs.prefect.io/v3/api-ref/python/prefect-workers-block.md) - [cloud](https://docs.prefect.io/v3/api-ref/python/prefect-workers-cloud.md) - [process](https://docs.prefect.io/v3/api-ref/python/prefect-workers-process.md) - [server](https://docs.prefect.io/v3/api-ref/python/prefect-workers-server.md) - [utilities](https://docs.prefect.io/v3/api-ref/python/prefect-workers-utilities.md)