---
title: "Summarise deployment targets and their health by deployment target type"
method: GET
path: "/{spaceId}/machines/summary"
tags: ["DeploymentTargets"]
---

# Summarise deployment targets and their health by deployment target type

`GET /{spaceId}/machines/summary`

## Request

- Base URL: `https://demo.octopus.app/api`
- URL: `https://demo.octopus.app/api/{spaceId}/machines/summary`
- Auth: one of:
  - API key in header `X-Octopus-ApiKey`
  - API key in query parameter `ApiKey`
  - API key in header `X-NuGet-ApiKey`

Counts the deployment targets in the supplied Octopus Deploy Space, grouped by deployment target type, with a breakdown by health status. Accepts the same filters as listing machines.

## Path parameters

- `spaceId` string, required

## Query parameters

- `commStyles` string[]
- `deploymentTargetTypes` string[]
- `environmentIds` string[]
- `healthStatuses` string[]
- `ids` string[]
- `isDisabled` boolean
- `operatingSystemNames` string[]
- `partialName` string
- `roles` string[]
- `shellNames` string[]
- `targetTags` string[]
- `tenantIds` string[]
- `tenantTags` string[]

## Response `200`

Deployment target counts and health, overall and per deployment target type.

- GetDeploymentTargetsSummaryResponse
  - `DeploymentTargetTypeSummaries` DeploymentTargetTypeSummaryResource[], required: Summaries per deployment target type, ordered by the number of deployment targets, largest first.
    - `DeploymentTargetType` string, required
    - `MachineHealthStatusSummaries` object, required
    - `TotalDisabledMachines` integer, required
    - `TotalMachines` integer, required
  - `MachineHealthStatusSummaries` object, required: Count of deployment targets per health status. Disabled targets are only counted in TotalDisabledMachines.
  - `TotalDisabledMachines` integer, required
  - `TotalMachines` integer, required

## 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.

## Changes

- **2026-10-12** `0d1041ae25f6`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/octopus/apis/octopus-server-api/changes/:spaceId/machines/summary/get.md)

---

[API](https://skmtc.dev/octopus/apis/octopus-server-api.md) - [All operations](https://skmtc.dev/octopus/apis/octopus-server-api/llms.txt) - [OpenAPI document](https://skmtc.dev/octopus/apis/octopus-server-api/revisions/fe937c07da34?raw)
