Filter by label
There are no items with the selected labels at this time.
Introduction
The SONARPLEX REST API offers an easy way to gather information and even post information to the SONARPLEX.
API Basics
| 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 '*' |
| Restrictions | Access is restricted to the admin interface (usually port 81) and to user 'admin' |
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 |
/services
/problems
| Example | /problems/{hosts|services|*|all} |
|---|---|
| Get all problems | problems/* |
Get all problems for service 'Mail_out' | problems/services/Mail_out/hosts/* |
| Get all problems of host 'Email_Loop' | problems/services/*/hosts/Email_Loop |
| Get detail view for problem of host 'Email_Loop' for service 'Mail_out' | problems/services/Mail_out/hosts/Email_Loop |
| Get all problems of host 'Email_Loop' | problems/services/*/hosts/Email_Loop |
/comments
| Example | /comments/{hosts|services|*|all} |
|---|---|
| Get all comments | comments/* |
| Get the comments detail of service 'Jobs' on host 'SAP' | comments/hosts/SAP/services/Jobs |
/downtimes
| Example | /downtimes/{hosts|services|*|all} |
|---|---|
| Get all downtimes | downtimes/* |
| Get the downtime detail of service 'Jobs' on host 'SAP' | downtimes/hosts/SAP/services/Jobs |
/cmd
Find a full list of compatible external commands here.
| Example | /cmd/{command_name} |
|---|---|
| Acknowledge host problem | cmd/ACKNOWLEDGE_HOST_PROBLEM/Google/1/1/1/Operator/'Aware of this problem, acknowledged' |
| Acknowledge service problem | cmd/ACKNOWLEDGE_SVC_PROBLEM/-azeti-A-/Email-Msg-Queue/1/1/1/admin/problem%20is%20known%20so%20far |
| Process external host check result | cmd/PROCESS_HOST_CHECK_RESULT/Google/0/OK - Wieder ein Fake|pkt=1;;0;2 rta=20.945;1000.000;2000.000; |
/checknow
| Example | /checknow/{host_name}/{service_name} |
|---|---|
| Execute an active service check 'Agent-Status' on host '-azeti-A-' now | checknow/-azeti-A-/Agent-Status/ |
/addons
This resource offers the possiblity to upload and download files to/from /mnt/hd/daaz/addons/var and below
| Method | Resource | Example | Description |
|---|---|---|---|
| GET/POST | addons/ | addons/var/azeti/door_access.policy | Either GET or POST the file |
http://192.168.111.1:81/v1/*/local/addons/var/azeti/door_access.policy
/oscmd
These commands support arguments which must be defined in an escaped manner.
The '/' must be given as backslash '\' and further arguments for the commands are separated through slashes.
Syntax
/oscmd/{command}/argument_1/argument_2/
Available Commands
| Resource | Example |
|---|---|
/oscmd/ls | oscmd/ls/\flash\sysconfig |
/oscmd/traceroute | oscmd/traceroute/www.google.de |
/oscmd/nslookup | oscmd/check/nslookup/www.google.de |
oscmd/type | oscmd/type/\azeti\door_access.policy |
oscmd/ping | oscmd/ping/-c/3/www.google.de |
oscmd/check | oscmd/check/check_icmp/-H/www.google.de oscmd/check/check_icmp/-H/www.google.de/-v oscmd/check/check_icmp/-H/www.google.de/-v/-v oscmd/check/check_host/-H/www.google.de oscmd/check/check_host/-H/www.google.de/-v oscmd/check/check_host/-H/www.google.de/-v/-v |
oscmd/df/-ah | Shows all free disk space human readable ('-ah') |
| oscmd/ps/web-monitor | This lists the processes and filters for 'web-monitor'/usr/local/bin/ps auxww --cols=300 | grep web-monitor", |
Additional Resources
| Resource, Examples | Description |
|---|---|
/comments | All comments |
/appinfo | System information about the SONARPLEX device, including machine and monitor process information |
/config/{config_object}/config/hosts /config/services /config/contacts /config/contactgroups /config/commands ... | Listing of the monitoring configuration by object
|
/queue | Overview of the monitoring queue and the particular check scheduling |