GET DataCenters

Get all datacenters.

Request Information

Parameters

NameDescriptionAdditional information
name

See Filtering, Arranging, and Paging.

Type: String

filterBy

See Filtering, Arranging, and Paging. The supported filters are:

  • All: All datacenters.
  • NotDeleted: All datacenters that are not currently being deleted. (default)
  • Empty: Only datacenters that do not contain any machines (session machines, delivery controllers, or StoreFront servers).
  • NotUsed: Only datacenters that do not contain any delivery groups.

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)
  • TotalItems: Arrange by the total number of machines (session machines, delivery controllers, and StoreFront servers) in the datacenter.

Type: String

skip

See Filtering, Arranging, and Paging.

Type: Number

take

See Filtering, Arranging, and Paging.

Type: Number

Response Information

A list of datacenters.

Response type

CollectionResultModel<DataCenterModel>

Response body formats

application/json, text/json

Sample:
{
  "Href": "[api:DataCenters]",
  "Count": 1,
  "TotalMatchingFilter": 1,
  "Items": [
    {
      "Href": "[api:DataCenters(af1fc9c4-dee5-4b0d-836c-9e1c5b57a88a)]",
      "Id": "af1fc9c4-dee5-4b0d-836c-9e1c5b57a88a",
      "ChangeId": "4",
      "DeleteState": "NotDeleted",
      "Name": "datacenter1",
      "ShortName": "datacenter1",
      "Description": "My datacenter",
      "Tags": [
        "tag"
      ],
      "CustomProperties": [
        {
          "Name": "myProperty",
          "Value": "myValue"
        }
      ],
      "LicenseServerAddress": "ctxlicense.mydomain.com",
      "LicenseServerAddressPort": 27000,
      "NetScalerGatewayAddress": "https://ag.datacenter1.mydomain.com",
      "NumDeliverySites": 2,
      "NumStoreFrontServerGroups": 5,
      "NumSessionMachines": 1000,
      "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"
          }
        ]
      }
    }
  ]
}