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

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

3003 - Mac - File System Space Change Check

<result created="2024-08-12T10:21:50+01:00" host="SERVER" status="OK">
  <check_config>
    <MountSpaceChange uid="35">
      <mountpoint>macOS</mountpoint>
      <threshold>25.00</threshold>
    </MountSpaceChange>
  </check_config>
</result>

3004 - Mac - File System Space Check

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

3006 - Mac - Failed Login 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>

3007 - Mac - Performance Monitoring

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

3008 - Mac - Physical Disk Health 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>

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

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

3013 - Mac - Daemon Check

<result created="2024-09-24T14:29:08+01:00" host="SERVER" status="OK">
  <check_config>
    <daemoncheck uid="41">
      <servicename>com.apple.autofsd</servicename>
      <failcount>1</failcount>
      <startpendingok>0</startpendingok>
      <restart>0</restart>
      <consecutiverestartcount>2</consecutiverestartcount>
      <cumulativerestartcount>4|24</cumulativerestartcount>
      <servicekeyname/>
    </daemoncheck>
  </check_config>
</result>

3014 - Apple System Log Check

<result created="2024-08-12T10:23:58+01:00" host="SERVER" status="OK">
  <check_config>
    <AppleSystemLogCheck uid="31">
      <level>2</level>
      <mode>0</mode>
      <option>0</option>
    </AppleSystemLogCheck>
  </check_config>
</result>

3021 - OSX Update Check

<result created="2024-08-12T10:25:29+01:00" host="SERVER" status="OK">
  <check_config>
    <OSXUpdateCheck uid="37">
      <mode>0</mode>
    </OSXUpdateCheck>
  </check_config>
</result>

3024 - Mac - 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>

3027 - Mac - 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>

3028 - Mac - Log File Check

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

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

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