mirror of
https://github.com/librenms/librenms.git
synced 2024-10-07 16:52:45 +00:00
Docs for listing devices in a device group seems misplaced in port-docs. (#9250)
DO NOT DELETE THIS TEXT #### Please note > Please read this information carefully. You can run `./scripts/pre-commit.php` to check your code before submitting. - [x] Have you followed our [code guidelines?](http://docs.librenms.org/Developing/Code-Guidelines/) #### Testers If you would like to test this pull request then please run: `./scripts/github-apply <pr_id>`, i.e `./scripts/github-apply 5926` After you are done testing, you can remove the changes with `./scripts/github-remove`. If there are schema changes, you can ask on discord how to revert.
This commit is contained in:
committed by
Neil Lathwood
parent
4e9a036fc4
commit
5aacb03a30
@@ -33,3 +33,42 @@ Output:
|
||||
}
|
||||
]
|
||||
```
|
||||
|
||||
### `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"
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
```
|
||||
|
||||
@@ -180,42 +180,3 @@ Output:
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
### `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"
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user