WorkerPools

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

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

get/workerpools/summary

Query parameters

commStylesstring[]
healthStatusesstring[]
hideEmptyWorkerPoolsboolean
idsstring[]
isDisabledboolean
machinePartialNamestring
partialNamestring
shellNamesstring[]

Response

The requested Worker Pool Summary

MachineEndpointSummariesobject
MachineHealthStatusSummariesobject
MachineIdsForCalamariUpgradestring[]
MachineIdsForTentacleUpgradestring[]
TentacleUpgradesRequiredboolean
TotalDisabledMachinesinteger
TotalMachinesinteger

Example response

{
  "WorkerPoolSummaries": [
    {
      "WorkerPool": {
        "SpaceId": "Spaces-1"
      }
    }
  ]
}

Changes