Skip to main content

prefect.server.api.workers

Routes for interacting with work queue objects.

Functions

create_work_pool

Creates a new work pool. If a work pool with the same name already exists, an error will be raised. For more information, see https://docs.prefect.io/v3/concepts/work-pools.

read_work_pool

Read a work pool by name

read_work_pools

Read multiple work pools

count_work_pools

Count work pools

update_work_pool

Update a work pool

delete_work_pool

Delete a work pool

read_work_pool_concurrency_status

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

Load scheduled runs for a worker

create_work_queue

Creates a new work pool queue. If a work pool queue with the same name already exists, an error will be raised. For more information, see https://docs.prefect.io/v3/concepts/work-pools#work-queues.

read_work_queue

Read a work pool queue

read_work_queues

Read all work pool queues

update_work_queue

Update a work pool queue

delete_work_queue

Delete a work pool queue

worker_channel_connect

worker_heartbeat

read_workers

Read all worker processes

delete_worker

Delete a work pool’s worker

Classes

WorkerLookups

WorkerChannelSetupError

WorkerChannelWorkPoolUpdateEvent