List Drive Space History
Service name: list_checks
Base URL
https://{SERVER}/api/?apikey={yourAPIkey}&service=list_checks
Description
Lists all checks for device identified by the deviceid parameter.
Parameters
Required parameters
Add required parameters immediately after the base URL.
https://{SERVER}/api/?apikey={yourAPIkey}&service=list_checks&required_parameters={parameter-value}
Parameter | Description | Type | Options | Default |
---|---|---|---|---|
deviceid | The deviceid must be a valid id. | integer | 0 | 0 |
Optional parameters
Add optional parameters immediately after the base URL.
https://{SERVER}/api/?apikey={yourAPIkey}&service=list_checks&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 |
---|---|---|
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
List Drive Space History
https://{SERVER}/api/?apikey={yourAPIkey}&service=list_checks&deviceid=DEVICEID
Example response
<result created="2024-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>2024-09-10</date>
<time>01:08:38</time>
<utc_run>2024-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>
Returned fields
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? Indicator and Status 0 - Check is synchronized bit 1 - Check is not synchronized bit 2 - Check has not run bit 3 - Check is new bit 4 - Check has been modified on server bit 5 - Check is locked bit 6 - Check has no valid data |
check_type | integer | no | The type of check: Windows 1001 - Antivirus Update Check 1002 - Backup Check 1003 - Drive Space Change Check 1004 - Disk Space Check 1005 - Exchange Store Size 1006 - Failed Login Check 1007 - Performance Monitoring Check 1008 - Physical Disk Health Check 1009 - Physical Memory Health Check 1010 - PING Check 1011 - TCP Service Check 1012 - Web Page Check 1013 - Windows Service Check 1014 - Critical Events Check 1015 - SNMP Check 1018 - Bandwidth Monitoring 1019 - File Size Check 1020 - Event Log Check 1021 - WSUS Check 1022 - Auto-Start Service Check 1023 - Script or Automated Task 1024 - Script Check 1025 - Patch Status Check (Vulnerability Check) 1026 - Managed Antivirus Check (VIPRE) (VIPRE now retired from N-sight RMM) 1030 - Backup & Recovery Selected Size Check 1033 - Web Protection Bandwidth Check (LEGACY) 1034 - Managed Antivirus Check (Bitdefender) 1035 - Managed Antivirus Update Check (Bitdefender) 1036 - Web Protection Bandwidth Check 1037 - NetPath Check 1038 - Disk Encryption Manager Check (Bitdefender) 1039 - Disk Encryption Manager Service Check (Bitdefender) 1040 - Integration Check Linux 2001 - Antivirus Update Check 2002 - Backup Check 2003 - File System Space Change Check 2004 - File System Space Check 2005 - MTA Queue Length 2006 - Failed Login Check 2007 - Performance Monitoring Check 2008 - Physical Disk Health 2009 - Physical Memory Health Check 2010 - PING Check 2011 - TCP Service Check 2012 - Web Page Check 2013 - Daemon Check 2015 - SNMP Check 2018 - Bandwidth Monitoring Check 2019 - File Size Check 2024 - Script Check 2027 - Process Check 2028 - Log File Check 2029 - MySQL Check 2031 - Package Manager Check Mac 3002 - Backup Check 3003 - File System Space Change Check 3004 - File System Space Check 3006 - Failed Login Check 3007 - Performance Monitoring Check 3008 - Physical Disk Health Check 3011 - TCP Service Check 3012 - Web Page Check 3013 - OSX Daemon Check 3014 - Apple system Log Check 3021 - Update Check 3023 - Script or Automated Task 3024 - Script Check 3027 - Process Check 3028 - Log File Check 3034 - Managed Antivirus Check (Bitdefender) 3035 - Managed Antivirus Update Check (Bitdefender) 3040 - Integration Check |
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? Indicator and Check 1 - 24x7 check 2 - Daily Safety Check 3 - Scheduled Task 4 - Managed Antivirus Check 6 - Backup & Recovery Selected Size Check |
statusid | integer | no | The status of the check: Indicator and Status 0 - Check has not run 1 - Check failed 4 - Check failed and has been parked 5 - Check passed |
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? Indicator and Status 0 - No 1 - Yes | |
sms | integer | no | Are SMS alerts enabled for check (server monitoring only) Indicator and Status 0 - No 1 - Yes |
Updated about 1 month ago