PUT DeliverySites({id})

Updates a delivery site.

Request Information

Parameters

NameDescriptionAdditional information
id

ID of the delivery site to update.

Type: String

changeId

See Optimistic Concurrency.

Type: String

Request body type

UpdateDeliverySiteModel

Request body formats

application/json, text/json

Sample:
{
  "Description": "my delivery site",
  "Tags": [
    "tag"
  ],
  "CustomProperties": [
    {
      "Name": "myProperty",
      "Value": "myValue"
    }
  ],
  "MaxSessionMachines": 10000,
  "AdministratorUserName": "DOMAIN\\user",
  "AdministratorPasswordBase64": "cGFzc3dvcmQ=",
  "Servers": [
    "controller1",
    "controller2"
  ]
}

Response Information

The updated delivery site.

Response type

DeliverySiteModel

Response body formats

application/json, text/json

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