Protocols

List of protocols related API

get

https://localhost:3000/apihttp://localhost:3000/api

/Bgps/list

Get list of all BGP devices with their status and details

Authorizations

api_key

authorizationstringRequired

Use User's Api for authorization

Responses

200

OK

No content

401

Unauthorized

403

Forbidden

500

Internal Server Error

get

/Bgps/list

HTTPcURLJavaScriptPython

GET /api/Bgps/list HTTP/1.1
Host: localhost:3000
authorization: YOUR_API_KEY
Accept: */*

No content

get

https://localhost:3000/apihttp://localhost:3000/api

/Bgps/neighborList

Get BGP neighbor list for a specific device

Authorizations

api_key

authorizationstringRequired

Use User's Api for authorization

Query parameters

filterstringRequired

{
 "deviceAddress" : "68:21:5F:A6:61:72",
 "vrf" : "default"
}

Note: For "deviceAddress" field accepts IP or Mac address.

Responses

200

OK

No content

401

Unauthorized

403

Forbidden

500

Internal Server Error

get

/Bgps/neighborList

HTTPcURLJavaScriptPython

GET /api/Bgps/neighborList?filter=text HTTP/1.1
Host: localhost:3000
authorization: YOUR_API_KEY
Accept: */*

No content

get

https://localhost:3000/apihttp://localhost:3000/api

/Bgps/protocolMega

Get combined BGP announcement and neighbor data for a device

Authorizations

api_key

authorizationstringRequired

Use User's Api for authorization

Query parameters

filterstringRequired

{
 "fromDate" : "2026-01-23 02:09:36",
 "toDate" : "2026-01-23 03:09:36",
 "windowSize" : "1 hour",
 "deviceAddress" : "68:21:5F:A6:61:72",
 "vrf" : "default"
}

Note: For "deviceAddress" field accepts IP or Mac address.

Responses

200

OK

No content

401

Unauthorized

403

Forbidden

500

Internal Server Error

get

/Bgps/protocolMega

HTTPcURLJavaScriptPython

GET /api/Bgps/protocolMega?filter=text HTTP/1.1
Host: localhost:3000
authorization: YOUR_API_KEY
Accept: */*

No content

get

https://localhost:3000/apihttp://localhost:3000/api

/Bgps/protocolNeighborMega

Get combined BGP neighbor connections and status data

Authorizations

api_key

authorizationstringRequired

Use User's Api for authorization

Query parameters

filterstringRequired

{
 "fromDate" : "2026-01-23 02:09:36",
 "toDate" : "2026-01-23 03:09:36",
 "windowSize" : "1 hour",
 "deviceAddress" : "68:21:5F:A6:61:72",
 "vrf" : "default"
}

Note: For "deviceAddress" field accepts IP or Mac address.

Responses

200

OK

No content

401

Unauthorized

403

Forbidden

500

Internal Server Error

get

/Bgps/protocolNeighborMega

HTTPcURLJavaScriptPython

GET /api/Bgps/protocolNeighborMega?filter=text HTTP/1.1
Host: localhost:3000
authorization: YOUR_API_KEY
Accept: */*

No content

get

https://localhost:3000/apihttp://localhost:3000/api

/Protocols/bgp

BGP Protocols stats based on the latest telemetry, i.e., host, neighbors, total advertised, local ASN

Authorizations

api_key

authorizationstringRequired

Use User's Api for authorization

Query parameters

filterstringRequired

{
 "ipAddress" : "10.4.4.55"
}

Note: ipAddress is required. Must use double quotes for valid JSON.

Responses

200

OK

No content

401

Unauthorized

403

Forbidden

500

Internal Server Error

get

/Protocols/bgp

HTTPcURLJavaScriptPython

GET /api/Protocols/bgp?filter=text HTTP/1.1
Host: localhost:3000
authorization: YOUR_API_KEY
Accept: */*

No content

get

https://localhost:3000/apihttp://localhost:3000/api

/Control-plane/vxlan

Get VXLAN

Authorizations

api_key

authorizationstringRequired

Use User's Api for authorization

Responses

200

OK

No content

401

Unauthorized

403

Forbidden

500

Internal Server Error

get

/Control-plane/vxlan

HTTPcURLJavaScriptPython

GET /api/Control-plane/vxlan HTTP/1.1
Host: localhost:3000
authorization: YOUR_API_KEY
Accept: */*

No content

get

https://localhost:3000/apihttp://localhost:3000/api

/Bgps/vlanMapping

Get VLAN to VNI and VRF to VNI mapping for a device

Authorizations

api_key

authorizationstringRequired

Use User's Api for authorization

Query parameters

filterstringRequired

{
 "deviceAddress" : "02:42:0a:00:15:20"
}

Note: For "deviceAddress" field accepts IP or Mac address.

Responses

200

OK

No content

401

Unauthorized

403

Forbidden

500

Internal Server Error

get

/Bgps/vlanMapping

HTTPcURLJavaScriptPython

GET /api/Bgps/vlanMapping?filter=text HTTP/1.1
Host: localhost:3000
authorization: YOUR_API_KEY
Accept: */*

No content

post

https://localhost:3000/apihttp://localhost:3000/api

/Bgps/getremotevteps

Get local and remote VTEP information for a device

Authorizations

api_key

authorizationstringRequired

Use User's Api for authorization

Body

application/json

typestringOptionalExample: object

Responses

200

OK

No content

401

Unauthorized

403

Forbidden

500

Internal Server Error

post

/Bgps/getremotevteps

HTTPcURLJavaScriptPython

POST /api/Bgps/getremotevteps HTTP/1.1
Host: localhost:3000
authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 82

{
  "type": "object",
  "properties": {
    "deviceAddress": {
      "type": "string",
      "examples": null
    }
  }
}

No content

get

https://localhost:3000/apihttp://localhost:3000/api

/Control-plane/mclag

Get McLAG

Authorizations

api_key

authorizationstringRequired

Use User's Api for authorization

Responses

200

OK

No content

401

Unauthorized

403

Forbidden

500

Internal Server Error

get

/Control-plane/mclag

HTTPcURLJavaScriptPython

GET /api/Control-plane/mclag HTTP/1.1
Host: localhost:3000
authorization: YOUR_API_KEY
Accept: */*

No content

get

https://localhost:3000/apihttp://localhost:3000/api

/Control-plane/lacp

Get LACP

Authorizations

api_key

authorizationstringRequired

Use User's Api for authorization

Responses

200

OK

No content

401

Unauthorized

403

Forbidden

500

Internal Server Error

get

/Control-plane/lacp

HTTPcURLJavaScriptPython

GET /api/Control-plane/lacp HTTP/1.1
Host: localhost:3000
authorization: YOUR_API_KEY
Accept: */*

No content

get

https://localhost:3000/apihttp://localhost:3000/api

/Control-plane/vrrp

Get VRRP

Authorizations

api_key

authorizationstringRequired

Use User's Api for authorization

Responses

200

OK

No content

401

Unauthorized

403

Forbidden

500

Internal Server Error

get

/Control-plane/vrrp

HTTPcURLJavaScriptPython

GET /api/Control-plane/vrrp HTTP/1.1
Host: localhost:3000
authorization: YOUR_API_KEY
Accept: */*

No content

post

https://localhost:3000/apihttp://localhost:3000/api

/Bgps/vrrpdetails

Get VRRP details for a specific interface on a device

Authorizations

api_key

authorizationstringRequired

Use User's Api for authorization

Body

application/json

typestringOptionalExample: object

Responses

200

OK

No content

401

Unauthorized

403

Forbidden

500

Internal Server Error

post

/Bgps/vrrpdetails

HTTPcURLJavaScriptPython

POST /api/Bgps/vrrpdetails HTTP/1.1
Host: localhost:3000
authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 125

{
  "type": "object",
  "properties": {
    "macaddress": {
      "type": "string",
      "examples": null
    },
    "interface": {
      "type": "string",
      "examples": null
    }
  }
}

No content

get

https://localhost:3000/apihttp://localhost:3000/api

/Bgps/mclag-grid

Get MCLAG transition/timeline data for grid display

Authorizations

api_key

authorizationstringRequired

Use User's Api for authorization

Query parameters

filterstringRequired

{
 "deviceAddress" : "02:42:0a:00:15:20",
 "domainId" : "1",
 "windowSize" : "1 hour"
}

Note: For "deviceAddress" field accepts IP or Mac address.

Responses

200

OK

No content

401

Unauthorized

403

Forbidden

500

Internal Server Error

get

/Bgps/mclag-grid

HTTPcURLJavaScriptPython

GET /api/Bgps/mclag-grid?filter=text HTTP/1.1
Host: localhost:3000
authorization: YOUR_API_KEY
Accept: */*

No content

get

https://localhost:3000/apihttp://localhost:3000/api

/Bgps/lacp-grid

Get LACP port channel time series data for grid display

Authorizations

api_key

authorizationstringRequired

Use User's Api for authorization

Query parameters

filterstringRequired

{
 "deviceAddress" : "02:42:0a:00:15:20",
 "portChannel" : "PortChannel1",
 "windowSize" : "1 hour"
}

Note: deviceAddress accepts IP or Mac address. portChannel is required.

Responses

200

OK

No content

401

Unauthorized

403

Forbidden

500

Internal Server Error

get

/Bgps/lacp-grid

HTTPcURLJavaScriptPython

GET /api/Bgps/lacp-grid?filter=text HTTP/1.1
Host: localhost:3000
authorization: YOUR_API_KEY
Accept: */*

No content

get

https://localhost:3000/apihttp://localhost:3000/api

/Bgps/vtep-health-grid

Get VTEP health time series data for grid display

Authorizations

api_key

authorizationstringRequired

Use User's Api for authorization

Query parameters

filterstringRequired

{
 "deviceAddress" : "02:42:0a:00:15:20",
 "remoteVtepIp" : "1.1.1.25",
 "windowSize" : "1 hour"
}

Note: For "deviceAddress" field accepts IP or Mac address.

Responses

200

OK

No content

401

Unauthorized

403

Forbidden

500

Internal Server Error

get

/Bgps/vtep-health-grid

HTTPcURLJavaScriptPython

GET /api/Bgps/vtep-health-grid?filter=text HTTP/1.1
Host: localhost:3000
authorization: YOUR_API_KEY
Accept: */*

No content

get

https://localhost:3000/apihttp://localhost:3000/api

/Control-plane/vlan

Get VLAN

Authorizations

api_key

authorizationstringRequired

Use User's Api for authorization

Responses

200

OK

No content

401

Unauthorized

403

Forbidden

500

Internal Server Error

get

/Control-plane/vlan

HTTPcURLJavaScriptPython

GET /api/Control-plane/vlan HTTP/1.1
Host: localhost:3000
authorization: YOUR_API_KEY
Accept: */*

No content

post

https://localhost:3000/apihttp://localhost:3000/api

/Bgps/vlanDetails

Get detailed VLAN information for a specific device

Authorizations

api_key

authorizationstringRequired

Use User's Api for authorization

Body

application/json

typestringOptionalExample: object

Responses

200

OK

No content

401

Unauthorized

403

Forbidden

500

Internal Server Error

post

/Bgps/vlanDetails

HTTPcURLJavaScriptPython

POST /api/Bgps/vlanDetails HTTP/1.1
Host: localhost:3000
authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 79

{
  "type": "object",
  "properties": {
    "macAddress": {
      "type": "string",
      "examples": null
    }
  }
}

No content