GET DeliveryGroups({id})/DeliverySites

Get the delivery sites hosting a delivery group.

Note: Multiple delivery sites may be required for a delivery group when its size exceeds the remaining capacity in one delivery group.

Request Information

Parameters

Name	Description	Additional information
id	ID of the delivery group.	Type:
name	See Filtering, Arranging, and Paging.	Type: String
filterBy	See Filtering, Arranging, and Paging. The supported filters are: All: All delivery sites. NotDeleted: All delivery sites that are not currently being deleted. (default) Allocated: Only delivery sites that are allocated either for shared use, or to a single tenant. NotUsed: Only delivery sites that do not contain any delivery groups. Empty: Only delivery sites that do not contain any session machines. Aggregation: Only delivery sites that are used for StoreFront site aggregation only.	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 the tenant who the delivery site is allocated to.	Type: String
skip	See Filtering, Arranging, and Paging.	Type: Number
take	See Filtering, Arranging, and Paging.	Type: Number

Response Information

A list of delivery sites.

Response type

CollectionResultModel<DeliverySiteModel>

Response body formats

application/json, text/json

Sample:

{
  "Href": "[api:DeliveryGroups(c004375e-a96d-4368-96ba-c80702d7e80f)/DeliverySites]",
  "Count": 1,
  "TotalMatchingFilter": 1,
  "Items": [
    {
      "Href": "[api:DeliverySites(0ef3e68d-bb8e-4b69-9c30-ae3fac533996)]",
      "Id": "0ef3e68d-bb8e-4b69-9c30-ae3fac533996",
      "ChangeId": "11",
      "Name": "site1",
      "Description": "my delivery site",
      "Tags": [
        "tag"
      ],
      "CustomProperties": [
        {
          "Name": "myProperty",
          "Value": "myValue"
        }
      ],
      "DeleteState": "NotDeleted",
      "IsShared": false,
      "ProductType": "XenDesktop71",
      "DeliveryControllerArchitecture": "FMA",
      "Tenant": {
        "Href": "[api:Tenants(91ade655-feb5-47d3-9585-a5827ad50132)]",
        "Name": "Tenant 1",
        "Id": "91ade655-feb5-47d3-9585-a5827ad50132"
      },
      "AllocationStatus": "Allocated",
      "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"
          }
        ]
      },
      "Domain": {
        "Href": "[api:Domains(241b45cc-261d-47d0-81d7-a0a41c54c760)]",
        "Name": "domain1.local",
        "Id": "241b45cc-261d-47d0-81d7-a0a41c54c760"
      },
      "NetworkName": "Shared Controller Management Network",
      "NumSessionMachines": 10,
      "MaxSessionMachines": 10000,
      "AdministratorUserName": "DOMAIN\\ctxadmin",
      "AdministratorGroup": "DOMAIN\\CitrixAdmins",
      "DeliverySiteUsageType": "Managed",
      "DBServerName": "sqlserver.csp.local",
      "DBName": "site1"
    }
  ]
}