mirror of
https://github.com/librenms/librenms.git
synced 2024-10-07 16:52:45 +00:00
api: Added api routes for eventlog, syslog, alertlog, authlog (#7071)
This commit is contained in:
@@ -65,7 +65,12 @@ source: API/API-Docs.md
|
||||
- [`services`](#api-services)
|
||||
- [`list_services`](#api-services-list_services)
|
||||
- [`get_service_for_host`](#api-services-get_service_for_host)
|
||||
|
||||
- [`logs`](#api-logs)
|
||||
- [`list_eventlog`](#api-logs-list_eventlog)
|
||||
- [`list_syslog`](#api-logs-list_syslog)
|
||||
- [`list_alertlog`](#api-logs-list_alertlog)
|
||||
- [`list_authlog`](#api-logs-list_authlog)
|
||||
|
||||
Describes the API structure.
|
||||
|
||||
# <a name="api-structure">`Structure`</a> [`top`](#top)
|
||||
@@ -1857,6 +1862,8 @@ Output:
|
||||
}
|
||||
```
|
||||
|
||||
## <a name="api-services">`Services`</a> [`top`](#top)
|
||||
|
||||
### <a name="api-services-list_services">Function: `list_services`</a> [`top`](#top)
|
||||
|
||||
Retrieve all services
|
||||
@@ -1963,3 +1970,74 @@ Output:
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
## <a name="api-logs">`Logs`</a> [`top`](#top)
|
||||
|
||||
### <a name="api-logs-list_eventlog">Function: `list_eventlog`</a> [`top`](#top)
|
||||
### <a name="api-logs-list_syslog">Function: `list_syslog`</a> [`top`](#top)
|
||||
### <a name="api-logs-list_alertlog">Function: `list_alertlog`</a> [`top`](#top)
|
||||
### <a name="api-logs-list_authlog">Function: `list_authlog`</a> [`top`](#top)
|
||||
|
||||
All the `list_*logs` calls are aliased to `list_logs`.
|
||||
|
||||
Retrieve all logs or logs for a specific device.
|
||||
|
||||
Route: /api/v0/logs/eventlog/:hostname
|
||||
Route: /api/v0/logs/syslog/:hostname
|
||||
Route: /api/v0/logs/alertlog/:hostname
|
||||
Route: /api/v0/logs/authlog/:hostname
|
||||
|
||||
- id or hostname is the specific device
|
||||
|
||||
Input:
|
||||
|
||||
- start: The page number to request.
|
||||
- limit: The limit of results to be returned.
|
||||
- from: The date and time to search from.
|
||||
- to: The data and time to search to.
|
||||
|
||||
Example:
|
||||
```curl
|
||||
curl -H 'X-Auth-Token: YOURAPITOKENHERE' https://librenms.org/api/v0/logs/eventlog/:hostname
|
||||
curl -H 'X-Auth-Token: YOURAPITOKENHERE' https://librenms.org/api/v0/logs/syslog/:hostname?limit=20
|
||||
curl -H 'X-Auth-Token: YOURAPITOKENHERE' https://librenms.org/api/v0/logs/eventlog/:hostname?limit=20&start=5&from=2017-07-22%2023:00:00
|
||||
```
|
||||
|
||||
Output:
|
||||
```text
|
||||
{
|
||||
"status": "ok",
|
||||
"err-msg": "",
|
||||
"count": 5,
|
||||
"total": "15",
|
||||
"logs": [
|
||||
{
|
||||
"hostname": "localhost",
|
||||
"sysName": "web01.1.novalocal",
|
||||
"event_id": "10050349",
|
||||
"host": "279",
|
||||
"device_id": "279",
|
||||
"datetime": "2017-07-22 19:57:47",
|
||||
"message": "ifAlias: -> <pptp-something-something-tunnel-something>",
|
||||
"type": "interface",
|
||||
"reference": "NULL",
|
||||
"username": "",
|
||||
"severity": "3"
|
||||
},
|
||||
....
|
||||
{
|
||||
"hostname": "localhost",
|
||||
"sysName": "web01.1.novalocal",
|
||||
"event_id": "10050353",
|
||||
"host": "279",
|
||||
"device_id": "279",
|
||||
"datetime": "2017-07-22 19:57:47",
|
||||
"message": "ifHighSpeed: -> 0",
|
||||
"type": "interface",
|
||||
"reference": "NULL",
|
||||
"username": "",
|
||||
"severity": "3"
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
Reference in New Issue
Block a user