---
title: "Lists all worker pools, including a summary of worker information."
method: GET
path: "/workerpools/summary"
tags: ["WorkerPools"]
---

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

`GET /workerpools/summary`

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

## 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
      - `Id` string
      - `IsDefault` boolean
      - `LastModifiedBy` string
      - `LastModifiedOn` string, date-time
      - `Links` object
      - `Name` string
      - `Slug` string
      - `SortOrder` integer
      - `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/versions/bc9158facfc7/schema)