mirror of
https://github.com/librenms/librenms.git
synced 2024-10-07 16:52:45 +00:00
3bd9920e38
* docs: Continue to reorganize things Make landing pages for /Installation, /API, etc. Split API out into multiple docs Properly use multi-level navigation Add lower nav buttons (tops are bug so disable for now) Add logo for fanciness Refine index page a bit * Improve API TOC layout * Couple of fixes. * Fix API/API-Docs, assumed it was at the right url.
50 lines
1.6 KiB
Markdown
50 lines
1.6 KiB
Markdown
source: API/PortGroups.md
|
|
|
|
### `get_graph_by_portgroup`
|
|
|
|
Get the graph based on the group type.
|
|
|
|
Route: `/api/v0/devices/portgroups/:group`
|
|
|
|
- group is the type of port group graph you want, I.e Transit, Peering, etc. You can specify multiple types comma separated.
|
|
|
|
Input:
|
|
|
|
- from: This is the date you would like the graph to start - See http://oss.oetiker.ch/rrdtool/doc/rrdgraph.en.html for more information.
|
|
- to: This is the date you would like the graph to end - See http://oss.oetiker.ch/rrdtool/doc/rrdgraph.en.html for more information.
|
|
- width: The graph width, defaults to 1075.
|
|
- height: The graph height, defaults to 300.
|
|
|
|
Example:
|
|
```curl
|
|
curl -H 'X-Auth-Token: YOURAPITOKENHERE' https://librenms.org/api/v0/portgroups/transit,peering
|
|
```
|
|
|
|
Output:
|
|
|
|
Output is an image.
|
|
|
|
### `get_graph_by_portgroup_multiport_bits`
|
|
|
|
Get the graph based on the multiple port id separated by commas `,`.
|
|
|
|
Route: `/api/v0/devices/portgroups/multiport/bits/:id`
|
|
|
|
- id is a comma separated list of port ids you want, I.e 1,2,3,4, etc. You can specify multiple IDs comma separated.
|
|
|
|
Input:
|
|
|
|
- from: This is the date you would like the graph to start - See http://oss.oetiker.ch/rrdtool/doc/rrdgraph.en.html for more information.
|
|
- to: This is the date you would like the graph to end - See http://oss.oetiker.ch/rrdtool/doc/rrdgraph.en.html for more information.
|
|
- width: The graph width, defaults to 1075.
|
|
- height: The graph height, defaults to 300.
|
|
|
|
Example:
|
|
```curl
|
|
curl -H 'X-Auth-Token: YOURAPITOKENHERE' https://librenms.org/api/v0/portgroups/multiport/bits/1,2,3
|
|
```
|
|
|
|
Output:
|
|
|
|
Output is an image.
|