Products
Support
Partners
Documentation

RDS

List

Retrieve a list of all the published RD Session Host desktops

GET/api/PubItems/Desktops/RDS
Query parameters
Response

Success

Body
idinteger (int32)

ID of the object.

adminCreatenullable string

User who created the object.

adminLastModnullable string

User who last modified the object.

timeCreatestring (date-time)

Time when the object was created.

timeLastModstring (date-time)

Time when the object was last modified.

maintenanceMessagesobject

Contains a set of maintenance messages in various languages

inheritMaintenanceboolean

Inherit Maintenance.

replicateMaintenanceboolean

Replicate Maintenance.

namenullable string

Name of the published item.

typeenum

RAS Publishing Objects

0 = Any,1 = Folder,2 = RDSApp,3 = RDSDesktop,4 = VDIDesktop,5 = PCDesktop,6 = PCApp,7 = VDIApp,8 = AVDApp,9 = AVDDesktop
parentIdinteger (int32)

ID of the parent folder of the published item.

previousIdinteger (int32)

ID of the previous published item.

descriptionnullable string

Description of the published item.

enabledModeenum

Published resource availability modes.

0 = Disabled,1 = Enabled,2 = Maintenance
enabledboolean

Whether the published item is enabled or not.

publishToSitenullable array of integer (int32)

List of the IDs of all the sites this item is published to.

userFilterEnabledboolean

Whether User Filtering is enabled or not (deprecated).

allowedUsersnullable array of object

Lists the allowed users (deprecated).

clientFilterEnabledboolean

Whether Client Filtering is enabled or not (deprecated).

allowedClientsnullable array of string

Lists the allowed clients (deprecated).

ipFilterEnabledboolean

Whether IP Filtering is enabled or not (deprecated).

allowedIP4snullable array of object

Lists the allowed IPv4 addresses (deprecated).

allowedIP6snullable array of object

Lists the allowed IPV6 addresses (deprecated).

macFilterEnabledboolean

Whether MAC address Filtering is enabled or not (deprecated).

allowedMACsnullable array of string

Lists the allowed MAC addresses (deprecated).

allowedGatewaysnullable array of string

Lists the allowed Gateways (deprecated).

osFilterEnabledboolean

Whether OS Filtering is enabled or not (deprecated).

allowedOSesobject

Allowed Operating Systems

preferredRoutingEnabledboolean

Whether Preferred Routing is enabled or not.

preferredRoutesnullable array of object

The list of Preferred Routes.

filterobject

The PubItem Filter object.

startOnLogonboolean

Whether the 'Start automatically when user logs on' option is enabled or disabled.

excludePrelaunchboolean

Exclude application from prelaunch.

inheritShortcutDefaultSettingsboolean

Whether to inherit default shortcut settings or not.

createShortcutOnDesktopboolean

Whether to create a shortcut on the desktop or not.

createShortcutInStartFolderboolean

Whether to create a shortcut in the start folder or not.

startPathnullable string

Starting path of the published item.

createShortcutInStartUpFolderboolean

Whether to create a shortcut in the startup folder or not.

replicateShortcutSettingsboolean

Whether to replicate shortcut settings or not.

desktopSizeenum

Desktop size options for published desktops.

0 = UseAvailableArea,1 = FullScreen,2 = W640xH480,3 = W800xH600,4 = W854xH480,5 = W1024xH576,6 = W1024xH768,7 = W1152xH864,8 = W1280xH720,9 = W1280xH768,10 = W1280xH800,11 = W1280xH960,12 = W1280xH1024,13 = W1360xH768,14 = W1366xH768,15 = W1400xH1050,16 = W1440xH900,17 = W1600xH900,18 = W1600xH1024,19 = W1600xH1200,20 = W1680xH1050,21 = W1920xH1080,22 = W1920xH1200,23 = W1920xH1440,24 = W2048xH1152,25 = Custom
widthinteger (int32)

Desktop width.

heightinteger (int32)

Desktop height.

allowMultiMonitorenum

Multi-monitor options for published desktops.

0 = Enabled,1 = Disabled,2 = UseClientSettings
connectToConsoleboolean

Connect to console

publishFromServernullable array of integer (int32)

List of servers to publish from.

publishFromHostPoolnullable array of integer (int32)

List of groups to publish from.

publishFromenum

Publish From' options for published items.

0 = All,1 = HostPool,2 = Host
Request
const response = await fetch('/api/PubItems/Desktops/RDS', {
    method: 'GET',
    headers: {},
});
const data = await response.json();
Response
{
  "id": 1,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2025-02-05T03:50:00.029Z",
  "timeLastMod": "2025-02-05T03:50:00.029Z",
  "maintenanceMessages": {
    "maintenanceMessage_en_US": "text",
    "maintenanceMessage_ja_JP": "text",
    "maintenanceMessage_fr_FR": "text",
    "maintenanceMessage_es_ES": "text",
    "maintenanceMessage_it_IT": "text",
    "maintenanceMessage_pt_BR": "text",
    "maintenanceMessage_nl_NL": "text",
    "maintenanceMessage_zh_TW": "text",
    "maintenanceMessage_zh_CN": "text",
    "maintenanceMessage_ko_KR": "text",
    "maintenanceMessage_de_DE": "text"
  },
  "inheritMaintenance": true,
  "replicateMaintenance": true,
  "name": "text",
  "type": [
    "0 = Any",
    "1 = Folder",
    "2 = RDSApp",
    "3 = RDSDesktop",
    "4 = VDIDesktop",
    "5 = PCDesktop",
    "6 = PCApp",
    "7 = VDIApp",
    "8 = AVDApp",
    "9 = AVDDesktop"
  ],
  "parentId": 1,
  "previousId": 1,
  "description": "text",
  "enabledMode": [
    "0 = Disabled",
    "1 = Enabled",
    "2 = Maintenance"
  ],
  "enabled": true,
  "publishToSite": [
    1
  ],
  "userFilterEnabled": true,
  "allowedUsers": [
    {
      "account": "text",
      "type": [
        "1 = User",
        "2 = Group",
        "3 = ForeignSecurityPrincipal",
        "4 = Computer"
      ],
      "sid": "text"
    }
  ],
  "clientFilterEnabled": true,
  "allowedClients": [
    "text"
  ],
  "ipFilterEnabled": true,
  "allowedIP4s": [
    {
      "from": "text",
      "to": "text"
    }
  ],
  "allowedIP6s": [
    {
      "from": "text",
      "to": "text"
    }
  ],
  "macFilterEnabled": true,
  "allowedMACs": [
    "text"
  ],
  "gatewayFilterEnabled": true,
  "allowedGateways": [
    "text"
  ],
  "osFilterEnabled": true,
  "allowedOSes": {
    "chrome": true,
    "android": true,
    "webClient": true,
    "iOS": true,
    "linux": true,
    "mac": true,
    "wyse": true,
    "windows": true
  },
  "preferredRoutingEnabled": true,
  "preferredRoutes": [
    {
      "id": 1,
      "priority": 1,
      "name": "text",
      "description": "text",
      "enabled": true,
      "referenceType": [
        "3 = Gateway",
        "51 = HALB",
        "83 = Custom"
      ],
      "referenceId": 1
    }
  ],
  "filter": {
    "rules": [
      {
        "id": 1,
        "priority": 1,
        "enabled": true,
        "name": "text",
        "description": "text",
        "criteria": {
          "securityPrincipals": {
            "enabled": true,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "members": [
              {
                "account": "text",
                "type": [
                  "1 = User",
                  "2 = Group",
                  "3 = ForeignSecurityPrincipal",
                  "4 = Computer"
                ],
                "sid": "text"
              }
            ]
          },
          "gateways": {
            "enabled": true,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "members": [
              {
                "gatewayIP": "text"
              }
            ]
          },
          "oSs": {
            "enabled": true,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "allowedOSes": {
              "chrome": true,
              "android": true,
              "webClient": true,
              "iOS": true,
              "linux": true,
              "mac": true,
              "wyse": true,
              "windows": true
            }
          },
          "iPs": {
            "enabled": true,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "allowedIPs": {
              "iPv4s": [
                {
                  "from": "text",
                  "to": "text"
                }
              ],
              "iPv6s": [
                {
                  "from": "text",
                  "to": "text"
                }
              ]
            }
          },
          "hardwareIDs": {
            "enabled": true,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "members": [
              {
                "hardwareID": "text"
              }
            ]
          },
          "access": [
            "0 = DenyCriteriaWhen",
            "1 = AllowCriteriaWhen"
          ],
          "devices": {
            "enabled": true,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "members": [
              {
                "client": "text"
              }
            ]
          },
          "themes": {
            "enabled": true,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "ids": [
              1
            ]
          }
        }
      }
    ],
    "default": [
      "0 = Deny",
      "1 = Allow"
    ]
  },
  "startOnLogon": true,
  "excludePrelaunch": true,
  "inheritShortcutDefaultSettings": true,
  "createShortcutOnDesktop": true,
  "createShortcutInStartFolder": true,
  "startPath": "text",
  "createShortcutInStartUpFolder": true,
  "replicateShortcutSettings": true,
  "desktopSize": [
    "0 = UseAvailableArea",
    "1 = FullScreen",
    "2 = W640xH480",
    "3 = W800xH600",
    "4 = W854xH480",
    "5 = W1024xH576",
    "6 = W1024xH768",
    "7 = W1152xH864",
    "8 = W1280xH720",
    "9 = W1280xH768",
    "10 = W1280xH800",
    "11 = W1280xH960",
    "12 = W1280xH1024",
    "13 = W1360xH768",
    "14 = W1366xH768",
    "15 = W1400xH1050",
    "16 = W1440xH900",
    "17 = W1600xH900",
    "18 = W1600xH1024",
    "19 = W1600xH1200",
    "20 = W1680xH1050",
    "21 = W1920xH1080",
    "22 = W1920xH1200",
    "23 = W1920xH1440",
    "24 = W2048xH1152",
    "25 = Custom"
  ],
  "width": 1,
  "height": 1,
  "allowMultiMonitor": [
    "0 = Enabled",
    "1 = Disabled",
    "2 = UseClientSettings"
  ],
  "connectToConsole": true,
  "publishFromServer": [
    1
  ],
  "publishFromHostPool": [
    1
  ],
  "publishFrom": [
    "0 = All",
    "1 = HostPool",
    "2 = Host"
  ]
}

Create

Add a published RD Session Host desktop to a site.

POST/api/PubItems/Desktops/RDS
Body
name*nullable string

Published resource name.

parentIdnullable integer (int32)

Parent publishing folder ID.

previousIdnullable integer (int32)

Previous published ID.

replicateMaintenancenullable boolean

Whether the option 'Replicate Maintenance' is enabled or not.

inheritMaintenancenullable boolean

Whether to inherit default Maintenance settings.

enabledModeenum

Published resource availability modes.

0 = Disabled,1 = Enabled,2 = Maintenance
maintenanceMessage_en_USnullable string

Maintenance message for the published resource in English.

maintenanceMessage_ja_JPnullable string

Maintenance message for the published resource in Japanese.

maintenanceMessage_fr_FRnullable string

Maintenance message for the published resource in French.

maintenanceMessage_es_ESnullable string

Maintenance message for the published resource in Spanish.

maintenanceMessage_it_ITnullable string

Maintenance message for the published resource in Italian.

maintenanceMessage_pt_BRnullable string

Maintenance message for the published resource in Portuguese.

maintenanceMessage_de_DEnullable string

Maintenance message for the published resource in German.

maintenanceMessage_nl_NLnullable string

Maintenance message for the published resource in Dutch.

maintenanceMessage_zh_TWnullable string

Maintenance message for the published resource in Chinese (Traditional).

maintenanceMessage_zh_CNnullable string

Maintenance message for the published resource in Chinese (Simplified).

maintenanceMessage_ko_KRnullable string

Maintenance message for the published resource in Korean.

descriptionnullable string

Published resource description.

publishToSiteIdsnullable array of integer (int32)

An array of Sites IDs to which to publish a resource.

siteIdinteger (int32)

Site ID in which to publish the specified Item. If the parameter is omitted, the site ID of the Licensing Server will be used.

startOnLogonboolean

Enable or disable the 'Start automatically when user logs on' option.

widthinteger (int32)

Specifies a custom desktop width.

heightinteger (int32)

Specifies a custom desktop height.

desktopSizeenum

Desktop size options for published desktops.

0 = UseAvailableArea,1 = FullScreen,2 = W640xH480,3 = W800xH600,4 = W854xH480,5 = W1024xH576,6 = W1024xH768,7 = W1152xH864,8 = W1280xH720,9 = W1280xH768,10 = W1280xH800,11 = W1280xH960,12 = W1280xH1024,13 = W1360xH768,14 = W1366xH768,15 = W1400xH1050,16 = W1440xH900,17 = W1600xH900,18 = W1600xH1024,19 = W1600xH1200,20 = W1680xH1050,21 = W1920xH1080,22 = W1920xH1200,23 = W1920xH1440,24 = W2048xH1152,25 = Custom
allowMultiMonitorenum

Multi-monitor options for published desktops.

0 = Enabled,1 = Disabled,2 = UseClientSettings
connectToConsoleboolean

Enable or disable the 'Connect to console' option.

publishFromenum

Publish From' options for published items.

0 = All,1 = HostPool,2 = Host
publishFromHostPoolIdsnullable array of integer (int32)

Specifies one or multiple host pool Ids from which to publish a desktop. The PublishFrom parameter must specify 1 (HostPool).

publishFromServerIdsnullable array of integer (int32)

Specifies one or multiple RDS Host server Ids from which to publish a desktop. The PublishFrom parameter must specify 2 (Host).

Response

Created

Body
idinteger (int32)

ID of the object.

adminCreatenullable string

User who created the object.

adminLastModnullable string

User who last modified the object.

timeCreatestring (date-time)

Time when the object was created.

timeLastModstring (date-time)

Time when the object was last modified.

maintenanceMessagesobject

Contains a set of maintenance messages in various languages

inheritMaintenanceboolean

Inherit Maintenance.

replicateMaintenanceboolean

Replicate Maintenance.

namenullable string

Name of the published item.

typeenum

RAS Publishing Objects

0 = Any,1 = Folder,2 = RDSApp,3 = RDSDesktop,4 = VDIDesktop,5 = PCDesktop,6 = PCApp,7 = VDIApp,8 = AVDApp,9 = AVDDesktop
parentIdinteger (int32)

ID of the parent folder of the published item.

previousIdinteger (int32)

ID of the previous published item.

descriptionnullable string

Description of the published item.

enabledModeenum

Published resource availability modes.

0 = Disabled,1 = Enabled,2 = Maintenance
enabledboolean

Whether the published item is enabled or not.

publishToSitenullable array of integer (int32)

List of the IDs of all the sites this item is published to.

userFilterEnabledboolean

Whether User Filtering is enabled or not (deprecated).

allowedUsersnullable array of object

Lists the allowed users (deprecated).

clientFilterEnabledboolean

Whether Client Filtering is enabled or not (deprecated).

allowedClientsnullable array of string

Lists the allowed clients (deprecated).

ipFilterEnabledboolean

Whether IP Filtering is enabled or not (deprecated).

allowedIP4snullable array of object

Lists the allowed IPv4 addresses (deprecated).

allowedIP6snullable array of object

Lists the allowed IPV6 addresses (deprecated).

macFilterEnabledboolean

Whether MAC address Filtering is enabled or not (deprecated).

allowedMACsnullable array of string

Lists the allowed MAC addresses (deprecated).

allowedGatewaysnullable array of string

Lists the allowed Gateways (deprecated).

osFilterEnabledboolean

Whether OS Filtering is enabled or not (deprecated).

allowedOSesobject

Allowed Operating Systems

preferredRoutingEnabledboolean

Whether Preferred Routing is enabled or not.

preferredRoutesnullable array of object

The list of Preferred Routes.

filterobject

The PubItem Filter object.

startOnLogonboolean

Whether the 'Start automatically when user logs on' option is enabled or disabled.

excludePrelaunchboolean

Exclude application from prelaunch.

inheritShortcutDefaultSettingsboolean

Whether to inherit default shortcut settings or not.

createShortcutOnDesktopboolean

Whether to create a shortcut on the desktop or not.

createShortcutInStartFolderboolean

Whether to create a shortcut in the start folder or not.

startPathnullable string

Starting path of the published item.

createShortcutInStartUpFolderboolean

Whether to create a shortcut in the startup folder or not.

replicateShortcutSettingsboolean

Whether to replicate shortcut settings or not.

desktopSizeenum

Desktop size options for published desktops.

0 = UseAvailableArea,1 = FullScreen,2 = W640xH480,3 = W800xH600,4 = W854xH480,5 = W1024xH576,6 = W1024xH768,7 = W1152xH864,8 = W1280xH720,9 = W1280xH768,10 = W1280xH800,11 = W1280xH960,12 = W1280xH1024,13 = W1360xH768,14 = W1366xH768,15 = W1400xH1050,16 = W1440xH900,17 = W1600xH900,18 = W1600xH1024,19 = W1600xH1200,20 = W1680xH1050,21 = W1920xH1080,22 = W1920xH1200,23 = W1920xH1440,24 = W2048xH1152,25 = Custom
widthinteger (int32)

Desktop width.

heightinteger (int32)

Desktop height.

allowMultiMonitorenum

Multi-monitor options for published desktops.

0 = Enabled,1 = Disabled,2 = UseClientSettings
connectToConsoleboolean

Connect to console

publishFromServernullable array of integer (int32)

List of servers to publish from.

publishFromHostPoolnullable array of integer (int32)

List of groups to publish from.

publishFromenum

Publish From' options for published items.

0 = All,1 = HostPool,2 = Host
Request
const response = await fetch('/api/PubItems/Desktops/RDS', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({
      "name": "text",
      "enabledMode": [
        "0 = Disabled",
        "1 = Enabled",
        "2 = Maintenance"
      ],
      "publishToSiteIds": [
        null
      ],
      "startOnLogon": false,
      "desktopSize": [
        "0 = UseAvailableArea",
        "1 = FullScreen",
        "2 = W640xH480",
        "3 = W800xH600",
        "4 = W854xH480",
        "5 = W1024xH576",
        "6 = W1024xH768",
        "7 = W1152xH864",
        "8 = W1280xH720",
        "9 = W1280xH768",
        "10 = W1280xH800",
        "11 = W1280xH960",
        "12 = W1280xH1024",
        "13 = W1360xH768",
        "14 = W1366xH768",
        "15 = W1400xH1050",
        "16 = W1440xH900",
        "17 = W1600xH900",
        "18 = W1600xH1024",
        "19 = W1600xH1200",
        "20 = W1680xH1050",
        "21 = W1920xH1080",
        "22 = W1920xH1200",
        "23 = W1920xH1440",
        "24 = W2048xH1152",
        "25 = Custom"
      ],
      "allowMultiMonitor": [
        "0 = Enabled",
        "1 = Disabled",
        "2 = UseClientSettings"
      ],
      "connectToConsole": false,
      "publishFrom": [
        "0 = All",
        "1 = HostPool",
        "2 = Host"
      ],
      "publishFromHostPoolIds": [
        null
      ],
      "publishFromServerIds": [
        null
      ]
    }),
});
const data = await response.json();
Response
{
  "id": 1,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2025-02-05T03:50:00.029Z",
  "timeLastMod": "2025-02-05T03:50:00.029Z",
  "maintenanceMessages": {
    "maintenanceMessage_en_US": "text",
    "maintenanceMessage_ja_JP": "text",
    "maintenanceMessage_fr_FR": "text",
    "maintenanceMessage_es_ES": "text",
    "maintenanceMessage_it_IT": "text",
    "maintenanceMessage_pt_BR": "text",
    "maintenanceMessage_nl_NL": "text",
    "maintenanceMessage_zh_TW": "text",
    "maintenanceMessage_zh_CN": "text",
    "maintenanceMessage_ko_KR": "text",
    "maintenanceMessage_de_DE": "text"
  },
  "inheritMaintenance": true,
  "replicateMaintenance": true,
  "name": "text",
  "type": [
    "0 = Any",
    "1 = Folder",
    "2 = RDSApp",
    "3 = RDSDesktop",
    "4 = VDIDesktop",
    "5 = PCDesktop",
    "6 = PCApp",
    "7 = VDIApp",
    "8 = AVDApp",
    "9 = AVDDesktop"
  ],
  "parentId": 1,
  "previousId": 1,
  "description": "text",
  "enabledMode": [
    "0 = Disabled",
    "1 = Enabled",
    "2 = Maintenance"
  ],
  "enabled": true,
  "publishToSite": [
    1
  ],
  "userFilterEnabled": true,
  "allowedUsers": [
    {
      "account": "text",
      "type": [
        "1 = User",
        "2 = Group",
        "3 = ForeignSecurityPrincipal",
        "4 = Computer"
      ],
      "sid": "text"
    }
  ],
  "clientFilterEnabled": true,
  "allowedClients": [
    "text"
  ],
  "ipFilterEnabled": true,
  "allowedIP4s": [
    {
      "from": "text",
      "to": "text"
    }
  ],
  "allowedIP6s": [
    {
      "from": "text",
      "to": "text"
    }
  ],
  "macFilterEnabled": true,
  "allowedMACs": [
    "text"
  ],
  "gatewayFilterEnabled": true,
  "allowedGateways": [
    "text"
  ],
  "osFilterEnabled": true,
  "allowedOSes": {
    "chrome": true,
    "android": true,
    "webClient": true,
    "iOS": true,
    "linux": true,
    "mac": true,
    "wyse": true,
    "windows": true
  },
  "preferredRoutingEnabled": true,
  "preferredRoutes": [
    {
      "id": 1,
      "priority": 1,
      "name": "text",
      "description": "text",
      "enabled": true,
      "referenceType": [
        "3 = Gateway",
        "51 = HALB",
        "83 = Custom"
      ],
      "referenceId": 1
    }
  ],
  "filter": {
    "rules": [
      {
        "id": 1,
        "priority": 1,
        "enabled": true,
        "name": "text",
        "description": "text",
        "criteria": {
          "securityPrincipals": {
            "enabled": true,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "members": [
              {
                "account": "text",
                "type": [
                  "1 = User",
                  "2 = Group",
                  "3 = ForeignSecurityPrincipal",
                  "4 = Computer"
                ],
                "sid": "text"
              }
            ]
          },
          "gateways": {
            "enabled": true,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "members": [
              {
                "gatewayIP": "text"
              }
            ]
          },
          "oSs": {
            "enabled": true,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "allowedOSes": {
              "chrome": true,
              "android": true,
              "webClient": true,
              "iOS": true,
              "linux": true,
              "mac": true,
              "wyse": true,
              "windows": true
            }
          },
          "iPs": {
            "enabled": true,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "allowedIPs": {
              "iPv4s": [
                {
                  "from": "text",
                  "to": "text"
                }
              ],
              "iPv6s": [
                {
                  "from": "text",
                  "to": "text"
                }
              ]
            }
          },
          "hardwareIDs": {
            "enabled": true,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "members": [
              {
                "hardwareID": "text"
              }
            ]
          },
          "access": [
            "0 = DenyCriteriaWhen",
            "1 = AllowCriteriaWhen"
          ],
          "devices": {
            "enabled": true,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "members": [
              {
                "client": "text"
              }
            ]
          },
          "themes": {
            "enabled": true,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "ids": [
              1
            ]
          }
        }
      }
    ],
    "default": [
      "0 = Deny",
      "1 = Allow"
    ]
  },
  "startOnLogon": true,
  "excludePrelaunch": true,
  "inheritShortcutDefaultSettings": true,
  "createShortcutOnDesktop": true,
  "createShortcutInStartFolder": true,
  "startPath": "text",
  "createShortcutInStartUpFolder": true,
  "replicateShortcutSettings": true,
  "desktopSize": [
    "0 = UseAvailableArea",
    "1 = FullScreen",
    "2 = W640xH480",
    "3 = W800xH600",
    "4 = W854xH480",
    "5 = W1024xH576",
    "6 = W1024xH768",
    "7 = W1152xH864",
    "8 = W1280xH720",
    "9 = W1280xH768",
    "10 = W1280xH800",
    "11 = W1280xH960",
    "12 = W1280xH1024",
    "13 = W1360xH768",
    "14 = W1366xH768",
    "15 = W1400xH1050",
    "16 = W1440xH900",
    "17 = W1600xH900",
    "18 = W1600xH1024",
    "19 = W1600xH1200",
    "20 = W1680xH1050",
    "21 = W1920xH1080",
    "22 = W1920xH1200",
    "23 = W1920xH1440",
    "24 = W2048xH1152",
    "25 = Custom"
  ],
  "width": 1,
  "height": 1,
  "allowMultiMonitor": [
    "0 = Enabled",
    "1 = Disabled",
    "2 = UseClientSettings"
  ],
  "connectToConsole": true,
  "publishFromServer": [
    1
  ],
  "publishFromHostPool": [
    1
  ],
  "publishFrom": [
    "0 = All",
    "1 = HostPool",
    "2 = Host"
  ]
}

Get

Retrieve information about a specified published RD Session Host desktop.

GET/api/PubItems/{id}/Desktops/RDS
Path parameters
id*integer (int32)

ID of the published RD Session Host desktop to be retrieved

Response

Success

Body
idinteger (int32)

ID of the object.

adminCreatenullable string

User who created the object.

adminLastModnullable string

User who last modified the object.

timeCreatestring (date-time)

Time when the object was created.

timeLastModstring (date-time)

Time when the object was last modified.

maintenanceMessagesobject

Contains a set of maintenance messages in various languages

inheritMaintenanceboolean

Inherit Maintenance.

replicateMaintenanceboolean

Replicate Maintenance.

namenullable string

Name of the published item.

typeenum

RAS Publishing Objects

0 = Any,1 = Folder,2 = RDSApp,3 = RDSDesktop,4 = VDIDesktop,5 = PCDesktop,6 = PCApp,7 = VDIApp,8 = AVDApp,9 = AVDDesktop
parentIdinteger (int32)

ID of the parent folder of the published item.

previousIdinteger (int32)

ID of the previous published item.

descriptionnullable string

Description of the published item.

enabledModeenum

Published resource availability modes.

0 = Disabled,1 = Enabled,2 = Maintenance
enabledboolean

Whether the published item is enabled or not.

publishToSitenullable array of integer (int32)

List of the IDs of all the sites this item is published to.

userFilterEnabledboolean

Whether User Filtering is enabled or not (deprecated).

allowedUsersnullable array of object

Lists the allowed users (deprecated).

clientFilterEnabledboolean

Whether Client Filtering is enabled or not (deprecated).

allowedClientsnullable array of string

Lists the allowed clients (deprecated).

ipFilterEnabledboolean

Whether IP Filtering is enabled or not (deprecated).

allowedIP4snullable array of object

Lists the allowed IPv4 addresses (deprecated).

allowedIP6snullable array of object

Lists the allowed IPV6 addresses (deprecated).

macFilterEnabledboolean

Whether MAC address Filtering is enabled or not (deprecated).

allowedMACsnullable array of string

Lists the allowed MAC addresses (deprecated).

allowedGatewaysnullable array of string

Lists the allowed Gateways (deprecated).

osFilterEnabledboolean

Whether OS Filtering is enabled or not (deprecated).

allowedOSesobject

Allowed Operating Systems

preferredRoutingEnabledboolean

Whether Preferred Routing is enabled or not.

preferredRoutesnullable array of object

The list of Preferred Routes.

filterobject

The PubItem Filter object.

startOnLogonboolean

Whether the 'Start automatically when user logs on' option is enabled or disabled.

excludePrelaunchboolean

Exclude application from prelaunch.

inheritShortcutDefaultSettingsboolean

Whether to inherit default shortcut settings or not.

createShortcutOnDesktopboolean

Whether to create a shortcut on the desktop or not.

createShortcutInStartFolderboolean

Whether to create a shortcut in the start folder or not.

startPathnullable string

Starting path of the published item.

createShortcutInStartUpFolderboolean

Whether to create a shortcut in the startup folder or not.

replicateShortcutSettingsboolean

Whether to replicate shortcut settings or not.

desktopSizeenum

Desktop size options for published desktops.

0 = UseAvailableArea,1 = FullScreen,2 = W640xH480,3 = W800xH600,4 = W854xH480,5 = W1024xH576,6 = W1024xH768,7 = W1152xH864,8 = W1280xH720,9 = W1280xH768,10 = W1280xH800,11 = W1280xH960,12 = W1280xH1024,13 = W1360xH768,14 = W1366xH768,15 = W1400xH1050,16 = W1440xH900,17 = W1600xH900,18 = W1600xH1024,19 = W1600xH1200,20 = W1680xH1050,21 = W1920xH1080,22 = W1920xH1200,23 = W1920xH1440,24 = W2048xH1152,25 = Custom
widthinteger (int32)

Desktop width.

heightinteger (int32)

Desktop height.

allowMultiMonitorenum

Multi-monitor options for published desktops.

0 = Enabled,1 = Disabled,2 = UseClientSettings
connectToConsoleboolean

Connect to console

publishFromServernullable array of integer (int32)

List of servers to publish from.

publishFromHostPoolnullable array of integer (int32)

List of groups to publish from.

publishFromenum

Publish From' options for published items.

0 = All,1 = HostPool,2 = Host
Request
const response = await fetch('/api/PubItems/{id}/Desktops/RDS', {
    method: 'GET',
    headers: {},
});
const data = await response.json();
Response
{
  "id": 1,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2025-02-05T03:50:00.029Z",
  "timeLastMod": "2025-02-05T03:50:00.029Z",
  "maintenanceMessages": {
    "maintenanceMessage_en_US": "text",
    "maintenanceMessage_ja_JP": "text",
    "maintenanceMessage_fr_FR": "text",
    "maintenanceMessage_es_ES": "text",
    "maintenanceMessage_it_IT": "text",
    "maintenanceMessage_pt_BR": "text",
    "maintenanceMessage_nl_NL": "text",
    "maintenanceMessage_zh_TW": "text",
    "maintenanceMessage_zh_CN": "text",
    "maintenanceMessage_ko_KR": "text",
    "maintenanceMessage_de_DE": "text"
  },
  "inheritMaintenance": true,
  "replicateMaintenance": true,
  "name": "text",
  "type": [
    "0 = Any",
    "1 = Folder",
    "2 = RDSApp",
    "3 = RDSDesktop",
    "4 = VDIDesktop",
    "5 = PCDesktop",
    "6 = PCApp",
    "7 = VDIApp",
    "8 = AVDApp",
    "9 = AVDDesktop"
  ],
  "parentId": 1,
  "previousId": 1,
  "description": "text",
  "enabledMode": [
    "0 = Disabled",
    "1 = Enabled",
    "2 = Maintenance"
  ],
  "enabled": true,
  "publishToSite": [
    1
  ],
  "userFilterEnabled": true,
  "allowedUsers": [
    {
      "account": "text",
      "type": [
        "1 = User",
        "2 = Group",
        "3 = ForeignSecurityPrincipal",
        "4 = Computer"
      ],
      "sid": "text"
    }
  ],
  "clientFilterEnabled": true,
  "allowedClients": [
    "text"
  ],
  "ipFilterEnabled": true,
  "allowedIP4s": [
    {
      "from": "text",
      "to": "text"
    }
  ],
  "allowedIP6s": [
    {
      "from": "text",
      "to": "text"
    }
  ],
  "macFilterEnabled": true,
  "allowedMACs": [
    "text"
  ],
  "gatewayFilterEnabled": true,
  "allowedGateways": [
    "text"
  ],
  "osFilterEnabled": true,
  "allowedOSes": {
    "chrome": true,
    "android": true,
    "webClient": true,
    "iOS": true,
    "linux": true,
    "mac": true,
    "wyse": true,
    "windows": true
  },
  "preferredRoutingEnabled": true,
  "preferredRoutes": [
    {
      "id": 1,
      "priority": 1,
      "name": "text",
      "description": "text",
      "enabled": true,
      "referenceType": [
        "3 = Gateway",
        "51 = HALB",
        "83 = Custom"
      ],
      "referenceId": 1
    }
  ],
  "filter": {
    "rules": [
      {
        "id": 1,
        "priority": 1,
        "enabled": true,
        "name": "text",
        "description": "text",
        "criteria": {
          "securityPrincipals": {
            "enabled": true,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "members": [
              {
                "account": "text",
                "type": [
                  "1 = User",
                  "2 = Group",
                  "3 = ForeignSecurityPrincipal",
                  "4 = Computer"
                ],
                "sid": "text"
              }
            ]
          },
          "gateways": {
            "enabled": true,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "members": [
              {
                "gatewayIP": "text"
              }
            ]
          },
          "oSs": {
            "enabled": true,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "allowedOSes": {
              "chrome": true,
              "android": true,
              "webClient": true,
              "iOS": true,
              "linux": true,
              "mac": true,
              "wyse": true,
              "windows": true
            }
          },
          "iPs": {
            "enabled": true,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "allowedIPs": {
              "iPv4s": [
                {
                  "from": "text",
                  "to": "text"
                }
              ],
              "iPv6s": [
                {
                  "from": "text",
                  "to": "text"
                }
              ]
            }
          },
          "hardwareIDs": {
            "enabled": true,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "members": [
              {
                "hardwareID": "text"
              }
            ]
          },
          "access": [
            "0 = DenyCriteriaWhen",
            "1 = AllowCriteriaWhen"
          ],
          "devices": {
            "enabled": true,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "members": [
              {
                "client": "text"
              }
            ]
          },
          "themes": {
            "enabled": true,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "ids": [
              1
            ]
          }
        }
      }
    ],
    "default": [
      "0 = Deny",
      "1 = Allow"
    ]
  },
  "startOnLogon": true,
  "excludePrelaunch": true,
  "inheritShortcutDefaultSettings": true,
  "createShortcutOnDesktop": true,
  "createShortcutInStartFolder": true,
  "startPath": "text",
  "createShortcutInStartUpFolder": true,
  "replicateShortcutSettings": true,
  "desktopSize": [
    "0 = UseAvailableArea",
    "1 = FullScreen",
    "2 = W640xH480",
    "3 = W800xH600",
    "4 = W854xH480",
    "5 = W1024xH576",
    "6 = W1024xH768",
    "7 = W1152xH864",
    "8 = W1280xH720",
    "9 = W1280xH768",
    "10 = W1280xH800",
    "11 = W1280xH960",
    "12 = W1280xH1024",
    "13 = W1360xH768",
    "14 = W1366xH768",
    "15 = W1400xH1050",
    "16 = W1440xH900",
    "17 = W1600xH900",
    "18 = W1600xH1024",
    "19 = W1600xH1200",
    "20 = W1680xH1050",
    "21 = W1920xH1080",
    "22 = W1920xH1200",
    "23 = W1920xH1440",
    "24 = W2048xH1152",
    "25 = Custom"
  ],
  "width": 1,
  "height": 1,
  "allowMultiMonitor": [
    "0 = Enabled",
    "1 = Disabled",
    "2 = UseClientSettings"
  ],
  "connectToConsole": true,
  "publishFromServer": [
    1
  ],
  "publishFromHostPool": [
    1
  ],
  "publishFrom": [
    "0 = All",
    "1 = HostPool",
    "2 = Host"
  ]
}

Update

Modify properties of a specified published desktop.

PUT/api/PubItems/{id}/Desktops/RDS
Path parameters
id*integer (int32)

ID of the published RD Session Host desktop to be updated

Body

Published RD Session Host desktop configuration

namenullable string

A new name to assign to the published resource.

replicateMaintenancenullable boolean

Replicate Maintenance

inheritMaintenancenullable boolean

Inherit Maintenance

enabledModeenum

Published resource availability modes.

0 = Disabled,1 = Enabled,2 = Maintenance
maintenanceMessage_en_USnullable string

Maintenance message for the published resource in English.

maintenanceMessage_ja_JPnullable string

Maintenance message for the published resource in Japanese.

maintenanceMessage_fr_FRnullable string

Maintenance message for the published resource in French.

maintenanceMessage_es_ESnullable string

Maintenance message for the published resource in Spanish.

maintenanceMessage_it_ITnullable string

Maintenance message for the published resource in Italian.

maintenanceMessage_pt_BRnullable string

Maintenance message for the published resource in Portuguese.

maintenanceMessage_nl_NLnullable string

Maintenance message for the published resource in Dutch.

maintenanceMessage_de_DEnullable string

Maintenance message for the published resource in German.

maintenanceMessage_zh_TWnullable string

Maintenance message for the published resource in Chinese (Traditional).

maintenanceMessage_zh_CNnullable string

Maintenance message for the published resource in Chinese (Simplified).

maintenanceMessage_ko_KRnullable string

Maintenance message for the published resource in Korean.

descriptionnullable string

Published resource description.

publishToSiteIdsnullable array of integer (int32)

An array of sites to which to publish a resource.

preferredRoutingEnablednullable boolean

Enable or disable Preferred Routing.

replicateShortcutSettingsnullable boolean

Replicate shortcut settings to all sites.

createShortcutOnDesktopnullable boolean

Create a shortcut on a client's desktop.

createShortcutInStartFoldernullable boolean

Create a shortcut in the client's Start folder.

createShortcutInStartUpFoldernullable boolean

Create a shortcut in the client's Auto Start folder.

startPathnullable string

Specifies the path in the Start folder where the shortcut will be created.

inheritShortcutDefaultSettingsnullable boolean

Inherit default shortcut settings.

startOnLogonnullable boolean

Start a resource automatically when a user logs on.

excludePrelaunchnullable boolean

Exclude application from prelaunch.

widthnullable integer (int32)

Desktop width.

heightnullable integer (int32)

Desktop height.

desktopSizeenum

Desktop size options for published desktops.

0 = UseAvailableArea,1 = FullScreen,2 = W640xH480,3 = W800xH600,4 = W854xH480,5 = W1024xH576,6 = W1024xH768,7 = W1152xH864,8 = W1280xH720,9 = W1280xH768,10 = W1280xH800,11 = W1280xH960,12 = W1280xH1024,13 = W1360xH768,14 = W1366xH768,15 = W1400xH1050,16 = W1440xH900,17 = W1600xH900,18 = W1600xH1024,19 = W1600xH1200,20 = W1680xH1050,21 = W1920xH1080,22 = W1920xH1200,23 = W1920xH1440,24 = W2048xH1152,25 = Custom
allowMultiMonitorenum

Multi-monitor options for published desktops.

0 = Enabled,1 = Disabled,2 = UseClientSettings
connectToConsolenullable boolean

Enable or disable the 'Connect to console' option.

publishFromenum

Publish From' options for published items.

0 = All,1 = HostPool,2 = Host
publishFromHostPoolIdsnullable array of integer (int32)

Specifies one or multiple host pool Ids from which to publish a desktop. The PublishFrom parameter must specify 1 (HostPool).

publishFromServerIdsnullable array of integer (int32)

Specifies one or multiple RDS Host server Ids from which to publish a desktop. The PublishFrom parameter must specify 2 (Host).

Response

No Content

Request
const response = await fetch('/api/PubItems/{id}/Desktops/RDS', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({
      "enabledMode": [
        "0 = Disabled",
        "1 = Enabled",
        "2 = Maintenance"
      ],
      "publishToSiteIds": [
        null
      ],
      "desktopSize": [
        "0 = UseAvailableArea",
        "1 = FullScreen",
        "2 = W640xH480",
        "3 = W800xH600",
        "4 = W854xH480",
        "5 = W1024xH576",
        "6 = W1024xH768",
        "7 = W1152xH864",
        "8 = W1280xH720",
        "9 = W1280xH768",
        "10 = W1280xH800",
        "11 = W1280xH960",
        "12 = W1280xH1024",
        "13 = W1360xH768",
        "14 = W1366xH768",
        "15 = W1400xH1050",
        "16 = W1440xH900",
        "17 = W1600xH900",
        "18 = W1600xH1024",
        "19 = W1600xH1200",
        "20 = W1680xH1050",
        "21 = W1920xH1080",
        "22 = W1920xH1200",
        "23 = W1920xH1440",
        "24 = W2048xH1152",
        "25 = Custom"
      ],
      "allowMultiMonitor": [
        "0 = Enabled",
        "1 = Disabled",
        "2 = UseClientSettings"
      ],
      "publishFrom": [
        "0 = All",
        "1 = HostPool",
        "2 = Host"
      ],
      "publishFromHostPoolIds": [
        null
      ],
      "publishFromServerIds": [
        null
      ]
    }),
});
const data = await response.json();
Response
{
  "type": "text",
  "title": "text",
  "status": 1,
  "detail": "text",
  "instance": "text",
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Delete

Delete a published RD Session Host desktop

DELETE/api/PubItems/{id}/Desktops/RDS
Path parameters
id*integer (int32)

ID of the published RD Session Host desktop to be deleted

Response

No Content

Request
const response = await fetch('/api/PubItems/{id}/Desktops/RDS', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();
Response
{
  "type": "text",
  "title": "text",
  "status": 1,
  "detail": "text",
  "instance": "text",
  "ANY_ADDITIONAL_PROPERTY": "anything"
}
PreviousAVDNextVDI

Was this helpful?