Sign in

74c95058b11f

latestOpenAPI 3.0.02026-07-243339471.1 MB
Topology

Returns topology details for the given site.

This API provides topology for a specific site

get/network-monitoring/v1/topology/{site-id}

Path parameters

site-idstring const required
Example:123682

ID of the site for which topology details are requested.

Response

Success

idstring required

Primary identifier for the resource.

typestring const required

API type.

isolatedDevicesCountinteger

The number of isolated devices in the topology.

isolatedHealthstring

Overall health status of isolated devices.

Example response

{
  "id": "00001",
  "type": "Topology",
  "devices": {
    "serial": "tpd_883a3094c340",
    "mac": "88:3A:30:94:C3:40",
    "name": "G-SG99KN3020",
    "health": "Good",
    "model": "CX-6300M",
    "deviceFunction": "Access Switch",
    "deployment": "Standalone",
    "status": "ONLINE",
    "type": "Switch",
    "ipv4": "10.97.64.117"
  },
  "links": {
    "from": "SG99KN3020",
    "to": "SG99KN4020",
    "edgeType": "ETHERNET",
    "health": "Good",
    "speed": 10,
    "stpState": "FORWARDING",
    "fromPortList": [
      {
        "index": 1,
        "name": "1/1/48",
        "lag": "lag1",
        "health": "Good"
      }
    ],
    "toPortList": [
      {
        "index": 1,
        "name": "1/1/48",
        "lag": "lag1",
        "health": "Good"
      }
    ]
  },
  "isolatedDevicesCount": 3,
  "isolatedHealth": "Poor"
}