---
title: "List all worker pools, including a summary of worker information."
method: GET
path: "/spaces/{spaceIdentifier}/workerpools/summary"
tags: ["WorkerPools"]
---

# List all worker pools, including a summary of worker information.

`GET /spaces/{spaceIdentifier}/workerpools/summary`

Lists all worker pools, including a summary of machine information.

## Path parameters

- `spaceIdentifier` string, required

## Query parameters

- `commStyles` string[]
- `healthStatuses` string[]
- `hideEmptyWorkerPools` boolean
- `ids` string[]
- `isDisabled` boolean
- `machinePartialName` string
- `partialName` string
- `shellNames` string[]

## Response `200`

The requested Worker Pool Summary

- WorkerPoolsSummaryResource
  - `MachineEndpointSummaries` object
  - `MachineHealthStatusSummaries` object
  - `MachineIdsForCalamariUpgrade` string[]
  - `MachineIdsForTentacleUpgrade` string[]
  - `TentacleUpgradesRequired` boolean
  - `TotalDisabledMachines` integer
  - `TotalMachines` integer
  - `WorkerPoolSummaries` WorkerPoolSummaryResource[]
    - `MachineEndpointSummaries` object
    - `MachineHealthStatusSummaries` object
    - `MachineIdsForCalamariUpgrade` string[]
    - `MachineIdsForTentacleUpgrade` string[]
    - `TentacleUpgradesRequired` boolean
    - `TotalDisabledMachines` integer
    - `TotalMachines` integer
    - `WorkerPool` WorkerPoolResource
      - `CanAddWorkers` boolean
      - `Description` string — 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.
      - `Id` string — Gets or sets a unique identifier for this resource.
      - `IsDefault` boolean — 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.
      - `LastModifiedBy` string — Gets or sets the username of the user who last modified this resource.
      - `LastModifiedOn` string, date-time — Gets or sets the date/time that this resource was last modified.
      - `Links` object — Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
      - `Name` string — Gets or sets the name of this pool. This should be short, preferably 5-20 characters.
      - `Slug` string
      - `SortOrder` integer — 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.
      - `SpaceId` string
      - `WorkerPoolType` 'StaticWorkerPool' | 'DynamicWorkerPool'

## Other responses

- `304` — Not Modified
- `400` — Bad request. Either the payload was not structurally valid or business rules did not permit the operation.
- `404` — Not found. One or more of the entities involved in the operation was not found.

---

[API](https://skmtc.net/octopus/apis/octopus-server-api.md) · [All operations](https://skmtc.net/octopus/apis/octopus-server-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/octopus/octopus-server-api/revisions/b296c3a60aa5/schema)