Listing Checks: list_checks
Service name: list_checks |
|
URL |
https://SERVER/api/?apikey=yourAPItoken&service=list_checks &required_parameters=required_parameters [&optional_parameters=optional_parameters] |
Description |
Lists all checks for device identified by the deviceid parameter. |
Parameters |
|||||
Post Variable |
Description |
Type |
Required |
Options |
Default |
Optional. Returns a description of the service. |
boolean |
no |
true |
0 |
|
deviceid |
The deviceid must be a valid id. |
integer |
yes |
0 |
0 |
Example Service Call - list_checks |
https://SERVER/api/?apikey=yourAPItoken&service=list_checks&deviceid=DEVICEID |
Example Response |
<result created="2015-07-22T16:48:09+01:00" host="SERVER" status="OK"> <items> <check> <uid>19</uid> <sync_status>0</sync_status> <description>Web Page Check - URL http://www.WebsiteToQuery.com/</description> <statusid>1</statusid> <date>2009-09-10</date> <time>01:08:38</time> <utc_run>2015-07-21 23:09:38</utc_run> <email>1</email> <sms>1</sms> <checkid>1304847</checkid> <check_type>1012</check_type> <dsc_247>1</dsc_247> <consecutive_fails>152</consecutive_fails> </check> .... more <check> nodes ... </items> </result> |
Fields Description |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Field |
Type |
Can Be Empty |
Description |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
checkid |
integer |
no |
The check's unique identifier. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
uid |
integer |
yes |
An identifier of check unique to that server / wkstn only. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
sync_status |
bitmask |
no |
Is the check configuration on the Agent synchronized with the check configuration on the Dashboard?
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
check_type |
integer |
no |
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
description |
string |
yes |
Description of a check. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
dsc_247 |
integer |
no |
Is the check a Daily Safety Check, 24x7 Check, Scheduled Task or special case?
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
statusid |
integer |
no |
The status of the check:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
consecutive_fails |
integer |
no |
The number of consecutive check failures. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
date |
date |
no |
Date (on server) check last ran. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
time |
time |
no |
Time (on server) check last ran. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
utc_run |
datetime |
no |
The UTC date and time (on server) check last ran. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
integer |
no |
Are email alerts enabled for check?
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
sms |
integer |
no |
Are SMS alerts enabled for check (server monitoring only)
|
* Please note: The Failed Login Check was previously known as the Hacker Check with this renamed in Dashboard v5.44.5 to more accurately reflect the Check's function.
Example Associated Service Calls | ||
Parameter | Call | URL Format |
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 |