Work Pools
Read Workers
Read all worker processes
POST
/
api
/
work_pools
/
{work_pool_name}
/
workers
/
filter
Headers
x-prefect-api-version
string
Path Parameters
work_pool_name
string
requiredThe work pool name
Body
application/json
workers
object | null
Filter by Worker.last_heartbeat_time
.
offset
integer
default: 0limit
integer
Defaults to PREFECT_API_DEFAULT_LIMIT if not provided.
Response
200 - application/json
id
string
created
string | null
updated
string | null
name
string
requiredThe name of the worker.
work_pool_id
string
requiredThe work pool with which the queue is associated.
last_heartbeat_time
string
The last time the worker process sent a heartbeat.
heartbeat_interval_seconds
integer | null
The number of seconds to expect between heartbeats sent by the worker.
status
enum<string>
Current status of the worker.
Available options:
ONLINE
, OFFLINE
Was this page helpful?