Listing Check Configuration

Base URL

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

Description

Lists configuration for given check.

Parameters

Required parameters

Add required parameters immediately after the base URL.

https://{SERVER}/api/?apikey={yourAPIkey}&service= list_check_config&required_parameters={parameter-value}

Parameter	Description	Type	Options	Default
checkid	The checkid 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_check_config&optional_parameters={parameter-value}

Parameter	Description	Type	Required	Options	Default
describe	Returns a description of the service.	boolean	no	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

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

Example response

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

Returned fields

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.