Folders
Retrieve a list of all the published folders
Query parameters
SiteIdinteger · int32Optional
Site ID for which to retrieve all the published RD Session Host folders (optional)
NamestringOptional
Filter the result by name (optional)
Responses
200
Success
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/Folders HTTP/1.1
Host:
Accept: */*
[
{
"id": 1,
"adminCreate": "text",
"adminLastMod": "text",
"timeCreate": "2025-07-07T19:57:39.362Z",
"timeLastMod": "2025-07-07T19:57:39.362Z",
"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"
]
},
"adminOnly": true
}
]Add a published folder to a site.
Body
Create a folder for published resources. Folders are used to organize published resources and to facilitate filtering options
namestring | 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 · enumOptionalPossible values:
Published resource availability modes.
maintenanceMessage_en_USstring | nullableOptional
Maintenance message for the published resource in English.
maintenanceMessage_ja_JPstring | nullableOptional
Maintenance message for the published resource in Japanese.
maintenanceMessage_fr_FRstring | nullableOptional
Maintenance message for the published resource in French.
maintenanceMessage_es_ESstring | nullableOptional
Maintenance message for the published resource in Spanish.
maintenanceMessage_it_ITstring | nullableOptional
Maintenance message for the published resource in Italian.
maintenanceMessage_pt_BRstring | nullableOptional
Maintenance message for the published resource in Portuguese.
maintenanceMessage_de_DEstring | nullableOptional
Maintenance message for the published resource in German.
maintenanceMessage_nl_NLstring | nullableOptional
Maintenance message for the published resource in Dutch.
maintenanceMessage_zh_TWstring | nullableOptional
Maintenance message for the published resource in Chinese (Traditional).
maintenanceMessage_zh_CNstring | nullableOptional
Maintenance message for the published resource in Chinese (Simplified).
maintenanceMessage_ko_KRstring | 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.
adminOnlybooleanOptionalDefault:
Use folder for administrative purposes only.
falseResponses
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/Folders HTTP/1.1
Host:
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 607
{
"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,
"adminOnly": false
}{
"id": 1,
"adminCreate": "text",
"adminLastMod": "text",
"timeCreate": "2025-07-07T19:57:39.362Z",
"timeLastMod": "2025-07-07T19:57:39.362Z",
"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"
]
},
"adminOnly": true
}Retrieve information about a specified published folder.
Path parameters
idinteger · int32Required
ID of the published folder to be retrieved
Responses
200
Success
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/{id}/Folders HTTP/1.1
Host:
Accept: */*
{
"id": 1,
"adminCreate": "text",
"adminLastMod": "text",
"timeCreate": "2025-07-07T19:57:39.362Z",
"timeLastMod": "2025-07-07T19:57:39.362Z",
"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"
]
},
"adminOnly": true
}Modify properties of a published folder.
Path parameters
idinteger · int32Required
ID of the published folder to be updated
Body
Update a folder for published resources settings
namestring | 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 · enumOptionalPossible values:
Published resource availability modes.
maintenanceMessage_en_USstring | nullableOptional
Maintenance message for the published resource in English.
maintenanceMessage_ja_JPstring | nullableOptional
Maintenance message for the published resource in Japanese.
maintenanceMessage_fr_FRstring | nullableOptional
Maintenance message for the published resource in French.
maintenanceMessage_es_ESstring | nullableOptional
Maintenance message for the published resource in Spanish.
maintenanceMessage_it_ITstring | nullableOptional
Maintenance message for the published resource in Italian.
maintenanceMessage_pt_BRstring | nullableOptional
Maintenance message for the published resource in Portuguese.
maintenanceMessage_nl_NLstring | nullableOptional
Maintenance message for the published resource in Dutch.
maintenanceMessage_de_DEstring | nullableOptional
Maintenance message for the published resource in German.
maintenanceMessage_zh_TWstring | nullableOptional
Maintenance message for the published resource in Chinese (Traditional).
maintenanceMessage_zh_CNstring | nullableOptional
Maintenance message for the published resource in Chinese (Simplified).
maintenanceMessage_ko_KRstring | 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.
adminOnlyboolean | nullableOptional
Use folder for administrative purposes only.
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}/Folders HTTP/1.1
Host:
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 598
{
"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,
"adminOnly": true
}No content
Delete a published folder
Path parameters
idinteger · int32Required
ID of the published folder 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}/Folders HTTP/1.1
Host:
Accept: */*
No content
Was this helpful?