Sign in

v1

latestSwagger 2.02026-08-061,9128853.7 MB
Workers

Lists all of the registered worker machines in the supplied Octopus Deploy Space. The results will be sorted alphabetically by name.

get/workers/v2

Query parameters

commStylesstring[]

List of communication styles which if specified, filters the result to only include Workers with matching communication styles.

healthStatusesstring[]

List of health statuses which if specified, filters the result to only include Workers with matching health statuses.

idsstring[]

List of Worker IDs which if specified, filters the result to only include Workers with matching IDs.

isDisabledboolean

A filter to return only disabled/enabled Workers

namestring

The exact name of a Worker to be matched

operatingSystemNamesstring[]

List of operating system names which if specified, filters the result to only include Workers with matching operating systems.

partialNamestring

A partial or complete name to search on. This will perform a "contains" style match against the supplied name or name-fragment

shellNamesstring[]

List of shell names which if specified, filters the result to only include Workers with matching shells.

skipinteger

Number of items to skip. Defaults to zero

takeinteger

Number of items to take. Defaults to 30

workerPoolIdsstring[]

List of Worker Pool IDs which if specified, filters the result to only include Workers belonging to these Worker Pools.

Response

The list of alphabetically sorted workers that matched the request.

WorkerCountPerHealthStatusobject required