Environments

Return the list of machines in an environment that matches the filters requested by the user.

get/environments/{id}/machines

Path parameters

idstring required

ID of the Environment

Query parameters

commStylesstring[]
deploymentTargetTypesstring[]
healthStatusesstring[]
isDisabledboolean
partialNamestring
rolesstring[]
shellNamesstring[]
skipinteger

Number of items to skip. Defaults to zero

takeinteger

Number of items per page. Defaults to 20

targetTagsstring[]
tenantIdsstring[]
tenantTagsstring[]

Response

The lists of all machines that belong to the given environment, and matches any specified filters.

Idstring

Gets or sets a unique identifier for this resource.

ItemsPerPageinteger
ItemTypestring
LastModifiedBystring

Gets or sets the username of the user who last modified this resource.

LastModifiedOnstring date-time

Gets or sets the date/time that this resource was last modified.

LastPageNumberinteger
Linksobject

Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.

NumberOfPagesinteger
TotalResultsinteger

Example response

{
  "Items": [
    {
      "EnvironmentIds": [
        "Environments-1",
        "..."
      ],
      "SpaceId": "Spaces-1",
      "TenantIds": [
        "Tenants-1",
        "..."
      ]
    }
  ]
}

Changes

No recorded changes to this endpoint across all 7 revisions of this API.