List Templates

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_templates

URL

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

&required_parameters=required_parameters

[&optional_parameters=optional_parameters]

Description

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

Parameters

Post Variable

Description

Type

Required

Options

Default

describe

Optional. Returns a description of the service.

boolean

no

true

0

devicetype

The devicetype is optional but if used should be either "server" or "workstation"

string

no

server

workstation

0

Example Service Call =list_templates

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

Example Response

<?xml version="1.0" ?>

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

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

Example Response

<?xml version="1.0" ?>

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

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

Example Response

<?xml version="1.0" ?>

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

Fields Description

Field

Type

Can Be Empty

Description

templateid

integer

no

Monitoring Template ID

name

string

yes

Monitoring Template name