Connection Broker and Secure Gateway Sample
Logon
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 All Secure Gateways
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
}
]
New Secure Gateway
POST api/gateway
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": 220
}
Get Secure Gateway
GET api/gateway/220
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": 220
}
Update Secure Gateway
PUT api/gateway/220
Headers
Content-Type: application/json; api-version=1.0
auth_token: [AUTHENTICATION_TOKEN]
Body
{
"ipversion":"bothVersions",
"enableGWPort":"false"
}
Status:No Content (204)
Delete Secure Gateway
DELETE api/gateway/224
Headers
Content-Type: application/json; api-version=1.0
auth_token: [AUTHENTICATION_TOKEN]
Status:No Content (204)
Get All Connection Brokers
GET api/broker
Headers
Content-Type: application/json; api-version=1.0
auth_token: [AUTHENTICATION_TOKEN]
Status:OK (200)
[
{
"priority": 0,
"ip": "10.226.13.23",
"alternativeIPs": "",
"standby": false,
"markedForDeletion": false,
"server": "DESKTOP-OAP0DJ2",
"enabled": true,
"description": "aekaek",
"siteId": 1,
"id": 1
}
]
Create Connection Broker
POST api/broker
Headers
Content-Type: application/json; api-version=1.0
auth_token: [AUTHENTICATION_TOKEN]
Body
{
"server":"192.12.0.8",
"siteId":"1"
}
Status:Created (201)
{
"priority": 1,
"ip": "192.12.0.8",
"alternativeIPs": "",
"standby": false,
"markedForDeletion": false,
"server": "192.12.0.8",
"enabled": true,
"description": "",
"siteId": 1,
"id": 133
}
Get All Conection broker Status
GET api/broker/status
Headers
Content-Type: application/json; api-version=1.0
auth_token: [AUTHENTICATION_TOKEN]
Status:OK (200)
[
{
"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
}
]
Update Connection Broker
PUT api/broker/133
Headers
Content-Type: application/json; api-version=1.0
auth_token: [AUTHENTICATION_TOKEN]
Body
{
"enable":"false",
"description":"alternative publishing agent"
}
Status:No Content (204)
Update Connection Broker Priority
PUT api/broker/133/priority
Headers
Content-Type: application/json; api-version=1.0
auth_token: [AUTHENTICATION_TOKEN]
Body
{
"direction":"up"
}
Status:Bad Request (400)
{
"code": 0,
"msg": "Cannot move selected Publishing Agent up."
}
Promote Connection Broker To Primary
POST api/broker/133/Promote
Headers
Content-Type: application/json; api-version=1.0
auth_token: [AUTHENTICATION_TOKEN]
Status:Bad Request (400)
{
"code": 0,
"msg": "Cannot promote RAS Connection Broker - The selected Connection Broker is already set as primary."
}
Delete Connection Broker
DELETE api/broker/133
Headers
Content-Type: application/json; api-version=1.0
auth_token: [AUTHENTICATION_TOKEN]
Status:No Content (204)
Apply Settings
POST api/Settings/Apply
Headers
Content-Type: application/json; api-version=1.0
auth_token: [AUTHENTICATION_TOKEN]
Status:No Content (204)
LogOff
POST api/Session/logoff
Headers
Content-Type: application/json; api-version=1.0
auth_token: [AUTHENTICATION_TOKEN]
Status:OK (200)
Last updated
Was this helpful?