Overview
Settings reference
REST API
CLI Reference
Python SDK Reference
- artifacts
- automations
- cache_policies
- context
- engine
- exceptions
- filesystems
- flow_engine
- flow_runs
- flows
- futures
- main
- plugins
- results
- schedules
- serializers
- states
- task_engine
- task_runners
- task_runs
- task_worker
- tasks
- transactions
- variables
- prefect.assets
- prefect.blocks
- prefect.cli
- prefect.client
- prefect.concurrency
- prefect.deployments
- prefect.docker
- prefect.events
- prefect.infrastructure
- prefect.input
- prefect.locking
- prefect.logging
- prefect.runner
- prefect.runtime
- prefect.server
  - __init__
  - api
  - database
  - events
  - exceptions
  - logs
  - models
  - orchestration
  - schemas
  - services
  - task_queue
  - utilities
- prefect.settings
- prefect.telemetry
- prefect.testing
- prefect.types
- prefect.utilities
- prefect.workers

On this page

prefect.server.api.task_workers
Functions
read_task_workers
Classes
TaskWorkerFilter

`prefect.server.api.task_workers`

Functions

`read_task_workers`

read_task_workers(task_worker_filter: Optional[TaskWorkerFilter] = Body(default=None, description='The task worker filter', embed=True)) -> List[TaskWorkerResponse]

Read active task workers. Optionally filter by task keys. For more information, see https://docs.prefect.io/v3/concepts/flows-and-tasks#background-tasks.

Classes

`TaskWorkerFilter`

task_runs templates