Listing Formatted Check Output

Base URL

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

Description

Returns formatted Dashboard More Information firstline result of check (error or otherwise)

Parameters

Required parameters

Add required parameters immediately after the base URL.

https://{SERVER}/api/?apikey={yourAPIkey}&service=get_formatted_check_output&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=get_formatted_check_output&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 Formatted Check Output

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

Example response

<?xml version="1.0" ?>
<result created="2024-08-03T15:46:21+01:00" host="SERVER" status="OK">
  <formatted_output>Average Queue: 7.250, Maximum Queue : 34.000</formatted_output>
</result>

Returned fields

Field	Type	Can Be Empty	Description
checkid	string	no	Formatted result of the check output