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.0
Body
{
"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)