List Monitors (XML API)

Last modified on May 14, 2021

The List Monitors operation has two versions:

  • Version 1.0 returns the following monitor types: Web URL, API endpoint, email, FTP, TCP, DNS, ping.

  • Version 1.1 returns all monitors and lets you filter the returned list by specific monitor types.

In both cases, the first call needs to be to Login to get a session ID.

Request URL

POST https://www.alertsite.com/restapi/devices/list

Request Body

Version 1.0

XML

<List>
   <TxnHeader>
      <Request>
         <Login>_LOGIN_</Login>
         <SessionID>_SESSION_</SessionID>
      </Request>
   </TxnHeader>
   <Source>REST_Client</Source>
</List>

Version 1.1

To enable V1.1 functionality, add the <APIVersion>1.1</APIVersion> tag to your XML request body, as shown below.

V1.1 supports an additional <DeviceFilter> tag, which specify the monitors types to return. In this example, we request only secure website, ServerAgent, and DéjàClick monitors. To return all monitors, omit the <DeviceFilter> tag and its contents.

XML

<List>
   <APIVersion>1.1</APIVersion>
   <TxnHeader>
      <Request>
         <Login>_LOGIN_</Login>
         <SessionID>_SESSION_</SessionID>
         <DeviceFilter>SITE_SSL,DEV_SA,TXN_DEJA</DeviceFilter>
     </Request>
   </TxnHeader>
   <Source>REST_Client</Source>
</List>

DeviceFilter Values

<DeviceFilter> supports the following values. Separate multiple values with commas.

Value Description
DEV_SA ServerAgents
DEV_SEC Security scans
EMAIL_IMAP Email (IMAP) server monitors
EMAIL_POP Email (POP) server monitors
EMAIL_ROUNDTRIP Round-trip email monitors
EMAIL_SMTP Email (SMTP) server monitors
NET_DNS DNS monitors
NET_FTP FTP monitors
NET_FTPS FTP over SSL monitors
NET_PING Ping monitors
NET_TCP TCP monitors
SITE_HTTP Website monitors
SITE_SSL Secure website monitors
TXN_DEJA DéjàClick monitors
TXN_HTTP HTTP monitors
TXN_SSL SSL monitors
TXN_SOAP SoapUI monitors

Response Body

XML

<Response>
   <Status>0</Status>
   <Message>No errors.</Message>
   <SessionID>6f982ef01eb1f628</SessionID>
   <ObjDevice>48423</ObjDevice>
   <ObjCust>24567</ObjCust>
   <Custid>C24567</Custid>
   <Company>WidgetWorld</Company>
   <CurrPlan></CurrPlan>
   <CurrInterval></CurrInterval>
   <AvailablePlans>WTP5-1.5x:1:1</AvailablePlans>
   <TxnList>
      <Txn>
      <TxnName>Device 1</TxnName>
      <TxnDetail
         BillPlan="PPRO15"
         Interval="15"
         MaxSteps="0"
         Monitor="n"
         Notify="n"
         ObjDevice="20829"
         PingError="y"
         TimeOut="30"
         TraceError="n"
         />
      </Txn>
      <Txn>
      <TxnName>Device 2</TxnName>
      <TxnDetail
         BillPlan="PPRO5"
         Interval="5"
         MaxSteps="0"
         Monitor="n"
         Notify="n"
         ObjDevice="14981"
         PingError="y"
         TimeOut="30"
         TraceError="n"
         />
      </Txn>
   </TxnList>
   <TxnOut></TxnOut>
</Response>

See Also

Add Monitor
Edit Monitor
Get Monitor
Delete Monitor
Get Monitor Status
Get Plans
AlertSite XML API

Highlight search results