Help Page Home

# GET DeliverySites({id})/SessionMachines

Get the session machines in a delivery site.

## Request Information

### Parameters

Name | Description | Additional information
--- | --- | ---
id | ID of the delivery site. | Type:
name | See Filtering, Arranging, and Paging. | Type: String
filterBy | See Filtering, Arranging, and Paging. The supported filters are: All: All session machines. NotDeleted: All session machines that are not currently being deleted. (default) CurrentVersion: All session machines that are at the current version of their session machine catalog. OldVersion: All session machines that are not at the current version of their session machine catalog. Allocated: All session machines that are allocated. Draining: All session machines that are draining user sessions. UpdatePending: All session machines that are pending update. NotUsed: All session machines that are not used as part of a delivery group. | Type: Filter
filterProp | See Filtering, Arranging, and Paging. | Type: String
arrangeBy | See Filtering, Arranging, and Paging. The supported arrangers are: Name: Arrange by name. (default) Tenant: Arrange by tenant who the session machine is allocated to. SessionMachineCatalog: Arrange by the session machine catalog that the session machine is a member of. | Type: String
skip | See Filtering, Arranging, and Paging. | Type: Number
take | See Filtering, Arranging, and Paging. | Type: Number

## Response Information

A list of session machines.

### Response type

CollectionResultModel<SessionMachineModel>

### Response body formats

#### application/json, text/json

Sample:

    {
      "Href": "[api:DeliverySites(0ef3e68d-bb8e-4b69-9c30-ae3fac533996)/SessionMachines]",
      "Count": 1,
      "TotalMatchingFilter": 1,
      "Items": [
        {
          "Href": "[api:SessionMachines(77b50020-4252-453c-815b-ce9b9412d543)]",
          "Id": "77b50020-4252-453c-815b-ce9b9412d543",
          "ChangeId": "12",
          "Name": "machine1",
          "DeleteState": "NotDeleted",
          "State": "Allocated",
          "IsShared": false,
          "VersionUpdatePending": false,
          "SessionMachineCatalogVersion": 2,
          "SessionMachineCatalog": {
            "Href": "[api:SessionMachineCatalogs(628fa898-0c36-4024-8fe4-d7e9a9bfbcfa)]",
            "Name": "catalog 1",
            "Id": "628fa898-0c36-4024-8fe4-d7e9a9bfbcfa"
          },
          "MachineDetail": {
            "Href": "[api:MachineDetails(bff69e21-c280-488b-ad9e-74b674ffb7c9)]",
            "Name": "machine1",
            "Id": "bff69e21-c280-488b-ad9e-74b674ffb7c9"
          },
          "DeliveryGroup": {
            "Href": "[api:DeliveryGroups(c004375e-a96d-4368-96ba-c80702d7e80f)]",
            "Name": "dg1",
            "Id": "c004375e-a96d-4368-96ba-c80702d7e80f"
          },
          "DeliverySite": {
            "Href": "[api:DeliverySites(0ef3e68d-bb8e-4b69-9c30-ae3fac533996)]",
            "Name": "site1",
            "Id": "0ef3e68d-bb8e-4b69-9c30-ae3fac533996"
          },
          "Tenant": {
            "Href": "[api:Tenants(91ade655-feb5-47d3-9585-a5827ad50132)]",
            "Name": "Tenant 1",
            "Id": "91ade655-feb5-47d3-9585-a5827ad50132"
          },
          "Tags": [
            "tag"
          ],
          "CustomProperties": [
            {
              "Name": "myProperty",
              "Value": "myValue"
            }
          ],
          "HealthSummary": {
            "ActiveCount": 0,
            "ErrorCount": 0,
            "WarningCount": 0,
            "InfoCount": 1,
            "Messages": [
              {
                "Text": "Attempting to reach desired capacity",
                "IsError": false,
                "IsWarning": false,
                "IsInfo": false,
                "IsActive": true,
                "Type": "Allocation"
              }
            ]
          },
          "Domain": {
            "Href": "[api:Domains(241b45cc-261d-47d0-81d7-a0a41c54c760)]",
            "Name": "domain1.local",
            "Id": "241b45cc-261d-47d0-81d7-a0a41c54c760"
          },
          "Network": "network1",
          "DataCenter": {
            "Href": "[api:DataCenters(af1fc9c4-dee5-4b0d-836c-9e1c5b57a88a)]",
            "Name": "datacenter1",
            "Id": "af1fc9c4-dee5-4b0d-836c-9e1c5b57a88a"
          },
          "UserName": "DOMAIN\\user1",
          "UserTenant": {
            "Href": "[api:Tenants(91ade655-feb5-47d3-9585-a5827ad50132)]",
            "Name": "Tenant 1",
            "Id": "91ade655-feb5-47d3-9585-a5827ad50132"
          }
        }
      ]
    }