v4

latestSwagger 2.02026-07-1333110154.1 KB

Retrieves existing workers.

Retrieves existing workers.

get/routing/workers

Query parameters

api-versionstring required

The API version to use for this operation.

maxpagesizeinteger

Number of objects to return per page.

state'active' | 'draining' | 'inactive' | 'all'

If specified, select workers by worker state.

channelIdstring

If specified, select workers who have a channel configuration with this channel.

queueIdstring

If specified, select workers who are assigned to this queue.

hasCapacityboolean

If set to true, select only workers who have capacity for the channel specified by channelId or for any channel if channelId not specified. If set to false, then will return all workers including workers without any capacity for jobs. Defaults to false.

Response

The request has succeeded.

nextLinkstring uri

The link to the next page of items