Environments

List all environments, including a summary of machine information

get/spaces/{spaceIdentifier}/environments/summary/v2

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[]
typestring[]

Filters the environment summaries using the specified environment 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 endpoint across all 7 revisions of this API.