Get Monitor (XML API)

Last modified on August 16, 2021

To get monitor configuration, send a POST request to /devices/download with the monitor ID in the <ObjDevice> XML tag.

Request URL

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

Request Body

XML

<Download>
   <TxnHeader>
      <Request>
         <Login>_LOGIN_</Login>
         <SessionID>_SESSION_</SessionID>
         <ObjCust>_CUSTOMER_ID_</ObjCust>
         <ObjDevice>_MONITOR_ID_</ObjDevice>
      </Request>
   </TxnHeader>
   <Source>REST_Client</Source>
</Download>

Response Body

XML

<Response>
   <Status>0</Status>
   <Message>No errors.</Message>
   <SessionID>a1077ff0b1a40a62</SessionID>
   <ObjDevice>48423</ObjDevice>
   <ObjCust>24567</ObjCust>
   <Custid>C34567</Custid>
   <Company>WidgetWorld</Company>
   <CurrPlan>PPRO5</CurrPlan>
   <CurrInterval>60</CurrInterval>
   <AvailablePlans></AvailablePlans>
   <Device>
      <Descrip>Widget Test [2008-02-01 16:47:57]</Descrip>
      <SSLCheckCertDates>Disabled</SSLCheckCertDates>
      <SSLClientCertRequired>0</SSLClientCertRequired>
      <SSLVersion></SSLVersion>
      <LastStatus>0</LastStatus>
      <DtLastStatus>0000-00-00 00:00:00</DtLastStatus>
      <DtLastError>0000-00-00 00:00:00</DtLastError>
      <DtLastErrorCleared>0000-00-00 00:00:00</DtLastErrorCleared>
      <DtLastNotify>0000-00-00 00:00:00</DtLastNotify>
      <RealmUserId>some realm userid</RealmUserId>
      <RealmPassword>xuLJ+Z1umvvd0AeLZo9gV38wNkVlsc4RCGbmiBUuqM=</RealmPassword>
      <FullIP>111.222.333.444</FullIP>
      <MonitorTimeout>30</MonitorTimeout>
      <SMTPaddr>smtpaddr.here</SMTPaddr>
      <Emailaddr>emailaddr.here</Emailaddr>
      <POP3addr>pop3addr.here</POP3addr>
      <FullpageNotify></FullpageNotify>
      <Report401Errors>1</Report401Errors>
      <Report302Errors>1</Report302Errors>
      <RawHttpHeaders>Disabled</RawHttpHeaders>
      <HttpMethod>p</HttpMethod>
      <HttpVersion>1.0</HttpVersion>
      <url>www.google.com</url>
      <TxnXml></TxnXml>
      <TxnPassword></TxnPassword>
      <Keyword>abc</Keyword>
      <KeywordType>Plain Text</KeywordType>
      <KeywordInvertMatch>n</KeywordInvertMatch>
      <FullpageDynamic></FullpageDynamic>
      <FullpageChecksize></FullpageChecksize>
      <FullpageTimeout>20</FullpageTimeout>
      <CaptureMType>image/jpeg</CaptureMType>
      <CaptureGroup>img,src,hdr</CaptureGroup>
      <CaptureLevel>0</CaptureLevel>
      <Port>88</Port>
      <ResolveDNS>y</ResolveDNS>
      <HttpBrowserCode>0</HttpBrowserCode>
      <Type>w</Type>
      <Compression>Disabled</Compression>
      <PingError>n</PingError>
      <FtpUploadTest>Disabled</FtpUploadTest>
      <Caching>Disabled</Caching>
      <PostPairs></PostPairs>
      <RawPostData>Disabled</RawPostData>
      <NsLookupObject>0</NsLookupObject>
      <Notify>n</Notify>
      <NotifyContent>n</NotifyContent>
      <NotifyTraceroute></NotifyTraceroute>
      <HttpFollowRedirect>y</HttpFollowRedirect>
      <ObjDevlog>0</ObjDevlog>
      <ObjDevlogPrev>0</ObjDevlogPrev>
      <HomeLocation>1</HomeLocation>
      <Monitor>y</Monitor>
      <MonitorType>I</MonitorType>
      <MonitorInterval>60</MonitorInterval>
      <MonitorSeed>59</MonitorSeed>
      <MonitorLocs>0</MonitorLocs>
      <MonitorIntervalFullpage>-1</MonitorIntervalFullpage>
      <IsTxn>0</IsTxn>
      <TxnMaxSteps>0</TxnMaxSteps>
      <UpdStamp>2008-02-01 16:48:40</UpdStamp>
      <AssertionList>
         <Assertion>
            <Source>Response</Source>
            <Property></Property>
            <Comparison>does not contain</Comparison>
            <Value>error</Value>
         </Assertion>
         <Assertion>
            <Source>JSON Response</Source>
            <Property>store.book[0].title</Property>
            <Comparison>equals</Comparison>
            <Value>The Lord of the Rings</Value>
         </Assertion>
      </AssertionList>
   </Device>
</Response>

The relevant XML tags are described below.

Descrip

The monitor name.

Type

The monitor type.

Value Description
w Web site (http://)
s Secure web site (https://)
a API endpoint (http://)
b Secure API endpoint (https://)
f FTP server
F Secure FTP server
p Email (POP) server
e Email (SMTP) server
i Email (IMAP) server
r Roundtrip Email (POP/SMTP)
t TCP (Simple TCP Connect)
empty string Ping (Server/Device Ping)
n DNS (name server)

SSLCheckCertDates

Defines whether the check for SSL certification expiration is enabled.

SSLClientCertRequired

Defines whether the monitor needs a SSL certificate to connect to your monitored website.

SSLVersion

SSL Version.

LastStatus

The latest status reported by the monitor.

DtLastStatus

Date and time when the last status was obtained.

DtLastError

Date and time when the last error was recorded.

DtLastErrorCleared

Date and time when the last error was cleared.

DtLastNotify

Date and time when the last notification about the monitor was sent.

RealmUserId and RealmPassword

Username and password used to log in to the monitored website.

FullIP

Resolvable IP address of the monitor.

MonitorTimeout

The monitor timeout, in seconds.

SMTPAddr

The SMTP server monitored by an Email (SMTP) server monitor (monitor type e).

Emailaddr

The email address used for round-trip email monitoring (monitor type r).

POP3addr

The POP3 server monitored by an Email (SMTP) server monitor (monitor type p).

FullpageNotify

Defines is there notifications on fullpage errors.

Report401Errors

Defines whether a 401 error should be treated as a monitor error.

Report302errors

Defines whether a 302 error should be treated as a monitor error.

RawHttpHeaders

Raw headers for HTTP POST monitors.

HttpMethod

The HTTP method used to access the monitored URL.

Value Description
g GET
p POST
h HEAD
c Other (specified in PostPairs)

HttpVersion

HTTP version: 1.0 or 1.1.

url

The monitored URL.

TxnXml

N/A

Keyword, KeywordType and KeywordInvertMatch

Keyword matching options. Used for website URL and DNS monitors (monitor types w, s and n).

AssertionList

A list of assertions used to validate the response from the API call. Applies only to API endpoint monitors (monitor types a and b).

<AssertionList> contains one or more <Assertion> tags, and each <Assertion> contains the following:

Source

Response or JSON Response.

Property

If Source=Response, this is an empty string.

If Source=JSON Response, this is a JSONPath expression that specifies the JSON field being verified, such as store.book[0].title.

Comparison

The comparison type to perform. Possible values:

  • Source=Response:
    • contains
    • does not contain
    • regular expression includes
    • regular expression excludes
  • Source=JSON Response or XML Response:
    • equals
    • count
    • exists
    • does not exist
    • regular expression includes
    • regular expression excludes
  • Source=Timeout:
    • less than or equal
  • Source=Status Code
    • equals
    • does not equal
  • Source=Header
    • equals
    • exists
    • regular expression includes

Value

The expected value for the assertion to pass. Depending on the Comparison, it can be a string or a regular expression pattern. If Comparison=exists or does not exist, Value is an empty string.

FullpageDynamic

Used for fullpage monitors only. Specifies whether a monitor reports an error if missing or new page objects were detected.

FullpageChecksize

Used for fullpage monitors only. Specifies whether a monitor reports an error if some page objects have changed.

FullpageTimeout

The fullpage timeout, in seconds.

CaptureMType

N/A

CaptureGroup

N/A

CaptureLevel

N/A

Port

If port number is not supplied, the default port number will be used for the specified service.

ResolveDNS

To enable DNS to be resolved, this parameter should be set to y.

HttpBrowserCode

User Agent string used on Web site monitors.

Compression

Enabled if server can accept Gzip payload.

PingError

Use y to verify network errors.

FtpUploadTest

Used for FTP monitors only. Specifies whether to test file upload and download. Possible values: Enabled, Disabled.

PostPairs

HTTP request headers and body. Used for API endpoint monitors and certain website URL monitors.

RawPostData

Corresponds to the POST exactly as entered option in AlertSite 1.0. Possible values: Enabled, Disabled.

RawHttpHeaders

Corresponds to the SEND HTTP Headers exactly as entered option in AlertSite 1.0. Possible values: Enabled, Disabled.

Caching

Use caching (repeat visitor) for HTTP payload and objects.

NsLookupObject

Resolve DNS at each monitoring interval.

Notify

Defines whether to send alerts on monitor errors.

NotifyContent

Defines whether to send notifications on content changes.

NotifyTraceroute

Defines whether to perform traceroute on network errors.

HttpFollowRedirect

Defines whether to follow HTTP 302 redirects.

ObjDevlog

Reserved for internal use.

ObjDevlogPrev

Reserved for internal use.

HomeLocation

The ID of the primary monitoring location for the monitor. For a list of location IDs, see Monitoring Locations.

Monitor

y if is monitoring is enabled, n if disabled.

MonitorType

The monitoring mode for this monitor.

Value Description
G Global Notify
I Primary
R Round Robin
U SLA (MultiPOP)
V Global Verify

MonitorInterval

The monitoring interval, in minutes.

MonitorSeed

Reserved for internal use.

MonitorLocs

If location rotating is enabled, this is the number of locations per interval. Otherwise 0.

MonitorIntervalFullpage

-1 means fullpage monitoring is disabled. Otherwise indicates how often page objects should be downloaded from the web address.

IsTxn

1 – for DéjàClick, SoapUI, Selenium, and BitBar monitors.

0 – for all other monitor types.

TxnMaxSteps

N/A

UpdStamp

Date and time the monitor was changed last time.

See Also

Add Monitor
Edit Monitor
List Monitors
Delete Monitor
Get Monitor Status
AlertSite XML API

Highlight search results