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 - Linux

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

2001 - Anti Virus Update Check

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

2002 - Backup Check

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

2003 - File System Space Change Check

<result created="2024-09-24T14:29:08+01:00" host="SERVER" status="OK">
  <check_config>
    <mountspacechange uid="43">
      <mountpoint>/</mountpoint>
      <threshold>25.00</threshold>
    </mountspacechange>
  </check_config>
</result>

2004 - File System Space Check

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

2005 - MTA Queue Length

<result created="2024-09-24T14:29:08+01:00" host="SERVER" status="OK">
  <check_config>
    <mtacheck uid="63">
      <function>exim</function>
      <action>Unused</action>
      <threshold>40</threshold>
    </mtacheck>
  </check_config>
</result>

2006 - 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>

2007 - 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>

2008 - 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>

2009 - Physical Memory Health Check

<result created="2024-08-11T20:09:46+01:00" host="SERVER" status="OK">
  <check_config>
    <PhysMemCheck uid="72">
      <memcheck>1</memcheck>
    </PhysMemCheck>
  </check_config>
</result>

2010 - 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>

2011 - 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>

2012- Web Page Check

<result created="2024-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>

2013 - Daemon Check

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

2015 - 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>

2018 - 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>

2024 - Script Check

<result created="2024-08-11T19:59:24+01:00" host="SERVER" status="OK">
  <check_config>
    <ScriptCheck uid="58">
      <description>script identifier</description>
      <scriptname>3511.sh</scriptname>
      <scriptlanguage>7</scriptlanguage>
      <timeout>10</timeout>
      <arguments/>
    </ScriptCheck>
  </check_config>
</result>

2027- Process Check

<result created="2024-08-11T19:56:55+01:00" host="SERVER" status="OK">
  <check_config>
    <ProcessCheck uid="56">
      <process>processName</process>
      <threshold1>1</threshold1>
      <threshold2>1000</threshold2>
    </ProcessCheck>
  </check_config>
</result>

2028 - Log File Check

<result created="2024-08-11T19:53:55+01:00" host="SERVER" status="OK">
  <check_config>
    <LogFileCheck uid="54">
      <logname>/var/log/apt/term.log</logname>
      <contains>some text</contains>
    </LogFileCheck>
  </check_config>
</result>

2029 - MySQL Check

<result created="2024-08-11T20:07:20+01:00" host="SERVER" status="OK">
  <check_config>
    <MySQLCheck uid="70">
      <product>mysql</product>
      <threadsconnected>100</threadsconnected>
      <createdtmpdisktables>10</createdtmpdisktables>
      <handlerreadfirst>10</handlerreadfirst>
      <innodbbufferpoolwaitfree>10</innodbbufferpoolwaitfree>
      <keyreads>10</keyreads>
      <maxusedconnections>100</maxusedconnections>
      <opentables>10</opentables>
      <selectfullJoin>10</selectfullJoin>
      <slowqueries>10</slowqueries>
    </MySQLCheck>
  </check_config>
</result>

2031 - Package Management Check

<result created="2024-08-11T19:38:34+01:00" host="SERVER" status="OK">
  <check_config>
    <PackageManagementCheck uid="66">
      <updatesthreshold>0</updatesthreshold>
      <noncritical>0</noncritical>
    </PackageManagementCheck>
  </check_config>
</result>