Environments

List all environments, including a summary of machine information

get/spaces/{spaceIdentifier}/environments/summary

Request

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

spaceIdentifierstring required

Identifier (ID or slug) of the space

Query parameters

commStylesstring[]
deploymentTargetTypesstring[]
environmentTagsstring[]
healthStatusesstring[]
hideEmptyEnvironmentsboolean
idsstring[]
isDisabledboolean
machinePartialNamestring
partialNamestring
rolesstring[]
shellNamesstring[]
targetTagsstring[]
tenantIdsstring[]
tenantTagsstring[]

Response

Contains the machines et al associated with a given environment.

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

Example response

{
  "EnvironmentSummaries": [
    {
      "Environment": {
        "ExtensionSettings": [],
        "Links": {
          "Self": "/api/..."
        },
        "SpaceId": "Spaces-1"
      }
    }
  ]
}

Changes

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