WorkerPools

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

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

get/{spaceId}/workerpools/summary

Request

  • Base URL
    https://demo.octopus.app/api
  • URL
    https://demo.octopus.app/api/{spaceId}/workerpools/summary
  • Auth
    • API key in header X-Octopus-ApiKey
    • or API key in query parameter ApiKey
    • or API key in header X-NuGet-ApiKey

Path parameters

spaceIdstring required

Query parameters

commStylesstring[]

Only count workers with one of these communication styles, such as TentaclePassive, TentacleActive or Ssh. Matching is exact and case-sensitive.

healthStatusesstring[]

Only count workers with one of these health statuses: Healthy, HasWarnings, Unhealthy, Unavailable or Unknown.

hideEmptyWorkerPoolsboolean

When true, leave out worker pools with no workers matching the filters.

idsstring[]
isDisabledboolean

When true, only count disabled workers. When false or not set, both enabled and disabled workers are counted.

machinePartialNamestring

A partial or complete worker name. Only workers whose name contains it are counted.

partialNamestring

A partial or complete worker pool name to search on, using a case-insensitive "contains" match.

shellNamesstring[]

Only count workers using one of these shells, such as PowerShell or Bash. Matching is exact and case-sensitive.

Response

The requested Worker Pool Summary

MachineEndpointSummariesobject
MachineHealthStatusSummariesobject
MachineIdsForCalamariUpgradestring[]
MachineIdsForTentacleUpgradestring[]
TentacleUpgradesRequiredboolean
TotalDisabledMachinesinteger
TotalMachinesinteger

Example response

{
  "WorkerPoolSummaries": [
    {
      "WorkerPool": {
        "Links": {
          "Self": "/api/..."
        },
        "SpaceId": "Spaces-1"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 13 revisions of this API.