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/{spaceId}/workerpools/all

Path parameters

spaceIdstring required

The ID of the space containing the resource(s).

Query parameters

idsstring[]

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

Response

The list of requested Worker Pools

CanAddWorkersboolean
Descriptionstring
Idstring
IsDefaultboolean
LastModifiedBystring
LastModifiedOnstring date-time
Linksobject
Namestring
Slugstring
SortOrderinteger
SpaceIdstring
WorkerPoolType'StaticWorkerPool' | 'DynamicWorkerPool'