Listing Check Configuration
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_check_config |
|
|
URL |
https://SERVER/api/?apikey=yourAPIkey&service=list_check_config &required_parameters=required_parameters [&optional_parameters=optional_parameters] |
|
Description |
Lists configuration for given check. |
|
Parameters |
|||||
|
Post Variable |
Description |
Type |
Required |
Options |
Default |
|
Optional. Returns a description of the service. |
boolean |
no |
true |
0 |
|
|
checkid |
The checkid must be a valid id. |
integer |
yes |
0 |
0 |
|
Example Service Call - list_check_config |
|
https://SERVER/api/?apikey=yourAPIkey&service=list_check_config&checkid=CHECKID |
|
Example Response - Antivirus Update Check (Windows) |
|
<result created="2009-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> |
|
Field Description |
|
Return values dependent on checkid, for examples of the returned output for each Operating System please go to the following sections for Windows, Linux and Mac computers. |
| Example Associated Service Calls | ||
| 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 |