DeploymentTargets

Summarise deployment targets and their health by deployment target type

Changed on

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.

get/{spaceId}/machines/summary

Request

  • Base URL
    https://demo.octopus.app/api
  • URL
    https://demo.octopus.app/api/{spaceId}/machines/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

The ID of the space containing the resource(s).

Query parameters

commStylesstring[]

List of communication styles which if specified, filters the result to only include Deployment Targets with matching communication styles.

deploymentTargetTypesstring[]

List of deployment target types which if specified, filters the result to only include Deployment Targets with matching types.

environmentIdsstring[]

List of Environment IDs which if specified, filters the result to only include Deployment Targets with matching Environment IDs.

healthStatusesstring[]

List of health statuses which if specified, filters the result to only include Deployment Targets with matching health statuses.

idsstring[]

List of Deployment Target IDs which if specified, filters the result to only include Deployment Targets with matching IDs.

isDisabledboolean

A filter to return only disabled/enabled Deployment Targets

operatingSystemNamesstring[]

List of operating system names which if specified, filters the result to only include Deployment Targets with matching operating systems.

partialNamestring

A partial or complete name to search on. This will perform a "contains" style match against the supplied name or name-fragment

rolesstring[]

List of roles which if specified, filters the result to only include Deployment Targets with matching roles.

shellNamesstring[]

List of shell names which if specified, filters the result to only include Deployment Targets with matching shells.

targetTagsstring[]

List of Target Tags which if specified, filters the result to only include Deployment Targets with matching Target Tags.

tenantIdsstring[]

List of Tenant IDs which if specified, filters the result to only include Deployment Targets with matching Tenant IDs.

tenantTagsstring[]

List of Tenant Tags which if specified, filters the result to only include Deployment Targets with matching Tenant Tags.

Response

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

MachineHealthStatusSummariesobject required

Count of deployment targets per health status. Disabled targets are only counted in TotalDisabledMachines.

TotalDisabledMachinesinteger required
TotalMachinesinteger required

Changes