Sign in
latestSwagger 2.02026-08-191,9198883.9 MB

b296c3a60aa5

WorkerPools

Get a list of Worker Pools.

Lists the name and ID of of the Worker Pools in the supplied Octopus Deploy Space. The results will be sorted by the SortOrder field on each Worker Pool.

get/workerpools

Query parameters

idsstring[]

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

namestring

The exact name of a Worker Pool to be matched

partialNamestring

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

skipinteger

Number of items to skip. Defaults to zero

takeinteger

Number of items to take. Defaults to 10

Response

The requested list of Worker Pools

Idstring

Gets or sets a unique identifier for this resource.

ItemsPerPageinteger
ItemTypestring
LastModifiedBystring

Gets or sets the username of the user who last modified this resource.

LastModifiedOnstring date-time

Gets or sets the date/time that this resource was last modified.

LastPageNumberinteger
Linksobject

Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.

NumberOfPagesinteger
TotalResultsinteger