List Templates

Service name: list_templates

Base URL

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

Description

List all of the account's server or workstation monitoring templates.

Parameters

Required parameters

Add required parameters immediately after the base URL.

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

Parameter	Type	Description	Options	Default
describe	Boolean	Optional. Returns a description of the service.	0	0
devicetype	string	The devicetype is optional but if used should be either "server" or "workstation"	server workstation	0

Optional parameters

Add optional parameters immediately after the base URL.

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

List Templates

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

Example response

<?xml version="1.0"?>
<result created="2024-05-26T16:43:19+01:00" host="SERVER" status="OK">
<items>
<installation_template>
<templateid>34</templateid>
<name>A Server Template</name>
</installation_template>
<installation_template>
<templateid>35</templateid>
<name>A Workstation Template</name>
</installation_template>
<installation_template>
<templateid>36</templateid>
<name>Another Server Template</name>
</installation_template>
<installation_template>
<templateid>37</templateid>
<name>Another WorkstationTemplate</name>
</installation_template>
</items>
</result>

List Templates - Server

https://{SERVER}/api/?apikey={yourAPIkey}&service=list_templates&devicetype=server

Example response

<?xml version="1.0"?>
<result created="2024-05-26T16:43:19+01:00" host="SERVER" status="OK">
<items>
<installation_template>
<templateid>34</templateid>
<name>A Server Template</name>
</installation_template>
<installation_template>
<templateid>36</templateid>
<name>Another Server Template</name>
</installation_template>
</items>
</result>

List Templates - Workstation

https://{SERVER}/api/?apikey={yourAPIkey}&service=list_templates&devicetype=workstation

Example response

<?xml version="1.0"?>
<result created="2024-05-26T16:43:19+01:00" host="SERVER" status="OK">
<items>
<installation_template>
<templateid>35</templateid>
<name>A Workstation Template</name>
</installation_template>
<installation_template>
<templateid>37</templateid>
<name>Another WorkstationTemplate</name>
</installation_template>
</items>
</result>

Returned fields

Field	Type	Can Be Empty	Description
templateid	integer	no	Monitoring Template ID
name	string	yes	Monitoring Template name

Updated 3 months ago