POST Domains

Create a new domain.

Request Information

Request body type

Request body formats

application/json, text/json

Sample:

{
  "Name": "domain1.local",
  "Type": "Both",
  "IsPasswordProtected": true,
  "DomainPasswordBase64": "cGFzc3dvcmQ=",
  "OrchestrationServiceUserName": "DOMAIN\\orch",
  "OrchestrationServicePasswordBase64": "cGFzc3dvcmQ=",
  "ProductInstallUserName": "DOMAIN\\install",
  "ProductInstallPasswordBase64": "cGFzc3dvcmQ=",
  "Tags": [
    "tag"
  ],
  "CustomProperties": [
    {
      "Name": "myProperty",
      "Value": "myValue"
    }
  ]
}

Response Information

The newly created domain.

Response type

DomainModel

Response body formats

application/json, text/json

Sample:

{
  "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
}