Viewing information about a gateway

You can use GET requests to view information about gateways in a VPN topology.

There are two requests for viewing information about gateways in the VPN topology:
  • GET http://localhost:8082/7.2.1/elements/vpn/5/gateway_tree_nodes/central — Shows information about gateways on the central gateways list.
  • GET http://localhost:8082/7.2.1/elements/vpn/5/gateway_tree_nodes/satellite — Shows information about gateways on the satellite gateways list.

After opening the VPN topology, use this request to view information about a specific gateway node:

GET http://localhost:8082/7.2.1/elements/vpn/5/gateway_tree_nodes/satellite/67

The request returns a 200 HTTP status response code and this result:

{
    "child_node":["http://localhost:8082/7.2.1/elements/vpn/5/gateway_tree_nodes/satellite/65"],
    "gateway":"http://localhost:8082/7.2.1/elements/fw_cluster/1588/internal_gateway/67",
    "key":67,
    "link":[
            {
            "href":"http://localhost:8082/7.2.1/elements/vpn/5/gateway_tree_nodes/satellite/67",
            "rel":"self",
            "type":"satellite_gateway_node"
            },
            
            {
            "href":"http://localhost:8082/7.2.1/elements/vpn/5/gateway_tree_nodes/satellite/67/sites/enabled",
            "rel":"vpn_site",
            "type":"vpn_site"
            },
            
            {
            "href":"http://localhost:8082/7.2.1/elements/vpn/5/gateway_tree_nodes/satellite/67/sites/disabled",
            "rel":"vpn_site",
            "type":"vpn_site"
            }
    ],
    
    "node_usage":"satellite",
    "parent_node":"http://localhost:8082/7.2.1/elements/vpn/5/gateway_tree_nodes/satellite/66",
    "vpn_key":5
}
Note: The gateway_tree_nodes data element represents nodes in the VPN topology tree. The internal_gateway attribute gives access to the gateway data element.