mirror of
https://github.com/librenms/librenms.git
synced 2024-10-07 16:52:45 +00:00
6575042f5f
* clean up all but header incrementing in Creating-Transport.md * make Device-Dependencies.md mdl happy * make Entities.md as mdl happy as possible... one long table line left * make mdl as happy as possible for index.md * clean up Introduction.md as much as possible * minor formatting cleanup... move each icon onto its own row * make ack and notes the same style * clean Macros.md up * clean Rules.md up as much as possible * tweak one line a bit to get it to format a bit nicer * a bit more format tweaking, making sure it does not sure with > * clean up as much as possible for Templates.md * make Testing.md as mdl happy as possibly * clean Transports.md up as much as possible * clean as many issues as possible for Alerts.md * clean up as much of ARP.md as possible * clean up as much as possible for Bills.md * make DeviceGroups.md as mdl happy as possible * cleanup Devices.md * make as mdl happy as possible Inventory.md and index.md * mdl cleanup for Logs.md and PortGroups.md * make Ports.md and Routing.md as happy as possible * clean up Services.md, Switching.md, and Systems.md as much as possible * more markup cleanup * lots more md cleanup udner Devloping/ * reapply bits from #10343 that accidentally got removed when merging
83 lines
1.5 KiB
Markdown
83 lines
1.5 KiB
Markdown
source: API/DeviceGroups.md
|
|
path: blob/master/doc/
|
|
|
|
### `get_devicegroups`
|
|
|
|
List all device groups.
|
|
|
|
Route: `/api/v0/devicegroups`
|
|
|
|
Input (JSON):
|
|
|
|
-
|
|
|
|
Examples:
|
|
|
|
```curl
|
|
curl -H 'X-Auth-Token: YOURAPITOKENHERE' https://librenms.org/api/v0/devicegroups
|
|
```
|
|
|
|
Output:
|
|
|
|
```json
|
|
[
|
|
{
|
|
"status": "ok",
|
|
"message": "Found 1 device groups",
|
|
"count": 1,
|
|
"groups": [
|
|
{
|
|
"id": "1",
|
|
"name": "Testing",
|
|
"desc": "Testing",
|
|
"pattern": "%devices.status = \"1\" &&"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
```
|
|
|
|
### `get_devices_by_group`
|
|
|
|
List all devices matching the group provided.
|
|
|
|
Route: `/api/v0/devicegroups/:name`
|
|
|
|
- name Is the name of the device group which can be obtained using
|
|
[`get_devicegroups`](#function-get_devicegroups). Please ensure that
|
|
the name is urlencoded if it needs to be (i.e Linux Servers would
|
|
need to be urlencoded.
|
|
|
|
Input (JSON):
|
|
|
|
- full: set to any value to return all data for the devices in a given group
|
|
|
|
Examples:
|
|
|
|
```curl
|
|
curl -H 'X-Auth-Token: YOURAPITOKENHERE' https://librenms.org/api/v0/devicegroups/LinuxServers
|
|
```
|
|
|
|
Output:
|
|
|
|
```json
|
|
[
|
|
{
|
|
"status": "ok",
|
|
"message": "Found 3 in group LinuxServers",
|
|
"count": 3,
|
|
"devices": [
|
|
{
|
|
"device_id": "15"
|
|
},
|
|
{
|
|
"device_id": "18"
|
|
},
|
|
{
|
|
"device_id": "20"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
```
|