clones/librenms
1
0
Fork 0
mirror of https://github.com/librenms/librenms.git synced 2024-09-23 03:18:54 +00:00
Code Issues Packages Projects Releases Wiki Activity

services docs

Browse Source
This commit is contained in:
nerdalertdk 2016-08-26 12:01:33 +02:00 committed by GitHub
parent 8a6ad076e2
commit cd7cf30c00
1 changed files with 69 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

69
doc/API/API-Docs.md
View File

@ -52,6 +52,10 @@ source: API/API-Docs.md
- [`get_bill`](#api-route-23)
- [`resources`](#api-resources)
- [`list_arp`](#api-resources-list_arp)
- [`services`](#api-services)
- [`list_services`](#api-services-list_services)
- [`get_service_for_host`](#api-services-get_service_for_host)
Describes the API structure.
# <a name="api-structure">`Structure`</a> [`top`](#top)
@ -1440,3 +1444,68 @@ Output:
]
}
```
### <a name="api-services-list_services">Function: `list_services`</a> [`top`](#top)
Retrieve all services
Route: /api/v0/services
Input:
- state: only which have a certain state (valid options are 0=Ok, 1=Warning, 2=Critical).
- type: service type, used sql LIKE to find services, so for tcp, use type=tcp for http use type=http
Example:
```curl
curl -H 'X-Auth-Token: YOURAPITOKENHERE' https://librenms.org/api/v0/services
curl -H 'X-Auth-Token: YOURAPITOKENHERE' https://librenms.org/api/v0/services?state=2
curl -H 'X-Auth-Token: YOURAPITOKENHERE' https://librenms.org/api/v0/services?state=0&type=tcp
```
Output:
```text
{
"status": "ok",
"err-msg": "",
"count": 1,
"services": [
{
"Need example"
}
]
}
```
### <a name="api-services-get_service_for_host">Function: `get_service_for_host`</a> [`top`](#top)
Retrieve services for device
Route: /api/v0/services/:hostname
- id or hostname is the specific device
Input:
- state: only which have a certain state (valid options are 0=Ok, 1=Warning, 2=Critical).
- type: service type, used sql LIKE to find services, so for tcp, use type=tcp for http use type=http
Example:
```curl
curl -H 'X-Auth-Token: YOURAPITOKENHERE' https://librenms.org/api/v0/services/:hostname
curl -H 'X-Auth-Token: YOURAPITOKENHERE' https://librenms.org/api/v0/services/:hostname?state=2
curl -H 'X-Auth-Token: YOURAPITOKENHERE' https://librenms.org/api/v0/services/:hostname?state=0&type=tcp
```
Output:
```text
{
"status": "ok",
"err-msg": "",
"count": 1,
"services": [
{
"Need example"
}
]
}
```