Environments

List all environments, including a summary of machine information

get/{spaceId}/environments/summary/v2

Request

  • Base URL
    https://demo.octopus.app/api
  • URL
    https://demo.octopus.app/api/{spaceId}/environments/summary/v2
  • 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[]

Filters deployment targets by communication style.

deploymentTargetTypesstring[]

Filters deployment targets by endpoint type ID.

environmentTagsstring[]

Filters environment summaries by environment tag.

healthStatusesstring[]

Filters deployment targets by health status.

hideEmptyEnvironmentsboolean

Excludes environments with no matching deployment targets.

idsstring[]

Filters environment summaries by environment ID.

isDisabledboolean

Filters deployment targets by whether they are disabled.

machinePartialNamestring

Filters deployment targets by a partial name.

partialNamestring

Filters environment summaries by a partial environment name.

rolesstring[]

Filters deployment targets by role.

shellNamesstring[]

Filters deployment targets by shell name.

targetTagsstring[]

Filters deployment targets by target tag.

tenantIdsstring[]

Filters deployment targets by tenant ID.

tenantTagsstring[]

Filters deployment targets by tenant tag.

typestring[]

Filters environment summaries by EnvironmentType.

Response

Contains the machines et al associated with a given environment.

DeploymentTargetSummariesobject required
MachineEndpointSummariesobject required
MachineHealthStatusSummariesobject required
MachineIdsForCalamariUpgradestring[] required
MachineTenantSummariesobject required
MachineTenantTagSummariesobject required
TentacleUpgradesRequiredboolean required
TotalDisabledMachinesinteger required
TotalMachinesinteger required

Example response

{
  "EnvironmentSummaries": [
    {
      "Environment": {
        "Id": "Environments-1",
        "SpaceId": "Spaces-1"
      }
    }
  ]
}

Changes

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