| Request |
|---|
| Response |
|---|
| Request |
|---|
| Response |
|---|
| Request |
|---|
| Response |
|---|
| Request |
|---|
| Response |
|---|
| Request |
|---|
| Response |
|---|
| Request |
|---|
| Response |
|---|
| Request |
|---|
| Response |
|---|
| Request |
|---|
| Response |
|---|
| Request |
|---|
| Response |
|---|
| Request |
|---|
| Response |
|---|
| Request |
|---|
| Response |
|---|
| Request |
|---|
| Response |
|---|
| Request |
|---|
| Response |
|---|
| Request |
|---|
| Response |
|---|
| Request |
|---|
| Response |
|---|
| Request |
|---|
| Response |
|---|
| Request |
|---|
| Response |
|---|
| Request |
|---|
| Response |
|---|
| Request |
|---|
| Response |
|---|
| Request |
|---|
| Response |
|---|
| Request |
|---|
| Response |
|---|
| Request |
|---|
| Response |
|---|
| Request |
|---|
| Response |
|---|
| Request |
|---|
| Response |
|---|
| Request |
|---|
| Response |
|---|
| Request |
|---|
| Response |
|---|
POST api/Session/logon
Headers
Content-Type: application/json; api-version=1.0Body
{
"username":"administrator",
"password":"11112222"
}Status:OK (200)
{
"authToken": "[AUTHENTICATION_TOKEN]"
}GET api/site
Headers
Content-Type: application/json; api-version=1.0
auth_token: [AUTHENTICATION_TOKEN]Status:OK (200)
[
{
"name": "site11",
"licensingSite": true,
"id": 1
}
]GET api/site/1
Headers
Content-Type: application/json; api-version=1.0
auth_token: [AUTHENTICATION_TOKEN]Status:OK (200)
{
"name": "site11",
"licensingSite": true,
"id": 1
}GET api/gateway
Headers
Content-Type: application/json; api-version=1.0
auth_token: [AUTHENTICATION_TOKEN]Status:OK (200)
[
{
"gwMode": 0,
"preferredPAId": 0,
"normalModeForwarding": false,
"forwardHttpServers": "localhost:81",
"forwardGatewayServers": "",
"ipVersion": 0,
"iPs": "126.0.0.5",
"bindV4Addresses": "",
"bindV6Addresses": "",
"optimizeConnectionIPv4": "",
"optimizeConnectionIPv6": "",
"enableGWPort": true,
"broadcast": true,
"enableClientManagerPort": true,
"dosPro": true,
"enableRDP": false,
"enableRDPUDP": true,
"gwPort": 80,
"rdpPort": 3389,
"enableSSL": true,
"minSSLVersion": 2,
"cipherStrength": 2,
"sslPort": 443,
"cipher": "EECDH:!SSLv2:!SSLv3:!aNULL:!RC4:!ADH:!eNULL:!LOW:!MEDIUM:!EXP:+HIGH",
"privateKeyFile": "SelfSignedCertificate.crt",
"certificateFile": "SelfSignedCertificate.crt",
"enableUserPortal": true,
"UserPortalPort": 20020,
"launchMethod": 0,
"allowEmbed": false,
"allowlaunchMethod": true,
"allowAppsInNewTab": false,
"allowFileTransfer": true,
"allowClipboard": true,
"usePreWin2000LoginFormat": true,
"enableHSTS": false,
"hstsIncludeSubdomains": false,
"hstsPreload": false,
"hstsMaxAge": 12,
"enableWyseSupport": true,
"securityMode": 0,
"macAllowExceptLst": [],
"macAllowOnlyLst": [],
"webRequestsURL": "",
"fwGWID": 4294967295,
"server": "126.0.0.5",
"enabled": true,
"description": "",
"siteId": 1,
"id": 218
}
]POST api/gateway?noinstall=true
Headers
Content-Type: application/json; api-version=1.0
auth_token: [AUTHENTICATION_TOKEN]Body
{
"server":"126.0.0.6",
"siteId":"1"
} Status:Created (201)
{
"gwMode": 0,
"preferredPAId": 0,
"normalModeForwarding": false,
"forwardHttpServers": "localhost:81",
"forwardGatewayServers": "",
"ipVersion": 0,
"iPs": "126.0.0.6",
"bindV4Addresses": "",
"bindV6Addresses": "",
"optimizeConnectionIPv4": "",
"optimizeConnectionIPv6": "",
"enableGWPort": true,
"broadcast": true,
"enableClientManagerPort": true,
"dosPro": true,
"enableRDP": false,
"enableRDPUDP": true,
"gwPort": 80,
"rdpPort": 3389,
"enableSSL": true,
"minSSLVersion": 2,
"cipherStrength": 2,
"sslPort": 443,
"cipher": "EECDH:!SSLv2:!SSLv3:!aNULL:!RC4:!ADH:!eNULL:!LOW:!MEDIUM:!EXP:+HIGH",
"privateKeyFile": "SelfSignedCertificate.crt",
"certificateFile": "SelfSignedCertificate.crt",
"enableUserPortal": true,
"UserPortalPort": 20020,
"launchMethod": 0,
"allowEmbed": false,
"allowlaunchMethod": true,
"allowAppsInNewTab": false,
"allowFileTransfer": true,
"allowClipboard": true,
"usePreWin2000LoginFormat": true,
"enableHSTS": false,
"hstsIncludeSubdomains": false,
"hstsPreload": false,
"hstsMaxAge": 12,
"enableWyseSupport": true,
"securityMode": 0,
"macAllowExceptLst": [],
"macAllowOnlyLst": [],
"webRequestsURL": "",
"fwGWID": 4294967295,
"server": "126.0.0.6",
"enabled": true,
"description": "",
"siteId": 1,
"id": 219
}GET api/gateway/219
Headers
Content-Type: application/json; api-version=1.0
auth_token: [AUTHENTICATION_TOKEN]Status:OK (200)
{
"gwMode": 0,
"preferredPAId": 0,
"normalModeForwarding": false,
"forwardHttpServers": "localhost:81",
"forwardGatewayServers": "",
"ipVersion": 0,
"iPs": "126.0.0.6",
"bindV4Addresses": "",
"bindV6Addresses": "",
"optimizeConnectionIPv4": "",
"optimizeConnectionIPv6": "",
"enableGWPort": true,
"broadcast": true,
"enableClientManagerPort": true,
"dosPro": true,
"enableRDP": false,
"enableRDPUDP": true,
"gwPort": 80,
"rdpPort": 3389,
"enableSSL": true,
"minSSLVersion": 2,
"cipherStrength": 2,
"sslPort": 443,
"cipher": "EECDH:!SSLv2:!SSLv3:!aNULL:!RC4:!ADH:!eNULL:!LOW:!MEDIUM:!EXP:+HIGH",
"privateKeyFile": "SelfSignedCertificate.crt",
"certificateFile": "SelfSignedCertificate.crt",
"enableUserPortal": true,
"UserPortalPort": 20020,
"launchMethod": 0,
"allowEmbed": false,
"allowlaunchMethod": true,
"allowAppsInNewTab": false,
"allowFileTransfer": true,
"allowClipboard": true,
"usePreWin2000LoginFormat": true,
"enableHSTS": false,
"hstsIncludeSubdomains": false,
"hstsPreload": false,
"hstsMaxAge": 12,
"enableWyseSupport": true,
"securityMode": 0,
"macAllowExceptLst": [],
"macAllowOnlyLst": [],
"webRequestsURL": "",
"fwGWID": 4294967295,
"server": "126.0.0.6",
"enabled": true,
"description": "",
"siteId": 1,
"id": 219
}POST api/rds?noinstall=true
Headers
Content-Type: application/json; api-version=1.0
auth_token: [AUTHENTICATION_TOKEN]Body
{
"server":"rds.company.dom",
"siteId":"1"
}Status:Created (201)
{
"directAddress": "rds.company.dom",
"rasTemplateId": 0,
"inheritDefaultAgentSettings": true,
"inheritDefaultPrinterSettings": true,
"inheritDefaultUPDSettings": true,
"inheritDefaultDesktopAccessSettings": true,
"port": 3389,
"maxSessions": 250,
"sessionTimeout": 25,
"sessionLogoffTimeout": 0,
"allowURLAndMailRedirection": 1,
"allowRemoteExec": true,
"enableAppMonitoring": true,
"useRemoteApps": false,
"allowFileTransfer": true,
"allowDragAndDrop": true,
"preferredPAId": 0,
"enablePrinting": true,
"enableTWAIN": true,
"enableWIA": false,
"printerNameFormat": 0,
"removeClientNameFromPrinterName": false,
"removeSessionNumberFromPrinterName": false,
"updMode": 0,
"maxUserProfileDiskSizeGB": 20,
"diskPath": "\\\\server\\upd-path",
"roamingMode": 0,
"includeFolderPath": [],
"includeFilePath": [],
"excludeFolderPath": [],
"excludeFilePath": [],
"restrictDesktopAccess": false,
"restrictedUsers": [],
"server": "rds.company.dom",
"enabled": true,
"description": "",
"siteId": 1,
"id": 361
}GET api/rds/361/status
Headers
Content-Type: application/json; api-version=1.0
auth_token: [AUTHENTICATION_TOKEN]Status:OK (200)
{
"preferredPA": "MC2019",
"activeSessions": 1,
"disconnectedSessions": 0,
"activeConnections": 1,
"ip": "0.0.0.0",
"loginStatus": 0,
"updStatus": 2,
"cpuLoad": 23,
"memLoad": 48,
"diskRead": 10,
"diskWrite": 0,
"enabled": true,
"id": "361",
"server": "172.30.10.20",
"siteId": 1,
"agentVer": "17.0 (build 21257)",
"serverOS": "Windows Server 2019 Standard Edition (WOW 64)",
"serviceStartTime": "Wed May 15 09:34:08 2019",
"systemBootTime": "Tue May 14 09:30:56 2019",
"unhandledExceptions": 0,
"agentState": 0,
"serverType": 1,
"logLevel": 3
}GET api/rds/sessions
Headers
Content-Type: application/json; api-version=1.0
auth_token: [AUTHENTICATION_TOKEN]Status:OK (200)
[]POST api/Session/logoff
Headers
Content-Type: application/json; api-version=1.0
auth_token: [AUTHENTICATION_TOKEN]Status:OK (200)
Status:No Content (204) |
Status:No Content (204) |
Status:No Content (204) |
Status:No Content (204) |
Status:No Content (204) |
Status:NoContent (204) |
Status:OK (200) |
POST api/Session/logon |
Headers |
Body |
Status:OK (200) |
POST api/pubrdsapps |
Headers |
Body |
Status:Created (201) |
GET api/pubrdsapps/172 |
Headers |
Status:OK (200) |
POST api/pubrdsapps/172/ClientFilters |
Headers |
Body |
Status:Created (201) |
POST api/pubrdsdesktops |
Headers |
Body |
Status:Created (201) |
GET api/pubrdsdesktops/174 |
Headers |
Status:OK (200) |
POST api/pubrdsdesktops/174/IPFilters |
Headers |
Body |
Status:Created (201) |
POST api/pubfolders |
Headers |
Body |
Status:Created (201) |
GET api/pubfolders/175 |
Headers |
Status:OK (200) |
POST api/pubfolders/175/MACFilters |
Headers |
Body |
Status:Created (201) |
GET api/PubItems |
Headers |
Status:OK (200) |
DELETE api/pubrdsapps/172/ClientFilters/parallels |
Headers |
DELETE api/pubrdsapps/172 |
Headers |
DELETE api/pubrdsdesktops/174/IPFilters/1.2.3.4 |
Headers |
DELETE api/pubrdsdesktops/174 |
Headers |
DELETE api/pubfolders/175/MACFilters/MAC_filter |
Headers |
DELETE api/pubfolders/175 |
Headers |
POST api/Session/logoff |
Headers |
| Request |
|---|
| Response |
|---|
| Request |
|---|
| Response |
|---|
| Request |
|---|
| Response |
|---|
| Request |
|---|
| Response |
|---|
| Request |
|---|
| Response |
|---|
| Request |
|---|
| Response |
|---|
| Request |
|---|
| Response |
|---|
| Request |
|---|
| Response |
|---|
| Request |
|---|
| Response |
|---|
| Request |
|---|
| Response |
|---|
| Request |
|---|
| Response |
|---|
| Request |
|---|
| Response |
|---|
| Request |
|---|
| Response |
|---|
| Request |
|---|
| Response |
|---|
| Request |
|---|
| Response |
|---|
| Request |
|---|
| Response |
|---|
| Request |
|---|
| Response |
|---|
| Request |
|---|
| Response |
|---|
| Request |
|---|
| Response |
|---|
| Request |
|---|
| Response |
|---|
| Request |
|---|
| Response |
|---|
| Request |
|---|
| Response |
|---|
| Request |
|---|
| Response |
|---|
POST api/Session/logon
Headers
Content-Type: application/json; api-version=1.0Body
{
"username":"administrator",
"password":"11112222"
}Status:OK (200)
{
"authToken": "[AUTHENTICATION_TOKEN]"
}GET api/rds
Headers
Content-Type: application/json; api-version=1.0
auth_token: [AUTHENTICATION_TOKEN]Status:OK (200)
[
{
"directAddress": "rds.trtr.co.mt",
"rasTemplateId": 0,
"inheritDefaultAgentSettings": true,
"inheritDefaultPrinterSettings": true,
"inheritDefaultUPDSettings": true,
"inheritDefaultDesktopAccessSettings": true,
"port": 3389,
"maxSessions": 250,
"sessionTimeout": 25,
"sessionLogoffTimeout": 0,
"allowURLAndMailRedirection": 1,
"allowRemoteExec": true,
"enableAppMonitoring": true,
"useRemoteApps": false,
"allowFileTransfer": true,
"allowDragAndDrop": true,
"preferredPAId": 0,
"enablePrinting": true,
"enableTWAIN": true,
"enableWIA": false,
"printerNameFormat": 0,
"removeClientNameFromPrinterName": false,
"removeSessionNumberFromPrinterName": false,
"updMode": 0,
"maxUserProfileDiskSizeGB": 20,
"diskPath": "\\\\server\\upd-path",
"roamingMode": 0,
"includeFolderPath": [],
"includeFilePath": [],
"excludeFolderPath": [],
"excludeFilePath": [],
"restrictDesktopAccess": false,
"restrictedUsers": [],
"server": "rds.trtr.co.mt",
"enabled": false,
"description": "",
"siteId": 1,
"id": 361
}
]POST api/rds?noinstall=true
Headers
Content-Type: application/json; api-version=1.0
auth_token: [AUTHENTICATION_TOKEN]Status:Created (201)
{
"directAddress": "rds.company.dom",
"rasTemplateId": 0,
"inheritDefaultAgentSettings": true,
"inheritDefaultPrinterSettings": true,
"inheritDefaultUPDSettings": true,
"inheritDefaultDesktopAccessSettings": true,
"port": 3389,
"maxSessions": 250,
"sessionTimeout": 25,
"sessionLogoffTimeout": 0,
"allowURLAndMailRedirection": 1,
"allowRemoteExec": true,
"enableAppMonitoring": true,
"useRemoteApps": false,
"allowFileTransfer": true,
"allowDragAndDrop": true,
"preferredPAId": 0,
"enablePrinting": true,
"enableTWAIN": true,
"enableWIA": false,
"printerNameFormat": 0,
"removeClientNameFromPrinterName": false,
"removeSessionNumberFromPrinterName": false,
"updMode": 0,
"maxUserProfileDiskSizeGB": 20,
"diskPath": "\\\\server\\upd-path",
"roamingMode": 0,
"includeFolderPath": [],
"includeFilePath": [],
"excludeFolderPath": [],
"excludeFilePath": [],
"restrictDesktopAccess": false,
"restrictedUsers": [],
"server": "rds.company.dom",
"enabled": true,
"description": "",
"siteId": 1,
"id": 362
}POST api/Settings/Apply
Headers
Content-Type: application/json; api-version=1.0
auth_token: [AUTHENTICATION_TOKEN]Status:No Content (204)
GET api/rds/361/status
Headers
Content-Type: application/json; api-version=1.0
auth_token: [AUTHENTICATION_TOKEN]Status:OK (200)
{
"preferredPA": "MC2019",
"activeSessions": 1,
"disconnectedSessions": 0,
"activeConnections": 1,
"ip": "0.0.0.0",
"loginStatus": 0,
"updStatus": 2,
"cpuLoad": 23,
"memLoad": 48,
"diskRead": 10,
"diskWrite": 0,
"enabled": true,
"id": "361",
"server": "172.30.10.20",
"siteId": 1,
"agentVer": "17.0 (build 21257)",
"serverOS": "Windows Server 2019 Standard Edition (WOW 64)",
"serviceStartTime": "Wed May 15 09:34:08 2019",
"systemBootTime": "Tue May 14 09:30:56 2019",
"unhandledExceptions": 0,
"agentState": 0,
"serverType": 1,
"logLevel": 3
}GET api/rds/sessions
Headers
Content-Type: application/json; api-version=1.0
auth_token: [AUTHENTICATION_TOKEN]Status:OK (200)
[
{
"sessionID": 1,
"type": 7,
"state": 5,
"protocol": 2,
"user": "Administrator",
"ip": "0.0.0.0",
"serverID": 361,
"themeID": 0,
"logonTime": "2019-05-07T09:19:59",
"deviceName": "DESKTOP",
"idleStartTime": "2019-05-29T09:02:38",
"verticalResolution": 1080,
"horizontalResolution": 1920,
"colourDepth": 32
},
{
"sessionID": 2,
"type": 7,
"state": 5,
"protocol": 2,
"user": "Administrator",
"ip": "0.0.0.0",
"serverID": 361,
"themeID": 0,
"logonTime": "2019-05-07T09:54:01",
"deviceName": "Bill PC",
"idleStartTime": "2019-05-27T13:10:46",
"verticalResolution": 855,
"horizontalResolution": 1404,
"colourDepth": 32
}
]POST api/rdsgroups
Headers
Content-Type: application/json; api-version=1.0
auth_token: [AUTHENTICATION_TOKEN]Body
{
"name":"NewGroupOfRds"
}Status:Created (201)
{
"rdsDefSettings": {
"port": 3389,
"maxSessions": 250,
"sessionTimeout": 25,
"sessionLogoffTimeout": 0,
"allowURLAndMailRedirection": 1,
"preferredPAId": 0,
"allowRemoteExec": true,
"enableAppMonitoring": true,
"useRemoteApps": false,
"allowFileTransfer": true,
"allowDragAndDrop": true,
"enablePrinting": true,
"enableTWAIN": true,
"enableWIA": false,
"printerNameFormat": 0,
"removeClientNameFromPrinterName": false,
"removeSessionNumberFromPrinterName": false,
"updMode": 0,
"maxUserProfileDiskSizeGB": 20,
"diskPath": "\\\\server\\upd-path",
"roamingMode": 0,
"includeFolderPath": [],
"includeFilePath": [],
"excludeFolderPath": [],
"excludeFilePath": [],
"restrictDesktopAccess": false,
"restrictedUsers": []
},
"name": "NewGroupOfRds",
"siteId": 1,
"enabled": true,
"description": "",
"useRASTemplate": false,
"rasTemplateId": 0,
"workLoadThreshold": 75,
"serversToAddPerRequest": 1,
"maxServersFromTemplate": 2,
"workLoadToDrain": 20,
"removeServersAfterDrainAndPowerOff": false,
"inheritDefaultAgentSettings": true,
"inheritDefaultPrinterSettings": true,
"inheritDefaultUPDSettings": true,
"inheritDefaultDesktopAccessSettings": true,
"rdsIds": [],
"id": 160
}POST api/rdsgroups/161/Members
Headers
Content-Type: application/json; api-version=1.0
auth_token: [AUTHENTICATION_TOKEN]Body
{
"rdsids": [363]
}Status:Created (201)
PUT api/rdsgroups/161
Headers
Content-Type: application/json; api-version=1.0
auth_token: [AUTHENTICATION_TOKEN]Body
{
"newname":"AnotherRdsGroup",
"description":"another_group_of_servers"
}Status:NoContent (204)
POST api/Session/logoff
Headers
Content-Type: application/json; api-version=1.0
auth_token: [AUTHENTICATION_TOKEN]Status:OK (200)
Status:No Content (204) |
Status:No Content (204) |
Status:No Content (204) |
Status:No Content (204) |
Status:No Content (204) |
Status:OK (200) |
Content-Type: application/json; api-version=1.0{
"username":"administrator",
"password":"11112222"
}{
"authToken": "[AUTHENTICATION_TOKEN]"
}Content-Type: application/json; api-version=1.0
auth_token: [AUTHENTICATION_TOKEN]{
"target":"notepad.exe",
"name":"Text Editor"
}{
"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
}Content-Type: application/json; api-version=1.0
auth_token: [AUTHENTICATION_TOKEN]{
"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
}Content-Type: application/json; api-version=1.0
auth_token: [AUTHENTICATION_TOKEN]{
"client":"parallels"
}[
"parallels"
]Content-Type: application/json; api-version=1.0
auth_token: [AUTHENTICATION_TOKEN]{
"name":"rainbow"
}{
"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
}Content-Type: application/json; api-version=1.0
auth_token: [AUTHENTICATION_TOKEN]{
"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
}Content-Type: application/json; api-version=1.0
auth_token: [AUTHENTICATION_TOKEN]{
"ip":"1.2.3.4"
}{
"allowedIP4s": [
{
"from": "1.2.3.4",
"to": "1.2.3.4"
}
],
"allowedIP6s": []
}Content-Type: application/json; api-version=1.0
auth_token: [AUTHENTICATION_TOKEN]{
"name":"monitor"
}{
"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
}Content-Type: application/json; api-version=1.0
auth_token: [AUTHENTICATION_TOKEN]{
"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
}Content-Type: application/json; api-version=1.0
auth_token: [AUTHENTICATION_TOKEN]{
"mac":"MAC_filter"
}[
"MAC_filter"
]Content-Type: application/json; api-version=1.0
auth_token: [AUTHENTICATION_TOKEN][
{
"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": [
{
"parallels"
}
],
"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
},
{
"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": [
{
"from": "1.2.3.4",
"to": "1.2.3.4"
}
],
"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
},
{
"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": [
{
"mac":"MAC_filter"
}
],
"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
}
]Content-Type: application/json; api-version=1.0
auth_token: [AUTHENTICATION_TOKEN]Content-Type: application/json; api-version=1.0
auth_token: [AUTHENTICATION_TOKEN]Content-Type: application/json; api-version=1.0
auth_token: [AUTHENTICATION_TOKEN]Content-Type: application/json; api-version=1.0
auth_token: [AUTHENTICATION_TOKEN]Content-Type: application/json; api-version=1.0
auth_token: [AUTHENTICATION_TOKEN]Content-Type: application/json; api-version=1.0
auth_token: [AUTHENTICATION_TOKEN]Content-Type: application/json; api-version=1.0
auth_token: [AUTHENTICATION_TOKEN]POST api/Session/logon |
Headers |
Body |
Status:OK (200) |
GET api/gateway |
Headers |
Status:OK (200) |
POST api/gateway |
Headers |
Body |
Status:Created (201) |
GET api/gateway/220 |
Headers |
Status:OK (200) |
PUT api/gateway/220 |
Headers |
Body |
DELETE api/gateway/224 |
Headers |
GET api/broker |
Headers |
Status:OK (200) |
POST api/broker |
Headers |
Body |
Status:Created (201) |
GET api/broker/status |
Headers |
Status:OK (200) |
PUT api/broker/133 |
Headers |
Body |
PUT api/broker/133/priority |
Headers |
Body |
Status:Bad Request (400) |
POST api/broker/133/Promote |
Headers |
Status:Bad Request (400) |
DELETE api/broker/133 |
Headers |
POST api/Settings/Apply |
Headers |
POST api/Session/logoff |
Headers |
| Request |
|---|
| Response |
|---|
| Request |
|---|
| Response |
|---|
| Request |
|---|
| Response |
|---|
Status:OK (200) |
Content-Type: application/json; api-version=1.0{
"username":"administrator",
"password":"11112222"
}{
"authToken": "[AUTHENTICATION_TOKEN]"
}Content-Type: application/json; api-version=1.0
auth_token: [AUTHENTICATION_TOKEN][
{
"gwMode": 0,
"preferredPAId": 0,
"normalModeForwarding": false,
"forwardHttpServers": "localhost:81",
"forwardGatewayServers": "",
"ipVersion": 0,
"iPs": "126.0.0.5",
"bindV4Addresses": "",
"bindV6Addresses": "",
"optimizeConnectionIPv4": "",
"optimizeConnectionIPv6": "",
"enableGWPort": true,
"broadcast": true,
"enableClientManagerPort": true,
"dosPro": true,
"enableRDP": false,
"enableRDPUDP": true,
"gwPort": 80,
"rdpPort": 3389,
"enableSSL": true,
"minSSLVersion": 2,
"cipherStrength": 2,
"sslPort": 443,
"cipher": "EECDH:!SSLv2:!SSLv3:!aNULL:!RC4:!ADH:!eNULL:!LOW:!MEDIUM:!EXP:+HIGH",
"privateKeyFile": "SelfSignedCertificate.crt",
"certificateFile": "SelfSignedCertificate.crt",
"enableUserPortal": true,
"UserPortalPort": 20020,
"launchMethod": 0,
"allowEmbed": false,
"allowlaunchMethod": true,
"allowAppsInNewTab": false,
"allowFileTransfer": true,
"allowClipboard": true,
"usePreWin2000LoginFormat": true,
"enableHSTS": false,
"hstsIncludeSubdomains": false,
"hstsPreload": false,
"hstsMaxAge": 12,
"enableWyseSupport": true,
"securityMode": 0,
"macAllowExceptLst": [],
"macAllowOnlyLst": [],
"webRequestsURL": "",
"fwGWID": 4294967295,
"server": "126.0.0.5",
"enabled": true,
"description": "",
"siteId": 1,
"id": 218
}
]Content-Type: application/json; api-version=1.0
auth_token: [AUTHENTICATION_TOKEN]{
"server":"126.0.0.6",
"siteId":"1"
}{
"gwMode": 0,
"preferredPAId": 0,
"normalModeForwarding": false,
"forwardHttpServers": "localhost:81",
"forwardGatewayServers": "",
"ipVersion": 0,
"iPs": "126.0.0.6",
"bindV4Addresses": "",
"bindV6Addresses": "",
"optimizeConnectionIPv4": "",
"optimizeConnectionIPv6": "",
"enableGWPort": true,
"broadcast": true,
"enableClientManagerPort": true,
"dosPro": true,
"enableRDP": false,
"enableRDPUDP": true,
"gwPort": 80,
"rdpPort": 3389,
"enableSSL": true,
"minSSLVersion": 2,
"cipherStrength": 2,
"sslPort": 443,
"cipher": "EECDH:!SSLv2:!SSLv3:!aNULL:!RC4:!ADH:!eNULL:!LOW:!MEDIUM:!EXP:+HIGH",
"privateKeyFile": "SelfSignedCertificate.crt",
"certificateFile": "SelfSignedCertificate.crt",
"enableUserPortal": true,
"UserPortalPort": 20020,
"launchMethod": 0,
"allowEmbed": false,
"allowlaunchMethod": true,
"allowAppsInNewTab": false,
"allowFileTransfer": true,
"allowClipboard": true,
"usePreWin2000LoginFormat": true,
"enableHSTS": false,
"hstsIncludeSubdomains": false,
"hstsPreload": false,
"hstsMaxAge": 12,
"enableWyseSupport": true,
"securityMode": 0,
"macAllowExceptLst": [],
"macAllowOnlyLst": [],
"webRequestsURL": "",
"fwGWID": 4294967295,
"server": "126.0.0.6",
"enabled": true,
"description": "",
"siteId": 1,
"id": 220
}Content-Type: application/json; api-version=1.0
auth_token: [AUTHENTICATION_TOKEN]{
"gwMode": 0,
"preferredPAId": 0,
"normalModeForwarding": false,
"forwardHttpServers": "localhost:81",
"forwardGatewayServers": "",
"ipVersion": 0,
"iPs": "126.0.0.6",
"bindV4Addresses": "",
"bindV6Addresses": "",
"optimizeConnectionIPv4": "",
"optimizeConnectionIPv6": "",
"enableGWPort": true,
"broadcast": true,
"enableClientManagerPort": true,
"dosPro": true,
"enableRDP": false,
"enableRDPUDP": true,
"gwPort": 80,
"rdpPort": 3389,
"enableSSL": true,
"minSSLVersion": 2,
"cipherStrength": 2,
"sslPort": 443,
"cipher": "EECDH:!SSLv2:!SSLv3:!aNULL:!RC4:!ADH:!eNULL:!LOW:!MEDIUM:!EXP:+HIGH",
"privateKeyFile": "SelfSignedCertificate.crt",
"certificateFile": "SelfSignedCertificate.crt",
"enableUserPortal": true,
"UserPortalPort": 20020,
"launchMethod": 0,
"allowEmbed": false,
"allowlaunchMethod": true,
"allowAppsInNewTab": false,
"allowFileTransfer": true,
"allowClipboard": true,
"usePreWin2000LoginFormat": true,
"enableHSTS": false,
"hstsIncludeSubdomains": false,
"hstsPreload": false,
"hstsMaxAge": 12,
"enableWyseSupport": true,
"securityMode": 0,
"macAllowExceptLst": [],
"macAllowOnlyLst": [],
"webRequestsURL": "",
"fwGWID": 4294967295,
"server": "126.0.0.6",
"enabled": true,
"description": "",
"siteId": 1,
"id": 220
}Content-Type: application/json; api-version=1.0
auth_token: [AUTHENTICATION_TOKEN]{
"ipversion":"bothVersions",
"enableGWPort":"false"
}Content-Type: application/json; api-version=1.0
auth_token: [AUTHENTICATION_TOKEN]Content-Type: application/json; api-version=1.0
auth_token: [AUTHENTICATION_TOKEN][
{
"priority": 0,
"ip": "10.226.13.23",
"alternativeIPs": "",
"standby": false,
"markedForDeletion": false,
"server": "DESKTOP-OAP0DJ2",
"enabled": true,
"description": "aekaek",
"siteId": 1,
"id": 1
}
]Content-Type: application/json; api-version=1.0
auth_token: [AUTHENTICATION_TOKEN]{
"server":"192.12.0.8",
"siteId":"1"
}{
"priority": 1,
"ip": "192.12.0.8",
"alternativeIPs": "",
"standby": false,
"markedForDeletion": false,
"server": "192.12.0.8",
"enabled": true,
"description": "",
"siteId": 1,
"id": 133
}Content-Type: application/json; api-version=1.0
auth_token: [AUTHENTICATION_TOKEN][
{
"cpuLoad": 0,
"memLoad": 0,
"diskRead": 0,
"diskWrite": 0,
"enabled": true,
"id": "1",
"server": "DESKTOP-OAP0DJ2",
"siteId": 1,
"agentVer": "17.0 (build 21000) vkoutsomanis 0",
"serverOS": "Windows 10 Enterprise Edition (x64)",
"serviceStartTime": "Unknown",
"systemBootTime": "Tue May 14 12:10:39 2019",
"unhandledExceptions": 0,
"agentState": 0,
"serverType": 7,
"logLevel": 3
}
]Content-Type: application/json; api-version=1.0
auth_token: [AUTHENTICATION_TOKEN]{
"enable":"false",
"description":"alternative publishing agent"
}Content-Type: application/json; api-version=1.0
auth_token: [AUTHENTICATION_TOKEN]{
"direction":"up"
}{
"code": 0,
"msg": "Cannot move selected Publishing Agent up."
}Content-Type: application/json; api-version=1.0
auth_token: [AUTHENTICATION_TOKEN]{
"code": 0,
"msg": "Cannot promote RAS Connection Broker - The selected Connection Broker is already set as primary."
}Content-Type: application/json; api-version=1.0
auth_token: [AUTHENTICATION_TOKEN]Content-Type: application/json; api-version=1.0
auth_token: [AUTHENTICATION_TOKEN]Content-Type: application/json; api-version=1.0
auth_token: [AUTHENTICATION_TOKEN]POST api/Session/logon |
Headers |
Body |
Status:OK (200) |
POST api/License/activate |
Headers |
Body |
Status:Bad Request (400) |
GET api/License |
Headers |
Status:OK (200) |
POST api/License/deactivate |
Headers |
Body |
Status:Bad Request (400) |
POST api/Session/logoff |
Headers |
Content-Type: application/json; api-version=1.0{
"username":"administrator",
"password":"11112222"
}{
"authToken": "[AUTHENTICATION_TOKEN]"
}Content-Type: application/json; api-version=1.0
auth_token: [AUTHENTICATION_TOKEN]{
"email":"someone@parallels.com",
"password":"11112222",
"key":"XXX"
}{
"code": 0,
"msg": "invalid login or password"
}Content-Type: application/json; api-version=1.0
auth_token: [AUTHENTICATION_TOKEN]{
"usageToday": "0",
"currPeriodUsage": "0",
"billingPeriodStart": "03/05/2019 05:30",
"billingPeriodEnd": "02/06/2019 05:30",
"paUserName": "Evgeny Danilenko",
"paCompanyName": "Parallels",
"paUserEmail": "edanilenko@parallels.com",
"licenseKey": "****-ME****-****-B9****-CV55K2",
"supportExpireDate": "23/03/2021",
"upgradeInsurance": "23/03/2021",
"licenseFirstActive": "21/02/2018 12:39",
"licenseStatus": "",
"licenseType": "Parallels Remote Application Server SPLA",
"expiryDate": "21/02/2021",
"installedUsers": "",
"usersPeak": "0",
"usersLicenseInfo": "0",
"gracePeriodState": "",
"gracePeriodDaysLeft": "",
"type": 3
}Content-Type: application/json; api-version=1.0
auth_token: [AUTHENTICATION_TOKEN]{
"email":"someone@parallels.com",
"password":"11112222"
}{
"code": 0,
"msg": "Failed to Deactivate - Product not activated with a license key."
}Content-Type: application/json; api-version=1.0
auth_token: [AUTHENTICATION_TOKEN]