Listing Failing Checks
Use this API Call to query our Data Extraction API to extract data gathered by N-sight RMM.This section shows the service name and parameters needed in the API Call query, and provides examples of some queries and system responses. For more information, see Data Extraction API.
Service name: list_failing_checks | |
---|---|
URL |
https://SERVER/api/?apikey=yourAPIkey&service=list_failing_checks |
Description |
List all failing checks across all clients. |
Parameters | |||||
---|---|---|---|---|---|
Post Variable | Description | Type | Required | Options | Default |
describe | Returns a description of the service. | boolean | no | true | 0 |
clientid | Lists all failing checks for the specified Client. | integer | no | 0 | 0 |
check_type |
Optional parameter to limit the returned information to:
|
string | no |
random checks tasks |
0 |
We have included variables to reduce the volume of data handled by the API call and minimize the potential for timeout issues.
Where your account contains a large number of customers, we suggest using the per-Client clientid variable to retrieve the data related to a specific customer.
https://SERVER/api/?apikey=yourAPIkey&service=list_failing_checks&clientid=[CLIENTID]
To limit the returned information to failed checks or tasks use the check_type variable. This can be set to all failures, only checks or Windows Automated Tasks (check type id: 1023) failures.
https://SERVER/api/?apikey=yourAPIkey&service=list_failing_checks&check_type=[CHECK_TYPE]
You can also combined both parameters in the one call:
https://SERVER/api/?apikey=yourAPIkey&service=list_failing_checks&clientid=[CLIENTID]&check_type=[CHECK_TYPE]
Example Service Call - list_failing_checks |
---|
https://SERVER/api/?apikey=yourAPIkey&service=list_failing_checks |
Example Response |
<?xml version="1.0" ?> <result created="2009-09-24T12:28:44+01:00" host="SERVER" status="OK"> <items> <client> <clientid>1234</clientid> <name>My Client</name> <site> <siteid>123</siteid> <name>My Site</name> <workstations> <workstation> <id>12</id> <name>My Workstation</name> [if device is offline] <offline> <description>offline - maintenance mode</description> <startdate>2010-01-28</startdate> <starttime>14:47:34</starttime> </offline> <failed_checks> <check> <checkid>23</checkid> <check_type>1012</check_type> <dsc_247>1</dsc_247> <description>Windows Service Check - Fax</description> <date>2010-01-28</date> <time>14:47:34</date> <formatted_output>Status: STOPPED</formatted_output> <checkstatus>testerror</checkstatus> </check> ... more check nodes </failed_checks> </workstation> .... more nodes </workstations> <servers> <server> <id>12</id> <name>My Workstation</name> [if device is offline] <offline> <description>offline - maintenance mode</description> <startdate>2010-01-28</startdate> <starttime>14:47:34</starttime> </offline> [if device is overdue] <overdue> <description>Overdue</description> <startdate>2010-01-28</startdate> <starttime>14:47:34</starttime> </overdue> [if device is unreachable] <unreachable> <description>Site Unreachable</description> <startdate>2010-01-28</startdate> <starttime>14:47:34</starttime> </unreachable> <failed_checks> <check> <checkid>23</checkid> <check_type>1012</check_type> <dsc_247>1</dsc_247> <description>Backup Check - Veritas Backup Exec v10.0</description> <date>2010-01-28</date> <time>14:47:34</date> <startdate>2009-11-19</startdate> <starttime>22:17:32</starttime> <formatted_output>Backup status can not be determined</formatted_output> <checkstatus>testerror</checkstatus> </check> ... more check nodes </failed_checks> </server> ... more server node if any </servers> </site> ..... more site nodes </client> ..... more client nodes </items> </result> |
Example Service Call - list_failing_checks&clientid |
https://SERVER/api/?apikey=yourAPIkey&service=list_failing_checks&clientid=[CLIENTID] |
Example Response |
<?xml version="1.0" ?> <result created="2009-09-24T12:28:44+01:00" host="SERVER" status="OK"> <items> <client> <clientid>1234</clientid> <name>My Client</name> <site> <siteid>123</siteid> <name>My Site</name> <workstations> <workstation> <id>12</id> <name>My Workstation</name> [if device is offline] <offline> <description>offline - maintenance mode</description> <startdate>2010-01-28</startdate> <starttime>14:47:34</starttime> </offline> <failed_checks> <check> <checkid>23</checkid> <check_type>1012</check_type> <dsc_247>1</dsc_247> <description>Windows Service Check - Fax</description> <date>2010-01-28</date> <time>14:47:34</date> <formatted_output>Status: STOPPED</formatted_output> <checkstatus>testerror</checkstatus> </check> ... more check nodes </failed_checks> </workstation> .... more nodes </workstations> <servers> <server> <id>12</id> <name>My Workstation</name> [if device is offline] <offline> <description>offline - maintenance mode</description> <startdate>2010-01-28</startdate> <starttime>14:47:34</starttime> </offline> [if device is overdue] <overdue> <description>Overdue</description> <startdate>2010-01-28</startdate> <starttime>14:47:34</starttime> </overdue> [if device is unreachable] <unreachable> <description>Site Unreachable</description> <startdate>2010-01-28</startdate> <starttime>14:47:34</starttime> </unreachable> <failed_checks> <check> <checkid>23</checkid> <check_type>1012</check_type> <dsc_247>1</dsc_247> <description>Backup Check - Veritas Backup Exec v10.0</description> <date>2010-01-28</date> <time>14:47:34</date> <startdate>2009-11-19</startdate> <starttime>22:17:32</starttime> <formatted_output>Backup status can not be determined</formatted_output> <checkstatus>testerror</checkstatus> </check> ... more check nodes </failed_checks> </server> ... more server node if any </servers> </site> ..... more site nodes </client> </items> </result> |
Example Service Call - list_failing_checks&check_type |
https://SERVER/api/?apikey=yourAPIkey&service=list_failing_checks&check_type=[CHECK_TYPE] |
Example Response |
<?xml version="1.0" ?> <result created="2009-09-24T12:28:44+01:00" host="SERVER" status="OK"> <items> <client> <clientid>1234</clientid> <name>My Client</name> <site> <siteid>123</siteid> <name>My Site</name> <workstations> <workstation> <id>12</id> <name>My Workstation</name> [if device is offline] <offline> <description>offline - maintenance mode</description> <startdate>2010-01-28</startdate> <starttime>14:47:34</starttime> </offline> <failed_checks> <check> <checkid>23</checkid> <check_type>1012</check_type> <dsc_247>1</dsc_247> <description>Windows Service Check - Fax</description> <date>2010-01-28</date> <time>14:47:34</date> <formatted_output>Status: STOPPED</formatted_output> <checkstatus>testerror</checkstatus> </check> ... more check nodes </failed_checks> </workstation> .... more nodes </workstations> <servers> <server> <id>12</id> <name>My Workstation</name> [if device is offline] <offline> <description>offline - maintenance mode</description> <startdate>2010-01-28</startdate> <starttime>14:47:34</starttime> </offline> [if device is overdue] <overdue> <description>Overdue</description> <startdate>2010-01-28</startdate> <starttime>14:47:34</starttime> </overdue> [if device is unreachable] <unreachable> <description>Site Unreachable</description> <startdate>2010-01-28</startdate> <starttime>14:47:34</starttime> </unreachable> <failed_checks> <check> <checkid>23</checkid> <check_type>1012</check_type> <dsc_247>1</dsc_247> <description>Backup Check - Veritas Backup Exec v10.0</description> <date>2010-01-28</date> <time>14:47:34</date> <startdate>2009-11-19</startdate> <starttime>22:17:32</starttime> <formatted_output>Backup status can not be determined</formatted_output> <checkstatus>testerror</checkstatus> </check> ... more check nodes </failed_checks> </server> ... more server node if any </servers> </site> ..... more site nodes </client> </items> </result> |
Fields Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Field | Type | Can Be Empty | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
client/clientid | integer | no | Unique identifier of client | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
client/name | string | no | Name of the client | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
client/site/siteid | integer | no | Unique identifier of site | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
client/site/name | string | no | Name of site | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
client/site/workstations/workstation/id | integer | no | Unique identifier of workstation | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
client/site/workstations/workstation/name | string | no | Name of workstation | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
client/site/workstations/workstation/check/checkid | integer | no | Unique identifier of a check | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
client/site/workstations/workstation/check/check_type | integer | no | The type of check (see below section check_type) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
client/site/workstations/workstation/check/dsc_247 | integer | no |
Is the check a Daily Safety Check, 24x7 Check, Scheduled Task or special case?
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
client/site/workstations/workstation/check/description | string | no | Check description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
client/site/workstations/workstation/check/date | date | no | Date of the last fail | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
client/site/workstations/workstation/check/time | time | no | Time of the last fail | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
client/site/workstations/workstation/check/formatted_output | string | no | Description of the problem | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
client/site/workstations/workstation/check/checkstatus | string | no |
Current Status of the Check
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
client/site/workstations/workstation/offline/description | string | no | Description of offline status | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
client/site/workstations/workstation/offline/startdate | date | no | Date since it is offline | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
client/site/workstations/workstation/offline/starttime | time | no | Time since it is offline | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
client/site/servers/server/id | integer | no | Unique identifier of server | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
client/site/servers/server/name | string | no | Name of server | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
client/site/servers/server/offline/description | string | no | Description of offline status | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
client/site/servers/server/offline/startdate | date | no | Date since it is offline | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
client/site/servers/server/offline/starttime | time | no | Time since it is offline | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
client/site/servers/server/overdue/description | string | no | Description of overdue status | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
client/site/servers/server/overdue/startdate | date | no | Date since it is overdue | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
client/site/servers/server/overdue/starttime | time | no | Time since it is overdue | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
client/site/servers/server/unreachable/description | string | no | Description of unreachable status | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
client/site/servers/server/unreachable/startdate | date | no | Date since it is unreachable | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
client/site/servers/server/unreachable/starttime | time | no | Time since it is unreachable | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
client/site/servers/server/check/checkid | integer | no | Unique identifier of a check | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
client/site/servers/server/check/check_type | integer | no | The type of check (see below section check_type) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
client/site/servers/server/check/dsc_247 | integer | no |
Is the check a Daily Safety Check, 24x7 Check, Scheduled Task or special case?
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
client/site/servers/server/check/description | string | no | Check description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
client/site/servers/server/check/date | date | no | Date of the last fail | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
client/site/servers/server/check/time | time | no | Time of the last fail | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
client/site/servers/server/check/startdate | date | no | Date when check started failing | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
client/site/servers/server/check/starttime | time | no | Time when check started failing | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
client/site/servers/server/check/formatted_output | string | no | Description of the problem | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
client/site/servers/server/check/checkstatus | string | no |
Current Status of the Check
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
check_type | integer | no |
The type of check:
|
Example Associated Service Calls | ||
---|---|---|
Parameter | Call | URL Format |
ClientID | list_clients | https://SERVER/api/?apikey=yourAPIkey&service=list_clients |