API Guide

Switch
Switch inventory information.
Topics:
• GET /switch/{switch-id}
• GET /switch/{switch-id}/interface
• GET /interface/{interface id}
• GET /switch/{switch-id}/bgp
• GET /switch/{switch-id}/lag
• GET /switches/summary
GET /switch/{switch-id}
Retrieves all interface summaries for a specific switch using the switch ID.
API
GET /switch/{switch-id}
Description This API retrieves a telemetry summary.
Parameters
Table 65. API parameters
Filter name Description
switch-id *
required
string
(path)
Unique identifier of the switch
Responses 200 - Telemetry summary for a switch
{
"switch_id": "2:51778771773521959",
"total_count": null,
"data": [
{
"data": [
{
"key": "host-name",
"value": "sc2-t5-s4148-l4"
},
{
"key": "management-ip",
"value": "10.175.18.64"
},
.
.
.
{
"key": "up_state_interface_count",
"value": "7"
},
{
"key": "established_state_bgp_neighbor_count",
"value": "1"
},
17
138 Switch