Read Workers

Read all worker processes

Headers

x-prefect-api-version

string

Path Parameters

work_pool_name

string

required

The work pool name

Body

application/json

limit

integer

Defaults to PREFECT_API_DEFAULT_LIMIT if not provided.

offset

integer

default:

0

Required range: x > 0

workers

object | null

Filter by Worker.last_heartbeat_time.

Show child attributes

workers.last_heartbeat_time

object | null

Filter criteria for Worker.last_heartbeat_time

Show child attributes

workers.last_heartbeat_time.after_

string | null

Only include processes whose last heartbeat was at or after this time

workers.last_heartbeat_time.before_

string | null

Only include processes whose last heartbeat was at or before this time

workers.operator

enum<string>

Operator for combining filter criteria. Defaults to 'and_'.

Available options:

and_,

or_

workers.status

object | null

Filter criteria for Worker.status

Show child attributes

workers.status.any_

enum<string>[] | null

A list of worker statuses to include

Available options:

ONLINE,

OFFLINE

workers.status.not_any_

enum<string>[] | null

A list of worker statuses to exclude

Available options:

ONLINE,

OFFLINE

Response

200 - application/json

created

string | null

required

id

string

required

name

string

required

The name of the worker.

updated

string | null

required

work_pool_id

string

required

The work pool with which the queue is associated.

heartbeat_interval_seconds

integer | null

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

last_heartbeat_time

string

The last time the worker process sent a heartbeat.

status

enum<string>

Current status of the worker.

Available options:

ONLINE,

OFFLINE