diff --git a/html/api_v0.php b/html/api_v0.php index 6c40a5cc4e..2e965a410d 100644 --- a/html/api_v0.php +++ b/html/api_v0.php @@ -36,6 +36,7 @@ $app->group('/api', function() use ($app) { $app->get('/:hostname/vlans', 'authToken', 'get_vlans')->name('get_vlans');//api/v0/devices/$hostname/vlans $app->get('/:hostname/graphs', 'authToken', 'get_graphs')->name('get_graphs');//api/v0/devices/$hostname/graphs $app->get('/:hostname/:type', 'authToken', 'get_graph_generic_by_hostname')->name('get_graph_generic_by_hostname');//api/v0/devices/$hostname/$type + $app->get('/:hostname/ports', 'authToken', 'get_port_graphs')->name('get_port_graphs');//api/v0/devices/$hostname/ports $app->get('/:hostname/ports/:ifname', 'authToken', 'get_port_stats_by_port_hostname')->name('get_port_stats_by_port_hostname');//api/v0/devices/$hostname/ports/$ifName $app->get('/:hostname/ports/:ifname/:type', 'authToken', 'get_graph_by_port_hostname')->name('get_graph_by_port_hostname');//api/v0/devices/$hostname/ports/$ifName/$type }); diff --git a/html/includes/api_functions.inc.php b/html/includes/api_functions.inc.php index ce4f95c60c..c8b40bb2af 100644 --- a/html/includes/api_functions.inc.php +++ b/html/includes/api_functions.inc.php @@ -444,3 +444,24 @@ function get_graphs() { $app->response->headers->set('Content-Type', 'application/json'); echo _json_encode($output); } + +function get_port_graphs() { + global $config; + $app = \Slim\Slim::getInstance(); + $router = $app->router()->getCurrentRoute()->getParams(); + $hostname = $router['hostname']; + if(isset($_GET['columns'])) { + $columns = $_GET['columns']; + } else { + $columns = 'ifName'; + } + + // use hostname as device_id if it's all digits + $device_id = ctype_digit($hostname) ? $hostname : getidbyname($hostname); + $ports = dbFetchRows("SELECT $columns FROM `ports` WHERE `device_id` = ? AND `deleted` = '0' ORDER BY `ifIndex` ASC", array($device_id)); + $total_ports = count($ports); + $output = array("status" => "ok", "err-msg" => '', "count" => $total_ports, "ports" => $ports); + $app->response->setStatus('200'); + $app->response->headers->set('Content-Type', 'application/json'); + echo _json_encode($output); +} diff --git a/html/pages/api-docs.inc.php b/html/pages/api-docs.inc.php index bddb64729b..02d9330b8e 100644 --- a/html/pages/api-docs.inc.php +++ b/html/pages/api-docs.inc.php @@ -296,6 +296,29 @@ if ($_SESSION['userlevel'] == '10') curl -H "X-Auth-Token: 91c60e737e342c205be5bba8e2954d27" \
"https://librenms.example.com/api/v0/bgp"
+ + List ports for a device + + + /api + /v0 + /devices/$hostname/ports + + + + + JSON + + + + curl -H "X-Auth-Token: 91c60e737e342c205be5bba8e2954d27" \
"https://librenms.example.com/api/v0/devices/localhost/ports"
+ + + curl -H "X-Auth-Token: 91c60e737e342c205be5bba8e2954d27" \
"https://librenms.example.com/api/v0/devices/localhost/ports?columns=ifDescr,ifName"
+