Get Connector Nodes

1 min

GET

{{url}}/aioc-rest-web/rest/tenantConnector/connectorNode/getAllNodes

Request Overview

This request is used to retrieve all connector nodes within the Kron PAM system. Connector nodes represent individual connection points within a connector site, facilitating secure communication between the remote data center and the central Kron PAM server.

Response Details:

dbId (integer): The unique identifier of the node.
nodeName (string): The name of the connector node.
subnet (string): The subnet associated with the node.
tunnelPort (integer): The tunnel port used by the node.
connectionPort (integer): The connection port used by the node.
externalIp (string): The external IP address of the node.
internalIp (string): The internal IP address of the node.
sshKey (string): The SSH key used for secure communication.
connectorSite: An object containing details about the associated connector site.
instanceName (string): The name of the instance associated with the node.
tunnelStatus (string): The current status of the tunnel connection.
heartbeat (string): The heartbeat information for monitoring node activity.
vpnUsername (string): The VPN username associated with the node.
vpnPassword (string): The VPN password associated with the node.
vpnConfig (string): The VPN configuration details. can be builtin openvpn builtin_inbound
connectorType (string): The type of connector (e.g., OpenVPN).
instanceNameTunnelStatusPair: An array that contains the instance name and tunnel status pairs.

This request provides comprehensive information about each connector node, including its configuration, status, and associated site details, enabling administrators to monitor and manage secure connections efficiently.

Path Parameters

urlstring
Default
url

Header Parameters

X-XSRF-TOKENstring
Default
{{csrftoken}}

Responses

200Get Connector Nodes

curl

curl --request GET \
     --url {{url}}/aioc-rest-web/rest/tenantConnector/connectorNode/getAllNodes \
     --header 'accept: application/json' \
     --header 'x-xsrf-token: {{csrftoken}}'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");
myHeaders.append("x-xsrf-token", "{{csrftoken}}");

var requestOptions = {
   method: 'GET',
   headers: myHeaders,
   redirect: 'follow'
};

fetch("{{url}}/aioc-rest-web/rest/tenantConnector/connectorNode/getAllNodes", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("{{url}}/aioc-rest-web/rest/tenantConnector/connectorNode/getAllNodes")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Get.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request["x-xsrf-token"] = "{{csrftoken}}"

response = http.request(request)
puts response.read_body

python

import requests
import json

url = "{{url}}/aioc-rest-web/rest/tenantConnector/connectorNode/getAllNodes"

payload = {}
headers = {
   'accept': 'application/json',
   'content-type': 'application/json',
   'x-xsrf-token': '{{csrftoken}}'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

200

[
    {
        "dbId": 2216211,
        "nodeName": "test_arift_openvpn",
        "subnet": "192.168.0.0/28",
        "tunnelPort": null,
        "connectionPort": null,
        "externalIp": null,
        "internalIp": "192.168.0.3",
        "sshKey": null,
        "connectorSite": {
            "dbId": 2215976,
            "siteName": "test",
            "siteDescription": "change_test",
            "isAnyNodeActive": false,
            "connectorNodeList": null,
            "pageForSearch": 0
        },
        "instanceName": null,
        "tunnelStatus": "other",
        "heartbeat": null,
        "clientId": "e609864c-bb9f-4d90-966c-5ed4cac32a77",
        "vpnUsername": "[email protected]",
        "vpnPassword": null,
        "vpnConfig": "[email protected]",
        "connectorType": "openvpn",
        "pageForSearch": 0,
        "instanceNameTunnelStatusPair": [
            {
                "instanceName": "arift",
                "tunnelStatus": "waiting_client_setup"
            }
        ]
    }
]