Info on the API
From ServersCheck Wiki
ServersCheck has over 60 different check types built-in. Those are checks like TCP, PING, SERVICES, etc... A full list can be viewed here: check types
Software packages or hardware devices can be monitored on different levels, requiring a combination of checks. For example when monitoring Exchange, one can perform following checks: - WINDOWSHEALTH to monitor if the server is alive, the CPU usage, available memory and disk space usage - By using the SERVICES check, the specific Exchange services can be monitored - Using the WMI check, WMI parameters from Exchange can be monitored
Prior to release 8 a user had to create his own combination of checks to monitor a specific software package or hardware device. In the above example it would require a multitude of individual checks and monitors to do the job.
How to add & define a new check using an existing API
With the API introduction in release 8, a user selects the API just as if he would select any other check type. In the image below, the API check is IMAGESTREAM and appears in the list just like any other monitor.
Instead of just seeing a screen to define the specific settings of the monitor, the user is first shown a screen where he is prompted to submit the predefined fields.
Once the predefined fields are completed, you see the combination of checks recommended for the chosen API. The one's with a red dot haven't been defined yet for the device. The one with a green dot are active.
How to add new API's to the list of monitors
API's come in 2 kinds: either they are included with the release of the software as made available to you by ServersCheck, or then can be made available by a software or equipment manufacturer. In the first case, the API's appear automatically whenever adding a new monitor.
In the second case, you need to install manually the API. This is provided to you as a file by the author of the API. Simply copy the file into the /api subfolder and you are all set.
Want to create your own API?
You can create your own API by following the instructions outlined here: API_file_structure
