Add a Check Note

Base URL

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

Add a public/private note to a check based on the provided public_note and/or private_note value.

Add required parameters immediately after the base URL.

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

Parameter	Type	Description
describe	Boolean	Optional. Returns a description of the service.
checkid	Number	The ID of the Check you want to clear.
private_note	String	Technical (private) note
public_note	String	Client-facing note

Add optional parameters immediately after the base URL.

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

Parameter	Description	Type	Required	Options	Default
describe	Returns a description of the service.	boolean	no	true	0

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

https://{SERVER}/api/?apikey={yourAPIkey}&service=add_check_note&checkid=CHECKID&private_note=PRIVATEMESSAGE&public_note=PUBLICMESSAGE

<?xml version="1.0"?>
<result created="2024-10-01T15:29:38+01:00" host="server" status="OK">
  <message><![CDATA[Note Added]]></message>
</result>

Field	Type	Can Be Empty	Description
checkid	integer	no	The unique ID of the Check the note is added to