Sign in

v1

latestOpenAPI 3.1.0raw.githubusercontent.com2024-11-08170291390.5 KB
Work Pools

Read Workers

Read all worker processes

post/api/work_pools/{work_pool_name}/workers/filter

Path parameters

work_pool_namestring required

The work pool name

The work pool name

Headers

x-prefect-api-versionstring

Request body

offsetinteger
limitinteger

Defaults to PREFECT_API_DEFAULT_LIMIT if not provided.

Response

Successful Response

idstring uuid
createdstring date-time
updatedstring date-time
namestring required

The name of the worker.

work_pool_idstring uuid required

The work pool with which the queue is associated.

last_heartbeat_timestring date-time

The last time the worker process sent a heartbeat.

heartbeat_interval_secondsinteger

The number of seconds to expect between heartbeats sent by the worker.

status'ONLINE' | 'OFFLINE'

Enumeration of worker statuses.