Endpoint
/api/v2/tenants/{tenantId}/resources/{resourceId}/remoteConsoles

Example:

Path Parameters
tenantId
string

clientId of the tenant

resourceId
string

resource uuid

Responses

OK

descendingOrder
boolean

nextPage
boolean

nextPageNo
number

pageNo
number

pageSize
number

previousPageNo
number

results
array

results.consoleAuthType
results.consoleConnector
results.consoleProtocol
results.name
totalPages
number

totalResults
number

{
  "descendingOrder": false,
  "nextPage": true,
  "nextPageNo": 2,
  "pageNo": 1,
  "pageSize": 5,
  "previousPageNo": 0,
  "results": [
    {
      "consoleConnector": "Agent",
      "consoleProtocol": "RDP",
      "name": "RDp console"
    },
    {
      "consoleConnector": "Agent",
      "consoleProtocol": "RDP",
      "name": "RDP 172.26.105.140:3389"
    },
    {
      "consoleConnector": "Agent",
      "consoleProtocol": "RDP",
      "name": "RDP Test Console"
    },
    {
      "consoleConnector": "Gateway",
      "consoleProtocol": "RDP",
      "name": "RDP 192.168.56.121: 23"
    },
    {
      "consoleAuthType": "PASSWORD",
      "consoleConnector": "Agent",
      "consoleProtocol": "SSH",
      "name": "SSH 1.2.4.35: 22"
    }
  ],
  "totalPages": 4,
  "totalResults": 17
}
Endpoint
/api/v2/tenants/{tenantId}/resources/{resourceId}/remoteConsoles

Note:

  • consoleAuthTypes - PASSWORD or PUBLICKEY only applicable if the consoleProtocol is SSH.
  • consoleProtocol - TELNET,SSH,RDP for browser consoles

Example:

Path Parameters
tenantId
string

clientId of the tenant

resourceId
string

resource uuid

consoleAuthType
string

consoleConnector
string

consoleProtocol
string

ipAddress
string

name
string

port
string

userName
string

[
  {
    "consoleAuthType": "PASSWORD",
    "consoleConnector": "Agent",
    "consoleProtocol": "SSH",
    "ipAddress": "192.168.56.103",
    "name": "Agent SSH console",
    "port": "22",
    "userName": "vadmin"
  },
  {
    "consoleConnector": "Gateway",
    "consoleProtocol": "RDP",
    "ipAddress": "192.168.56.112",
    "name": "Gateway RDP",
    "port": "3389"
  }
]

Responses

OK

[
  {
    "consoleAuthType": "PASSWORD",
    "consoleConnector": "Agent",
    "consoleProtocol": "SSH",
    "ipAddress": "192.168.56.103",
    "name": "Agent SSH console",
    "port": "22",
    "userName": "vadmin"
  },
  {
    "consoleConnector": "Gateway",
    "consoleProtocol": "RDP",
    "ipAddress": "192.168.56.112",
    "name": "Gateway RDP",
    "port": "3389"
  }
]