Local | Parallels REST API

Parallels REST API

Products Support Partners Documentation

Delete

delete

Delete a published application from a site.

Path parameters

idinteger · int32Required

ID of the published Local application 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

DELETE /api/PubItems/{id}/Apps/Local HTTP/1.1
Host: 
Accept: */*

No content

List

get

Retrieve a list of all the published Local applications

Query parameters

SiteIdinteger · int32Optional

Site ID for which to retrieve all the published Local applications (optional)

Responses

200

application/json; api-version=1.0

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

GET /api/PubItems/Apps/Local HTTP/1.1
Host: 
Accept: */*

[
  {
    "id": 1,
    "adminCreate": "text",
    "adminLastMod": "text",
    "timeCreate": "2025-05-23T11:56:08.484Z",
    "timeLastMod": "2025-05-23T11:56:08.484Z",
    "name": "text",
    "type": [
      "0 = Any",
      "1 = Folder",
      "2 = RDSApp",
      "3 = RDSDesktop",
      "4 = VDIDesktop",
      "5 = PCDesktop",
      "6 = PCApp",
      "7 = VDIApp",
      "8 = AVDApp",
      "9 = AVDDesktop",
      "10 = LocalApp"
    ],
    "parentId": 1,
    "previousId": 1,
    "description": "text",
    "enabledMode": [
      "0 = Disabled",
      "1 = Enabled",
      "2 = Maintenance"
    ],
    "enabled": true,
    "publishToSite": [
      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,
    "inheritShortcutDefaultSettings": true,
    "createShortcutOnDesktop": true,
    "createShortcutInStartFolder": true,
    "startPath": "text",
    "createShortcutInStartUpFolder": true,
    "replicateShortcutSettings": true,
    "url": "text",
    "windows": {
      "enabled": true,
      "useIfAvailable": true,
      "target": "text",
      "startIn": "text",
      "parameters": "text",
      "winType": [
        "0 = Normal",
        "1 = Maximized",
        "2 = Minimized"
      ]
    },
    "mac": {
      "enabled": true
    },
    "linux": {
      "enabled": true
    },
    "iOS": {
      "enabled": true
    },
    "android": {
      "enabled": true
    },
    "userPortal": {
      "enabled": true
    },
    "replicateLocalAppSettings": true
  }
]

Create

post

Add a published Local application to a site.

Body

Create a new published local application

namestring | nullableRequired

Published resource name.

parentIdinteger · int32 | nullableOptional

Parent publishing folder ID.

previousIdinteger · int32 | nullableOptional

Previous published ID.

enabledModestring · enumOptional

Published resource availability modes.

Possible values:

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.

urlstring | nullableOptional

URL.

windowsEnabledboolean | nullableOptional

Windows: Whether the application is enabled for the operating system or not.

windowsUseIfAvailableboolean | nullableOptional

Windows: Use the following application if available on local device.

windowsStartInstring | nullableOptional

Windows: Application working directory.

windowsTargetstring | nullableOptional

Windows: Application target file. (i.e. calc.exe, file.txt, etc.).

windowsParametersstring | nullableOptional

Windows: Application parameters.

windowsWinTypestring · enumOptional

Published application window type

Possible values:

macEnabledboolean | nullableOptional

Mac: Whether the application is enabled for the operating system or not.

linuxEnabledboolean | nullableOptional

Linux: Whether the application is enabled for the operating system or not.

iOSEnabledboolean | nullableOptional

iOS: Whether the application is enabled for the operating system or not.

androidEnabledboolean | nullableOptional

Android: Whether the application is enabled for the operating system or not.

userPortalEnabledboolean | nullableOptional

UserPortal: Whether the application is enabled for the operating system or not.

replicateLocalAppSettingsboolean | nullableOptional

Whether to replicate local application settings or not.

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

POST /api/PubItems/Apps/Local HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 499

{
  "name": "text",
  "parentId": 1,
  "previousId": 1,
  "enabledMode": [
    "0 = Disabled",
    "1 = Enabled",
    "2 = Maintenance"
  ],
  "description": "text",
  "publishToSiteIds": [
    1
  ],
  "siteId": 1,
  "url": "text",
  "windowsEnabled": true,
  "windowsUseIfAvailable": true,
  "windowsStartIn": "text",
  "windowsTarget": "text",
  "windowsParameters": "text",
  "windowsWinType": [
    "0 = Normal",
    "1 = Maximized",
    "2 = Minimized"
  ],
  "macEnabled": true,
  "linuxEnabled": true,
  "iOSEnabled": true,
  "androidEnabled": true,
  "userPortalEnabled": true,
  "replicateLocalAppSettings": true
}

{
  "id": 1,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2025-05-23T11:56:08.484Z",
  "timeLastMod": "2025-05-23T11:56:08.484Z",
  "name": "text",
  "type": [
    "0 = Any",
    "1 = Folder",
    "2 = RDSApp",
    "3 = RDSDesktop",
    "4 = VDIDesktop",
    "5 = PCDesktop",
    "6 = PCApp",
    "7 = VDIApp",
    "8 = AVDApp",
    "9 = AVDDesktop",
    "10 = LocalApp"
  ],
  "parentId": 1,
  "previousId": 1,
  "description": "text",
  "enabledMode": [
    "0 = Disabled",
    "1 = Enabled",
    "2 = Maintenance"
  ],
  "enabled": true,
  "publishToSite": [
    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,
  "inheritShortcutDefaultSettings": true,
  "createShortcutOnDesktop": true,
  "createShortcutInStartFolder": true,
  "startPath": "text",
  "createShortcutInStartUpFolder": true,
  "replicateShortcutSettings": true,
  "url": "text",
  "windows": {
    "enabled": true,
    "useIfAvailable": true,
    "target": "text",
    "startIn": "text",
    "parameters": "text",
    "winType": [
      "0 = Normal",
      "1 = Maximized",
      "2 = Minimized"
    ]
  },
  "mac": {
    "enabled": true
  },
  "linux": {
    "enabled": true
  },
  "iOS": {
    "enabled": true
  },
  "android": {
    "enabled": true
  },
  "userPortal": {
    "enabled": true
  },
  "replicateLocalAppSettings": true
}

Update

put

Modify properties of a published Local application.

Path parameters

idinteger · int32Required

ID of the published Local application to be updated

Body

Update settings of a local application

namestring | nullableOptional

A new name to assign to the published resource.

enabledModestring · enumOptional

Published resource availability modes.

Possible values:

descriptionstring | nullableOptional

Published resource description.

publishToSiteIdsinteger · int32[] | nullableOptional

An array of sites to which to publish a resource.

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 | 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.

urlstring | nullableOptional

URL.

windowsEnabledboolean | nullableOptional

Windows: Whether the application is enabled for the operating system or not.

windowsUseIfAvailableboolean | nullableOptional

Windows: Use the following application if available on local device.

windowsStartInstring | nullableOptional

Windows: Application working directory.

windowsTargetstring | nullableOptional

Windows: Application target file. (i.e. calc.exe, file.txt, etc.).

windowsParametersstring | nullableOptional

Windows: Application parameters.

windowsWinTypestring · enumOptional

Published application window type

Possible values:

macEnabledboolean | nullableOptional

Mac: Whether the application is enabled for the operating system or not.

linuxEnabledboolean | nullableOptional

Linux: Whether the application is enabled for the operating system or not.

iOSEnabledboolean | nullableOptional

iOS: Whether the application is enabled for the operating system or not.

androidEnabledboolean | nullableOptional

Android: Whether the application is enabled for the operating system or not.

userPortalEnabledboolean | nullableOptional

UserPortal: Whether the application is enabled for the operating system or not.

replicateLocalAppSettingsboolean | nullableOptional

Whether to replicate local application settings or not.

Responses

204

No Content

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

put

PUT /api/PubItems/{id}/Apps/Local HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 728

{
  "name": "text",
  "enabledMode": [
    "0 = Disabled",
    "1 = Enabled",
    "2 = Maintenance"
  ],
  "description": "text",
  "publishToSiteIds": [
    1
  ],
  "preferredRoutingEnabled": true,
  "replicateShortcutSettings": true,
  "createShortcutOnDesktop": true,
  "createShortcutInStartFolder": true,
  "createShortcutInStartUpFolder": true,
  "startPath": "text",
  "inheritShortcutDefaultSettings": true,
  "startOnLogon": true,
  "excludePrelaunch": true,
  "url": "text",
  "windowsEnabled": true,
  "windowsUseIfAvailable": true,
  "windowsStartIn": "text",
  "windowsTarget": "text",
  "windowsParameters": "text",
  "windowsWinType": [
    "0 = Normal",
    "1 = Maximized",
    "2 = Minimized"
  ],
  "macEnabled": true,
  "linuxEnabled": true,
  "iOSEnabled": true,
  "androidEnabled": true,
  "userPortalEnabled": true,
  "replicateLocalAppSettings": true
}

No content