mirror/librenms-librenms
1
0
Fork 0
mirror of https://github.com/librenms/librenms.git synced 2024-10-07 16:52:45 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Tidy API entry points & doc; error if something other than image/png is asked for from portgroup graphs

Browse Source
This commit is contained in:
Paul Gear
2014-11-25 21:45:15 +10:00
parent 935e51d3c8
commit 9930670119
3 changed files with 19 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
html/pages/api-docs.inc.php
View File

@@ -157,14 +157,14 @@ if ($_SESSION['userlevel'] == '10')
<tr>
<td colspan="5"><code>curl -H "Content-Type: application/json" -H "X-Auth-Token: 91c60e737e342c205be5bba8e2954d27" \<br/> "https://librenms.example.com/api/v0/devices/localhost/ports/eth0"</code></td>
</tr>
<a name="graphs_group"></a>
<a name="graphs_portgroup"></a>
<tr class="success">
<td colspan="5"><strong>Graphs by group</strong></td>
<td colspan="5"><strong>Graphs by portgroup</strong></td>
</tr>
<tr>
<td>/api</td>
<td>/v0</td>
<td>/graphs/ports/$group</td>
<td>/portgroups/$group</td>
<td>
<ul class="list-unstyled">
<li>$group = transit,peering,core (or multiple separated by comma)</li>
@@ -176,14 +176,14 @@ if ($_SESSION['userlevel'] == '10')
</ul>
</td>
<td>
JSON
image/png
</td>
</tr>
<tr>
<td colspan="5"><code>curl -H "Content-Type: application/json" -H "X-Auth-Token: 91c60e737e342c205be5bba8e2954d27" \<br/> "https://librenms.example.com/api/v0/graphs/ports/peering"</code></td>
<td colspan="5"><code>curl -H "Content-Type: image/png" -H "X-Auth-Token: 91c60e737e342c205be5bba8e2954d27" \<br/> "https://librenms.example.com/api/v0/portgroups/peering"</code></td>
</tr>
<tr>
<td colspan="5"><code>curl -H "Content-Type: application/json" -H "X-Auth-Token: 91c60e737e342c205be5bba8e2954d27" \<br/> "https://librenms.example.com/api/v0/graphs/ports/peering,transit?width=1024&height=768&from=1405457456&to=1405543856&legend=no"</code></td>
<td colspan="5"><code>curl -H "Content-Type: image/png" -H "X-Auth-Token: 91c60e737e342c205be5bba8e2954d27" \<br/> "https://librenms.example.com/api/v0/portgroups/peering,transit?width=1024&height=768&from=1405457456&to=1405543856&legend=no"</code></td>
</tr>
<a name="list"></a>
<tr class="success">