Listing Formatted Check Output: get_formatted_check_output
|
Service name: get_formatted_check_output |
|
|
URL |
https://SERVER/api/?apikey=yourAPItoken&service=get_formatted_check_output &required_parameters=required_parameters [&optional_parameters=optional_parameters] |
|
Description |
Returns formatted Dashboard More Information firstline result of check (error or otherwise) |
|
Parameters |
|||||
|
Post Variable |
Description |
Type |
Required |
Options |
Default |
|
Optional. Returns a description of the service. |
boolean |
no |
true |
0 |
|
|
checkid |
The checkid must be a valid id. |
integer |
yes |
0 |
0 |
|
Example Service Call =get_formatted_check_output |
|
https://SERVER/api/?apikey=yourAPItoken&service=get_formatted_check_output&checkid=CHECKID |
|
Example Response - Performance Monitoring Check - Processor Queue Length (Windows) |
|
<?xml version="1.0" ?> <result created="2015-08-03T15:46:21+01:00" host="SERVER" status="OK"> <formatted_output>Average Queue: 7.250, Maximum Queue : 34.000</formatted_output> </result> |
|
Fields Description |
|||
|
Field |
Type |
Can Be Empty |
Description |
|
checkid |
string |
no |
Formatted result of the check output |
| Example Associated Service Calls | ||
| Parameter | Call | URL Format |
| CheckID | list_checks |
https://SERVER/api/?apikey=yourAPItoken&service=list_checks&deviceid=DEVICEID |
| DeviceID | list_devices_at_client |
https://SERVER/api/?apikey=yourAPItoken&service=list_devices_at_client&clientid=CLIENTID&devicetype=server |
| list_servers |
https://SERVER/api/?apikey=yourAPItoken&service=list_servers&siteid=SITEID |
|
| list_workstations |
https://SERVER/api/?apikey=yourAPItoken&service=list_workstations&siteid=SITEID |
|
| SiteID | list_sites | https://SERVER/api/?apikey=yourAPItoken&service=list_sites&clientid=CLIENTID |
| ClientID | list_clients | https://SERVER/api/?apikey=yourAPItoken&service=list_clients |