Help Page Home

# GET MachineDetails

Get details of all machines (session machines, delivery controllers, and StoreFront servers).

## Request Information

### Parameters

Name | Description | Additional information
--- | --- | ---
name | See Filtering, Arranging, and Paging. | Type: String
filterBy | See Filtering, Arranging, and Paging. The supported filters are: All: All machines (session machines, delivery controllers, and StoreFront servers). NotDeleted: All machines (session machines, delivery controllers, and StoreFront servers) that are not currently being deleted. (default) NotUsed: All session machines that are not part of a delivery group. Allocated: All machines that are allocated either for shared use, or to a tenant. Includes allocated session machines and delivery controllers that are part of an allocated delivery site. CurrentVersion: All session machines that are updated to the latest version of their session machine catalog. UpdatePending: All session machines that have an update pending. Draining: All session machines that are currently draining user sessions. OldVersion: All session machines that are not updated to the latest version of their session machine catalog. | 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. SessionMachineCatalog: Arrange by session machine catalog. | Type: String
skip | See Filtering, Arranging, and Paging. | Type: Number
take | See Filtering, Arranging, and Paging. | Type: Number

## Response Information

A list of machine details.

### Response type

CollectionResultModel<MachineDetailModel>

### Response body formats

#### application/json, text/json

Sample:

    {
      "Href": "[api:MachineDetails]",
      "Count": 1,
      "TotalMatchingFilter": 1,
      "Items": [
        {
          "Href": "[api:MachineDetails(bff69e21-c280-488b-ad9e-74b674ffb7c9)]",
          "Id": "bff69e21-c280-488b-ad9e-74b674ffb7c9",
          "ChangeId": "3",
          "Name": "machine1",
          "DeleteState": "NotDeleted",
          "Architecture": "x64",
          "CPUs": 2,
          "MemoryMB": 4096,
          "OSName": "Windows Server 2008 R2",
          "OSVersion": "Service Pack 1",
          "Capabilities": "CAP1,CAP2",
          "MachineType": "SessionMachine",
          "DeliveryController": {
            "Href": "[api:DeliveryControllers(34c04635-50fc-4506-99fc-da1b459fbefa)]",
            "Name": "controller1",
            "Id": "34c04635-50fc-4506-99fc-da1b459fbefa"
          },
          "SessionMachine": {
            "Href": "[api:SessionMachines(77b50020-4252-453c-815b-ce9b9412d543)]",
            "Name": "machine1",
            "Id": "77b50020-4252-453c-815b-ce9b9412d543"
          },
          "DeliveryControllerArchitecture": "FMA",
          "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"
          },
          "SID": "S-1-5-20-12123131231",
          "Tenant": {
            "Href": "[api:Tenants(91ade655-feb5-47d3-9585-a5827ad50132)]",
            "Name": "Tenant 1",
            "Id": "91ade655-feb5-47d3-9585-a5827ad50132"
          },
          "SessionMachineCatalog": {
            "Href": "[api:SessionMachineCatalogs(628fa898-0c36-4024-8fe4-d7e9a9bfbcfa)]",
            "Name": "catalog 1",
            "Id": "628fa898-0c36-4024-8fe4-d7e9a9bfbcfa"
          },
          "DataCenter": {
            "Href": "[api:DataCenters(af1fc9c4-dee5-4b0d-836c-9e1c5b57a88a)]",
            "Name": "datacenter1",
            "Id": "af1fc9c4-dee5-4b0d-836c-9e1c5b57a88a"
          },
          "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"
              }
            ]
          }
        }
      ]
    }