Local
Add a published Local application to a site.
Create a new published local application
Published resource name.
Parent publishing folder ID.
Previous published ID.
Published resource availability modes.
Published resource description.
An array of Sites IDs to which to publish a resource.
Site ID in which to publish the specified Item. If the parameter is omitted, the site ID of the Licensing Server will be used.
URL.
Windows: Whether the application is enabled for the operating system or not.
Windows: Use the following application if available on local device.
Windows: Application working directory.
Windows: Application target file. (i.e. calc.exe, file.txt, etc.).
Windows: Application parameters.
Published application window type
Mac: Whether the application is enabled for the operating system or not.
Linux: Whether the application is enabled for the operating system or not.
iOS: Whether the application is enabled for the operating system or not.
Android: Whether the application is enabled for the operating system or not.
UserPortal: Whether the application is enabled for the operating system or not.
Whether to replicate local application settings or not.
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-07-07T14:43:12.767Z",
"timeLastMod": "2025-07-07T14:43:12.767Z",
"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
}Retrieve a list of all the published Local applications
Site ID for which to retrieve all the published Local applications (optional)
GET /api/PubItems/Apps/Local HTTP/1.1
Host:
Accept: */*
[
{
"id": 1,
"adminCreate": "text",
"adminLastMod": "text",
"timeCreate": "2025-07-07T14:43:12.767Z",
"timeLastMod": "2025-07-07T14:43:12.767Z",
"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
}
]Modify properties of a published Local application.
ID of the published Local application to be updated
Update settings of a local application
A new name to assign to the published resource.
Published resource availability modes.
Published resource description.
An array of sites to which to publish a resource.
Enable or disable Preferred Routing.
Replicate shortcut settings to all sites.
Create a shortcut on a client's desktop.
Create a shortcut in the client's Start folder.
Create a shortcut in the client's Auto Start folder.
Specifies the path in the Start folder where the shortcut will be created.
Inherit default shortcut settings.
Start a resource automatically when a user logs on.
Exclude application from prelaunch.
URL.
Windows: Whether the application is enabled for the operating system or not.
Windows: Use the following application if available on local device.
Windows: Application working directory.
Windows: Application target file. (i.e. calc.exe, file.txt, etc.).
Windows: Application parameters.
Published application window type
Mac: Whether the application is enabled for the operating system or not.
Linux: Whether the application is enabled for the operating system or not.
iOS: Whether the application is enabled for the operating system or not.
Android: Whether the application is enabled for the operating system or not.
UserPortal: Whether the application is enabled for the operating system or not.
Whether to replicate local application settings or not.
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
Delete a published application from a site.
ID of the published Local application to be deleted
DELETE /api/PubItems/{id}/Apps/Local HTTP/1.1
Host:
Accept: */*
No content
Last updated
Was this helpful?