Products
Support
Partners
Documentation

Publishing Sample

Logon

Request

POST api/Session/logon

Headers

Content-Type: application/json; api-version=1.0

Body

{
  "username":"administrator",
  "password":"11112222"
}

Response

Status:OK (200) 

{
  "authToken": "[AUTHENTICATION_TOKEN]"
}

New Published RDS App

Request

POST api/pubrdsapps

Headers

Content-Type: application/json; api-version=1.0
auth_token: [AUTHENTICATION_TOKEN]

Body

{
  "target":"notepad.exe",
  "name":"Text Editor"
}

Response

Status:Created (201)

{
  "publishFromServer": [],
  "publishFromGroup": [],
  "perServerAttributes": [],
  "publishFrom": 0,
  "enableFileExtensions": false,
  "inheritDisplayDefaultSettings": true,
  "replicateDisplaySettings": false,
  "startMaximized": true,
  "startFullscreen": true,
  "waitForPrinters": false,
  "waitForPrintersTimeout": 20,
  "colorDepth": 5,
  "inheritLicenseDefaultSettings": true,
  "replicateLicenseSettings": false,
  "replicateFileExtensionSettings": false,
  "replicateDefaultServerSettings": false,
  "disableSessionSharing": false,
  "oneInstancePerUser": false,
  "conCurrentLicenses": 0,
  "licenseLimitNotify": 0,
  "fileExtensions": [],
  "winType": 0,
  "parameters": "",
  "startIn": "",
  "target": "notepad.exe",
  "startOnLogon": false,
  "excludePrelaunch": false,
  "inheritShortcutDefaultSettings": true,
  "replicateShortcutSettings": false,
  "createShortcutOnDesktop": true,
  "createShortcutInStartFolder": false,
  "createShortcutInStartUpFolder": false,
  "startPath": "RAS Remote Desktops & Applications\\%Groups%",
  "name": "Text Editor",
  "type": 2,
  "parentId": 0,
  "previousId": 0,
  "description": "",
  "enabled": true,
  "publishToSite": [
    1
  ],
  "userFilterEnabled": false,
  "userFilterReplicate": false,
  "allowedUsers": [],
  "clientFilterEnabled": false,
  "clientFilterReplicate": false,
  "allowedClients": [],
  "ipFilterEnabled": false,
  "ipFilterReplicate": false,
  "allowedIP4s": [],
  "allowedIP6s": [],
  "macFilterEnabled": false,
  "macFilterReplicate": false,
  "allowedMACs": [],
  "gwFilterEnabled": false,
  "allowedGWs": [],
  "osFilterEnabled": false,
  "osFilterReplicate": false,
  "allowedOSes": {
    "chrome": true,
    "android": true,
    "WebClient": true,
    "iOS": true,
    "linux": true,
    "mac": true,
    "webPortal": true,
    "windows": true,
    "wyse": true
  },
  "id": 172
}

Get Published RDS App

Request

GET api/pubrdsapps/172

Headers

Content-Type: application/json; api-version=1.0
auth_token: [AUTHENTICATION_TOKEN]

Response

Status:OK (200)

{
  "publishFromServer": [],
  "publishFromGroup": [],
  "perServerAttributes": [],
  "publishFrom": 0,
  "enableFileExtensions": false,
  "inheritDisplayDefaultSettings": true,
  "replicateDisplaySettings": false,
  "startMaximized": true,
  "startFullscreen": true,
  "waitForPrinters": false,
  "waitForPrintersTimeout": 20,
  "colorDepth": 5,
  "inheritLicenseDefaultSettings": true,
  "replicateLicenseSettings": false,
  "replicateFileExtensionSettings": false,
  "replicateDefaultServerSettings": false,
  "disableSessionSharing": false,
  "oneInstancePerUser": false,
  "conCurrentLicenses": 0,
  "licenseLimitNotify": 0,
  "fileExtensions": [],
  "winType": 0,
  "parameters": "",
  "startIn": "",
  "target": "notepad.exe",
  "startOnLogon": false,
  "excludePrelaunch": false,
  "inheritShortcutDefaultSettings": true,
  "replicateShortcutSettings": false,
  "createShortcutOnDesktop": true,
  "createShortcutInStartFolder": false,
  "createShortcutInStartUpFolder": false,
  "startPath": "RAS Remote Desktops & Applications\\%Groups%",
  "name": "Text Editor",
  "type": 2,
  "parentId": 0,
  "previousId": 172,
  "description": "",
  "enabled": true,
  "publishToSite": [
    1
  ],
  "userFilterEnabled": false,
  "userFilterReplicate": false,
  "allowedUsers": [],
  "clientFilterEnabled": false,
  "clientFilterReplicate": false,
  "allowedClients": [],
  "ipFilterEnabled": false,
  "ipFilterReplicate": false,
  "allowedIP4s": [],
  "allowedIP6s": [],
  "macFilterEnabled": false,
  "macFilterReplicate": false,
  "allowedMACs": [],
  "gwFilterEnabled": false,
  "allowedGWs": [],
  "osFilterEnabled": false,
  "osFilterReplicate": false,
  "allowedOSes": {
    "chrome": true,
    "android": true,
    "WebClient": true,
    "iOS": true,
    "linux": true,
    "mac": true,
    "webPortal": true,
    "windows": true,
    "wyse": true
  },
  "id": 172
}

New Client Filter For Published RDS App

Request

POST api/pubrdsapps/172/ClientFilters

Headers

Content-Type: application/json; api-version=1.0
auth_token: [AUTHENTICATION_TOKEN]

Body

{
  "client":"parallels"
}

New Published RDS Desktop

Response

Status:Created (201)

[
  "parallels"
]
Request

POST api/pubrdsdesktops

Headers

Content-Type: application/json; api-version=1.0
auth_token: [AUTHENTICATION_TOKEN]

Body

{
  "name":"rainbow"
}

Response

Status:Created (201)

{
  "connectToConsole": false,
  "publishFromServer": [],
  "publishFromGroup": [],
  "publishFrom": 0,
  "useAvailableArea": false,
  "width": 0,
  "height": 0,
  "allowMultiMonitor": 2,
  "startOnLogon": false,
  "excludePrelaunch": false,
  "inheritShortcutDefaultSettings": true,
  "replicateShortcutSettings": false,
  "createShortcutOnDesktop": true,
  "createShortcutInStartFolder": false,
  "createShortcutInStartUpFolder": false,
  "startPath": "RAS Remote Desktops & Applications\\%Groups%",
  "name": "rainbow",
  "type": 3,
  "parentId": 0,
  "previousId": 172,
  "description": "",
  "enabled": true,
  "publishToSite": [
    1
  ],
  "userFilterEnabled": false,
  "userFilterReplicate": false,
  "allowedUsers": [],
  "clientFilterEnabled": false,
  "clientFilterReplicate": false,
  "allowedClients": [],
  "ipFilterEnabled": false,
  "ipFilterReplicate": false,
  "allowedIP4s": [],
  "allowedIP6s": [],
  "macFilterEnabled": false,
  "macFilterReplicate": false,
  "allowedMACs": [],
  "gwFilterEnabled": false,
  "allowedGWs": [],
  "osFilterEnabled": false,
  "osFilterReplicate": false,
  "allowedOSes": {
    "chrome": true,
    "android": true,
    "WebClient": true,
    "iOS": true,
    "linux": true,
    "mac": true,
    "webPortal": true,
    "windows": true,
    "wyse": true
  },
  "id": 174
}

Get Published RDS Desktop

Request

GET api/pubrdsdesktops/174

Headers

Content-Type: application/json; api-version=1.0
auth_token: [AUTHENTICATION_TOKEN]

Response

Status:OK (200)

{
  "connectToConsole": false,
  "publishFromServer": [],
  "publishFromGroup": [],
  "publishFrom": 0,
  "useAvailableArea": false,
  "width": 0,
  "height": 0,
  "allowMultiMonitor": 2,
  "startOnLogon": false,
  "excludePrelaunch": false,
  "inheritShortcutDefaultSettings": true,
  "replicateShortcutSettings": false,
  "createShortcutOnDesktop": true,
  "createShortcutInStartFolder": false,
  "createShortcutInStartUpFolder": false,
  "startPath": "RAS Remote Desktops & Applications\\%Groups%",
  "name": "rainbow",
  "type": 3,
  "parentId": 0,
  "previousId": 172,
  "description": "",
  "enabled": true,
  "publishToSite": [
    1
  ],
  "userFilterEnabled": false,
  "userFilterReplicate": false,
  "allowedUsers": [],
  "clientFilterEnabled": false,
  "clientFilterReplicate": false,
  "allowedClients": [],
  "ipFilterEnabled": false,
  "ipFilterReplicate": false,
  "allowedIP4s": [],
  "allowedIP6s": [],
  "macFilterEnabled": false,
  "macFilterReplicate": false,
  "allowedMACs": [],
  "gwFilterEnabled": false,
  "allowedGWs": [],
  "osFilterEnabled": false,
  "osFilterReplicate": false,
  "allowedOSes": {
    "chrome": true,
    "android": true,
    "WebClient": true,
    "iOS": true,
    "linux": true,
    "mac": true,
    "webPortal": true,
    "windows": true,
    "wyse": true
  },
  "id": 174
}

New IP Filter For Published RDS Desktop

Request

POST api/pubrdsdesktops/174/IPFilters

Headers

Content-Type: application/json; api-version=1.0
auth_token: [AUTHENTICATION_TOKEN]

Body

{
  "ip":"1.2.3.4"
}

Response

Status:Created (201)

{
  "allowedIP4s": [
    {
      "from": "1.2.3.4",
      "to": "1.2.3.4"
    }
  ],
  "allowedIP6s": []
}

New Published Folder

Request

POST api/pubfolders

Headers

Content-Type: application/json; api-version=1.0
auth_token: [AUTHENTICATION_TOKEN]

Body

{
  "name":"monitor"
}

Response

Status:Created (201)

{
  "adminOnly": false,
  "name": "monitor",
  "type": 1,
  "parentId": 0,
  "previousId": 172,
  "description": "",
  "enabled": true,
  "publishToSite": [
    1
  ],
  "userFilterEnabled": false,
  "userFilterReplicate": false,
  "allowedUsers": [],
  "clientFilterEnabled": false,
  "clientFilterReplicate": false,
  "allowedClients": [],
  "ipFilterEnabled": false,
  "ipFilterReplicate": false,
  "allowedIP4s": [],
  "allowedIP6s": [],
  "macFilterEnabled": false,
  "macFilterReplicate": false,
  "allowedMACs": [],
  "gwFilterEnabled": false,
  "allowedGWs": [],
  "osFilterEnabled": false,
  "osFilterReplicate": false,
  "allowedOSes": {
    "chrome": true,
    "android": true,
    "WebClient": true,
    "iOS": true,
    "linux": true,
    "mac": true,
    "webPortal": true,
    "windows": true,
    "wyse": true
  },
  "id": 175
}

Get Published Folder

Request

GET api/pubfolders/175

Headers

Content-Type: application/json; api-version=1.0
auth_token: [AUTHENTI