Listing Check Configuration

Base URL

https://{SERVER}/api/?apikey={yourAPIkey}&service=list_check_config

Description

This section lists the example responses expected when running the list_check_config service call on Windows devices.

https://{SERVER}/api/?apikey={yourAPIkey}&service= list_check_config&optional_parameters={parameter-value}

Parameter	Description	Type	Options	Default
describe	Returns a description of the service.	boolean	true	0

Determine parameter values

Use the following associated service calls to determine parameter values.

Parameter	Call	URL Format
checkid	list_checks	https://`{SERVER}`/api/?apikey=`{yourAPIkey}`&service=list_checks&deviceid=DEVICEID
deviceid	list_devices_at_client	https://`{SERVER}`/api/?apikey=`{yourAPIkey}`&service=list_devices_at_client&clientid=CLIENTID&devicetype=server
	list_servers	https://`{SERVER}`/api/?apikey=`{yourAPIkey}`&service=list_servers&siteid=SITEID
	list_workstations	https://`{SERVER}`/api/?apikey=`{yourAPIkey}`&service=list_workstations&siteid=SITEID
siteid	list_sites	https://`{SERVER}`/api/?apikey=`{yourAPIkey}`&service=list_sites&clientid=CLIENTID
clientid	list_clients	https://`{SERVER}`/api/?apikey=`{yourAPIkey}`&service=list_clients

Examples

Listing Check Configuration - Windows

https://{SERVER}/api/?apikey={yourAPIkey}&service=list_check_config&checkid=CHECKID

1001 - Anti Virus Update Check

<result created="2024-09-24T14:29:08+01:00" host="SERVER" status="OK">
  <check_config>
    <avupdatecheck uid="45">
      <avproduct>Symantec Antivirus</avproduct>
      <checkdays>MTWTFSS</checkdays>
    </avupdatecheck>
  </check_config>
</result>

1002 - Backup Check

<result created="2024-09-24T14:29:08+01:00" host="SERVER" status="OK">
  <check_config>
    <backupcheck uid="49">
      <backupproduct>Symantec Backup Exec v11.0</backupproduct>
      <checkdays>MTWTF__</checkdays>
      <partial>0</partial>
      <count>2</count>
    </backupcheck>
  </check_config>
</result>

1003 - Drive Space Change Check

<result created="2024-09-24T14:29:08+01:00" host="SERVER" status="OK">
  <check_config>
    <diskspacechange uid="43">
      <driveletter>C:\</driveletter>
      <threshold>25</threshold>
    </diskspacechange>
  </check_config>
</result>

1004 - Drive Space Check

<result created="2024-09-24T14:29:08+01:00" host="SERVER" status="OK">
  <check_config>
    <drivespacecheck uid="5">
      <driveletter>F:\</driveletter>
      <freespace>24</freespace>
      <spaceunits>3</spaceunits>
    </drivespacecheck>
  </check_config>
</result>

1005 - Exchange Check

<result created="2024-09-24T14:29:08+01:00" host="SERVER" status="OK">
  <check_config>
    <exchangecheck uid="63">
      <function>First Storage Group\Mailbox Store (MAIL)</function>
      <action />
      <threshold>40</threshold>
      <edbfile>E:\Program Files\Exchsrvr\mdbdata\priv1.edb</edbfile>
      <slvfile>E:\Program Files\Exchsrvr\mdbdata\priv1.stm</slvfile>
    </exchangecheck>
  </check_config>
</result>

1006 - Failed Login Check

<result created="2024-09-24T14:29:08+01:00" host="SERVER" status="OK">
  <check_config>
    <hackercheck uid="55">
      <logfails>100</logfails>
    </hackercheck>
  </check_config>
</result>

1007 - Performance Monitoring Check

<result created="2024-09-24T14:29:08+01:00" host="SERVER" status="OK">
  <check_config>
    <perfcountercheck uid="11">
      <type>4</type>
      <instance>Intel[R] PRO_1000 MT Network Connection _2</instance>
      <threshold1>40</threshold1>
      <threshold2/>
      <threshold3/>
      <threshold4/>
    </perfcountercheck>
  </check_config>
</result>

1008 - Physical Disk Check

<result created="2024-09-24T14:29:08+01:00" host="SERVER" status="OK">
  <check_config>
    <physdiskcheck uid="57">
      <volcheck>1</volcheck>
    </physdiskcheck>
  </check_config>
</result>

1009 - Physical Memory Health Check - Deprecated

1010 - PING Check

<result created="2024-09-24T14:29:08+01:00" host="SERVER" status="OK">
  <check_config>
    <pingcheck uid="7">
      <pinghost>10.10.1.254</pinghost>
      <name>Branch VPN</name>
      <failcount>1</failcount>
    </pingcheck>
  </check_config>
</result>

1011 - TCP Service Check

<result created="2024-09-24T14:29:08+01:00" host="SERVER" status="OK">
  <check_config>
    <tcpservicecheck uid="11">
      <name>SMTP 2</name>
      <portnumber>25</portnumber>
      <hostname>192.168.253.18</hostname>
      <mode>Alert if inactive</mode>
      <failcount>1</failcount>
    </tcpservicecheck>
  </check_config>
</result>

1012- Web Page Check

<result created="2009-09-24T14:29:08+01:00" host="SERVER" status="OK">
  <check_config>
    <webpagecheck uid="11">
      <url>www.WebsiteToQuery.com</url>
      <matchtext>enter text from source here</matchtext>
      <failcount>3</failcount>
    </webpagecheck>
  </check_config>
</result>

1013 - Windows Service Check

<result created="2024-09-24T14:29:08+01:00" host="SERVER" status="OK">
  <check_config>
    <winservicecheck uid="41">
      <servicename>Automatic Updates</servicename>
      <failcount>1</failcount>
      <startpendingok>0</startpendingok>
      <restart />
      <consecutiverestartcount />
      <cumulativerestartcount />
    </winservicecheck>
  </check_config>
</result>

1014 - Critical Events Check

<result created="2024-09-24T14:29:08+01:00" host="SERVER" status="OK">
  <check_config>
    <criticalevents uid="81">
      <eventlog>Application</eventlog>
      <mode>0</mode>
      <option>0</option>
    </criticalevents>
  </check_config>
</result>

1015 - SNMP Check

<result created="2024-09-24T14:29:08+01:00" host="SERVER" status="OK">
  <check_config>
    <snmpcheck uid="215">
      <product>Memory</product>
      <host>localhost</host>
      <port>161</port>
      <community>public</community>
      <uid>4</uid>
      <oid>1.3.6.1.4.1.674.10892.1.200.10.1.27.1</oid>
      <op>0</op>
      <testvalue>3</testvalue>
      <snmpversion />
    </snmpcheck>
  </check_config>
</result>

1018 - Bandwidth Monitoring Check

<result created="2024-09-24T14:29:08+01:00" host="SERVER" status="OK">
  <check_config>
    <bandwidthcheck uid="69">
      <name>Draytek Router</name>
      <host>192.168.201.254</host>
      <routerport>4</routerport>
      <threshold>40|40</threshold>
      <portspeed>0|0</portspeed>
      <units>1|1</units>
      <port>161</port>
      <community>public</community>
      <hispeed>0</hispeed>
    </bandwidthcheck>
  </check_config>
</result>

1019 - File Size Check

<result created="2024-09-24T14:29:08+01:00" host="SERVER" status="OK">
  <check_config>
    <filesizecheck uid="7">
      <uid>1</uid>
      <name>Message Store</name>
      <threshold>13</threshold>
      <units>3|0</units>
      <include>0|D:\Exchsvr\|priv1.edb</include>
      <exclude />
    </filesizecheck>
  </check_config>
</result>

1021 - WSUS Check

<result created="2024-09-24T14:29:08+01:00" host="SERVER" status="OK">
  <check_config>
    <wsuscheck uid="97">
      <active>1</active>
      <computersneedingupdatesthreshold>0</computersneedingupdatesthreshold>
      <computerswithupdateerrorsthreshold>0</computerswithupdateerrorsthreshold>
      <updatesneededthreshold>0</updatesneededthreshold>
      <updateswitherrorsthreshold>0</updateswitherrorsthreshold>
      <computersoverduethreshold>0</computersoverduethreshold>
    </wsuscheck>
  </check_config>
</result>

1025 - Patch Status Check (Vulnerability Check)

<result created="2024-08-11T20:17:01+01:00" host="www.systemmonitor.co.uk" status="OK">
  <check_config>
    <VulnerabilityCheck uid="2">
      <schedule1/>
      <schedule2>4|0|9|0|X______|0</schedule2>
      <devtype>2</devtype>
      <mode>0</mode>
      <autoapproval>3|3|3|3|3,3|3|3|3|3</autoapproval>
      <scandelaytime/>
      <failureemails>1</failureemails>
      <rebootdevice>0</rebootdevice>
      <rebootcriteria>0|1</rebootcriteria>
    </VulnerabilityCheck>
  </check_config>
</result>

1026 - Managed Antivirus Check (VIPRE) - no configuration options

<result created="2024-07-23T15:24:36+01:00" host="SERVER" status="OK">
  <check_config/>
</result>

1030 - Backup & Recovery Selected Size Check

<result created="2024-08-11T20:21:15+01:00" host="SERVER" status="OK">
  <check_config>
    <MOBSelectedSizeCheck uid="72">
      <pluginthresholds>fs|50|2_ss|10|2_e|13|1_ns||_vm||_ms||_vsssp||_o||_all|100|2</pluginthresholds>
    </MOBSelectedSizeCheck>
  </check_config>
</result>

1033 - Web Protection Bandwidth Check

<result created="2024-08-11T20:23:46+01:00" host="SERVER" status="OK">
  <check_config>
    <wpcategorycounternotificationcheck uid="66">
      <fieldToCount>Downloads</fieldToCount>
      <actionPerformed>Any</actionPerformed>
      <categories>
        <category id="0"/>
        <category id="1"/>
        <category id="2"/>
        <category id="3"/>
        ....
      </categories>
    </wpcategorycounternotificationcheck>
  </check_config>
</result>

1034 - Managed Antivirus Check (Bitdefender) - no configuration options

<result created="2015-07-23T15:24:36+01:00" host="SERVER" status="OK">
  <check_config/>
</result>