VDI

List

get

Retrieve a list of all the published VDI desktops

Query parameters

SiteIdinteger · int32Optional

Site ID for which to retrieve all the published VDI desktops (optional)

NamestringOptional

Filter the result by name (optional)

Responses

200

Success

application/json; api-version=1.0

Published VDI Desktop

idinteger · int32Optional

ID of the object.

adminCreatestring · nullableOptional

User who created the object.

adminLastModstring · nullableOptional

User who last modified the object.

timeCreatestring · date-timeOptional

Time when the object was created.

timeLastModstring · date-timeOptional

Time when the object was last modified.

inheritMaintenancebooleanOptional

Inherit Maintenance.

replicateMaintenancebooleanOptional

Replicate Maintenance.

namestring · nullableOptional

Name of the published item.

typestring · enumOptional

RAS Publishing Objects

Possible values:

parentIdinteger · int32Optional

ID of the parent folder of the published item.

previousIdinteger · int32Optional

ID of the previous published item.

descriptionstring · nullableOptional

Description of the published item.

enabledModestring · enumOptional

Published resource availability modes.

Possible values:

enabledbooleanOptional

Whether the published item is enabled or not.

publishToSiteinteger · int32[] · nullableOptional

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

userFilterEnabledbooleanOptional

Whether User Filtering is enabled or not (deprecated).

clientFilterEnabledbooleanOptional

Whether Client Filtering is enabled or not (deprecated).

allowedClientsstring[] · nullableOptional

Lists the allowed clients (deprecated).

ipFilterEnabledbooleanOptional

Whether IP Filtering is enabled or not (deprecated).

macFilterEnabledbooleanOptional

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

allowedMACsstring[] · nullableOptional

Lists the allowed MAC addresses (deprecated).

gatewayFilterEnabledbooleanOptionalDeprecated

Whether Gateway Filtering is enabled or not (deprecated).

allowedGatewaysstring[] · nullableOptional

Lists the allowed Gateways (deprecated).

osFilterEnabledbooleanOptional

Whether OS Filtering is enabled or not (deprecated).

preferredRoutingEnabledbooleanOptional

Whether Preferred Routing is enabled or not.

startOnLogonbooleanOptional

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

excludePrelaunchbooleanOptional

Exclude application from prelaunch.

inheritShortcutDefaultSettingsbooleanOptional

Whether to inherit default shortcut settings or not.

createShortcutOnDesktopbooleanOptional

Whether to create a shortcut on the desktop or not.

createShortcutInStartFolderbooleanOptional

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

startPathstring · nullableOptional

Starting path of the published item.

createShortcutInStartUpFolderbooleanOptional

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

replicateShortcutSettingsbooleanOptional

Whether to replicate shortcut settings or not.

desktopSizestring · enumOptional

Desktop size options for published desktops.

Possible values:

widthinteger · int32Optional

Desktop width.

heightinteger · int32Optional

Desktop height.

allowMultiMonitorstring · enumOptional

Multi-monitor options for published desktops.

Possible values:

vdiHostPoolIdinteger · int32Optional

ID of the VDI Host Pool

persistentbooleanOptional

Specifies whether the connection is persistent or not

connectTostring · enumOptional

VDI Matching Mode.

Possible values:

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

/api/PubItems/Desktops/VDI

HTTPcURLJavaScriptPython

GET /api/PubItems/Desktops/VDI HTTP/1.1
Accept: */*

{
  "id": 1,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2026-03-10T23:10:51.818Z",
  "timeLastMod": "2026-03-10T23:10:51.818Z",
  "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"
  ],
  "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"
  ],
  "vdiHostPoolId": 1,
  "persistent": true,
  "connectTo": [
    "0 = AnyGuest"
  ]
}

Create

post

Add a published VDI desktop to a site.

Body

application/json; api-version=1.0

Create a new published desktop from a VDI Desktop

namestring · min: 1 · max: 255 · nullableRequired

Published resource name.

parentIdinteger · int32 · nullableOptional

Parent publishing folder ID.

previousIdinteger · int32 · nullableOptional

Previous published ID.

replicateMaintenanceboolean · nullableOptional

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

inheritMaintenanceboolean · nullableOptional

Whether to inherit default Maintenance settings.

enabledboolean · nullableOptionalDeprecated

Enable or disable a published resource.

enabledModestring · enumOptional

Published resource availability modes.

Possible values:

maintenanceMessage_en_USstring · min: 1 · max: 255 · nullableOptional

Maintenance message for the published resource in English.

maintenanceMessage_ja_JPstring · min: 1 · max: 255 · nullableOptional

Maintenance message for the published resource in Japanese.

maintenanceMessage_fr_FRstring · min: 1 · max: 255 · nullableOptional

Maintenance message for the published resource in French.

maintenanceMessage_es_ESstring · min: 1 · max: 255 · nullableOptional

Maintenance message for the published resource in Spanish.

maintenanceMessage_it_ITstring · min: 1 · max: 255 · nullableOptional

Maintenance message for the published resource in Italian.

maintenanceMessage_pt_BRstring · min: 1 · max: 255 · nullableOptional

Maintenance message for the published resource in Portuguese.

maintenanceMessage_de_DEstring · min: 1 · max: 255 · nullableOptional

Maintenance message for the published resource in German.

maintenanceMessage_nl_NLstring · min: 1 · max: 255 · nullableOptional

Maintenance message for the published resource in Dutch.

maintenanceMessage_zh_TWstring · min: 1 · max: 255 · nullableOptional

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

maintenanceMessage_zh_CNstring · min: 1 · max: 255 · nullableOptional

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

maintenanceMessage_ko_KRstring · min: 1 · max: 255 · nullableOptional

Maintenance message for the published resource in Korean.

descriptionstring · nullableOptional

Published resource description.

publishToSiteIdsinteger · int32[] · nullableOptional

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

siteIdinteger · int32Optional

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

ipFilterEnabledboolean · nullableOptionalDeprecated

Enable or disable IP filters.

clientFilterEnabledboolean · nullableOptionalDeprecated

Enable or disable client filters.

macFilterEnabledboolean · nullableOptionalDeprecated

Enable or disable mac filters.

userFilterEnabledboolean · nullableOptionalDeprecated

Enable or disable user filters.

gatewayFilterEnabledboolean · nullableOptionalDeprecated

Enable or disable Secure Gateway filters.

startOnLogonbooleanOptional

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

Default: false

widthinteger · int32Optional

Specifies a custom desktop width.

heightinteger · int32Optional

Specifies a custom desktop height.

desktopSizestring · enumOptional

Desktop size options for published desktops.

Possible values:

allowMultiMonitorstring · enumOptional

Multi-monitor options for published desktops.

Possible values:

persistentbooleanOptional

Specifies whether the connection is persistent or not.

connectTostring · enumOptional

VDI Matching Mode.

Possible values:

vdiHostPoolIdinteger · int32 · nullableOptional

Specifies the VDI Host Pool ID from which to publish a desktop.

vdiTemplateIdinteger · int32 · nullableOptional

Specifies the VDI Template ID from which to publish an application.

Responses

201

Created

application/json; api-version=1.0

401

Unauthorized

application/json; api-version=1.0

409

Conflict

application/json; api-version=1.0

post

/api/PubItems/Desktops/VDI

HTTPcURLJavaScriptPython

POST /api/PubItems/Desktops/VDI HTTP/1.1
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 1271

{
  "name": "text",
  "parentId": 1,
  "previousId": 1,
  "replicateMaintenance": true,
  "inheritMaintenance": true,
  "enabledMode": [
    "0 = Disabled",
    "1 = Enabled",
    "2 = Maintenance"
  ],
  "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_de_DE": "text",
  "maintenanceMessage_nl_NL": "text",
  "maintenanceMessage_zh_TW": "text",
  "maintenanceMessage_zh_CN": "text",
  "maintenanceMessage_ko_KR": "text",
  "description": "text",
  "publishToSiteIds": [
    1
  ],
  "siteId": 1,
  "startOnLogon": false,
  "width": 1,
  "height": 1,
  "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"
  ],
  "persistent": true,
  "connectTo": [
    "0 = AnyGuest"
  ],
  "vdiHostPoolId": 1,
  "vdiTemplateId": 1
}

{
  "id": 1,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2026-03-10T23:10:51.818Z",
  "timeLastMod": "2026-03-10T23:10:51.818Z",
  "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"
  ],
  "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"
  ],
  "vdiHostPoolId": 1,
  "persistent": true,
  "connectTo": [
    "0 = AnyGuest"
  ]
}

Get

get

Retrieve information about a specified published VDI desktop.

Path parameters

idinteger · int32Required

ID of the published VDI desktop to be retrieved

Responses

200

Success

application/json; api-version=1.0

Published VDI Desktop

idinteger · int32Optional

ID of the object.

adminCreatestring · nullableOptional

User who created the object.

adminLastModstring · nullableOptional

User who last modified the object.

timeCreatestring · date-timeOptional

Time when the object was created.

timeLastModstring · date-timeOptional

Time when the object was last modified.

inheritMaintenancebooleanOptional

Inherit Maintenance.

replicateMaintenancebooleanOptional

Replicate Maintenance.

namestring · nullableOptional

Name of the published item.

typestring · enumOptional

RAS Publishing Objects

Possible values:

parentIdinteger · int32Optional

ID of the parent folder of the published item.

previousIdinteger · int32Optional

ID of the previous published item.

descriptionstring · nullableOptional

Description of the published item.

enabledModestring · enumOptional

Published resource availability modes.

Possible values:

enabledbooleanOptional

Whether the published item is enabled or not.

publishToSiteinteger · int32[] · nullableOptional

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

userFilterEnabledbooleanOptional

Whether User Filtering is enabled or not (deprecated).

clientFilterEnabledbooleanOptional

Whether Client Filtering is enabled or not (deprecated).

allowedClientsstring[] · nullableOptional

Lists the allowed clients (deprecated).

ipFilterEnabledbooleanOptional

Whether IP Filtering is enabled or not (deprecated).

macFilterEnabledbooleanOptional

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

allowedMACsstring[] · nullableOptional

Lists the allowed MAC addresses (deprecated).

gatewayFilterEnabledbooleanOptionalDeprecated

Whether Gateway Filtering is enabled or not (deprecated).

allowedGatewaysstring[] · nullableOptional

Lists the allowed Gateways (deprecated).

osFilterEnabledbooleanOptional

Whether OS Filtering is enabled or not (deprecated).

preferredRoutingEnabledbooleanOptional

Whether Preferred Routing is enabled or not.

startOnLogonbooleanOptional

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

excludePrelaunchbooleanOptional

Exclude application from prelaunch.

inheritShortcutDefaultSettingsbooleanOptional

Whether to inherit default shortcut settings or not.

createShortcutOnDesktopbooleanOptional

Whether to create a shortcut on the desktop or not.

createShortcutInStartFolderbooleanOptional

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

startPathstring · nullableOptional

Starting path of the published item.

createShortcutInStartUpFolderbooleanOptional

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

replicateShortcutSettingsbooleanOptional

Whether to replicate shortcut settings or not.

desktopSizestring · enumOptional

Desktop size options for published desktops.

Possible values:

widthinteger · int32Optional

Desktop width.

heightinteger · int32Optional

Desktop height.

allowMultiMonitorstring · enumOptional

Multi-monitor options for published desktops.

Possible values:

vdiHostPoolIdinteger · int32Optional

ID of the VDI Host Pool

persistentbooleanOptional

Specifies whether the connection is persistent or not

connectTostring · enumOptional

VDI Matching Mode.

Possible values:

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

/api/PubItems/{id}/Desktops/VDI

HTTPcURLJavaScriptPython

GET /api/PubItems/{id}/Desktops/VDI HTTP/1.1
Accept: */*

{
  "id": 1,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2026-03-10T23:10:51.818Z",
  "timeLastMod": "2026-03-10T23:10:51.818Z",
  "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"
  ],
  "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"
  ],
  "vdiHostPoolId": 1,
  "persistent": true,
  "connectTo": [
    "0 = AnyGuest"
  ]
}

Update

put

Modify properties of a specified published desktop.

Path parameters

idinteger · int32Required

ID of the published VDI desktop to be updated

Body

application/json; api-version=1.0

Update settings of a desktop published from a VDI Desktop

namestring · min: 1 · max: 255 · nullableOptional

A new name to assign to the published resource.

replicateMaintenanceboolean · nullableOptional

Replicate Maintenance

inheritMaintenanceboolean · nullableOptional

Inherit Maintenance

enabledboolean · nullableOptionalDeprecated

Enable or disable a published resource.

enabledModestring · enumOptional

Published resource availability modes.

Possible values:

maintenanceMessage_en_USstring · min: 1 · max: 255 · nullableOptional

Maintenance message for the published resource in English.

maintenanceMessage_ja_JPstring · min: 1 · max: 255 · nullableOptional

Maintenance message for the published resource in Japanese.

maintenanceMessage_fr_FRstring · min: 1 · max: 255 · nullableOptional

Maintenance message for the published resource in French.

maintenanceMessage_es_ESstring · min: 1 · max: 255 · nullableOptional

Maintenance message for the published resource in Spanish.

maintenanceMessage_it_ITstring · min: 1 · max: 255 · nullableOptional

Maintenance message for the published resource in Italian.

maintenanceMessage_pt_BRstring · min: 1 · max: 255 · nullableOptional

Maintenance message for the published resource in Portuguese.

maintenanceMessage_nl_NLstring · min: 1 · max: 255 · nullableOptional

Maintenance message for the published resource in Dutch.

maintenanceMessage_de_DEstring · min: 1 · max: 255 · nullableOptional

Maintenance message for the published resource in German.

maintenanceMessage_zh_TWstring · min: 1 · max: 255 · nullableOptional

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

maintenanceMessage_zh_CNstring · min: 1 · max: 255 · nullableOptional

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

maintenanceMessage_ko_KRstring · min: 1 · max: 255 · nullableOptional

Maintenance message for the published resource in Korean.

descriptionstring · nullableOptional

Published resource description.

publishToSiteIdsinteger · int32[] · nullableOptional

An array of sites to which to publish a resource.

ipFilterEnabledboolean · nullableOptionalDeprecated

Enable or disable IP filters.

clientFilterEnabledboolean · nullableOptionalDeprecated

Enable or disable client filters.

macFilterEnabledboolean · nullableOptionalDeprecated

Enable or disable mac filters.

userFilterEnabledboolean · nullableOptionalDeprecated

Enable or disable user filters.

gatewayFilterEnabledboolean · nullableOptionalDeprecated

Enable or disable Secure Gateway filters.

osFilterEnabledboolean · nullableOptionalDeprecated

Enable or disable the OS filter.

allowClientChromeboolean · nullableOptionalDeprecated

Allow or not Chrome OS Clients.

allowClientAndroidboolean · nullableOptionalDeprecated

Allow or not Android Clients.

allowClientWebboolean · nullableOptionalDeprecated

Allow or not Web Clients.

allowClientIOSboolean · nullableOptionalDeprecated

Allow or not IOS Clients.

allowClientLinuxboolean · nullableOptionalDeprecated

Allow or not Linux Clients.

allowClientMACboolean · nullableOptionalDeprecated

Allow or not MAC Clients.

allowClientWindowsboolean · nullableOptionalDeprecated

Allow or not Windows Clients.

allowClientWyseboolean · nullableOptionalDeprecated

Allow or not Wyse Clients.

preferredRoutingEnabledboolean · nullableOptional

Enable or disable Preferred Routing.

replicateShortcutSettingsboolean · nullableOptional

Replicate shortcut settings to all sites.

createShortcutOnDesktopboolean · nullableOptional

Create a shortcut on a client's desktop.

createShortcutInStartFolderboolean · nullableOptional

Create a shortcut in the client's Start folder.

createShortcutInStartUpFolderboolean · nullableOptional

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

startPathstring · min: 1 · max: 255 · nullableOptional

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

inheritShortcutDefaultSettingsboolean · nullableOptional

Inherit default shortcut settings.

startOnLogonboolean · nullableOptional

Start a resource automatically when a user logs on.

excludePrelaunchboolean · nullableOptional

Exclude application from prelaunch.

widthinteger · int32 · nullableOptional

Desktop width.

heightinteger · int32 · nullableOptional

Desktop height.

desktopSizestring · enumOptional

Desktop size options for published desktops.

Possible values:

allowMultiMonitorstring · enumOptional

Multi-monitor options for published desktops.

Possible values:

persistentboolean · nullableOptional

Defines whether the connection is persistent or not.

connectTostring · enumOptional

VDI Matching Mode.

Possible values:

vdiHostPoolIdinteger · int32 · nullableOptional

Specifies the VDI Host Pool from which to publish a desktop.

Responses

204

No Content

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

put

/api/PubItems/{id}/Desktops/VDI

HTTPcURLJavaScriptPython

PUT /api/PubItems/{id}/Desktops/VDI HTTP/1.1
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 1461

{
  "name": "text",
  "replicateMaintenance": true,
  "inheritMaintenance": true,
  "enabledMode": [
    "0 = Disabled",
    "1 = Enabled",
    "2 = Maintenance"
  ],
  "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_de_DE": "text",
  "maintenanceMessage_zh_TW": "text",
  "maintenanceMessage_zh_CN": "text",
  "maintenanceMessage_ko_KR": "text",
  "description": "text",
  "publishToSiteIds": [
    1
  ],
  "preferredRoutingEnabled": true,
  "replicateShortcutSettings": true,
  "createShortcutOnDesktop": true,
  "createShortcutInStartFolder": true,
  "createShortcutInStartUpFolder": true,
  "startPath": "text",
  "inheritShortcutDefaultSettings": true,
  "startOnLogon": true,
  "excludePrelaunch": true,
  "width": 1,
  "height": 1,
  "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"
  ],
  "persistent": true,
  "connectTo": [
    "0 = AnyGuest"
  ],
  "vdiHostPoolId": 1
}

No content

Delete

delete

Delete a published VDI desktop

Path parameters

idinteger · int32Required

ID of the published VDI desktop to be deleted

Responses

204

No Content

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

delete

/api/PubItems/{id}/Desktops/VDI

HTTPcURLJavaScriptPython

DELETE /api/PubItems/{id}/Desktops/VDI HTTP/1.1
Accept: */*

No content