...
| Base URI | http(s)://example.com/{version}/{location}/{resource}/ | ||
| Authentication | Basic HTTP Auth | ||
| Encryption | HTTPS with certificate can be configured in the administrative web interface Configuration :: Network :: HTTP Configuration | ||
| Encoding | UTF-8 | ||
| Methods | GET and POST depending on the resource | ||
| Response content type | application/json | ||
| Wildcard | Asterisk '*' or 'all' | ||
| Restrictions |
|
Resource Path
The reosurce path specifies which location information should be accessed.
Especially if the device receives data from remote satellites (See Distributed Monitoring).
| Level | 1 | 2 | 3 | 4 |
|---|---|---|---|---|
| Description | Version | Tenant | Location | Resources |
| Example 1 | /v1 | /all | /local | /hosts/* |
| Example 2 | /v1 | /aeg | /berlin | /services/ping |
| Example 3 | /v1 | /siemens | /site382 | /problems |
Resources
/hosts
| Example | /hosts/{host_name|*|all} |
|---|---|
| Get all hosts | hosts/* |
Get all hosts, filter details for the fields current_state and plugin_output | hosts/*?fields=current_state,plugin_output |
| Get details for the host 'Google' | hosts/Google |
...