Updated api routes to new format + moved includes file to correct location

This commit is contained in:
laf
2014-09-16 22:19:29 +01:00
parent 5d83c30708
commit a0b52743d0
3 changed files with 60 additions and 341 deletions
+7 -25
View File
@@ -24,36 +24,18 @@ include_once("../includes/rrdtool.inc.php");
require 'includes/Slim/Slim.php';
\Slim\Slim::registerAutoloader();
$app = new \Slim\Slim();
require_once("../includes/api_functions.inc.php");
require_once("includes/api_functions.inc.php");
$app->setName('api');
$app->group('/api', function() use ($app) {
$app->group('/v1', function() use ($app) {
$app->group('/get', function() use ($app) {
$app->group('/graph', function() use ($app) {
$app->group('/port', function() use ($app) {
$app->get('/id/:id(/:type)(/:width)(/:height)(/:from)(/:to)(/)', 'authToken', 'get_graph_by_id');//api/v1/get/graph/port/id/$port_id
$app->get('/device/:id/:port(/:type)(/:width)(/:height)(/:from)(/:to)(/)', 'authToken', 'get_graph_by_port');//api/v1/get/graph/port/device/$device_id/$ifName
$app->get('/hostname/:hostname/:port(/:type)(/:width)(/:height)(/:from)(/:to)(/)', 'authToken', 'get_graph_by_port_hostname');//api/v1/get/graph/port/device/$hostname/$ifName
});
$app->group('/general', function() use ($app) {
$app->get('/device/:id/:type(/:width)(/:height)(/:from)(/:to)(/)', 'authToken', 'get_graph_generic_by_deviceid');//api/v1/get/graph/general/device/$device_id/$graph_type
$app->get('/hostname/:hostname/:type(/:width)(/:height)(/:from)(/:to)(/)', 'authToken', 'get_graph_generic_by_hostname');//api/v1/get/graph/general/hostname/$hostname/$graph_type
});
});
$app->group('/stats', function() use ($app) {
$app->group('/port', function() use ($app) {
$app->get('/id/:id(/)', 'authToken', 'get_port_stats_by_id');//api/v1/get/stats/port/id/$port_id
$app->get('/device/:id/:port(/)', 'authToken', 'get_port_stats_by_port');//api/v1/get/stats/port/device/$device_id/$ifName
});
});
});
$app->group('/list', function() use ($app) {
$app->get('/devices(/:order)(/:type)(/)', 'authToken', 'list_devices');//api/v1/list/devices (order can be any device column) (types = all, ignored, up, down, disabled)
});
$app->group('/add', function() use ($app) {
$app->post('/device(/)', 'authToken', 'add_device');//api/v1/add/device (json data needs to be passed)
$app->group('/devices', function() use ($app) {
$app->get('/:hostname/ports/:ifname/:type', 'authToken', 'get_graph_by_port_hostname');//api/v1/devices/$hostname/ports/$ifName/$type
$app->get('/:hostname/:type', 'authToken', 'get_graph_generic_by_hostname');//api/v1/devices/$hostname/$type
$app->get('/:hostname/ports/:ifname', 'authToken', 'get_port_stats_by_port_hostname');//api/v1/devices/$hostname/ports/$ifName
});
$app->get('/devices', 'authToken', 'list_devices');//api/v1/devices
$app->post('/devices', 'authToken', 'add_device');//api/v1/devices (json data needs to be passed)
});
});
+363
View File
@@ -0,0 +1,363 @@
<?php
/*
* LibreNMS
*
* Copyright (c) 2014 Neil Lathwood <https://github.com/laf/ http://www.lathwood.co.uk/fa>
*
* This program is free software: you can redistribute it and/or modify it
* under the terms of the GNU General Public License as published by the
* Free Software Foundation, either version 3 of the License, or (at your
* option) any later version. Please see LICENSE.txt at the top level of
* the source code distribution for details.
*/
if (!defined('JSON_UNESCAPED_SLASHES'))
define('JSON_UNESCAPED_SLASHES', 64);
if (!defined('JSON_PRETTY_PRINT'))
define('JSON_PRETTY_PRINT', 128);
if (!defined('JSON_UNESCAPED_UNICODE'))
define('JSON_UNESCAPED_UNICODE', 256);
function _json_encode($data, $options = 448)
{
if (version_compare(PHP_VERSION, '5.4', '>='))
{
return json_encode($data, $options);
}
return _json_format(json_encode($data), $options);
}
function _pretty_print_json($json)
{
return _json_format($json, JSON_PRETTY_PRINT);
}
function _json_format($json, $options = 448)
{
$prettyPrint = (bool) ($options & JSON_PRETTY_PRINT);
$unescapeUnicode = (bool) ($options & JSON_UNESCAPED_UNICODE);
$unescapeSlashes = (bool) ($options & JSON_UNESCAPED_SLASHES);
if (!$prettyPrint && !$unescapeUnicode && !$unescapeSlashes)
{
return $json;
}
$result = '';
$pos = 0;
$strLen = strlen($json);
$indentStr = ' ';
$newLine = "\n";
$outOfQuotes = true;
$buffer = '';
$noescape = true;
for ($i = 0; $i < $strLen; $i++)
{
// Grab the next character in the string
$char = substr($json, $i, 1);
// Are we inside a quoted string?
if ('"' === $char && $noescape)
{
$outOfQuotes = !$outOfQuotes;
}
if (!$outOfQuotes)
{
$buffer .= $char;
$noescape = '\\' === $char ? !$noescape : true;
continue;
}
elseif ('' !== $buffer)
{
if ($unescapeSlashes)
{
$buffer = str_replace('\\/', '/', $buffer);
}
if ($unescapeUnicode && function_exists('mb_convert_encoding'))
{
// http://stackoverflow.com/questions/2934563/how-to-decode-unicode-escape-sequences-like-u00ed-to-proper-utf-8-encoded-cha
$buffer = preg_replace_callback('/\\\\u([0-9a-f]{4})/i',
function ($match)
{
return mb_convert_encoding(pack('H*', $match[1]), 'UTF-8', 'UCS-2BE');
}, $buffer);
}
$result .= $buffer . $char;
$buffer = '';
continue;
}
elseif(false !== strpos(" \t\r\n", $char))
{
continue;
}
if (':' === $char)
{
// Add a space after the : character
$char .= ' ';
}
elseif (('}' === $char || ']' === $char))
{
$pos--;
$prevChar = substr($json, $i - 1, 1);
if ('{' !== $prevChar && '[' !== $prevChar)
{
// If this character is the end of an element,
// output a new line and indent the next line
$result .= $newLine;
for ($j = 0; $j < $pos; $j++)
{
$result .= $indentStr;
}
}
else
{
// Collapse empty {} and []
$result = rtrim($result) . "\n\n" . $indentStr;
}
}
$result .= $char;
// If the last character was the beginning of an element,
// output a new line and indent the next line
if (',' === $char || '{' === $char || '[' === $char)
{
$result .= $newLine;
if ('{' === $char || '[' === $char)
{
$pos++;
}
for ($j = 0; $j < $pos; $j++)
{
$result .= $indentStr;
}
}
}
// If buffer not empty after formating we have an unclosed quote
if (strlen($buffer) > 0)
{
//json is incorrectly formatted
$result = false;
}
return $result;
}
function authToken(\Slim\Route $route)
{
$app = \Slim\Slim::getInstance();
$token = $app->request->headers->get('X-Auth-Token');
if(isset($token) && !empty($token))
{
$username = dbFetchCell("SELECT `U`.`username` FROM `api_tokens` AS AT JOIN `users` AS U ON `AT`.`user_id`=`U`.`user_id` WHERE `AT`.`token_hash`=?", array($token));
if(!empty($username))
{
$authenticated = true;
}
else
{
$authenticated = false;
}
}
else
{
$authenticated = false;
}
if($authenticated === false)
{
$app->response->setStatus(400);
$output = array("status" => "error", "message" => "API Token is invalid");
echo _json_encode($output);
$app->stop();
}
}
function get_graph_by_port_hostname()
{
// This will return a graph for a given port by the ifName
global $config;
$app = \Slim\Slim::getInstance();
$router = $app->router()->getCurrentRoute()->getParams();
$hostname = $router['hostname'];
$vars = array();
$vars['port'] = $router['ifname'];
$vars['type'] = $router['type'] ?: 'port_bits';
if(!empty($_GET['from']))
{
$vars['from'] = $_GET['from'];
}
if(!empty($_GET['to']))
{
$vars['to'] = $_GET['to'];
}
$vars['width'] = $_GET['width'] ?: 1075;
$vars['height'] = $_GET['height'] ?: 300;
$auth = "1";
$vars['id'] = dbFetchCell("SELECT `P`.`port_id` FROM `ports` AS `P` JOIN `devices` AS `D` ON `P`.`device_id` = `D`.`device_id` WHERE `D`.`hostname`=? AND `P`.`ifName`=?", array($hostname,$vars['port']));
$app->response->headers->set('Content-Type', 'image/png');
require("includes/graphs/graph.inc.php");
}
function get_port_stats_by_port_hostname()
{
// This will return port stats based on a devices hostname and ifName
global $config;
$app = \Slim\Slim::getInstance();
$router = $app->router()->getCurrentRoute()->getParams();
$ifName = $router['ifname'];
$stats = dbFetchRow("SELECT * FROM `ports` WHERE `ifName`=?", array($ifName));
$output = array("status" => "ok", "port" => $stats);
$app->response->headers->set('Content-Type', 'application/json');
echo _json_encode($output);
}
function get_graph_generic_by_hostname()
{
// This will return a graph type given a device id.
global $config;
$app = \Slim\Slim::getInstance();
$router = $app->router()->getCurrentRoute()->getParams();
$hostname = $router['hostname'];
$vars = array();
$vars['type'] = $router['type'] ?: 'device_uptime';
if(!empty($_GET['from']))
{
$vars['from'] = $_GET['from'];
}
if(!empty($_GET['to']))
{
$vars['to'] = $_GET['to'];
}
$vars['width'] = $_GET['width'] ?: 1075;
$vars['height'] = $_GET['height'] ?: 300;
$auth = "1";
$vars['device'] = dbFetchCell("SELECT `D`.`device_id` FROM `devices` AS `D` WHERE `D`.`hostname`=?", array($hostname));
$app->response->headers->set('Content-Type', 'image/png');
require("includes/graphs/graph.inc.php");
}
function list_devices()
{
// This will return a list of devices
global $config;
$app = \Slim\Slim::getInstance();
$router = $app->router()->getCurrentRoute()->getParams();
$order = $_GET['order'];
$type = $_GET['type'];
if(empty($order))
{
$order = "hostname";
}
if(stristr($order,' desc') === FALSE && stristr($order, ' asc') === FALSE)
{
$order .= ' ASC';
}
if($type == 'all' || empty($type))
{
$sql = "1";
}
elseif($type == 'ignored')
{
$sql = "ignore='1' AND disabled='0'";
}
elseif($type == 'up')
{
$sql = "status='1' AND ignore='0' AND disabled='0'";
}
elseif($type == 'down')
{
$sql = "status='0' AND ignore='0' AND disabled='0'";
}
elseif($type == 'disabled')
{
$sql = "disabled='1'";
}
else
{
$sql = "1";
}
$devices = array();
foreach (dbFetchRows("SELECT * FROM `devices` WHERE $sql ORDER by $order") as $device)
{
$devices[] = $device;
}
$output = array("status" => "ok", "devices" => $devices);
$app->response->headers->set('Content-Type', 'application/json');
echo _json_encode($output);
}
function add_device()
{
// This will add a device using the data passed encoded with json
global $config;
$app = \Slim\Slim::getInstance();
$data = json_decode(file_get_contents('php://input'), true);
// Default status to error and change it if we need to.
$status = "error";
if(empty($data))
{
$message = "No information has been provided to add this new device";
}
elseif(empty($data["hostname"]))
{
$message = "Missing the device hostname";
}
$hostname = $data['hostname'];
if ($data['port']) { $port = mres($data['port']); } else { $port = $config['snmp']['port']; }
if ($data['transport']) { $transport = mres($data['transport']); } else { $transport = "udp"; }
if($data['version'] == "v1" || $data['version'] == "v2c")
{
if ($data['community'])
{
$config['snmp']['community'] = array($data['community']);
}
$snmpver = mres($data['version']);
}
elseif($data['version'] == 'v3')
{
$v3 = array (
'authlevel' => mres($data['authlevel']),
'authname' => mres($data['authname']),
'authpass' => mres($data['authpass']),
'authalgo' => mres($data['authalgo']),
'cryptopass' => mres($data['cryptopass']),
'cryptoalgo' => mres($data['cryptoalgo']),
);
array_push($config['snmp']['v3'], $v3);
$snmpver = "v3";
}
else
{
$message = "You haven't specified an SNMP version to use";
}
if(empty($message))
{
require_once("functions.php");
$result = addHost($hostname, $snmpver, $port, $transport, 1);
if($result)
{
$status = 'ok';
$message = 'Device has been added successfully';
}
else
{
$message = "Failed adding $hostname";
}
}
$output = array("status" => $status, "message" => $message);
$app->response->headers->set('Content-Type', 'application/json');
echo _json_encode($output);
}
+33 -208
View File
@@ -23,11 +23,13 @@ if ($_SESSION['userlevel'] == '10')
<h3>Introduction</h3>
<p>The API is designed to enable you to interact with your <?php echo $config['project_name'];?> installtion from other systems, monitoring systems, apps or websites using any programming language that can make a web request and both send and receive json data. This documentation will provide you the methods, accepted parameters and responses from the API.</p>
<a name="tokens"></a>
<hr><br />
<h3>Token authentication</h3>
<p>Authentication against the API is done by tokens which are assigned to a user account. You can view and create tokens using the <a href="api-access">API access</a> link within the System > API menu.</p><br />
<p>To send the token to the API you need to do this by using the X-Auth-Token within the header. As example if your API token was 91c60e737e342c205be5bba8e2954d27 then you would send the following X-Auth-Token: 91c60e737e342c205be5bba8e2954d27. As an example using curl within PHP you would do something like this:</p>
<code>curl_setopt($ch, CURLOPT_HTTPHEADER, array('X-Auth-Token: 91c60e737e342c205be5bba8e2954d27'));</code><br />
<a name="responses"></a>
<hr><br />
<h3>API Responses</h3>
<p>The following responses are standard across each request type except for where an image would be returned directly, the response will be output in json format:</p>
<strong>status</strong><br />
@@ -37,93 +39,8 @@ if ($_SESSION['userlevel'] == '10')
</ul>
<strong>message</strong><br />
<p>This will contain the reason for the success or failure of the request.</p><br />
<p>As an example to get you started quickly, here we use the API to request to list all devices:</p>
<pre>curl -H "Content-Type: application/json" -H "X-Auth-Token: 91c60e737e342c205be5bba8e2954d27" "https://librenms.example.com/api/v1/list/devices"
{
"status": "ok",
"devices": [
{
"device_id": "4",
"hostname": "example.co.uk",
"sysName": "example.co.uk",
"community": "public",
"authlevel": null,
"authname": null,
"authpass": null,
"authalgo": null,
"cryptopass": null,
"cryptoalgo": null,
"snmpver": "v1",
"port": "161",
"transport": "udp",
"timeout": null,
"retries": null,
"bgpLocalAs": null,
"sysObjectID": null,
"sysDescr": "Linux example.co.uk 2.6.18-238.19.1.el5 #1 SMP Fri Jul 15 07:31:24 EDT 2011 x86_64",
"sysContact": "root@localhost",
"version": "2.6.18-238.19.1.el5",
"hardware": "Generic x86 64-bit",
"features": null,
"location": "Unknown",
"os": "linux",
"status": "1",
"ignore": "0",
"disabled": "0",
"uptime": "90741309",
"agent_uptime": "0",
"last_polled": "2014-07-16 17:40:04",
"last_polled_timetaken": "2.16",
"last_discovered_timetaken": "3.15",
"last_discovered": "2014-07-16 12:33:44",
"purpose": "",
"type": "server",
"serial": null,
"icon": null
},
{
"device_id": "24",
"hostname": "localhost",
"sysName": "testing",
"community": "public",
"authlevel": "noAuthNoPriv",
"authname": "",
"authpass": "",
"authalgo": "MD5",
"cryptopass": "",
"cryptoalgo": "AES",
"snmpver": "v1",
"port": "161",
"transport": "udp",
"timeout": null,
"retries": null,
"bgpLocalAs": null,
"sysObjectID": null,
"sysDescr": "Linux testing 2.6.32-431.el6.x86_64 #1 SMP Fri Nov 22 03:15:09 UTC 2013 x86_64",
"sysContact": "root@localhost",
"version": "2.6.32-431.el6.x86_64",
"hardware": "Generic x86 64-bit",
"features": null,
"location": "Unknown",
"os": "linux",
"status": "1",
"ignore": "0",
"disabled": "0",
"uptime": "19355163",
"agent_uptime": "0",
"last_polled": "2014-07-16 17:40:04",
"last_polled_timetaken": "1.74",
"last_discovered_timetaken": "1.28",
"last_discovered": "2014-07-16 12:33:25",
"purpose": null,
"type": "server",
"serial": null,
"icon": null
}
]
}
</pre>
<a name="request-types"></a>
<hr><br />
<h3>API request types</h3>
<p>The following request types are currently used:</p>
<ul class="list-unstyled">
@@ -133,6 +50,7 @@ if ($_SESSION['userlevel'] == '10')
<li><strong>DELETE</strong> - This is used to remove items.</li>
</ul>
<a name="requests"></a>
<hr><br />
<h3>Available requests</h3>
<div class="table-responsive">
<table class="table table-bordered table-hover table-condensed">
@@ -140,21 +58,21 @@ if ($_SESSION['userlevel'] == '10')
<th></th>
<th>Version</th>
<th>Path (required)</th>
<th>Path (additional)</th>
<th>Variables / JSON Data</th>
<th>Additional variables / JSON Data</th>
<th>Returns</th>
</tr>
<a name="port_graphs"></a>
<tr class="success">
<td colspan="6"><a name="port_graphs"></a><strong>Port Graphs</strong></td>
<td colspan="5"><strong>Port Graphs</strong></td>
</tr>
<tr>
<td>/api</td>
<td>/v1</td>
<td>/get/graph/port/id/$id</td>
<td>/$type/$width/$height/$from/$to</td>
<td>/devices/$hostname/ports/$ifName/$type</td>
<td>
<ul class="list-unstyled">
<li>$id = the ID of the port</li>
<li>$hostname = the hostname of the device you want the graph for</li>
<li>$ifName = The ifName of the interface you want a graph for</li>
<li>$type = the type of graph for the port (port_bits,port_upkts)</li>
<li>$width = the width of the graph to be returned</li>
<li>$height = the height of the graph to be returned</li>
@@ -167,74 +85,22 @@ if ($_SESSION['userlevel'] == '10')
</td>
</tr>
<tr>
<td colspan="6"><code>curl -H "Content-Type: application/json" -H "X-Auth-Token: 91c60e737e342c205be5bba8e2954d27" \<br/> "https://librenms.example.com/api/v1/get/graph/port/id/1" > /tmp/graph.png</code></td>
<td colspan="5"><code>curl -H "Content-Type: application/json" -H "X-Auth-Token: 91c60e737e342c205be5bba8e2954d27" \<br/> "https://librenms.example.com/api/v1/devices/localhost/ports/eth0/port_bits" > /tmp/graph.png</code></td>
</tr>
<tr>
<td colspan="6"><code>curl -H "Content-Type: application/json" -H "X-Auth-Token: 91c60e737e342c205be5bba8e2954d27" \<br/> "https://librenms.example.com/api/v1/get/graph/port/id/1/port_bits/1024/768/1405457456/1405543856" > /tmp/graph.png</code></td>
</tr>
<tr>
<td>/api</td>
<td>/v1</td>
<td>/get/graph/port/device/$device_id/$ifName</td>
<td>/$type/$width/$height/$from/$to</td>
<td>
<ul class="list-unstyled">
<li>$device_id = the ID of the device</li>
<li>$ifName = the ifName of an interface</li>
<li>$type = the type of graph for the port (port_bits,port_upkts)</li>
<li>$width = the width of the graph to be returned</li>
<li>$height = the height of the graph to be returned</li>
<li>$from = the from date/time of the graph (unix timestamp)</li>
<li>$to = the to date/time of the graph (unix timestamp)</li>
</ul>
</td>
<td>
PNG Image
</td>
</tr>
<tr>
<td colspan="6"><code>curl -H "Content-Type: application/json" -H "X-Auth-Token: 91c60e737e342c205be5bba8e2954d27" \<br/> "https://librenms.example.com/api/v1/get/graph/port/device/1/eth0" > /tmp/graph.png</code></td>
</tr>
<tr>
<td colspan="6"><code>curl -H "Content-Type: application/json" -H "X-Auth-Token: 91c60e737e342c205be5bba8e2954d27" \<br/> "https://librenms.example.com/api/v1/get/graph/port/device/1/eth0/port_bits/1024/768/1405457456/1405543856" > /tmp/graph.png</code></td>
</tr>
<tr>
<td>/api</td>
<td>/v1</td>
<td>/get/graph/port/hostname/$hostname/$ifName</td>
<td>/$type/$width/$height/$from/$to</td>
<td>
<ul class="list-unstyled">
<li>$hostname = the hostname of the device</li>
<li>$ifName = the ifName of an interface</li>
<li>$type = the type of graph for the port (port_bits,port_upkts)</li>
<li>$width = the width of the graph to be returned</li>
<li>$height = the height of the graph to be returned</li>
<li>$from = the from date/time of the graph (unix timestamp)</li>
<li>$to = the to date/time of the graph (unix timestamp)</li>
</ul>
</td>
<td>
PNG Image
</td>
</tr>
<tr>
<td colspan="6"><code>curl -H "Content-Type: application/json" -H "X-Auth-Token: 91c60e737e342c205be5bba8e2954d27" \<br/> "https://librenms.example.com/api/v1/get/graph/port/hostname/localhost/eth0" > /tmp/graph.png</code></td>
</tr>
<tr>
<td colspan="6"><code>curl -H "Content-Type: application/json" -H "X-Auth-Token: 91c60e737e342c205be5bba8e2954d27" \<br/> "https://librenms.example.com/api/v1/get/graph/port/hostname/localhost/eth0/port_bits/1024/768/1405457456/1405543856" > /tmp/graph.png</code></td>
<td colspan="5"><code>curl -H "Content-Type: application/json" -H "X-Auth-Token: 91c60e737e342c205be5bba8e2954d27" \<br/> "https://librenms.example.com/api/v1/devices/localhost/ports/eth0/port_bits?width=1024&height=768&from=1405457456&to=1405543856" > /tmp/graph.png</code></td>
</tr>
<a name="general_graphs"></a>
<tr class="success">
<td colspan="6"><a name="general_graphs"></a><strong>General Graphs</strong></td>
<td colspan="5"><strong>General Graphs</strong></td>
</tr>
<tr>
<td>/api</td>
<td>/v1</td>
<td>/get/graph/general/device/$device_id/$type</td>
<td>/$width/$height/$from/$to</td>
<td>/devices/$hostname/$type</td>
<td>
<ul class="list-unstyled">
<li>$device_id = the ID of the device</li>
<li>$hostname = the hostname of the device you want the graph for</li>
<li>$type = the type of graph for the device (device_processor,device_storage)</li>
<li>$width = the width of the graph to be returned</li>
<li>$height = the height of the graph to be returned</li>
@@ -247,64 +113,22 @@ if ($_SESSION['userlevel'] == '10')
</td>
</tr>
<tr>
<td colspan="6"><code>curl -H "Content-Type: application/json" -H "X-Auth-Token: 91c60e737e342c205be5bba8e2954d27" \<br/> "https://librenms.example.com/api/v1/get/graph/general/device/1/device_processor" > /tmp/graph.png</code></td>
<td colspan="5"><code>curl -H "Content-Type: application/json" -H "X-Auth-Token: 91c60e737e342c205be5bba8e2954d27" \<br/> "https://librenms.example.com/api/v1/devices/localhost/device_processor" > /tmp/graph.png</code></td>
</tr>
<tr>
<td colspan="6"><code>curl -H "Content-Type: application/json" -H "X-Auth-Token: 91c60e737e342c205be5bba8e2954d27" \<br/> "https://librenms.example.com/api/v1/get/graph/general/device/1/device_processor/1024/768/1405457456/1405543856" > /tmp/graph.png</code></td>
<td colspan="5"><code>curl -H "Content-Type: application/json" -H "X-Auth-Token: 91c60e737e342c205be5bba8e2954d27" \<br/> "https://librenms.example.com/api/v1/devices/localhost/device_processor?width=1024&height=768&from=1405457456&to=1405543856" > /tmp/graph.png</code></td>
</tr>
<a name="port_stats"></a>
<tr class="success">
<td colspan="5"><strong>Port Stats</strong></td>
</tr>
<tr>
<td>/api</td>
<td>/v1</td>
<td>/get/graph/general/hostname/$hostname/$type</td>
<td>/$width/$height/$from/$to</td>
<td>/devices/$hostname/ports/$ifName</td>
<td>
<ul class="list-unstyled">
<li>$hostname = the hostname of the device</li>
<li>$type = the type of graph for the device (device_processor,device_storage)</li>
<li>$width = the width of the graph to be returned</li>
<li>$height = the height of the graph to be returned</li>
<li>$from = the from date/time of the graph (unix timestamp)</li>
<li>$to = the to date/time of the graph (unix timestamp)</li>
</ul>
</td>
<td>
PNG Image
</td>
</tr>
<tr>
<td colspan="6"><code>curl -H "Content-Type: application/json" -H "X-Auth-Token: 91c60e737e342c205be5bba8e2954d27" \<br/> "https://librenms.example.com/api/v1/get/graph/general/hostname/localhost/device_processor" > /tmp/graph.png</code></td>
</tr>
<tr>
<td colspan="6"><code>curl -H "Content-Type: application/json" -H "X-Auth-Token: 91c60e737e342c205be5bba8e2954d27" \<br/> "https://librenms.example.com/api/v1/get/graph/general/hostname/localhost/device_processor/1024/768/1405457456/1405543856" > /tmp/graph.png</code></td>
</tr>
<tr class="success">
<td colspan="6"><a name="port_stats"></a><strong>Port Stats</strong></td>
</tr>
<tr>
<td>/api</td>
<td>/v1</td>
<td>/get/stats/port/id/$port_id</td>
<td></td>
<td>
<ul class="list-unstyled">
<li>$port_id = the ID of the port</li>
</ul>
</td>
<td>
JSON
</td>
</tr>
<tr>
<td colspan="6"><code>curl -H "Content-Type: application/json" -H "X-Auth-Token: 91c60e737e342c205be5bba8e2954d27" \<br/> "https://librenms.example.com/api/v1/get/stats/port/id/1"</code></td>
</tr>
<tr>
<td>/api</td>
<td>/v1</td>
<td>/get/stats/port/device/$device_id/$ifName</td>
<td></td>
<td>
<ul class="list-unstyled">
<li>$device_id = the ID of the device</li>
<li>$ifName = the ifName of the port</li>
</ul>
</td>
@@ -313,16 +137,16 @@ if ($_SESSION['userlevel'] == '10')
</td>
</tr>
<tr>
<td colspan="6"><code>curl -H "Content-Type: application/json" -H "X-Auth-Token: 91c60e737e342c205be5bba8e2954d27" \<br/> "https://librenms.example.com/api/v1/get/stats/port/device/1/eth0"</code></td>
<td colspan="5"><code>curl -H "Content-Type: application/json" -H "X-Auth-Token: 91c60e737e342c205be5bba8e2954d27" \<br/> "https://librenms.example.com/api/v1/devices/localhost/ports/eth0"</code></td>
</tr>
<a name="list"></a>
<tr class="success">
<td colspan="6"><a name="list"></a><strong>List</strong></td>
<td colspan="5"><strong>List</strong></td>
</tr>
<tr>
<td>/api</td>
<td>/v1</td>
<td>/list/devices</td>
<td>/$order/$type</td>
<td>
<ul class="list-unstyled">
<li>$order = the name of the column to order by</li>
@@ -334,19 +158,19 @@ if ($_SESSION['userlevel'] == '10')
</td>
</tr>
<tr>
<td colspan="6"><code>curl -H "Content-Type: application/json" -H "X-Auth-Token: 91c60e737e342c205be5bba8e2954d27" \<br/> "https://librenms.example.com/api/v1/list/devices"</code></td>
<td colspan="5"><code>curl -H "Content-Type: application/json" -H "X-Auth-Token: 91c60e737e342c205be5bba8e2954d27" \<br/> "https://librenms.example.com/api/v1/devices"</code></td>
</tr>
<tr>
<td colspan="6"><code>curl -H "Content-Type: application/json" -H "X-Auth-Token: 91c60e737e342c205be5bba8e2954d27" \<br/> "https://librenms.example.com/api/v1/list/devices/hostname/all"</code></td>
<td colspan="5"><code>curl -H "Content-Type: application/json" -H "X-Auth-Token: 91c60e737e342c205be5bba8e2954d27" \<br/> "https://librenms.example.com/api/v1/devices?order=hostname&type=all"</code></td>
</tr>
<a name="add"></a>
<tr class="success">
<td colspan="6"><a name="add"></a><strong>Add</strong></td>
<td colspan="5"><strong>Add</strong></td>
</tr>
<tr>
<td>/api</td>
<td>/v1</td>
<td>/add/device</td>
<td></td>
<td>/devices</td>
<td>
<ul class="list-unstyled">
<li>hostname = the hostname to be added</li>
@@ -367,7 +191,7 @@ if ($_SESSION['userlevel'] == '10')
</td>
</tr>
<tr>
<td colspan="6"><code>curl -X POST -d '{"hostname":"localhost.localdomain","version":"v1","community":"public"}' \<br />-H "Content-Type: application/json" -H "X-Auth-Token: 91c60e737e342c205be5bba8e2954d27" \<br/> "https://librenms.example.com/api/v1/add/device"</code></td>
<td colspan="5"><code>curl -X POST -d '{"hostname":"localhost.localdomain","version":"v1","community":"public"}' \<br />-H "Content-Type: application/json" -H "X-Auth-Token: 91c60e737e342c205be5bba8e2954d27" \<br/> "https://librenms.example.com/api/v1/devices"</code></td>
</tr>
</table>
</div>
@@ -386,6 +210,7 @@ if ($_SESSION['userlevel'] == '10')
<li><a href="api-docs/#general_graphs">General Graphs</a></li>
<li><a href="api-docs/#port_stats">Port Stats</a></li>
<li><a href="api-docs/#list">List</a></li>
<li><a href="api-docs/#add">Add</a></li>
</ul>
</li>
</ul>