Documentation Index Fetch the complete documentation index at: https://docs.prefect.io/llms.txt
Use this file to discover all available pages before exploring further.
prefect.server.api.work_queuesRoutes for interacting with work queue objects.
Functions create_work_queue create_work_queue(work_queue: schemas.actions.WorkQueueCreate, db: PrefectDBInterface = Depends(provide_database_interface)) -> schemas.responses.WorkQueueResponse
Creates a new work queue.
If a work 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 .
update_work_queue update_work_queue(work_queue: schemas.actions.WorkQueueUpdate, work_queue_id: UUID = Path( ... , description = 'The work queue id' , alias = 'id' ), db: PrefectDBInterface = Depends(provide_database_interface)) -> None
Updates an existing work queue.
read_work_queue_by_name read_work_queue_by_name(name: str = Path( ... , description = 'The work queue name' ), db: PrefectDBInterface = Depends(provide_database_interface)) -> schemas.responses.WorkQueueResponse
Get a work queue by id.
read_work_queue read_work_queue(work_queue_id: UUID = Path( ... , description = 'The work queue id' , alias = 'id' ), db: PrefectDBInterface = Depends(provide_database_interface)) -> schemas.responses.WorkQueueResponse
Get a work queue by id.
read_work_queue_runs read_work_queue_runs(docket: dependencies.Docket, work_queue_id: UUID = Path( ... , description = 'The work queue id' , alias = 'id' ), limit: int = dependencies.LimitBody(), scheduled_before: DateTime = Body( None , description = 'Only flow runs scheduled to start before this time will be returned.' ), x_prefect_ui: Optional[ bool ] = Header( default = False , description = 'A header to indicate this request came from the Prefect UI.' ), db: PrefectDBInterface = Depends(provide_database_interface)) -> List[schemas.responses.FlowRunResponse]
Get flow runs from the work queue.
read_work_queues read_work_queues(limit: int = dependencies.LimitBody(), offset: int = Body( 0 , ge = 0 ), work_queues: Optional[schemas.filters.WorkQueueFilter] = None , db: PrefectDBInterface = Depends(provide_database_interface)) -> List[schemas.responses.WorkQueueResponse]
Query for work queues.
delete_work_queue delete_work_queue(work_queue_id: UUID = Path( ... , description = 'The work queue id' , alias = 'id' ), db: PrefectDBInterface = Depends(provide_database_interface)) -> None
Delete a work queue by id.
read_work_queue_concurrency_status read_work_queue_concurrency_status(work_queue_id: UUID = Path( ... , description = 'The work queue id' , alias = 'id' ), page: int = Body( 1 , ge = 1 ), limit: int = dependencies.LimitBody(), db: PrefectDBInterface = Depends(provide_database_interface)) -> schemas.responses.WorkQueueConcurrencyStatus
Read concurrency status for a work queue, including paginated flow run
summaries. active_slots always reflects the total count.
read_work_queue_status read_work_queue_status(work_queue_id: UUID = Path( ... , description = 'The work queue id' , alias = 'id' ), db: PrefectDBInterface = Depends(provide_database_interface)) -> schemas.core.WorkQueueStatusDetail
Get the status of a work queue. 
