GET Domains

Get all domains.

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 domains.
  • NotDeleted: All domains that are not currently being deleted. (default)

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)

Type: String

skip

See Filtering, Arranging, and Paging.

Type: Number

take

See Filtering, Arranging, and Paging.

Type: Number

Response Information

A list of domains.

Response type

CollectionResultModel<DomainModel>

Response body formats

application/json, text/json

Sample:
{
  "Href": "[api:Domains]",
  "Count": 1,
  "TotalMatchingFilter": 1,
  "Items": [
    {
      "Href": "[api:Domains(241b45cc-261d-47d0-81d7-a0a41c54c760)]",
      "Id": "241b45cc-261d-47d0-81d7-a0a41c54c760",
      "ChangeId": "7",
      "DeleteState": "NotDeleted",
      "Name": "domain1.local",
      "Type": "Both",
      "IsPasswordProtected": true,
      "OrchestrationServiceUserName": "DOMAIN\\orch",
      "IsInUse": true,
      "ProductInstallUserName": "DOMAIN\\install",
      "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"
          }
        ]
      },
      "Tags": [
        "tag"
      ],
      "CustomProperties": [
        {
          "Name": "myProperty",
          "Value": "myValue"
        }
      ],
      "NumTenants": 1
    }
  ]
}