v1

latestSwagger 2.02026-08-061,9128853.7 MB
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/spaces/{spaceIdentifier}/workerpools

Path parameters

spaceIdentifierstring required

Identifier (ID or slug) of the space

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
ItemsPerPageinteger
ItemTypestring
LastModifiedBystring
LastModifiedOnstring date-time
LastPageNumberinteger
Linksobject
NumberOfPagesinteger
TotalResultsinteger