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

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.

Response

The list of requested Worker Pools

CanAddWorkersboolean
Descriptionstring

Gets or sets a short description of this pool that can be used to explain the purpose of the pool to other users. May describe the kinds of machines in the pool. This field may contain markdown.

Idstring

Gets or sets a unique identifier for this resource.

IsDefaultboolean

Is this the default pool. The default pool is used for steps that don't specify a worker pool. The default pool, if empty, uses the builtin worker to run steps.

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.

Linksobject

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

Namestring

Gets or sets the name of this pool. This should be short, preferably 5-20 characters.

Slugstring
SortOrderinteger

Gets or sets a number indicating the priority of this pool in sort order. Pools with a lower sort order will appear in the UI before items with a higher sort order.

SpaceIdstring
WorkerPoolType'StaticWorkerPool' | 'DynamicWorkerPool'