API Documentation
User Guide Contact Us

Introduction

API Root Endpoint

https://www.site24x7.com/api

The Site24x7 API helps you achieve all the operations that can be performed on our web client.

The API requires Authtoken as an account identifier. This API is built using the REST principles which ensures predictable URLs that make writing applications easy. This API follows HTTP rules, where a wide range of HTTP clients can be used to interact with the API.

Every resource is exposed as a URL. The URL of each resource can be obtained by accessing the API Root Endpoint.

Getting Started

Example

$ curl https://www.site24x7.com/api/monitors \
    -H 'Authorization: Zoho-authtoken ba4604e8e433g9c892e360d53463oec5' \ 

All Site24x7 APIs require a Authorization request header for authentication.

Authentication

All Site24x7 API need to be authenticated using an authtoken.

You can obtain an authtoken by the following ways:

  1. Through a URL in your browser.
  2. Programmatically using the Zoho Accounts API.

Sample Success Response

#
#Fri Apr 11 06:14:13 PST 2014
AUTHTOKEN=ba4604e8e433g9c892e360d53463oec5
RESULT=TRUE

Sample Error Response

#
#Fri Apr 11 06:32:13 PST 2014
CAUSE=INVALID_API_AUTHTOKEN_SCOPE
RESULT=FALSE

In your browser

Obtaining an authtoken in your browser is very simple. Login to your Site24x7 account and go to the URL below.

https://accounts.zoho.com/apiauthtoken/create?SCOPE=Site24x7/site24x7api

Programmatically using the API

If you choose to obtain your authtoken via an API, please follow the instructions below:

Submit an HTTP POST request to the below URL.

https://accounts.zoho.com/apiauthtoken/nb/create.

The POST body should include a string in the below format.

?SCOPE=Site24x7/site24x7api&EMAIL_ID=[Site24x7 ID/EmailID]&PASSWORD=[Password]

Below are the mandatory case sensitive fields to be passed in the URL.

Parameter Description
SCOPE Site24x7/site24x7api
EMAIL_ID Your Site24x7 ID or Email ID.
PASSWORD Your Zoho password or your TFA*

* To know more about TFA and creating application password click here.

Points To Note

API

Example

$ curl https://www.site24x7.com/api/monitors \
    -H 'Accept: application/json; version=2.0' \ 

Using Accept header, access the appropriate version of the API.

cURL

All the examples provided in Site24x7’s API documentation are executed using cURL. cURL is a tool for making REST calls independent of a browser. It works on numerous platforms like Mac OS X, Linux, Windows etc.

Example using double quotes

  $ curl https://www.site24x7.com/api/monitor_groups ^
    -H "Content-Type: application/json;charset=UTF-8" ^
    -H "Accept: application/json; version=2.0" ^
    -H "Authorization: Zoho-authtoken a12345b6c8de901f2gh3456ij78k901l" ^
    -d "{\"display_name\" : \"Monitor Group\", \"description\": \"IDC monitors.\"}"

Example using file

  C:\> cd folder_name

  $ curl https://www.site24x7.com/api/monitor_groups ^
    -H "Content-Type: application/json;charset=UTF-8" ^
    -H "Accept: application/json; version=2.0" ^
    -H "Authorization: Zoho-authtoken a12345b6c8de901f2gh3456ij78k901l" ^
    -d @json.txt

cURL is installed by default in Mac and most of the Linux distributions, but not in Windows. If it is not installed in your Linux system, then you can simply run a apt-get (apt-get install curl) or yum (yum install curl) command, to install cURL. For Windows, download and install cURL from here

The examples used in this document are Mac/Linux specific.

If you are a Windows user, you have to make the following modifications in our examples for the cURL statements to work correctly.

Using single quotes does not work in Windows(?). So, you have to wrap you JSON in double quotes and escape the inner quotes with backslashes.

You could also import your JSON data from a file (-d @filename.txt). For this, first you have to navigate to the folder containing the file and then run the statement as shown in the example.

MSP

Example for MSP Account Operation Request

  $ curl https://www.site24x7.com/api/short/msp_customers_list \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-authtoken a12345b6c8de901f2gh3456ij78k901l"

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "customers": [{  
        "name":"Customer 1",
        "zaaid":"657637305"
    }]
  }
}

Example for MSP Customer Account Operation

  $ curl https://www.site24x7.com/api/monitors \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-authtoken a12345b6c8de901f2gh3456ij78k901l" \
    -H "Cookie: msp_zaaid=657637305"

Site24x7 MSPs can use APIs to manage both MSP and their associated customer accounts. To execute an API request, an authorization request header has to be passed using a REST API client or cURL request. The header is authenticated using an API authtoken.

MSP Account:

By default, all API requests executed as part of the MSP account operation will use the standard header parameters. You do not have to generate any additional cookie headers to initiate an API request. However, If you initiate an API request for an unauthorized MSP operation, the following error message will be shown “You are not authorized to perform this operation.”

MSP Customer Account:

To operate your MSP customer account using APIs, you must pass an additional cookie header parameter “msp_zaaid”. You can obtain this unique “msp_zaaid” parameter for your individual customer accounts by initiating a GET API request “msp_customers_list”. You can use the “zaaid” parameter received in this API response.

HTTP Methods

Using GET method, you can get the list of resources or details of a particular instance of a resource.

To get a list of monitors

$ curl https://www.site24x7.com/api/monitors \
    -H 'Authorization: Zoho-authtoken ba4604e8e433g9c892e360d53463oec5' \
    -H 'Accept: application/json; version=2.0'
To get the details of a monitor referred to by a specified monitor_id

$ curl https://www.site24x7.com/api/monitors/903000000000099 \
    -H 'Authorization: Zoho-authtoken ba4604e8e433g9c892e360d53463oec5' \
    -H 'Accept: application/json, version=2.0'

Site24x7 API uses appropriate HTTP verbs for every action.

Method Description
GET Used for retrieving resources.
POST Used for creating resources and performing resource actions.
PUT Used for updating resources.
DELETE Used for deleting resources.

Response

Response Structure in JSON format

The JSON response structure for the Site24x7 API follows the below format.

{
    "code" : 0,
    "message" : "success",
    "data" : {
        "monitor_id" : "..."
    }
}

Responses will be in the JSON format.

JSON Response Parameters

Node Name Description
code Site24x7 error code. Indicates zero for a success response and non-zero in case of an error.
message Status Message for the invoked API.
data Comprising the invoked API’s Data.

Date

All timestamps are returned in the ISO 8601 format - yyyy-MM-dd’T'HH:mm:ssZZZZ.

Example: 2014-06-11T17:38:06-0700

JSONP

JSONP Request through AJAX

  $.ajax({
            type:'GET',
            url: 'https://www.site24x7.com/api/email_templates',
            data: {authtoken: 'Authtoken'},
            dataType: 'jsonp',
            success: function(result) {
               //Your Code goes here       
             }
        });

JSONP Response

result:
 {
  "header": {
    "status": 200
  },
  "body": {
    "code": 0,
    "message":"success",
    "data": [
      {
        "template_id": "165519000000993001",
        "display_name": "sample_email_template",
        "subject": "$MONITORNAME is $STATUS",
        "message": "Sample email template"
      }
    ]
  }
}

You can make a JSONP request by appending a callback parameter to any API request, wherein the callback function will get JSON response as an argument. The JSONP response contains a header and a body element. The header element will identify the HTTP Status code, whereas body element will have the actual JSON parameters listed under it.

For a JSONP response, the request URL should follow the below format:

https://www.site24x7.com/api/email_templates?authtoken=[Authtoken]&callback=[Function name]

JSONP Response Parameters

Node Name Description
header Indicates the HTTP Status codes
body Standard JSON response parameters are listed inside the body element.

Errors

Request Example

$ curl https://www.site24x7.com/api/invoices/700000007942 \
    -H 'Authorization: Zoho-authtoken ba4604e8e433g9c892e360d53463oec5' 

Response Example


HTTP/1.1 404 Not Found
Content-Type: application/json;charset=UTF-8

{
    "code": 1002,
    "message": "Monitor does not exist."
}

Site24x7 uses HTTP status codes to indicate success or failure of an API call. In general, status codes in the 2xx range mean success, 4xx range mean there was an error in the provided information, and those in the 5xx range indicate server side errors. Commonly used HTTP status codes are listed below.

HTTP Status Codes

Status Code Description
200 OK
201 Created
400 Bad request
401 Unauthorized (Invalid AuthToken)
404 Resource Not Found
405 Method Not Allowed (Method you have called is not supported for the invoked API)
500 Internal Error

User Authorization

Following Authentication rules are valid for all Site24x7 API calls:

Role Name Permission
Super Admin Super Admin will have full control of the account.
Administrator Administrators will have write access to the most of the modules except Billing and User Access.
Operator Operator will have read only access to most of the module. Will have write access to Schedule a maintenance.
Read Only User will have read only access to the account.
Billing Contact User will have access only to Billing modules like Upgrade and Renewals.
Spokes Person User will have read access to all the modules. User will have permission to post public comments through Dashboards.
Hosting Provider User will have permission to configure Schedule maintenance.
No Access No access to the Site24x7 Client / API.

Constants

Site24x7 uses Constants to identify certain resources configuration. Use the following Constants in respective modules

Report Type Constants

ID Resource
11 Availability Summary Report
13 Health Trend Report
14 Busy Hours Report
15 Top N Reports
16 Performance Report
17 Summary Report
18 Availability Trend Report
19 Executive Summary SLA Report

Schedule Report Status Constants

ID Resource
0 Active
5 Suspend

Custom Report Type Constants

ID Resource
1 Custom Report
2 Global Benchmark Report

Report Format Constants

ID Resource
2 PDF
3 CSV

Report Frequency Constants

ID Resource
1 Daily
2 Weekly
3 Monthly

Schedule Maintenance Constants

ID Resource
1 Daily
2 Weekly
3 Once
5 Monthly - By Date
6 Monthly - By Day

Day Constants

ID Resource
0 Sunday
1 Monday
2 Tuesday
3 Wednesday
4 Thursday
5 Friday
6 Saturday

Week Constants

ID Resource
1 First
2 Second
3 Third
4 Fourth

Period Constants

ID Resource
Period Constants
1 Last 24 hours
2 Last 7 Days
3 Today
4 Yesterday
5 Last 30 Days
7 Last Month
8 This Year
11 This Week
12 Last Week
13 This Month
50 Custom Period

Trend Report Segments

ID Resource
1 Day
2 Week
3 Month

Busy Hour Report Segments

ID Resource
1 Hour of Day
2 Day of Week

Outage Report Period Constants

ID Resource
1 For one day
2 For one week
5 For one month
90 For 3 months
180 For 6 months

Unit of time constants

ID Resource
1 Raw Data
2 Hourly Data
3 Daily Data
4 Weekly Data
5 Monthly Data

Month Constants

ID Month Name
1 January
2 February
3 March
4 April
5 May
6 June
7 July
8 August
9 September
10 October
11 November
12 December

SLA Constants

ID Resource
SLA Types
1 Composite SLA
2 Availability SLA
3 Performance SLA
SLA Target Constants
0 Greater Than
1 Equal
2 Greater Than or Equal
3 Less Than
4 Less Than or Equal

Notification Profile Constants

ID Target
Downtime Delay Constants
1 Notify on First Failure
2 Notify on Second Failure
3 Notify on Third Failure
4 Notify on Fourth Failure
5 Notify on Fifth Failure
Persistent Notification Constant
-1 Do not notify Persistently
1 Notify on Every Error
2 Notify on Every Second Error
3 Notify on Every Third Error
4 Notify on Every Fourth Error
5 Notify on Every Fifth Error

Alerting Constants

ID Resource
Alerting Mode Constants
1 Email
2 SMS
3 Voice Call
4 IM
5 Twitter
Alerting Status Constants
10 Notify Down Status
20 Notify Trouble Status
30 Notify Up Status
SMS Providers
1 Clickatell
2 BulkSMS
3 RouteSMS
4 Twilio
Voice Call Provider
1 Twilio
IM Providers
0 GMail
1 Yahoo
2 MSN
Email Format
0 Text
1 HTML

Action Rule Constants

ID Resource
0 Execute Action when Monitor is declared Down
1 Execute Action when Monitor is declared Up
2 Execute Action when Monitor is declared Trouble
-1 Execute Action when Monitor status changes
20 Execute Action when Attribute status changes

User Access Constants

Role ID Role Name
0 No Access
1 Super Administrator
2 Administrator
3 Operator
4 Billing Contact
5 Spokes Person
6 Hosting Provider
10 Read Only

Monitor Type Constants

ID Monitor Type
URL Website
HOMEPAGE Web Page Speed (Browser)
URL-SEQ Web Transaction
REALBROWSER Web Transaction (Browser)
RESTAPI REST API
SSL_CERT SSL/TLS Certificate
PING Ping
PORT Port (Custom Protocol)
DNS DNS Server
PORT-POP POP Server
PORT-SMTP SMTP Server
PORT_FTP FTP Server
SMTP Mail Delivery (Send and Receive Mail)
FTP FTP Transfer (Upload / Download a file)
SERVER Server Monitor
MSEXCHANGE MS Exchange Monitor
AMAZON Amazon Cloud Services Monitor
EC2INSTANCE EC2 Server Instance Monitor
RDSINSTANCE RDS Instance Monitor
SNSTOPIC SNS Topic Monitor
DYNAMODBTABLE DynamoDB Table Monitor
LOADBALANCER Classic Load Balancer
APPLN-LOADBALANCER Application Load Balancer
LAMBDAFUNCTION Lambda Function Monitor
EC-MEMCACHED EC Memcached Cluster
EC-MEM-NODE EC Memcached Node
EC-REDIS EC Redis Node
VCENTER VCenter Monitor
VMWAREESX VMWare ESx Monitor
VMWAREVM VMWare VM Monitor
NETWORKDEVICE Network Device Monitor
SOAP SOAP Web Service
BIZTALKSERVER BizTalk Server Monitor
OFFICE365 Office 365

Check interval

Check Interval Description Unsupported Monitor Type
1 1 min URL-SEQ,REALBROWSER,SMTP,HOMEPAGE,FTP
3 3 mins URL-SEQ,REALBROWSER,SMTP,HOMEPAGE,FTP
5 5 mins SMTP,HOMEPAGE
10 10 mins SMTP,HOMEPAGE
15 15 mins
20 20 mins
30 30 mins
60 1 hr
120 2 hrs
180 3 hrs
360 6 hrs
1440 1 day

AWS Discover Services

ID Type
1 EC2 Instance
2 RDS Instance
3 S3
4 DynamoDB
5 SNS Topic
6 Elastic Load Balancer
8 ElastiCache
11 Lambda Function

AWS Discover Frequency

ID Type
0 Fewer Polling
1 Default Polling
2 Never

AWS Management Actions

ID Type
1 Start
2 Stop
3 Reboot

HTTP Methods Constants

ID HTTP Method
P POST
G GET
H HEAD
U PUT
D DELETE
A PATCH

WEBSITE TYPES

ID Website Type
1 Static Website
2 Dynamic Website
3 Flash-Based Website

Request Content Type Constants

Indicates how parameters will be sent to the website for monitoring.

ID Type Content-Type
F FORM application/url-form-encoded
T TEXT application/text
X XML application/xml
J JSON application/json

Response Content Type Constants

ID Type Content-Type
T TEXT application/text
X XML application/xml
J JSON application/json

Authentication Method Constants

ID Authentication Method
B Basic/NTLM
O OAuth 2

DNS Server Lookup type Constants

ID Type
1 A
255 ALL
28 AAAA
2 NS
15 MX
5 CNAME
6 SOA
12 PTR
33 SRV

DNS Server Search Field Constants

ID Type Search Field
Record Name string Record Name
Address string Address

Web Transaction (Browser) Resolution Constants

ID Type Resolution
1024,768 string 1024 X 768
1366,768 string 1366 X 768
1600,900 string 1600 X 900
1920,1080 string 1920 X 1080

Downtime Rules Constants

ID Number of Locations
1 1 location
2 2 locations
3 3 locations
4 4 locations
5 5 locations
6 6 locations
7 7 locations
8 8 locations
0 All selected locations

Threshold Condition Constants

ID Strategy
1 Greater than (>)
2 Less than (<)
3 Greater than or equal to (>=)
4 Less than or equal to (<=)

Threshold Strategy Constants

ID Strategy
1 Poll Count
2 Poll Avg
3 Time Range
4 Avg Time

Global Parameters Functions

ID Function Name
0 Current date and time
1 Random number by length
2 Random number by maximum value
3 Time in milliseconds

Status Constants

ID Status
0 Down
1 Up
2 Trouble
5 Suspended
7 Maintenance
9 Discovery
10 Configuration Error

State Constants

ID State
0 Active
5 Suspended

Time Window Constants

ID Type
H Last One Hour Data
H3 Last Three Hour Data
H6 Last Six Hour Data
hD Last Twelve Hour Data
D Last One Day Data
SD/dd.mm.yyyy Particular Date Data (SD/20.04.2016)

Resource Type

ID Type
app Application
ins Instance

Browser Name Constants

ID Type
Chrome Google Chrome Browser
MSIE Microsoft Internet Explorer Browser
FireFox Mozilla Firefox Browser
Safari Safari Browser
Opera Opera Browser
Other Other Browser

Web Transaction Constants

ID Type
apdex Apdex Score
avgrt Average Response Time
errors Error
throughput Throughput
totalrt Total Response Time

Database Operation Constants

ID Type
avgrt Average Response Time
errors Error
throughput Throughput
totalrt Total Response Time

Background Transaction Constants

ID Type
avgrt Average Response Time
errors Error
throughput Throughput
totalrt Total Response Time

Transaction Constants

ID Type
txn Web Transaction
bgtxn Background Transaction
db Database Operation

Graph Constants

ID Type
apdex Apdex Score
rtandthroughput Response Time and Throughput
components Transaction Components
rtbycomponents Response Time By Component
throughput Throughput
avgrt Average Response Time

Graph Constants for Particular Transaction

ID Type
rtandthroughput Response Time and Throughput(Supported with txn, bgtxn, db transaction Type)
components Transaction Components(Supported with txn,bgtxn transaction Type)
rtbycomponents Response Time By Component(Supported with bgtxn transaction Type)
throughputbycaller Throughput by Caller(Supported with db transaction Type)
throughput Throughput(Supported with db transaction Type)
avgrt Average Response Time(Supported with db transaction Type)

Database Operation Graph Constants

ID Type
avgrt Average Response Time
rtandthroughput Response Time and Throughput
throughput Throughput

Traces Transaction Constants

ID Type
txn Web Transaction
bgtxn Background Transaction
db Database Operation

Transaction Attribute Constants

ID Type
apdex Apdex Score (only for txn transaction type)
avgrt Average Response Time
errors Error
throughput Throughput
totalrt Total Response Time

Traces List Attribute Constants

ID Type
avgrt Response Time
cpu CPU Time
exe Exception Count
ext External Calls
sql SQL Time

Uptime Button Time Period Constants

ID Resource
1 Last 24 hours
2 Last 7 Days
5 Last 30 Days

Severity Constants

ID Severity
0 Critical
1 Non-Critical

IT Automation Type Constants

ID Type
1 Invoke URL
2 Server Script
3 Server Command
4 Windows Service
5 Server Reboot
6 Hyper-V
7 IIS
8 Mark as Maintenance

Script Type Constants

ID Type
100 Batch
101 PowerShell
102 VB script
200 Shell
201 Python
202 Ruby
203 Python3

OS Type Constants

ID TYPE
0 Windows
1 Linux

Service Action Type Constants

ID TYPE
1 Start Service
2 Stop Service
3 Restart Service

Hyper-V Action Type Constants

ID TYPE
1 Start VM
2 Stop VM
3 Restart VM

IIS Action Type Constants

ID TYPE
1 Start Site
2 Stop Site
3 Start App pools
4 Stop App Pools

Alert Type Constants

ID Type
0 Down
2 Trouble

Resource Type Constants

ID Resource
1 Monitor Group
2 Monitor
0 All Monitors

Group Type Constants

ID Resource
0 Monitor Group
1 Subgroup

Outage and Alarms Type Constants

ID Type
0 Down
2 Trouble
7 Maintenance

Segment Type Constants

ID Type
1 Hour of the day
2 Day of the week

OAuth Grant Type Constants

ID Type
1 Authorization Code
2 Client Credentials
3 Resource Owner Password Credentials

OAuth Send Token As Method Constants

ID Type
H HTTP Request Headers
Q Query Parameters

AWS Discovery Types

ID Type
1 Exclude AWS Resources
2 Include AWS Resources

TOP N Attributes

Attribute Description
URL
response_time Response time of the configured URL.
HOMEPAGE
response_time Response time of the configured website.
URL-SEQ
transaction_time Transaction time of the transaction.
REALBROWSER
transaction_time Transaction time of the configured transaction.
RESTAPI
response_time Response time of the configured REST API.
PING
response_time Response time of the configured IP.
PORT
response_time Response time of the configured host.
DNS
response_time Response time of the configured DNS host.
PORT-POP
response_time Response time of the configured POP host.
PORT-SMTP
response_time Response time of the configured SMTP host.
PORT_FTP
response_time Response time of the configured host.
SMTP
response_time Response time of the configured SMTP host.
FTP
response_time Response time of the configured host.
SERVER
cpu CPU utilization of the server.
cpu_lowest CPU utilization of the server in ascending order.
memory Memory utilization of the server.
memory_lowest Memory utilization of the server in ascending order.
disk Disk utilization of the server.
process_cpu Top process by CPU.
process_memory Top process by memory.
packets_sent Packets sent by the server.
packets_recieved Packets recieved by the server.
error_packets Error packets.
MSEXCHANGE
page_requests_fullfilled_by_cache Page requests fulfilled by cache.
db_writes_average_latency DB writes latency.
rpc_request RPC requests.
slow_qp_threads Slow qp threads.
mb_avg_delivery_time MB average delivery time.
pf_avg_delivery_time PF average delivery time.
smtp_outbound HUB SMTP outbound.
smtp_inbound HUB SMTP inbound.
messages_sent_per_second Messages sent per second.
message_received_per_second Messages received per second.
active_sync_request_per_second Active sync request per second.
outlook_web_access_request_per_second Outlook web access request per second.
delayed_calls Delayed calls.
average_call_duration Average call duration.
EC2INSTANCE
cpu_utilization CPU utilization.
bytes_received Bytes received.
bytes_sent Bytes sent.
disk_read_operations Disk read operations.
disk_write_operations Disk write operations
cpu_credit_usage CPU Credit usage
cpu_credit_balance CPU Credit balance
RDSINSTANCE
cpu_utilization CPU utilization.
free_storage Free storage.
database_connections Database connections.
disk_read_operations Disk read operations.
disk_write_operations Disk write operations.
bytes_read_from_disk Byte read from disk.
bytes_write_to_disk Byte write to disk.
read_latency Read latency.
write_latency Write latency.
SNSTOPIC
number_of_messages_published Messages Published
pubic_size Publish Size
number_of_notifications_delivered Notifications Delivered
number_of_notifications_failed Notifications Failed
DYNAMODBTABLE
consumed_read_capacity_units Consumed Read Capacity Units
provisional_read_capacity_units Provisional Read Capacity Units
consumed_write_capacity_units Consumed Write Capacity Units
provisional_read_capacity_units Provisional Write Capacity Units
read_throttle_events Read Throttle Events
write_throttle_events Write Throttle Events
get_latency Get Latency
put_latency Put Latency
throttled_get_item_requests Throttled Getitem Requests
throttled_put_item_requests Throttled Putitem Requests
conditional_check_failed_requests Conditional Check Failed Requests
LAMBDAFUNCTION
invocations_sum Number of invocations
errors_sum Number of errors
duration_sum Function duration
throttles_sum Number of throttles
EC Memcached Cluster
cpu_utilization CPU utilization
ec_memcached_cache_hits Number of hits
ec_memcached_cache_misses Number of misses
ec_memcached_cache_evictions Number of evictions
EC Memcached Node
cpu_utilization CPU utilization
ec_memcached_cache_hits Number of hits
ec_memcached_cache_misses Number of misses
ec_memcached_cache_evictions Number of evictions
EC Redis Node
cpu_utilization CPU utilization
ec_redis_cache_hits Number of hits
ec_redis_cache_misses Number of misses
ec_redis_cache_evictions Number of evictions
VMWAREESX
cpu_usage CPU usage.
disk_usage Disk usage.
memory_usage Memory usage.
network_usage Network usage.
VMWAREVM
memory_usage Memory usage.
disk_usage Disk usage.
cpu_usage CPU usage.
network_usage Network usage.
NETWORKDEVICE
response_time Response time of the configured IP.
packet_loss Packet loss for the configured IP.
SOAP
response_time Response time of the configured endpoint url.
SQLSERVER
batch_request Batch Request
target_server_memory Target Server Memory
IISSERVER
network_traffic Network Traffic

Report Attributes

Attribute Description
URL-SEQ
RESPONSETIME Response Time
TRANSACTIONTIME Transaction Time
REALBROWSER
RESPONSETIME Page Load Time
TRANSACTIONTIME Transaction Time
SERVER
CPU CPU Usage
MEMORY Memory Breakup
DISK Disk Utilization
PROCESS Process Statistics
PROCESSQUEUELENGTH Processor Queue Length
SYSTEMLOAD Load Average
UPTIME System Busy/Idle Time
IISSERVER
NWTRAFFIC Network Statistics
SQLSERVER
PAGEREADS Page Operations
ERRORS Number of Errors
BKPDEVICETRP Backup Device Throughput
LATCHWAITS Latch Waits
CHECKPOINTPAGES Checkpoint Pages
LONGTRANSTIME Longest Transaction Time
FAILEDJOBS Jobs Statistics
LAZYWRITES Lazy Writes
USERCONNECTIONS Connection
DEADLOCKS Lock Statistics
SUCCESSJOBRATE Job Success Rate
DBPAGES Page Statistics
TOTSERVERMEM Memory Utilization
BATCHREQ Batch Requests
PENDINGMEMGRANTS Memory Grants Pending
AVGWAITTIME Lock And Latch Wait Times
PAGEEXPECTENCY Page Life Expectancy
LOGINS Login / Logout
SQLCOMPILATIONS Compilations
REPLMERGECONFLICT Replication Merge Conflicts
FULLSCANS Access Methods
PLANCACHEOBJECTS Plan Cache Statistics
MSEXCHANGE
CASREQUEST Outlook Web Access and Active Sync Requests
CASRESPONSETIME Outlook Web Access and Active Sync Response time
EDGESMTP Edge SMTP(In/Out bound)
HUBSMTP Hub SMTP(In/Out bound)
ISCASOpr RPC Operations from Client Access
ISCAS RPC Response time from Mailbox to Client Access
ISHub Communication with Hub Tranport Store
UMAvail Access Failure
UMHUBResp RPC Response time to Unified Messaging and Hub Transport
UMRPC RPC Operations from Unified Messaging
EC2INSTANCE
CPUUTILIZATION CPU Usage
DISKREADOPS Disk I/O Activity
NETWORKIN Network Traffic
CPUCREDITUSAGE CPU Credit Activity
RDSINSTANCE
CPUUTILIZATION CPU Usage
DATABASECONNECTIONS rds.databaseconnections.text
FREESTORAGE Free Storage
READLATENCY Read Latency
READIOPS Read Operations
READTHROUGHPUT Read Through put
WRITELATENCY Write Latency
WRITEOPS Write Operations
WRITETHROUGHPUT Write Throughput
SNSTOPIC
NUMBEROFNOTIFICATIONSDELIVERED Number Of Notifications Delivered
PUBLISHSIZE Publish Size
NUMBEROFNOTIFICATIONSFAILED Number Of Notification Failed
NUMBEROFMESSAGESPUBLISHED Number Of Messages Published
DYNAMODBTABLE
USERERRORS User Errors
CONDCHKFAILEDREQ Conditional Check Failed Requests
CONSUMEDWRITECAP Write Capacity
THROTTLEDGETITMREQ Throttled Read Requests
SYSTEMERRORS System Errors
QUERYRETURNEDITMCNT Query Returned Item Count
READTHROTTLEEVENTS Throttle Events
SCANRETURNEDITMCNT Scan Returned Item Count
QUERYLATENCY Query Latency
PUTLATENCY Put Latency
THROTTLEDPUTITMREQ Throttled Write Requests
CONSUMEDREADCAP Read Capacity
SCANLATENCY Scan Latency
GETLATENCY Get Latency
LOADBALANCER
REQUESTCOUNT Requests Count
ELB_5XX ELB 5XX Errors
UNHEALTHYHOSTCOUNT Unhealthy Hosts
LATENCY Average Latency
SPILLOVERCOUNT Spill Over Count
ELB_4XX ELB 4XX Errors
SURGEQUEUELENGTH Surge Queue Length
HEALTHYHOSTCOUNT Healthy Hosts
BACKENDERRORS Backend Connection Errors
APPLN-LOADBALANCER
REQUESTCOUNT Requests Count
TARGET_4XX HTTP 4XX Errors
ELB_5XX ELB 5XX Errors
UNHEALTHYHOSTCOUNT Unhealthy Hosts
LATENCY Average Latency
TARGET_5XX HTTP 5XX Errors
TARGET_CONNECTIONERRORS Target Connection Errors
ACTIVECONNECTIONS Connections
ELB_4XX ELB 4XX Errors
HEALTHYHOSTCOUNT Healthy Hosts
LAMBDAFUNCTION
INVOCATIONSSUM Sum of number of invocations in last 5 mins
INVOCATIONSAVERAGE Average number of invocations in last 5 mins
ERRORSSUM Sum of number of errors in last 5 mins
ERRORSAVERAGE Average number of errors in last 5 mins
DURATIONSUM Sum of duration of all invocations in last 5 mins
DURATIONAVERAGE Average duration of all invocations in last 5 mins
THROTTLESSUM Sum of throttles in last 5 mins
THROTTLESAVERAGE Average number of throttles in last 5 mins
EC Memcached Cluster
CPUUTILIZATION Average CPU Usage in last 5 mins
BYTESUSEDFORCACHE Average bytes used by the cache in last 5 mins
EVICTIONS Sum of number of evictions occured in last 5 mins
RECLAIMED Sum of number of reclaimed occured in last 5 mins
CONNECTIONS Average number of connections in last 5 mins
CURRENTITEMS Average numer of items present in the cache for the last 5 mins
SWAPUSAGE Average swap usage in last 5 mins
HITS Sum of number of hits occured in last 5 mins
MISSES Sum of number of misses occured in last 5 mins
CMDFLUSH Sum of number of flush commands received by cache in last 5 mins
CMDGET Sum of number of get commands received by cache in last 5 mins
CMDSET Sum of number of set commands received by cache in last 5 mins
EC Memcached Cluster
CPUUTILIZATION Average CPU Usage in last 5 mins
BYTESUSEDFORCACHE Average bytes used by the cache in last 5 mins
EVICTIONS Sum of number of evictions occured in last 5 mins
RECLAIMED Sum of number of reclaimed occured in last 5 mins
CONNECTIONS Average number of connections in last 5 mins
CURRENTITEMS Average numer of items present in the cache for the last 5 mins
SWAPUSAGE Average swap usage in last 5 mins
HITS Sum of number of hits occured in last 5 mins
MISSES Sum of number of misses occured in last 5 mins
CMDFLUSH Sum of number of flush commands received by cache in last 5 mins
CMDGET Sum of number of get commands received by cache in last 5 mins
CMDSET Sum of number of set commands received by cache in last 5 mins
EC Memcached Node
CPUUTILIZATION Average CPU Usage in last 5 mins
BYTESUSEDFORCACHE Average bytes used by the cache in last 5 mins
EVICTIONS Sum of number of evictions occured in last 5 mins
RECLAIMED Sum of number of reclaimed occured in last 5 mins
CONNECTIONS Average number of connections in last 5 mins
CURRENTITEMS Average numer of items present in the cache for the last 5 mins
SWAPUSAGE Average swap usage in last 5 mins
HITS Sum of number of hits occured in last 5 mins
MISSES Sum of number of misses occured in last 5 mins
CMDFLUSH Sum of number of flush commands received by cache in last 5 mins
CMDGET Sum of number of get commands received by cache in last 5 mins
CMDSET Sum of number of set commands received by cache in last 5 mins
EC Redis Node
CPUUTILIZATION Average CPU Usage in last 5 mins
BYTESUSEDFORCACHE Average bytes used by the cache in last 5 mins
EVICTIONS Sum of number of evictions occured in last 5 mins
RECLAIMED Sum of number of reclaimed occured in last 5 mins
CONNECTIONS Average number of connections(Excluding connections from read replicas) in last 5 mins
NEWCONNECTIONS Average number of connections accepted in last 5 mins
CURRENTITEMS Average numer of items present in the cache for the last 5 mins
SWAPUSAGE Average swap usage in last 5 mins
HITS Sum of number of hits occured in last 5 mins
MISSES Sum of number of misses occured in last 5 mins
VMWAREESX
CPUUTIL CPU Utilization (%)
DISKUSAGE Disk Usage(kbps)
MEMUTIL Memory
NETUSAGE Network Usage(kbps)
VMWAREVM
AVGCPUUTIL CPU Utilization (%)
DISKUTIL Disk Usage(kbps)
MEMUTIL Memory
AVGNETUTIL Network Utilization
NETWORKDEVICE
CPUUTILIZATION CPU Utilized
RXPACKETS Rx Packets
TXPACKETS Tx Packets
RXUTIL Rx Utilized
INTRAFFIC In Traffic
OUTTRAFFIC Out Traffic
TXUTIL Tx Utilized
MEMORYUTILIZATION Memory Used
PACKETLOSS Packet Loss
RESPONSETIME Response Time
HUGEBUFFERHITS Buffer Hit Statistics
BIGBUFFERMISSES Buffer Miss Statistics
OFFICE365
TOTCONFERENCES Conference Statistics
TOTSESSIONS Session Statistics
GROUPCREATED Mail Groups
TOTMBCOUNT MailBoxes
ACTIVEDRIVEDEPLOYMENT Drive Deployment
USEDDRIVESIZE Drive Usage
ACTIVESITEDEPLOYMENT Site Deployment
USEDSITESIZE Site Usage

Location IDs

Request Example

$ curl https://www.site24x7.com/api/location_template \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-authtoken a12345b6c8de901f2gh3456ij78k901l"

Details of on-premise pollers, mobile pollers and servers that are configured to the account can be fetched by making GET API request “/api/location_template”.

ID Location IPv6 Supported
1 Fremont-CA - US
2 New Jersey - US
3 Singapore - SG
4 Houston - US
5 Amsterdam - NL
6 London - UK
7 Dallas - US
8 Seattle - US
9 Chicago - US
10 Frankfurt - DE
11 Johannesburg - ZA
12 Melbourne - AUS
13 Nagano - JP ×
14 Shanghai - CHN ×
15 Chennai - IN ×
16 Rio de Janeiro - BR ×
17 Stockholm - SWE
18 Paris - FR
19 Virginia - US
20 Dublin - IE
21 Hong Kong - HK
22 Sao Paulo - BR
23 Barcelona - ES
24 Milano - IT
25 New York - US
26 Los Angeles - US
27 Denver - US
28 Kansas - US
29 Munich - DE
30 Washington - US
31 Montreal - CA
32 Phoenix - US
33 Mumbai - IN ×
34 Istanbul - TR ×
35 Tel Aviv - IL ×
36 Sydney - AUS
37 Auckland - NZ
38 Atlanta - US
39 Brussels - BE
40 Toronto - CA
41 Copenhagen - DA
42 Vienna - AT
43 Zurich - CH
44 Warsaw - PL
45 Bucharest - RO
46 Moscow - RU
47 Beijing - CHN ×
48 Hangzhou City - CHN ×
49 Qingdao City - CHN ×
50 Miami - US
51 Oslo - NOR ×
52 Tokyo - JP
53 Brisbane - AUS
54 Manchester - UK
55 Dubai - UAE ×
56 Queretaro - MEX
57 Falkenstein - DE ×
58 Strasbourg - FR
59 Bengaluru - IN
60 Edinburgh - UK
61 Buenos Aires - ARG
62 Seoul - SK ×
63 Vancouver - CA
64 Kuala Lumpur - MYS ×
65 Detroit - US
66 Helsinki - FI
67 Lisbon - PT
68 San Francisco - US
69 Riyadh - KSA
70 Budapest - HU
71 Luxembourg City - LU
72 Prague - CZ
73 Sofia - BG
74 Athens - GR
75 Kiev - UA ×
76 Manila - PH ×
77 Medellin - CO ×
78 Shenzhen - CN ×
79 Philadelphia - US
80 Boston - US
81 Las Vegas - US ×
82 Jakarta - ID
83 Santiago - CL ×
84 Portland - US
85 Salt Lake City - US
86 Zhangjiakou - CN ×
87 Bangkok - THA
88 Tampa - US ×
89 Saint Petersburg - RU
90 Guangzhou - CN ×
91 Hanoi - VNM ×
92 Madrid - ESP

Monitor Parameters

This section details all the parameters required for a given monitor type.

Website

Monitor availability and end user experience of the website from 50+ locations.

Attribute Type Description
display_name string Mandatory
Name for the monitor.
type string Mandatory
URL
website string Mandatory
Website address to monitor.
check_frequency int Mandatory
Check interval for monitoring.
timeout int Mandatory
Timeout for connecting to website.
Range 1 - 45.
location_profile_id string Mandatory
Location Profile to be associated with the monitor.
Create new location profile or find your preferred location profile’s ID.
notification_profile_id string Mandatory
Notification profile to be associated with the monitor.
Create new notification profile or find your preferred notification profile’s ID.
threshold_profile_id string Mandatory
Threshold profile to be associated with the monitor.
Create new threshold profile or find your preferred threshold profile’s ID.
user_group_ids array Mandatory
User group to be notified on down.
Create new user group or find your preferred user group’s ID.
http_method string Mandatory
HTTP Method to be used for accessing the website.
PUT, PATCH and DELETE are not supported
use_ipv6 boolean Select IPv6 for monitoring the websites hosted with IPv6 address. If you choose non IPv6 supported locations, monitoring will happen through IPv4.
request_content_type string Provide content type for request params.
state int State of the monitor.
request_param string Provide parameters to be passed while accessing the website.
auth_method string Authentication method to access the website.
auth_user string Authentication user name to access the website.
auth_pass string Authentication password to access the website.
oauth2_provider string Provider ID of the OAuth Provider to be associated with the monitor.
client_certificate_password string Password of the uploaded client certificate.
ssl_protocol string Specify the version number of the ssl protocol.
Use among TLSv1.2, TLSv1.1, TLSv1 and SSLv3.
If you are unsure of the protocol, use Auto
Default value is Auto
matching_keyword json Check for the keyword in the website response.
JSON Format: {value: “$value”, severity: “$alert_type_constant”}
unmatching_keyword json Check for non existence of keyword in the website response.
JSON Format: {value: “$value”, severity: “$alert_type_constant”}
match_regex json Match the regular expression in the website response.
JSON Format: {value: “$value”, severity: “$alert_type_constant”}
match_case boolean Perform case sensitive keyword search or not.
user_agent string User Agent to be used while monitoring the website.
custom_headers JSON array Header name and value in a string array.
JSON Format: {name: “$Header Name”, value: “$Header Value”}
monitor_groups array Group IDs to associate monitor.
Create new monitor group or find your preferred monitor group’s ID.
dependency_resource_id string Suppress alert when dependent monitor is down
action_ids JSON array Action to be performed on monitor status changes.
JSON Format {action_id: “$action_id”, alert_type: $action_rule_constants}.
Create new action or find your preferred action’s ID.
use_name_server boolean Resolve the IP address using Domain Name Server.
forced_ips String Provide comma-separated list of IP addresses to override IP addresses resolved by the DNS server.
up_status_codes string Provide a comma-separated list of HTTP status codes that indicate a successful response. You can specify individual status codes, as well as ranges separated with a colon.
third_party_services array Third party services to be notified.

Web Page Speed (Browser)

Track and analyze the component slowing down your web page.

Attribute Type Description
display_name string Mandatory
Name for the monitor.
type string Mandatory
HOMEPAGE
website string Mandatory
Website address to monitor.
check_frequency int Mandatory
Check interval for monitoring.
timeout int Mandatory
Timeout for connecting to website.
Range 1 - 45.
website_type int Mandatory
Type of content the website page has.
location_profile_id string Mandatory
Location Profile to be associated with the monitor.
Create new location profile or find your preferred location profile’s ID.
notification_profile_id string Mandatory
Notification profile to be associated with the monitor.
Create new notification profile or find your preferred notification profile’s ID.
threshold_profile_id string Mandatory
Threshold profile to be associated with the monitor.
Create new threshold profile or find your preferred threshold profile’s ID.
user_group_ids array Mandatory
User group to be notified on down.
Create new user group or find your preferred user group’s ID.
http_method string Mandatory
HTTP Method to be used for accessing the website.
HEAD, PUT, PATCH and DELETE are not supported
request_content_type string Provide content type for request params.
request_param string Provide parameters to be passed while accessing the website.
auth_user string Authentication user name to access the website.
auth_pass string Authentication password to access the website.
matching_keyword json Check for the keyword in the website response.
JSON Format: {value: “$value”, severity: “$alert_type_constant”}
unmatching_keyword json Check for non existence of keyword in the website response.
JSON Format: {value: “$value”, severity: “$alert_type_constant”}
match_regex json Match the regular expression in the website response.
JSON Format: {value: “$value”, severity: “$alert_type_constant”}
match_case boolean Perform case sensitive keyword search or not.
user_agent string User Agent to be used while monitoring the website.
custom_headers JSON array Header name and value in a string array.
JSON Format: {name: “$Header Name”, value: “$Header Value”}
monitor_groups array Group IDs to associate monitor.
Create new monitor group or find your preferred monitor group’s ID.
dependency_resource_id string Suppress alert when dependent monitor is down
action_ids JSON array Action to be performed on monitor status changes.
JSON Format [{action_id: “$action_id”, alert_type: $action_rule_constants}].
Create new action or find your preferred action’s ID.
third_party_services array Third party services to be notified.
state int State of the monitor.

REST API

Monitor the availability and performance of your published Restful API.

Attribute Type Description
display_name string Mandatory
Name for the monitor.
type string Mandatory
RESTAPI
website string Mandatory
Website address to monitor.
check_frequency int Mandatory
Check interval for monitoring.
timeout int Mandatory
Timeout for connecting to website.
Range 1 - 45.
location_profile_id string Mandatory
Location Profile to be associated with the monitor.
Create new location profile or find your preferred location profile’s ID.
notification_profile_id string Mandatory
Notification profile to be associated with the monitor.
Create new notification profile or find your preferred notification profile’s ID.
threshold_profile_id string Mandatory
Threshold profile to be associated with the monitor.
Create new threshold profile or find your preferred threshold profile’s ID.
user_group_ids array Mandatory
User group to be notified on down.
Create new user group or find your preferred user group’s ID.
http_method string Mandatory
HTTP Method used for accessing the website. HTTP Methods
use_ipv6 boolean Select IPv6 for monitoring the websites hosted with IPv6 address. If you choose non IPv6 supported locations, monitoring will happen through IPv4.
request_content_type string Provide content type for request params. Content Types
request_param string Provide parameters to be passed while accessing the website.
auth_user string Authentication user name to access the website.
auth_pass string Authentication password to access the website.
oauth2_provider string Provider ID of the OAuth Provider to be associated with the monitor.
client_certificate_password string Password of the uploaded client certificate.
response_type string Response content type. Response Content Types
monitor_groups array Mandatory
Group IDs to associate monitor.
Create new monitor group or find your preferred monitor group’s ID.
dependency_resource_id string Suppress alert when dependent monitor is down
matching_keyword json Check for the keyword in the website response.
JSON Format: {value: “$value”, severity: “$alert_type_constant”}
unmatching_keyword json Check for non existence of keyword in the website response.
JSON Format: {value: “$value”, severity: “$alert_type_constant”}
match_regex json Match the regular expression in the website response.
JSON Format: {value: “$value”, severity: “$alert_type_constant”}
match_case boolean Perform case sensitive keyword search or not.
match_xml json Check for the XPATH in the xml response.
JSON Format: {xpath: “$XPATH”, value: “$value”, severity: “$alert_type_constant”}
match_json json Check for the JSON in the in JSON response.
JSON Format: {attribute: “$attribute”, value: “$value”. severity: “$alert_type_constant”}
user_agent string User Agent to be used while monitoring the website.
custom_headers JSON array Header name and value in a string array.
JSON Format: {name: “$Header Name”, value: “$Header Value”}
action_ids JSON array Action to be performed on monitor status changes.
JSON Format {action_id: “$action_id”, alert_type: $action_rule_constants}
use_name_server boolean Resolve the IP address using Domain Name Server.
up_status_codes string Provide a comma-separated list of HTTP status codes that indicate a successful response. You can specify individual status codes, as well as ranges separated with a colon.
third_party_services array Third party services to be notified.
state int State of the monitor.
json_schema_check boolean Enable this option to perform the JSON schema check.
json_schema json Provide the JSON schema to be validated against the JSON response and specify the alert type to be raised during a test failure.
JSON Format: {schema_value:“$schema_value”,severity:“$alert_type_constant”}

DNS Server

Continuously check your DNS server at regular intervals for optimum performance and ensure DNS lookup is working properly.

Attribute Type Description
display_name string Mandatory
Name for the monitor.
type string Mandatory
DNS
dns_host string Mandatory
DNS Name Server to be monitored
dns_port int Mandatory
Port for DNS access. Default value: 53
use_ipv6 boolean Select IPv6 for monitoring the websites hosted with IPv6 address. If you choose non IPv6 supported locations, monitoring will happen through IPv4.
domain_name string Mandatory
Domain name to be resolved.
check_frequency int Mandatory
Check interval for monitoring.
timeout int Mandatory
Timeout for connecting to DNS Server.
Range 1 - 45.
location_profile_id string Mandatory
Location Profile to be associated with the monitor.
Create new location profile or find your preferred location profile’s ID.
notification_profile_id string Mandatory
Notification profile to be associated with the monitor.
Create new notification profile or find your preferred notification profile’s ID.
threshold_profile_id string Mandatory
Threshold profile to be associated with the monitor.
Create new threshold profile or find your preferred threshold profile’s ID.
user_group_ids array Mandatory
User group to be notified on down.
Create new user group or find your preferred user group’s ID.
monitor_groups array Group IDs to associate monitor.
Create new monitor group or find your preferred monitor group’s ID.
dependency_resource_id string Suppress alert when dependent monitor is down
lookup_type int Lookup Type
search_field string Select a search field based on your configured lookup type.
domain_ip string Mandatory, if value is passed for search_field.
Value for search field
dnssec boolean Pass dnssec parameter to enable Site24x7 to validate DNS responses. Know More
action_ids JSON array Action to be performed on monitor status changes.
JSON Format {action_id: “$action_id”, alert_type: $action_rule_constants}.
Create new action or find your preferred action’s ID.
third_party_services array Third party services to be notified.
state int State of the monitor.

Port (Custom Protocol)

Monitor availability of critical services hosted over a TCP port.

Attribute Type Description
display_name string Mandatory
Name for the monitor.
type string Mandatory
PORT
host_name string Mandatory
Hostname to be monitored.
port int Mandatory
Port for DNS access. Default value: 53
check_frequency int Mandatory
Check interval for monitoring.
timeout int Mandatory
Timeout for connecting to the host.
Range 1 - 45.
location_profile_id string Mandatory
Location Profile to be associated with the monitor.
Create new location profile or find your preferred location profile’s ID.
notification_profile_id string Mandatory
Notification profile to be associated with the monitor.
Create new notification profile or find your preferred notification profile’s ID.
threshold_profile_id string Mandatory
Threshold profile to be associated with the monitor.
Create new threshold profile or find your preferred threshold profile’s ID.
user_group_ids array Mandatory
User group to be notified on down.
Create new user group or find your preferred user group’s ID.
use_ipv6 boolean Select IPv6 for monitoring the websites hosted with IPv6 address. If you choose non IPv6 supported locations, monitoring will happen through IPv4.
monitor_groups array Group IDs to associate monitor.
Create new monitor group or find your preferred monitor group’s ID.
dependency_resource_id string Suppress alert when dependent monitor is down
command string Write this command to TCP connection to execute a command.
matching_keyword json Check for the keyword in the website response.
JSON Format: {value: “$value”, severity: “$alert_type_constant”}
unmatching_keyword json Check for non existence of keyword in the website response.
JSON Format: {value: “$value”, severity: “$alert_type_constant”}
action_ids JSON array Action to be performed on monitor status changes.
JSON Format {action_id: “$action_id”, alert_type: $action_rule_constants}.
Create new action or find your preferred action’s ID.
third_party_services array Third party services to be notified.
state int State of the monitor.

POP Server

Monitor the availability of the POP service.

Attribute Type Description
display_name string Mandatory
Name for the monitor.
type string Mandatory
PORT-POP
host_name string Mandatory
POP server hostname.
port int Mandatory
POP server PORT. Default value: 110
check_frequency int Mandatory
Check interval for monitoring.
timeout int Mandatory
Timeout for connecting to the host.
Range 1 - 45.
location_profile_id string Mandatory
Location Profile to be associated with the monitor.
Create new location profile or find your preferred location profile’s ID.
notification_profile_id string Mandatory
Notification profile to be associated with the monitor.
Create new notification profile or find your preferred notification profile’s ID.
threshold_profile_id string Mandatory
Threshold profile to be associated with the monitor.
Create new threshold profile or find your preferred threshold profile’s ID.
user_group_ids array Mandatory
User group to be notified on down.
Create new user group or find your preferred user group’s ID.
use_ipv6 boolean Select IPv6 for monitoring the websites hosted with IPv6 address. If you choose non IPv6 supported locations, monitoring will happen through IPv4.
monitor_groups array Group IDs to associate monitor.
Create new monitor group or find your preferred monitor group’s ID.
dependency_resource_id string Suppress alert when dependent monitor is down
action_ids JSON array Action to be performed on monitor status changes.
JSON Format {action_id: “$action_id”, alert_type: $action_rule_constants}.
Create new action or find your preferred action’s ID.
third_party_services array Third party services to be notified.
state int State of the monitor.

SMTP Server

Monitor the availability of the SMTP service.

Attribute Type Description
display_name string Mandatory
Name for the monitor.
type string Mandatory
PORT-SMTP
host_name string Mandatory
SMTP server hostname.
port int Mandatory
SMTP server PORT. Default value: 25
check_frequency int Mandatory
Check interval for monitoring.
timeout int Mandatory
Timeout for connecting to the host.
Range 1 - 45.
location_profile_id string Mandatory
Location Profile to be associated with the monitor.
Create new location profile or find your preferred location profile’s ID.
notification_profile_id string Mandatory
Notification profile to be associated with the monitor.
Create new notification profile or find your preferred notification profile’s ID.
threshold_profile_id string Mandatory
Threshold profile to be associated with the monitor.
Create new threshold profile or find your preferred threshold profile’s ID.
user_group_ids array Mandatory
User group to be notified on down.
Create new user group or find your preferred user group’s ID.
use_ipv6 boolean Select IPv6 for monitoring the websites hosted with IPv6 address. If you choose non IPv6 supported locations, monitoring will happen through IPv4.
high_avail_check boolean Use high availability set-up mode to achieve better availability SLA reporting for your SMTP host.
monitor_groups array Group IDs to associate monitor.
Create new monitor group or find your preferred monitor group’s ID.
dependency_resource_id string Suppress alert when dependent monitor is down
action_ids JSON array Action to be performed on monitor status changes.
JSON Format {action_id: “$action_id”, alert_type: $action_rule_constants}.
Create new action or find your preferred action’s ID.
third_party_services array Third party services to be notified.
state int State of the monitor.

PING

Monitor the availability of the server via PING.

Attribute Type Description
display_name string Mandatory
Name for the monitor.
type string Mandatory
PING
host_name string Mandatory
Server hostname.
check_frequency int Mandatory
Check interval for monitoring.
timeout int Mandatory
Timeout for connecting to the host.
Range 1 - 45.
location_profile_id string Mandatory
Location Profile to be associated with the monitor.
Create new location profile or find your preferred location profile’s ID.
notification_profile_id string Mandatory
Notification profile to be associated with the monitor.
Create new notification profile or find your preferred notification profile’s ID.
threshold_profile_id string Mandatory
Threshold profile to be associated with the monitor.
Create new threshold profile or find your preferred threshold profile’s ID.
user_group_ids array Mandatory
User group to be notified on down.
Create new user group or find your preferred user group’s ID.
use_ipv6 boolean Select IPv6 for monitoring the websites hosted with IPv6 address. If you choose non IPv6 supported locations, monitoring will happen through IPv4.
monitor_groups array Group IDs to associate monitor.
Create new monitor group or find your preferred monitor group’s ID
dependency_resource_id string Suppress alert when dependent monitor is down
action_ids JSON array Action to be performed on monitor status changes.
JSON Format {action_id: “$action_id”, alert_type: $action_rule_constants}.
Create new action or find your preferred action’s ID.
third_party_services array Third party services to be notified.
state int State of the monitor.

FTP Server

Monitor the availability of the FTP Service.

Attribute Type Description
display_name string Mandatory
Name for the monitor.
type string Mandatory
PORT_FTP
host_name string Mandatory
FTP server hostname.
port int Mandatory
FTP service PORT. Default value: 21
check_frequency int Mandatory
Check interval for monitoring.
timeout int Mandatory
Timeout for connecting to the host.
Range 1 - 45.
location_profile_id string Mandatory
Location Profile to be associated with the monitor.
Create new location profile or find your preferred location profile’s ID.
notification_profile_id string Mandatory
Notification profile to be associated with the monitor.
Create new notification profile or find your preferred notification profile’s ID.
threshold_profile_id string Mandatory
Threshold profile to be associated with the monitor.
Create new threshold profile or find your preferred threshold profile’s ID.
user_group_ids array Mandatory
User group to be notified on down.
Create new user group or find your preferred user group’s ID.
use_ipv6 boolean Select IPv6 for monitoring the websites hosted with IPv6 address. If you choose non IPv6 supported locations, monitoring will happen through IPv4.
monitor_groups array Group IDs to associate monitor.
Create new monitor group or find your preferred monitor group’s ID.
dependency_resource_id string Suppress alert when dependent monitor is down
action_ids JSON array Action to be performed on monitor status changes.
JSON Format {action_id: “$action_id”, alert_type: $action_rule_constants}.
Create new action or find your preferred action’s ID.
third_party_services array Third party services to be notified.
state int State of the monitor.

Mail Delivery

Continuously monitor the uptime and performance of your mail servers, both outgoing (SMTP) and incoming (POP, IMAP).

Attribute Type Description
display_name string Mandatory
Name for the monitor.
type string Mandatory
SMTP
check_frequency int Mandatory
Check interval for monitoring.
timeout int Mandatory
TCP connection timeout for connecting to the host.
Range 1 - 45.
location_profile_id string Mandatory
Location Profile to be associated with the monitor.
Create new location profile or find your preferred location profile’s ID.
notification_profile_id string Mandatory
Notification profile to be associated with the monitor.
Create new notification profile or find your preferred notification profile’s ID.
threshold_profile_id string Mandatory
Threshold profile to be associated with the monitor.
Create new threshold profile or find your preferred threshold profile’s ID.
user_group_ids array Mandatory
User group to be notified on down.
Create new user group or find your preferred user group’s ID.
use_site24x7_smtp boolean When this is set true, mails will be triggered from Site24x7 SMTP server.
smtp_host string Mandatory, if use_site24x7_smtp is set as false.
SMTP server hostname.
smtp_port int Mandatory, if use_site24x7_smtp is set as false.
SMTP service PORT. Default value: 25
smtp_user string Mandatory, if use_site24x7_smtp is set as false.
SMTP Username
smtp_pass string Mandatory, if use_site24x7_smtp is set as false.
SMTP Password
from_emailid string Mandatory
From Email address to be used.
to_emailid string Mandatory
To Email address to be used.
secure_smtp boolean Optional, use if use_site24x7_smtp is set as false.
Denotes SMTP use secure mode.
smtp_tls boolean Optional, use if use_site24x7_smtp is set as false.
Denotes TLS protocol enabled for SMTP.
smtp_auth boolean Optional, use if use_site24x7_smtp is set as false.
Denotes Authentication required for accessing SMTP server.
mail_subject string Mail subject to be used.
enable_mail_fetch boolean Enables to check mail is received.
use_site24x7_imap boolean When this is set true, mails will be sent to Site24x7 mail account.
pop_host string Mandatory, if use_site24x7_imap is set as false and fetch_protocol is POP
POP server host.
pop_port int Mandatory, if use_site24x7_imap is set as false and fetch_protocol is POP
POP server Port.
imap_host string Mandatory, if use_site24x7_imap is set as false and fetch_protocol is IMAP
IMAP server host.
imap_port int Mandatory, if use_site24x7_imap is set as false and fetch_protocol is imap_port
IMAP server port.
fetch_user string Mandatory, if use_site24x7_imap is set as false.
Authentication username to be used to fetch mail.
fetch_pass string Mandatory, if use_site24x7_imap is set as false.
Authentication password to be used to fetch mail.
fetch_folder string Mandatory, if use_site24x7_imap is set as false.
Folder name to fetch the mail.
fetch_protocol int Optional, use if use_site24x7_imap is set as false.
Denotes which protocol to use for mail fetching 1-POP or 2-IMAP
secure_fetch boolean Optional, use if use_site24x7_imap is set as false.
Denotes to fetch mail using secure connection.
fetch_tls boolean Optional, use if use_site24x7_imap is set as false.
Denotes TLS protocol enabled for mail fetching.
attachment_file_name string A file with this name will be attached to the email.
monitor_groups array Group IDs to associate monitor.
Create new monitor group or find your preferred monitor group’s ID.
dependency_resource_id string Suppress alert when dependent monitor is down
action_ids JSON array Action to be performed on monitor status changes.
JSON Format {action_id: “$action_id”, alert_type: $action_rule_constants}.
Create new action or find your preferred action’s ID.
third_party_services array Third party services to be notified.
state int State of the monitor.

FTP Transfer

Check the response time for uploading and downloading important files via your FTP server.

Attribute Type Description
display_name string Mandatory
Name for the monitor.
type string Mandatory
FTP
protocol string Mandatory
Denotes which protocol to use for File Transfer.
FTP,SFTP,FTPS-SSL or FTPS-TLS
host_name string Mandatory
FTP server hostname.
port int Mandatory
FTP service PORT. Default value: 21
check_frequency int Mandatory
Check interval for monitoring.
timeout int Mandatory
Timeout for connecting to the host.
Range 1 - 45.
location_profile_id string Mandatory
Location Profile to be associated with the monitor.
Create new location profile or find your preferred location profile’s ID.
notification_profile_id string Mandatory
Notification profile to be associated with the monitor.
Create new notification profile or find your preferred notification profile’s ID.
threshold_profile_id string Mandatory
Threshold profile to be associated with the monitor.
Create new threshold profile or find your preferred threshold profile’s ID.
user_group_ids array Mandatory
User group to be notified on down.
Create new user group or find your preferred user group’s ID.
check_upload boolean Denotes to upload a file to FTP server.
check_download boolean Denotes to download the file from FTP server.
username string Mandatory
Server authentication username.
password string Server authentication password.
destination string Mandatory
Destination folder name.
monitor_groups array Group IDs to associate monitor.
Create new monitor group or find your preferred monitor group’s ID.
dependency_resource_id string Suppress alert when dependent monitor is down
action_ids JSON array Action to be performed on monitor status changes.
JSON Format {action_id: “$action_id”, alert_type: $action_rule_constants}.
Create new action or find your preferred action’s ID.
third_party_services array Third party services to be notified.
state int State of the monitor.

SSL Certificate

Set alerts to notify you before the SSL certificate of your website expires.

Attribute Type Description
display_name string Mandatory
Name for the monitor.
type string Mandatory
SSL_CERT
protocol string Mandatory
HTTPS,SMTPS,POPS,IMAPS,FTPS or CUSTOM
domain_name string Mandatory
Domain name to be verified for SSL Certificate.
port int Mandatory
Server Port.
timeout int Mandatory
Timeout for connecting to the host.
Range 1 - 45.
expire_days int Mandatory
Day threshold for certificate expiry notification.
location_profile_id string Mandatory
Location Profile to be associated with the monitor.
Create new location profile or find your preferred location profile’s ID.
notification_profile_id string Mandatory
Notification profile to be associated with the monitor.
Create new notification profile or find your preferred notification profile’s ID.
user_group_ids array Mandatory
User group to be notified on down.
Create new user group or find your preferred user group’s ID.
ignore_domain_mismatch boolean Denotes to handle domain name mismatch errors.
monitor_groups array Group IDs to associate monitor.
action_ids JSON array Action to be performed on monitor status changes.
JSON Format {action_id: “$action_id”, alert_type: $action_rule_constants}.
Create new action or find your preferred action’s ID.
third_party_services array Third party services to be notified.
state int State of the monitor.

Domain Expiry

Set alerts to notify before your domain expires.

Attribute Type Description
display_name string Mandatory
Name for the monitor.
type string Mandatory
DOMAINEXPIRY
host_name string Mandatory
Registered domain name.
port int Mandatory
Whois Server Port
Default value is 43
timeout int Mandatory
Timeout for connecting to the host.
Range 1 - 45.
expire_days int Mandatory
Day threshold for domain expiry notification.
notification_profile_id string Mandatory
Notification profile to be associated with the monitor.
Create new notification profile or find your preferred notification profile’s ID.
user_group_ids array Mandatory
User group to be notified on down.
Create new user group or find your preferred user group’s ID.
ignore_registry_date boolean Ignores the registry expiry date and prefer registrar expiry date when notifying for domain expiry.
monitor_groups array Group IDs to associate monitor.
Create new monitor group or find your preferred monitor group’s ID.
action_ids JSON array Action to be performed on monitor status changes.
JSON Format {action_id: “$action_id”, alert_type: $action_rule_constants}.
Create new action or find your preferred action’s ID.
third_party_services array Third party services to be notified.
state int State of the monitor.

Web Transaction - POST not allowed

Proactively monitor and measure multi-step user interactions with your Web applications (shopping carts, Web registrations forms, HR portals, etc.)

Attribute Type Description
display_name string Mandatory
Name for the monitor.
type string Mandatory
URL-SEQ
check_frequency int Mandatory
Check interval for monitoring.
location_profile_id string Mandatory
Location Profile to be associated with the monitor.
Create new location profile or find your preferred location profile’s ID.
notification_profile_id string Mandatory
Notification profile to be associated with the monitor.
Create new notification profile or find your preferred notification profile’s ID.
threshold_profile_id string Mandatory
Threshold profile to be associated with the monitor.
Create new threshold profile or find your preferred threshold profile’s ID.
user_group_ids array Mandatory
User group to be notified on down.
Create new user group or find your preferred user group’s ID.
use_ipv6 boolean Select IPv6 for monitoring the websites hosted with IPv6 address. If you choose non IPv6 supported locations, monitoring will happen through IPv4.
auth_user string Authentication user name to access the website.
auth_pass string Authentication password to access the website.
user_agent string User Agent to be used while monitoring the website.
custom_headers JSON array Header name and value in a string array.
JSON Format: {name: “$Header Name”, value: “$Header Value”}
monitor_groups array Group IDs to associate monitor.
Create new monitor group or find your preferred monitor group’s ID.
dependency_resource_id string Suppress alert when dependent monitor is down
action_ids JSON array Action to be performed on monitor status changes.
JSON Format {action_id: “$action_id”, alert_type: $action_rule_constants}
use_name_server boolean Resolve the IP address using Domain Name Server.
Create new action or find your preferred action’s ID.
third_party_services array Third party services to be notified.
state int State of the monitor.

Web Transaction Steps - POST not allowed

Steps are part of the Web Transaction Monitor represents individual step in the monitor.

Attribute Type Description
display_name string Mandatory
Name for the monitor.
step_url string Mandatory
URL of the application under monitor.
type string Mandatory
URL-SEQ
timeout int Mandatory
Timeout for connecting to URL.
http_method string Mandatory
HTTP Method to be used for accessing the website. PUT, PATCH and DELETE are not supported.
request_content_type string Provide content type for request params. Content Types
request_param string Provide parameters to be passed while accessing the website.
forced_ips String Provide comma-separated list of IP addresses to override IP addresses resolved by the DNS server.
matching_keyword json Check for the keyword in the website response.
JSON Format: {value: “$value”, severity: “$alert_type_constant”}
unmatching_keyword json Check for non existence of keyword in the website response.
JSON Format: {value: “$value”, severity: “$alert_type_constant”}
match_regex json Match the regular expression in the website response.
JSON Format: {value: “$value”, severity: “$alert_type_constant”}
match_case boolean Perform case sensitive keyword search or not.
severity int Severity of the step in the application. Severity
state int State of the monitor.

REST API Transaction

Monitor the availability and performance of your published Restful API transaction sequence.

Attribute Type Description
display_name string Mandatory
Name for the monitor.
type string Mandatory
RESTAPISEQ
check_frequency int Mandatory
Check interval for monitoring.
location_profile_id string Mandatory
Location Profile to be associated with the monitor.
Create new location profile or find your preferred location profile’s ID.
notification_profile_id string Mandatory
Notification profile to be associated with the monitor.
Create new notification profile or find your preferred notification profile’s ID.
threshold_profile_id string Mandatory
Threshold profile to be associated with the monitor.
Create new threshold profile or find your preferred threshold profile’s ID.
user_group_ids array Mandatory
User group to be notified on down.
Create new user group or find your preferred user group’s ID.
monitor_groups array Mandatory
Group IDs to associate monitor.
Create new monitor group or find your preferred monitor group’s ID.
steps JSONArray Mandatory
Steps are the various API transactions for the single monitor. Create multiple steps, arrange them in order of execution.
JSON Format [{display_name: “$display_name”, step_details: [{$step_details}]}]
dependency_resource_id string Suppress alert when dependent monitor is down
action_ids JSON array Action to be performed on monitor status changes.
JSON Format {action_id: “$action_id”, alert_type: $action_rule_constants}
third_party_services array Third party services to be notified.
state int State of the monitor.

Step Details

Steps are the various API transactions for the single monitor. Create multiple steps, arrange them in order of execution.

Attribute Type Description
display_name string Mandatory
Name for the Step.
step_url string Mandatory
Website address to monitor.
http_method string Mandatory
HTTP Method used for accessing the website. HTTP Methods
timeout int Mandatory
Timeout for connecting to website.
Range 1 - 45.
use_ipv6 boolean Select IPv6 for monitoring the websites hosted with IPv6 address. If you choose non IPv6 supported locations, monitoring will happen through IPv4.
request_content_type string Provide content type for request params. Content Types
request_param string Provide parameters to be passed while accessing the website.
auth_user string Authentication user name to access the website.
auth_pass string Authentication password to access the website.
oauth2_provider string Provider ID of the OAuth Provider to be associated with the monitor.
response_type string Response content type. Response Content Types
matching_keyword json Check for the keyword in the website response.
JSON Format: {value: “$value”, severity: “$alert_type_constant”}
unmatching_keyword json Check for non existence of keyword in the website response.
JSON Format: {value: “$value”, severity: “$alert_type_constant”}
match_regex json Match the regular expression in the website response.
JSON Format: {value: “$value”, severity: “$alert_type_constant”}
match_case boolean Perform case sensitive keyword search or not.
match_xml json Check for the XPATH in the xml response.
JSON Format: {xpath: “$XPATH”, value: “$value”, severity: “$alert_type_constant”}
match_json json Check for the JSON in the in JSON response.
JSON Format: {jsonpath: “$JSONPATH”, value: “$value”. severity: “$alert_type_constant”}
user_agent string User Agent to be used while monitoring the website.
custom_headers JSON array Header name and value in a string array.
JSON Format: {name: “$Header Name”, value: “$Header Value”}
use_name_server boolean Resolve the IP address using Domain Name Server.
up_status_codes string Provide a comma-separated list of HTTP status codes that indicate a successful response. You can specify individual status codes, as well as ranges separated with a colon.
response_variables json These are the parameter forwards used for the next step in the transaction.
JSON Format:{response_type:“Response Content Types”,variables:“[{name:”$name",value:“$value”}]“}
severity int Severity of the step in the application. Severity
json_schema_check boolean Enable this option to perform the JSON schema check.
json_schema json Provide the JSON schema to be validated against the JSON response and specify the alert type to be raised during a test failure.
JSON Format: {schema_value:”$schema_value",severity:“$alert_type_constant”}

Web Transaction (Browser) - POST not allowed

Proactively monitor and measure multi-step user interactions with your Web applications (shopping carts, Web registrations forms, HR portals, etc.) using real browser.

Attribute Type Description
display_name string Mandatory
Name for the monitor.
type string Mandatory
REALBROWSER
check_frequency int Mandatory
Check interval for monitoring.
think_time int Mandatory
Think time between each steps
page_load_time int Mandatory
Timeout for page load.
resolution string Mandatory
Screen resolution for running the script.
location_profile_id string Mandatory
Location Profile to be associated with the monitor.
Create new location profile or find your preferred location profile’s ID.
notification_profile_id string Mandatory
Notification profile to be associated with the monitor.
Create new notification profile or find your preferred notification profile’s ID.
threshold_profile_id string Mandatory
Threshold profile to be associated with the monitor.
Create new threshold profile or find your preferred threshold profile’s ID.
user_group_ids array Mandatory
User group to be notified on down.
Create new user group or find your preferred user group’s ID.
monitor_groups array Group IDs to associate monitor.
Create new monitor group or find your preferred monitor group’s ID.
dependency_resource_id string Suppress alert when dependent monitor is down
action_ids JSON array Action to be performed on monitor status changes.
JSON Format {action_id: “$action_id”, alert_type: $action_rule_constants}.
Create new action or find your preferred action’s ID.
third_party_services array Third party services to be notified.
state int State of the monitor.

Web Transaction Browser Steps - POST not allowed

Steps are part of the Web Transaction (Browser) Monitor represents individual step in the monitor.

Attribute Type Description
step_name string Mandatory
Name for the monitor.
step_url string Mandatory
URL of the application under monitor.
type string Mandatory
REALBROWSER
matching_keyword json Check for the keyword in the website response.
JSON Format: {value: “$value”, severity: “$alert_type_constant”}
unmatching_keyword json Check for non existence of keyword in the website response.
JSON Format: {value: “$value”, severity: “$alert_type_constant”}
step_actions JSON array Array of action part of the step.
JSON Format:
[{“type”:“$Action Name”,“identifier”:“$Element Id”,“value”:“$Action value”}]
state int State of the monitor.

Server Monitor - POST not allowed

Monitor critical metrics such as CPU, Disk, Memory, Network, Process Services of Linux and Windows server.

Attribute Type Description
display_name string Mandatory
Name for the serve monitor.
type string Mandatory
SERVER
hostname string Mandatory
Hostname of the server.
ipaddress string Mandatory
IP Address of the server.
notification_profile_id string Mandatory
Notification profile to be associated with the monitor.
Create new notification profile or find your preferred notification profile’s ID.
threshold_profile_id string Mandatory
Threshold profile to be associated with the monitor.
Create new threshold profile or find your preferred threshold profile’s ID.
user_group_ids array Mandatory
User group to be notified on down.
Create new user group or find your preferred user group’s ID.
monitor_groups array Group ids to associate monitor.
Create new monitor group or find your preferred monitor group’s ID.
dependency_resource_id string Suppress alert when dependent monitor is down
action_ids JSON array Action to be performed on monitor status changes.
JSON Format {action_id: “$action_id”, alert_type: $action_rule_constants}.
Create new action or find your preferred action’s ID.
third_party_services array Third party services to be notified.
state int State of the monitor.

Microsoft IIS Server - POST not allowed

Get actionable insights on how sites, applications, application pools are performing and resolve impending problems using Site24x7 IIS Monitoring tool.

Attribute Type Description
display_name string Mandatory
Name for the serve monitor.
type string Mandatory
IISSERVER
hostname string Mandatory
Hostname of the server.
ipaddress string Mandatory
IP Address of the server.
iisversion string Mandatory
Version
bit string Mandatory
Platform
notification_profile_id string Mandatory
Notification profile to be associated with the monitor.
Create new notification profile or find your preferred notification profile’s ID.
threshold_profile_id string Mandatory
Threshold profile to be associated with the monitor.
Create new threshold profile or find your preferred threshold profile’s ID.
user_group_ids array Mandatory
User group to be notified on down.
Create new user group or find your preferred user group’s ID.
monitor_groups array Group IDs to associate monitor.
Create new monitor group or find your preferred monitor group’s ID.
dependency_resource_id string Suppress alert when dependent monitor is down
action_ids JSON array Action to be performed on monitor status changes.
JSON Format {action_id: “$action_id”, alert_type: $action_rule_constants}.
Create new action or find your preferred action’s ID.
third_party_services array Third party services to be notified.
state int State of the monitor.

Microsoft SQL Server - POST not allowed

Ensure high SQL server availability and performance with out-of-the-box monitoring data. Mitigate server sprawl and deliver optimal performance 24x7!

Attribute Type Description
display_name string Mandatory
Name for the serve monitor.
type string Mandatory
SQLSERVER
hostname string Mandatory
Hostname of the server.
instance_name string Mandatory
Name of the instance.
ipaddress string Mandatory
IP Address of the server.
notification_profile_id string Mandatory
Notification profile to be associated with the monitor.
Create new notification profile or find your preferred notification profile’s ID.
threshold_profile_id string Mandatory
Threshold profile to be associated with the monitor.
Create new threshold profile or find your preferred threshold profile’s ID.
user_group_ids array Mandatory
User group to be notified on down.
Create new user group or find your preferred user group’s ID.
monitor_groups array Group IDs to associate monitor.
Create new monitor group or find your preferred monitor group’s ID.
dependency_resource_id string Suppress alert when dependent monitor is down
action_ids JSON array Action to be performed on monitor status changes.
JSON Format {action_id: “$action_id”, alert_type: $action_rule_constants}.
Create new action or find your preferred action’s ID.
third_party_services array Third party services to be notified.
state int State of the monitor.

Microsoft Exchange Server - POST not allowed

Monitor the various exchange roles like mailbox, hub transport, client access, unified messaging, edge role etc. Get insights into the organizational view and monitor the uptime of various roles of Exchange server.

Attribute Type Description
display_name string Mandatory
Name for the monitor.
type string Mandatory
MSEXCHANGE
monitor_name string Mandatory
Name of the server
msversion string Mandatory
Version
threshold_profile_id string Mandatory
Threshold profile to be associated with the monitor.
Create new threshold profile or find your preferred threshold profile’s ID.
user_group_ids array Mandatory
User group to be notified on down.
Create new user group or find your preferred user group’s ID.
third_party_services array Third party services to be notified.
state int State of the monitor.

VMWare ESX/ESXi Server Monitor

Analyze the uptime and ensure optimal performance of your VM infrastructure.

Attribute Type Description
display_name string Mandatory
Name for the server monitor.
type string Mandatory
VMWAREESX
esx_host_name string Mandatory
Hostname of the ESX server.
esx_port int Mandatory
ESX server port
user_name string Mandatory
ESX server authentication username
password string Mandatory
ESX server authentication password
location_profile_id string Mandatory
Location Profile to be associated with the monitor.
Create new location profile or find your preferred location profile’s ID.
notification_profile_id string Mandatory
Notification profile to be associated with the monitor.
Create new notification profile or find your preferred notification profile’s ID.
threshold_profile_id string Mandatory
Threshold profile to be associated with the monitor.
Create new threshold profile or find your preferred threshold profile’s ID.
user_group_ids array Mandatory
User group to be notified on down.
Create new user group or find your preferred user group’s ID.
auto_discovery boolean Auto discover VMs.
monitor_groups array Group IDs to associate monitor.
Create new monitor group or find your preferred monitor group’s ID.
dependency_resource_id string Suppress alert when dependent monitor is down
action_ids JSON array Action to be performed on monitor status changes.
JSON Format {action_id: “$action_id”, alert_type: $action_rule_constants}.
Create new action or find your preferred action’s ID.
third_party_services array Third party services to be notified.
state int State of the monitor.

VMWare VM Monitor

Analyze the uptime and ensure optimal performance of your VM instance.

Attribute Type Description
display_name string Mandatory
Name for the serve monitor.
type string Mandatory
VMWAREVM
vm_name string Mandatory
Name of the VM to be monitored.
host_name string Mandatory
Hostname of the ESX server.
port int Mandatory
ESX server port
user_name string Mandatory
ESX server authentication username
password string Mandatory
ESX server authentication password
location_profile_id string Mandatory
Location Profile to be associated with the monitor.
Create new location profile or find your preferred location profile’s ID.
notification_profile_id string Mandatory
Notification profile to be associated with the monitor.
Create new notification profile or find your preferred notification profile’s ID.
threshold_profile_id string Mandatory
Threshold profile to be associated with the monitor.
Create new threshold profile or find your preferred threshold profile’s ID.
user_group_ids array Mandatory
User group to be notified on down.
Create new user group or find your preferred user group’s ID.
monitor_groups array Group IDs to associate monitor.
Create new monitor group or find your preferred monitor group’s ID.
dependency_resource_id string Suppress alert when dependent monitor is down.
uuid string Unique ID assigned to each virtual machine
action_ids JSON array Action to be performed on monitor status changes.
JSON Format {action_id: “$action_id”, alert_type: $action_rule_constants}.
Create new action or find your preferred action’s ID.
third_party_services array Third party services to be notified.
state int State of the monitor.

vCenter Monitor

Analyze the uptime and ensure optimal performance of your VM infrastructure.

Attribute Type Description
display_name string Mandatory
Name for the serve monitor.
type string Mandatory
VCENTER
host_name string Mandatory
Hostname of the ESX server.
port int Mandatory
ESX server port
user_name string Mandatory
ESX server authentication username
password string Mandatory
ESX server authentication password
location_profile_id string Mandatory
Location Profile to be associated with the monitor.
Create new location profile or find your preferred location profile’s ID.
notification_profile_id string Mandatory
Notification profile to be associated with the monitor.
Create new notification profile or find your preferred notification profile’s ID.
threshold_profile_id string Mandatory
Threshold profile to be associated with the monitor.
Create new threshold profile or find your preferred threshold profile’s ID.
user_group_ids array Mandatory
User group to be notified on down.
Create new user group or find your preferred user group’s ID.
auto_discovery boolean Auto discover ESX/VMs.
monitor_groups array Group IDs to associate monitor.
Create new monitor group or find your preferred monitor group’s ID.
dependency_resource_id string Suppress alert when dependent monitor is down.
action_ids JSON array Action to be performed on monitor status changes.
JSON Format {action_id: “$action_id”, alert_type: $action_rule_constants}.
Create new action or find your preferred action’s ID.
third_party_services array Third party services to be notified.
state int State of the monitor.

Amazon Webservice Monitor

Discover and add Amazon Instances for monitoring availability and performance.

Attribute Type Description
display_name string Mandatory
Name for the AWS monitor.
type string Mandatory
AMAZON
aws_secret_key string Mandatory, if registering with IAM security credentials
Secret Access key for AWS account.
aws_access_key string Mandatory, if registering with IAM security credentials
Access Key ID for AWS account.
role_arn string Mandatory, if registering with AWS IAM role
Amazon Resource Name for the IAM role created.
aws_discover_services array Mandatory
Select the AWS service that needs to be discovered.
aws_discovery_frequency int Mandatory
Configure rediscovery polling interval for the AWS account.
notification_profile_id string Mandatory
Notification profile to be associated with the monitor.
Create new notification profile or find your preferred notification profile’s ID.
user_group_ids array Mandatory
The User Group, which needs to be notified during an outage of your AWS resource.
Create new user group or find your preferred user group’s ID.
aws_discovery_type string Discovery type to include/exclude AWS resources using Tags
aws_exclude_tags string The tags that need to be configured to exclude/include AWS resources from discovery.
aws_external_id string The unique external id required to enable cross account access.
Create External ID
third_party_services array Third party services to be notified.
state int State of the monitor.

EC2 Instance Monitor - POST not allowed

Monitor availability and performance of Amazon EC2 Instances.

Attribute Type Description
display_name string Mandatory
Name for the EC2 Instance.
type string Mandatory
EC2INSTANCE
instance_id string Mandatory
System generated ID of the EC2 Instance.
region string Mandatory
System discovered region of the EC2 Instance.
aws_account_id string Mandatory
AWS Monitor id.
aws_child_type string Mandatory
AWS child type for the EC2 INSTANCE.
notification_profile_id string Mandatory
Notification profile to be associated with the monitor.
Create new notification profile or find your preferred notification profile’s ID.
threshold_profile_id string Mandatory
Threshold profile to be associated with the monitor.
Create new threshold profile or find your preferred threshold profile’s ID.
user_group_ids array Mandatory
User group to be notified on down.
Create new user group or find your preferred user group’s ID.
monitor_groups array Group IDs to associate monitor.
Create new monitor group or find your preferred monitor group’s ID.
dependency_resource_id string Suppress alert when dependent monitor is down.
action_ids JSON array Action to be performed on monitor status changes.
JSON Format {action_id: “$action_id”, alert_type: $action_rule_constants}.
Create new action or find your preferred action’s ID.
third_party_services array Third party services to be notified.
state int State of the monitor.

RDS Instance Monitor - POST not allowed

Monitor availability and performance of RDS Instance Monitor.

Attribute Type Description
display_name string Mandatory
Name for the RDS Instance.
type string Mandatory
RDSINSTANCE
instance_id string Mandatory
System generated ID of the RDS Instance.
aws_account_id string Mandatory
AWS Monitor id.
aws_child_type string Mandatory
AWS child type for the RDS Instance.
region string Mandatory
System discovered region of the RDS Instance.
notification_profile_id string Mandatory
Notification profile to be associated with the monitor.
Create new notification profile or find your preferred notification profile’s ID.
threshold_profile_id string Mandatory
Threshold profile to be associated with the monitor.
Create new threshold profile or find your preferred threshold profile’s ID.
user_group_ids array Mandatory
User group to be notified on down.
Create new user group or find your preferred user group’s ID.
monitor_groups array Group IDs to associate monitor.
Create new monitor group or find your preferred monitor group’s ID.
dependency_resource_id string Suppress alert when dependent monitor is down.
action_ids JSON array Action to be performed on monitor status changes.
JSON Format {action_id: “$action_id”, alert_type: $action_rule_constants}.
Create new action or find your preferred action’s ID.
third_party_services array Third party services to be notified.
state int State of the monitor.

SNS Topic Monitor - POST not allowed

Monitor availability and performance of Amazon SNS Topic.

Attribute Type Description
display_name string Mandatory
Name for the SNS Topic.
type string Mandatory
SNSTOPIC
topic_name string Mandatory
Topic created for the SNS Topic.
region string Mandatory
System discovered region of the SNS Topic.
aws_account_id string Mandatory
AWS Monitor id.
aws_child_type string Mandatory
AWS child type for the SNS Topic.
topic_arn string Mandatory
System generated ARN of the SNS Topic.
owner string Mandatory
System generated ID of the SNS Topic.
threshold_profile_id string Mandatory
Threshold profile to be associated with the monitor.
Create new threshold profile or find your preferred threshold profile’s ID.
notification_profile_id string Mandatory
Notification profile to be associated with the monitor.
Create new notification profile or find your preferred notification profile’s ID.
user_group_ids array Mandatory
User group to be notified on down.
Create new user group or find your preferred user group’s ID.
monitor_groups array Group IDs to associate monitor.
Create new monitor group or find your preferred monitor group’s ID.
action_ids json array Action to be performed on monitor status changes.
JSON Format {action_id: “$action_id”, alert_type: $action_rule_constants}.
Create new action or find your preferred action’s ID.
third_party_services array Third party services to be notified.
state int State of the monitor.

DynamoDB Table Monitor - POST not allowed

Monitor availability and performance of Amazon DynamoDB Table.

Attribute Type Description
display_name string Mandatory
Name for the DynamoDB Table.
type string Mandatory
DYNAMODBTABLE
region string Mandatory
System discovered region of the DynamoDB Table.
aws_account_id string Mandatory
AWS account id for DynamoDB Table.
aws_child_type int Mandatory
AWS child type for DynamoDB Table.
threshold_profile_id string Mandatory
Threshold profile to be associated with the monitor.
Create new threshold profile or find your preferred threshold profile’s ID.
notification_profile_id string Mandatory
Notification profile to be associated with the monitor.
Create new notification profile or find your preferred notification profile’s ID.
user_group_ids array Mandatory
User group to be notified on down.
Create new user group or find your preferred user group’s ID.
monitor_groups array Group IDs to associate monitor.
Create new monitor group or find your preferred monitor group’s ID.
dependency_resource_id string Suppress alert when dependent monitor is down.
action_ids json array Action to be performed on monitor status changes.
JSON Format {action_id: “$action_id”, alert_type: $action_rule_constants}.
Create new action or find your preferred action’s ID.
third_party_services array Third party services to be notified.
state int State of the monitor.

Classic Load Balancer - POST not allowed

Monitor availability and performance of Amazon Classic Load Balancer.

Attribute Type Description
display_name string Mandatory
Name for the Classic Load Balancer.
type string Mandatory
LOADBALANCER
region string Mandatory
System discovered region of the Load balancer.
aws_account_id string Mandatory
AWS Monitor id.
aws_child_type string Mandatory
AWS child type for the Classic Load Balancer.
elb_name string Mandatory
Name of the ELB.
elb_type string Mandatory
Type of the ELB.
threshold_profile_id string Mandatory
Threshold profile to be associated with the monitor.
Create new threshold profile or find your preferred threshold profile’s ID.
notification_profile_id string Mandatory
Notification profile to be associated with the monitor.
Create new notification profile or find your preferred notification profile’s ID.
user_group_ids array Mandatory
User group to be notified on down.
Create new user group or find your preferred user group’s ID.
monitor_groups array Group IDs to associate monitor.
Create new monitor group or find your preferred monitor group’s ID.
action_ids json array Action to be performed on monitor status changes.
JSON Format {action_id: “$action_id”, alert_type: $action_rule_constants}.
Create new action or find your preferred action’s ID.
third_party_services array Third party services to be notified.
state int State of the monitor.

Application Load Balancer - POST not allowed

Monitor availability and performance of Amazon Application Load Balancer.

Attribute Type Description
display_name string Mandatory
Name for the Application Load Balancer.
type string Mandatory
APPLN-LOADBALANCER
region string Mandatory
System discovered region of the Load Balancer.
aws_account_id string Mandatory
AWS Monitor id.
aws_child_type string Mandatory
AWS child type for the ELB.
elb_name string Mandatory
Name of the ELB.
elb_type string Mandatory
Type of the ELB.
threshold_profile_id string Mandatory
Threshold profile to be associated with the monitor.
Create new threshold profile or find your preferred threshold profile’s ID.
notification_profile_id string Mandatory
Notification profile to be associated with the monitor.
Create new notification profile or find your preferred notification profile’s ID.
user_group_ids array Mandatory
User group to be notified on down.
Create new user group or find your preferred user group’s ID.
monitor_groups array Group IDs to associate monitor.
Create new monitor group or find your preferred monitor group’s ID.
action_ids json array Action to be performed on monitor status changes.
JSON Format {action_id: “$action_id”, alert_type: $action_rule_constants}.
Create new action or find your preferred action’s ID.
third_party_services array Third party services to be notified.
state int State of the monitor.

Lambda Function Monitor - POST not allowed

Monitor the usage and performance of Lambda functions.

Attribute Type Description
display_name string Mandatory
Name for the Lambda Function.
function_name string Mandatory
Name for the Lambda Function.
region string Mandatory
System discovered region of the Lambda Function.
aws_account_id string Mandatory
AWS Monitor id.
aws_child_type string Mandatory
AWS child type for the Lambda Function.
aws_arn string Mandatory
Amazon Resource Name for the Lambda Function.
owner string Mandatory
System generated ID of the AWS account.
threshold_profile_id string Mandatory
Threshold profile to be associated with the monitor.
Create new threshold profile or find your preferred threshold profile’s ID.
notification_profile_id string Mandatory
Notification profile to be associated with the monitor.
Create new notification profile or find your preferred notification profile’s ID.
user_group_ids array Mandatory
User group to be notified on down.
Create new user group or find your preferred user group’s ID.
monitor_groups array Group IDs to associate monitor.
Create new monitor group or find your preferred monitor group’s ID.
action_ids json array Action to be performed on monitor status changes.
JSON Format {action_id: “$action_id”, alert_type: $action_rule_constants}.
Create new action or find your preferred action’s ID.
third_party_services array Third party services to be notified.
state int State of the monitor.

EC Memcached Cluster - POST not allowed

Monitor the usage and performance of Memcached Cluster.

Attribute Type Description
display_name string Mandatory
Name for the Memcached Cluster.
region string Mandatory
System discovered region of the Memcached Cluster.
aws_account_id string Mandatory
AWS account id.
threshold_profile_id string Mandatory
Threshold profile to be associated with the monitor.
Create new threshold profile or find your preferred threshold profile’s ID.
notification_profile_id string Mandatory
Notification profile to be associated with the monitor.
Create new notification profile or find your preferred notification profile’s ID.
user_group_ids array Mandatory
User group to be notified on down.
Create new user group or find your preferred user group’s ID.
aws_arn string Amazon Resource Name for the Memcached Cluster.
monitor_groups array Group IDs to associate monitor.
Create new monitor group or find your preferred monitor group’s ID.
action_ids json array Action to be performed on monitor status changes.
JSON Format {action_id: “$action_id”, alert_type: $action_rule_constants}.
Create new action or find your preferred action’s ID.
third_party_services array Third party services to be notified.
state int State of the monitor.

EC Memcached Node - POST not allowed

Monitor the usage and performance of Memcached Node.

Attribute Type Description
display_name string Mandatory
Name for the Memcached Node.
region string Mandatory
System discovered region of the Memcached Node.
aws_account_id string Mandatory
AWS account id.
threshold_profile_id string Mandatory
Threshold profile to be associated with the monitor.
Create new threshold profile or find your preferred threshold profile’s ID.
notification_profile_id string Mandatory
Notification profile to be associated with the monitor.
Create new notification profile or find your preferred notification profile’s ID.
user_group_ids array Mandatory
User group to be notified on down.
Create new user group or find your preferred user group’s ID.
aws_arn string Amazon Resource Name for the Memcached Node.
monitor_groups array Group IDs to associate monitor.
Create new monitor group or find your preferred monitor group’s ID.
action_ids json array Action to be performed on monitor status changes.
JSON Format {action_id: “$action_id”, alert_type: $action_rule_constants}.
Create new action or find your preferred action’s ID.
third_party_services array Third party services to be notified.
state int State of the monitor.

EC Redis Node - POST not allowed

Monitor the usage and performance of Redis Node.

Attribute Type Description
display_name string Mandatory
Name for the Redis Node.
region string Mandatory
System discovered region of the Redis Node.
aws_account_id string Mandatory
AWS account id.
threshold_profile_id string Mandatory
Threshold profile to be associated with the monitor.
Create new threshold profile or find your preferred threshold profile’s ID.
notification_profile_id string Mandatory
Notification profile to be associated with the monitor.
Create new notification profile or find your preferred notification profile’s ID.
user_group_ids array Mandatory
User group to be notified on down.
Create new user group or find your preferred user group’s ID.
aws_arn string Amazon Resource Name for the Redis Node.
monitor_groups array Group IDs to associate monitor.
Create new monitor group or find your preferred monitor group’s ID.
action_ids json array Action to be performed on monitor status changes.
JSON Format {action_id: “$action_id”, alert_type: $action_rule_constants}.
Create new action or find your preferred action’s ID.
third_party_services array Third party services to be notified.
state int State of the monitor.

Network Device Monitor - POST not allowed

Monitor critical network devices such as Routers, Switches and Firewalls using SNMP protocol and helps network teams visualize, monitor, optimize and manage the network devices and interface performance.

Attribute Type Description
display_name string Mandatory
Name for the network device monitor.
type string Mandatory
NETWORKDEVICE
device_name string Mandatory
Name of the network device
ipaddress string Mandatory
Host Name/IP Address of the device
category string Mandatory
Category of the device(Routers, Switches or Firewalls)
device_type string Mandatory
Type of the device
device_mapname string Mandatory
Device Mapping Name
location_profile_id string Mandatory
Location Profile to be associated with the monitor.
Create new location profile or find your preferred location profile’s ID.
threshold_profile_id string Mandatory
Threshold profile to be associated with the monitor.
Create new threshold profile or find your preferred threshold profile’s ID.
notification_profile_id string Mandatory
Notification profile to be associated with the monitor.
Create new notification profile or find your preferred notification profile’s ID.
user_group_ids array Mandatory
User group to be notified on down.
Create new user group or find your preferred user group’s ID.
monitor_groups array Group IDs to associate monitor.
Create new monitor group or find your preferred monitor group’s ID.
dependency_resource_id string Suppress alert when dependent monitor is down.
action_ids JSON array Action to be performed on monitor status changes.
JSON Format {action_id: “$action_id”, alert_type: $action_rule_constants}.
Create new action or find your preferred action’s ID.
third_party_services array Third party services to be notified.
state int State of the monitor.

SOAP Web Service

Monitor the availability and performance of your SOAP based Web Services.

Attribute Type Description
display_name string Mandatory
Name for the monitor.
type string Mandatory
SOAP
website string Mandatory
SOAP Endpoint URL
request_param string Mandatory
SOAP payload(request xml)
check_frequency int Mandatory
Check interval for monitoring.
timeout int Mandatory
Timeout for connecting to website.
Range 1 - 45.
location_profile_id string Mandatory
Location Profile to be associated with the monitor.
Create new location profile or find your preferred location profile’s ID.
notification_profile_id string Mandatory
Notification profile to be associated with the monitor.
Create new notification profile or find your preferred notification profile’s ID.
threshold_profile_id string Mandatory
Threshold profile to be associated with the monitor.
Create new threshold profile or find your preferred threshold profile’s ID.
user_group_ids array Mandatory
User group to be notified on down.
Create new user group or find your preferred user group’s ID.
use_ipv6 boolean Select IPv6 for monitoring the websites hosted with IPv6 address. If you choose non IPv6 supported locations, monitoring will happen through IPv4.
auth_user string Authentication user name to access the website.
auth_pass string Authentication password to access the website.
oauth2_provider string Provider ID of the OAuth Provider to be associated with the monitor.
client_certificate_password string Password of the uploaded client certificate.
soap_attributes JSON array SOAP attribute name and value in a string array.
JSON Format: {name: “$SOAP attribute name”, value: “$SOAP attribute value”}
soap_attributes_severity int Alert Severity
user_agent string User Agent to be used while monitoring the website.
custom_headers JSON array Header name and value in a string array.
JSON Format: {name: “$Header Name”, value: “$Header Value”}
monitor_groups array Group IDs to associate monitor.
Create new monitor group or find your preferred monitor group’s ID.
dependency_resource_id string Suppress alert when dependent monitor is down.
action_ids JSON array Action to be performed on monitor status changes.
JSON Format {action_id: “$action_id”, alert_type: $action_rule_constants}.
Create new action or find your preferred action’s ID.
use_name_server boolean Resolve the IP address using Domain Name Server.
up_status_codes string Provide a comma-separated list of HTTP status codes that indicate a successful response. You can specify individual status codes, as well as ranges separated with a colon.
third_party_services array Third party services to be notified.
state int State of the monitor.
up_status_codes string Provide a comma-separated list of HTTP status codes that indicate a successful response. You can specify individual status codes, as well as ranges separated with a colon.

BIZTALKSERVER - POST not allowed

Monitors the functioning and performance of BizTalk servers.

Attribute Type Description
display_name string Mandatory
Display name for the biztalk monitor
host_name string Mandatory
Hostname of the server where Biztalk is installed
type string Mandatory
BIZTALKSERVER
ipaddress string Mandatory
IP address of the server where Biztalk is installed
btversion string Mandatory
Biztalk version
threshold_profile_id string Mandatory
Threshold profile to be associated with the monitor.
Create new threshold profile or find your preferred threshold profile’s ID.
notification_profile_id string Mandatory
Notification profile to be associated with the monitor.
Create new notification profile or find your preferred notification profile’s ID.
user_group_ids array Mandatory
User group to be notified on down.
Create new user group or find your preferred user group’s ID.
monitor_groups array Group IDs to associate monitor.
Create new monitor group or find your preferred monitor group’s ID.
dependency_resource_id string Suppress alert when dependent monitor is down.
action_ids JSON array Action to be performed on monitor status changes.
JSON Format {action_id: “$action_id”, alert_type: $action_rule_constants}.
Create new action or find your preferred action’s ID.
third_party_services array Third party services to be notified.
state int State of the monitor.

OFFICE 365 - POST not allowed

Monitors the functioning and performance of Office 365 services.

Attribute Type Description
display_name string Mandatory
Name of the office 365 monitor
type string Mandatory
OFFICE365
user_name string Mandatory
Username for the Office365 account
password string Mandatory
Password for the Office365 account
location_profile_id string Mandatory
Location Profile to be associated with the monitor.
Create new location profile or find your preferred location profile’s ID.
threshold_profile_id string Mandatory
Threshold profile to be associated with the monitor.
Create new threshold profile or find your preferred threshold profile’s ID.
notification_profile_id string Mandatory
Notification profile to be associated with the monitor.
Create new notification profile or find your preferred notification profile’s ID.
user_group_ids array Mandatory
User group to be notified on down.
Create new user group or find your preferred user group’s ID.
monitor_groups array Group IDs to associate monitor.
Create new monitor group or find your preferred monitor group’s ID.
dependency_resource_id string Suppress alert when dependent monitor is down.
action_ids JSON array Action to be performed on monitor status changes.
JSON Format {action_id: “$action_id”, alert_type: $action_rule_constants}.
Create new action or find your preferred action’s ID.
third_party_services array Third party services to be notified.
state int State of the monitor.

Microsoft Failover Cluster - POST not allowed

Microsoft Failover Cluster monitoring capability includes monitoring of the cluster details, the cluster nodes, resource groups, cluster performance, networks, disk utilization and storage stats.

Attribute Type Description
display_name string Mandatory
Name of the failover cluster monitor
type string Mandatory
WINDOWSCLUSTER
threshold_profile_id string Mandatory
Threshold profile to be associated with the monitor.
Create new threshold profile or find your preferred threshold profile’s ID.
notification_profile_id string Mandatory
Notification profile to be associated with the monitor.
Create new notification profile or find your preferred notification profile’s ID.
user_group_ids array Mandatory
User group to be notified on down.
Create new user group or find your preferred user group’s ID.
monitor_groups array Group IDs to associate monitor.
Create new monitor group or find your preferred monitor group’s ID.
dependency_resource_id string Suppress alert when dependent monitor is down.
action_ids JSON array Action to be performed on monitor status changes.
JSON Format {action_id: “$action_id”, alert_type: $action_rule_constants}.
Create new action or find your preferred action’s ID.
third_party_services array Third party services to be notified.
state int State of the monitor.

Microsoft Active Directory - POST not allowed

Get insights on the performance metrics of Microsoft Active Directory details.

Attribute Type Description
display_name string Mandatory
Name of the active directory monitor
type string Mandatory
ADSERVER
ad_domain string Mandatory
Domain name of Active Directory
ad_forest string Mandatory
Forest name where the Active Directory exists
dc_name string Mandatory
Active Directory Domain Controller Name
threshold_profile_id string Mandatory
Threshold profile to be associated with the monitor.
Create new threshold profile or find your preferred threshold profile’s ID.
notification_profile_id string Mandatory
Notification profile to be associated with the monitor.
Create new notification profile or find your preferred notification profile’s ID.
user_group_ids array Mandatory
User group to be notified on down.
Create new user group or find your preferred user group’s ID.
monitor_groups array Group IDs to associate monitor.
Create new monitor group or find your preferred monitor group’s ID.
dependency_resource_id string Suppress alert when dependent monitor is down.
action_ids JSON array Action to be performed on monitor status changes.
JSON Format {action_id: “$action_id”, alert_type: $action_rule_constants}.
Create new action or find your preferred action’s ID.
third_party_services array Third party services to be notified.
state int State of the monitor.

Website Defacement

Continuously check for the integrity of your website by detecting any modification of the content or critical elements in your web page.

Attribute Type Description
display_name string Mandatory
Name of the monitor.
type string Mandatory
WEBSITEDEFACEMENT
website string Mandatory
Domain URL
check_frequency int Mandatory
Check interval for monitoring.
location_profile_id string Mandatory
Location Profile to be associated with the monitor.
Create new location profile or find your preferred location profile’s ID.
user_group_ids array Mandatory
User group to be notified on down.
Create new user group or find your preferred user group’s ID.
webpage_list JSON array Mandatory
Array of web pages to be monitored.
JSON Format: { page_name: “$page_name”, page_url: “$page_url”, update_type: $update_type, script_percentage: $scriptModificationThreshold, text_percentage: $textModificationThreshold}
custom_domain_names string Comma separated list of domain names that can be trusted while monitoring.
auth_user string Authentication user name to access the website.
auth_pass string Authentication password to access the website.
monitor_groups array Group IDs to associate monitor.
Create new monitor group or find your preferred monitor group’s ID.
action_ids JSON array Execute an action when the monitor’s status changes.
JSON Format {action_id: “$action_id”, alert_type: $action_rule_constants}.
Create new action or find your preferred action’s ID.
third_party_services array Third party services to be notified.
state int State of the monitor.

JSON FORMAT

Attribute Type Description
page_name string Mandatory
Name of the web page.
page_url string Mandatory
URL of the web page, which needs to be monitored.
update_type boolean Mandatory
Threshold detection type.
false(Automatic) / true(Manual).
script_percentage int Optional, use if update_type is set as true.
Set threshold percentage to detect script modification in the web page.
text_percentage int Optional, use if update_type is set as true.
Set threshold percentage to detect text content modification in the web page.

Monitors

Monitor performance of websites and internet services like DNS, FTP, SSL, SMTP, POP, URLs, APIs and HTTPS from 50+ locations and via wireless carriers.

Create Monitor

POST /monitors

Create a new monitor.

Request Example for Adding a Website Monitor

$ curl https://www.site24x7.com/api/monitors \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-authtoken a12345b6c8de901f2gh3456ij78k901l" \
    -d '{
          "display_name": "Display name for the monitor",
          "type": "URL",
          "website": "http://www.example.com",
          "check_frequency": 1440,
          "timeout": 30,
          "http_method": "P",
          "location_profile_id": "123412341234123412",
          "notification_profile_id": "123412341234123413",
          "threshold_profile_id": "123412341234123414",
          "user_group_ids": [
            "123412341234123415"
          ],
          "use_ipv6": true,
          "request_content_type": "F",
          "request_param": "param=value",
          "auth_user": "username",
          "auth_pass": "password",
          "matching_keyword": {
            "value": "Title",
            "severity": 0
          },
          "unmatching_keyword": {
            "value": "Exception",
            "severity": 2
          },
          "match_regex": {
            "value": "^reg*",
            "severity": 0
          },
          "match_case": true,
          "user_agent": "Mozilla Firefox",
          "custom_headers": [
            {
              "name": "Accept-Encoding",
              "value": "gzip"
            },
            {
              "name": "Cache-Control",
              "value": "nocache"
            }
          ],
          "monitor_groups": [
            "123412341234123416",
            "123412341234123417"
          ],
          "action_ids": [
            {
              "action_id": "123412341234123418",
              "alert_type": 20
            }
          ],
          "use_name_server": false,
          "up_status_codes": "200",
          "dependency_resource_id": "123412341234123419",
          "third_party_services":[
            "123412341234123423",
            "123412341234123433"
          ]
    }'

Response Example

HTTP/1.1 201 Created
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": {
    "monitor_id": "123412341234123411",
    "request_param": "param=value",
    "use_ipv6": true,
    "third_party_services":[
            "123412341234123423",
            "123412341234123433"
     ],
    "website": "http://www.example.com",
    "type": "URL",
    "custom_headers": [
      {
        "name": "Accept-Encoding",
        "value": "gzip"
      },
      {
        "name": "Cache-Control",
        "value": "nocache"
      }
    ],
    "up_status_codes": "200",
    "user_group_ids": [
      "123412341234123415"
    ],
    "location_profile_id": "123412341234123412",
    "user_agent": "Mozilla Firefox",
    "request_content_type": "F",
    "timeout": 30,
    "match_regex": {
      "severity": "0",
      "value": "^reg*"
    },
    "auth_user": "username",
    "monitor_groups": [
      "123412341234123416",
      "123412341234123417"
    ],
    "auth_pass": "password",
    "threshold_profile_id": "123412341234123414",
    "match_case": true,
    "notification_profile_id": "123412341234123413",
    "http_method": "P",
    "matching_keyword": {
      "severity": "0",
      "value": "Title"
    },
    "action_ids": [
      {
        "action_id": "123412341234123418",
        "alert_type": 20
      }
    ],
    "unmatching_keyword": {
      "severity": "2",
      "value": "Exception"
    },
    "dependency_resource_id": "123412341234123419",
    "check_frequency": "1440",
    "display_name": "Display name for the monitor",
    "use_name_server": true
  }
}

Website
Web Page Speed (Browser)
REST API
SSL/TLS Certificate
Ping
Port (Custom Protocol)
DNS Server
POP Server
SMTP Server
FTP Server
Mail Delivery (Send and Receive Mail)
FTP Transfer (Upload / Download a file)
Amazon Cloud Services Monitor
VCenter Monitor
VMWare ESX/ESXi Server Monitor
VMWare VM Monitor
SOAP Web Service
Website Defacement
Domain Expiry
REST API Transaction

Retrieve Monitor

GET /monitors/{monitor_id}

Retrieve details of an existing monitor.

Request Example

$ curl https://www.site24x7.com/api/monitors/123412341234123411 \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-authtoken a12345b6c8de901f2gh3456ij78k901l"

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": {
        "dns_port": "53",
        "state": 0,
        "monitor_type": "DNS",
        "threshold_profile_id": "123412341234123414",
        "notification_profile_id": "123412341234123413",
        "is_upgrade_available": false,
        "display_name": "DNS",
        "dns_host": "site-centos-64-1",
        "monitor_id": "123412341234123411",
        "user_group_ids": [
          "123412341234123415"
        ],
        "location_profile_id": "123412341234123412",
        "domain_name": "site24x7.com",
        "lookup_type": 2,
        "check_frequency": 5,
        "timeout": 15
    }
}

Path Parameters

Param Type Description
monitor_id string Mandatory
Unique ID of the monitor.
You can find monitor_id using the monitor list api.

Response Attributes

Response attributes by monitor type.

Website
Web Page Speed (Browser)
Web Transaction
REST API Transaction
Web Transaction (Browser)
REST API
SSL/TLS Certificate
Ping
Port (Custom Protocol)
DNS Server
POP Server
SMTP Server
FTP Server
Mail Delivery (Send and Receive Mail)
FTP Transfer (Upload / Download a file)
Server Monitor
Microsoft IIS Server
Microsoft SQL Server
Microsoft Exchange Server
Amazon Cloud Services Monitor
EC2 Instance Monitor
RDS Instance Monitor
SNS Topic Monitor
DynamoDB Table Monitor
Classic Load Balancer
Application Load Balancer
VCenter Monitor
VMWare ESX/ESXi Server Monitor
VMWare VM Monitor
Network Device Monitor
SOAP Web Service
Domain Expiry
BizTalk Server Monitor
Office 365
Website Defacement

You can also retrieve the steps of your Web Transaction Monitor and Web Transaction (Browser) Monitor

Retrieve Monitor By Name

GET /monitors/name/{display_name}

Retrieve details of an existing monitor by display name. Display name of the monitor should be in URL encoding format.

Request Example

$ curl https://www.site24x7.com/api/monitors/name/site24x7Monitor \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-authtoken a12345b6c8de901f2gh3456ij78k901l"

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": {
        "dns_port": "53",
        "state": 0,
        "monitor_type": "DNS",
        "threshold_profile_id": "123412341234123414",
        "notification_profile_id": "123412341234123413",
        "is_upgrade_available": false,
        "display_name": "site24x7Monitor",
        "dns_host": "site-centos-64-1",
        "monitor_id": "123412341234123411",
        "user_group_ids": [
          "123412341234123415"
        ],
        "location_profile_id": "123412341234123412",
        "domain_name": "site24x7.com",
        "lookup_type": 2,
        "check_frequency": 5,
        "timeout": 15
    }
}

Path Parameters

Param Type Description
display_name string Mandatory
Display name of the monitor.

Response Attributes

Response attributes by monitor type.

Website
Web Page Speed (Browser)
Web Transaction
REST API Transaction
Web Transaction (Browser)
REST API
Ping
Port (Custom Protocol)
DNS Server
POP Server
SMTP Server
FTP Server
Mail Delivery (Send and Receive Mail)
FTP Transfer (Upload / Download a file)
Server Monitor
Microsoft IIS Server
Microsoft SQL Server
Microsoft Exchange Server
Amazon Cloud Services Monitor
EC2 Instance Monitor
RDS Instance Monitor
SNS Topic Monitor
DynamoDB Table Monitor
Classic Load Balancer
Application Load Balancer
VCenter Monitor
VMWare ESX/ESXi Server Monitor
VMWare VM Monitor
Network Device Monitor
SOAP Web Service
Domain Expiry
BizTalk Server Monitor
Office 365

Update Monitor

PUT /monitors/{monitor_id}

Update an existing monitor

Request Example for Updating a Website Monitor

$ curl https://www.site24x7.com/api/monitors/123412341234123411 \
    -X PUT \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-authtoken a12345b6c8de901f2gh3456ij78k901l" \
    -d '{
        "display_name": "Display name for the monitor",
        "type": "URL",
        "website": "http://www.example.com",
        "check_frequency": 1440,
        "timeout": 30,
        "http_method": "P",
        "location_profile_id": "123412341234123412",
        "notification_profile_id": "123412341234123413",
        "threshold_profile_id": "123412341234123414",
        "user_group_ids": ["123412341234123415"],
        "use_ipv6": true,
        "request_content_type": "F",
        "request_param": "param=value",
        "auth_user":"username",
        "auth_pass":"password",
        "matching_keyword":{
            value:"Title",
            severity:0
        },
        "unmatching_keyword":{
            value:"Exception",
            severity:2
        },
        "match_regex":{
            value:"^reg*",
            severity:0
        },
        "match_case":true,
        "user_agent":"Mozilla Firefox",
        "custom_headers":[
            {
                "name":"Accept-Encoding", 
                "value":"gzip"
            },
            {
                "name":"Cache-Control",
                "value":"nocache"
            }
        ],
        "monitor_groups":["123412341234123416","123412341234123417"],
        "action_ids":[
            {
                "action_id":"123412341234123418",
                "alert_type":20
            }
        ],
        "use_name_server":false,
        "up_status_codes":"200",
        "dependency_resource_id":"123412341234123419",
        "third_party_services":[
            "123412341234123423",
            "123412341234123433"
          ]
    }'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "success",
    "data": {
    "monitor_id": "123412341234123411",
    "request_param": "param=value",
    "use_ipv6": true,
    "third_party_services":[
            "123412341234123423",
            "123412341234123433"
     ],
    "website": "http://www.example.com",
    "type": "URL",
    "custom_headers": [
        {
            "name": "Accept-Encoding",
            "value": "gzip"
        },
        {
            "name": "Cache-Control",
            "value": "nocache"
        }
    ],
    "up_status_codes": "200",
    "user_group_ids": [
      "123412341234123415"
    ],
    "location_profile_id": "123412341234123412",
    "user_agent": "Mozilla  Firefox",
    "request_content_type": "F",
    "timeout": 30,
    "match_regex": {
      "severity": "0",
      "value": "^reg*"
    },
    "auth_user": "username",
    "monitor_groups": ["123412341234123416","123412341234123417"],
    "auth_pass": "password",
    "threshold_profile_id": "123412341234123414",
    "match_case": true,
    "notification_profile_id": "123412341234123413",
    "http_method": "P",
    "matching_keyword": {
      "severity": "0",
      "value": "Title"
    },
    "action_ids": [
        {
            "action_id": "123412341234123418",
            "alert_type": 20
        }
    ],
    "unmatching_keyword": {
      "severity": "2",
      "value": "Exception"
    },
    "dependency_resource_id": "123412341234123419",
    "check_frequency": "1440",
    "display_name": "Display name for the monitor",
    "use_name_server": true
  }
}

Path Parameters

Param Type Description
monitor_id string Mandatory
Unique ID of the monitor.
You can find monitor_id using the monitor list api.

Response Attributes

Response attributes by monitor type.

Website
Web Page Speed (Browser)
Web Transaction
REST API Transaction
Web Transaction (Browser)
REST API
SSL/TLS Certificate
Ping
Port (Custom Protocol)
DNS Server
Pop Server
SMTP Server
FTP Server
Mail Delivery (Send and Receive Mail)
FTP Transfer (Upload / Download a file)
Server Monitor
Microsoft IIS Server
Microsoft SQL Server Monitor
Microsoft Exchange Server
Amazon Cloud Services Monitor
EC2 Instance Monitor
RDS Instance Monitor
SNS Topic Monitor
DynamoDB Table Monitor
Classic Load Balancer
Application Load Balancer
VCenter Monitor
VMWare ESX/ESXi Server Monitor
VMWare VM Monitor
Network Device Monitor
SOAP Web Service
Domain Expiry
BizTalk Server Monitor
Office 365
Website Defacement

You can also update the steps of your Web Transaction and Web Transacton (Browser)

Delete Monitor

DELETE /monitors/{monitor_id}

Delete a monitor

Request Example

$ curl https://www.site24x7.com/api/monitors/72000078998922 \
    -X DELETE \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-authtoken a12345b6c8de901f2gh3456ij78k901l"

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data":{
  "resource_name":"Display name for the monitor"
  }
}

Path Parameters

Param Type Description
monitor_id string Mandatory
Unique ID of the monitor.
You can find monitor_id using the monitor list api.

Delete Monitor By Name

DELETE /monitors/name/{display_name}

Delete a monitor by display name.Display name of the monitor should be in URL encoding format.

Request Example

$ curl https://www.site24x7.com/api/monitors/name/site24x7Monitor \
    -X DELETE \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-authtoken a12345b6c8de901f2gh3456ij78k901l"

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data":{
  "resource_name":"site24x7Monitor"
  }
}

Path Parameters

Param Type Description
display_name string Mandatory
Display name of the monitor.

Delete Multiple Monitors

DELETE /monitors?monitor_ids={monitor_ids}

Delete list of monitors

Request Example

$ curl https://www.site24x7.com/api/monitors?monitor_ids=72000078998922,72000078998926,72000078998928 \
    -X DELETE \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-authtoken a12345b6c8de901f2gh3456ij78k901l"

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success"
}

Query Parameters

Param Type Description
monitor_ids string Mandatory
Comma-separated list of ID of monitors to be deleted.
You can find monitor_id using the monitor list api.

List Monitor

GET /monitors

Request Example

$ curl https://www.site24x7.com/api/monitors \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-authtoken a12345b6c8de901f2gh3456ij78k901l"

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": [
    {
      "dns_port": "53",
      "state": 0,
      "monitor_type": "DNS",
      "threshold_profile_id": "726000000002090",
      "notification_profile_id": "726000000002035",
      "is_upgrade_available": false,
      "display_name": "DNS",
      "dns_host": "site-centos-64-1",
      "monitor_id": "726000000002101",
      "user_group_ids": [
        "726000000002003"
      ],
      "location_profile_id": "726000000084439",
      "domain_name": "site24x7.com",
      "lookup_type": 2,
      "check_frequency": 5,
      "timeout": 15
    },
    {
      "port": 21,
      "state": 0,
      "host_name": "site24x7.com",
      "monitor_type": "PORT_FTP",
      "threshold_profile_id": "726000000002458",
      "notification_profile_id": "726000000002035",
      "is_upgrade_available": false,
      "display_name": "FTP",
      "monitor_id": "726000000002460",
      "user_group_ids": [
        "726000000002003"
      ],
      "location_profile_id": "726000000002033",
      "check_frequency": 5,
      "timeout": 10
    }
  ]
}

Website
Web Page Speed (Browser)
Web Transaction
Web Transaction - Steps
Web Transaction (Browser)
Web Transaction (Browser) - Steps
REST API Transaction
REST API
SSL/TLS Certificate
Ping
Port (Custom Protocol)
DNS Server
POP Server
SMTP Server
FTP Server
Mail Delivery (Send and Receive Mail)
FTP Transfer (Upload / Download a file)
Server Monitor
Microsoft IIS Server Monitor
Microsoft SQL Server Monitor
Microsoft Exchange Server
Amazon Cloud Services Monitor
EC2 Instance Monitor
RDS Instance Monitor
SNS Topic Monitor
DynamoDB Table Monitor
Classic Load Balancer
Application Load Balancer
VCenter Monitor
VMWare ESX/ESXi Server Monitor
VMWare VM Monitor
Network Device Monitor
SOAP Web Service
Domain Expiry
BizTalk Server Monitor
Office 365
Website Defacement

Enable Client Certificate Authentication

PUT /monitors/client_certificate/{monitor_id}

Upload client certificate (Only PKCS #12 files are supported) for Website/RESTAPI/SOAP monitors, requiring client certificate authentication.

Request Example

$ curl https://www.site24x7.com/api/monitors/client_certificate/72000078998922 \
    -X PUT
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-authtoken ba4604e8e433g9c892e360d53463oec5" \
    -F file=@/home/local/home/certificates/ClientKey.p12

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
}

Path Parameters

Param Type Description
monitor_id string Mandatory
Unique ID of the monitor.
You can find monitor_id using the monitor list api.

Form Parameters

Param Type Description
file PKCS #12 Mandatory
Client Certificate file.

Disable Client Certificate Authentication

DELETE /monitors/client_certificate/{monitor_id}

Remove the uploaded client certificate for a Website/RESTAPI/SOAP monitor.

Request Example

$ curl https://www.site24x7.com/api/monitors/client_certificate/72000078998922 \
    -X DELETE
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-authtoken ba4604e8e433g9c892e360d53463oec5" 

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
}

Path Parameters

Param Type Description
monitor_id string Mandatory
Unique ID of the monitor.
You can find monitor_id using the monitor list api.

Activate Monitor

PUT /monitors/activate/{monitor_id}

Activate a suspended monitor

Request Example

$ curl https://www.site24x7.com/api/monitors/activate/72000078998922 \
    -X PUT \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-authtoken a12345b6c8de901f2gh3456ij78k901l"

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success"
}

Path Parameters

Param Type Description
monitor_id string Mandatory
Unique ID of the monitor.
You can find monitor_id using the monitor list api.

Suspend Monitor

PUT /monitors/suspend/{monitor_id}

Suspend an active monitor

Request Example

$ curl https://www.site24x7.com/api/monitors/suspend/72000078998922 \
    -X PUT \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-authtoken a12345b6c8de901f2gh3456ij78k901l"

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success"
}

Path Parameters

Param Type Description
monitor_id string Mandatory
Unique ID of the monitor.
You can find monitor_id using the monitor list api.

Poll Monitor

GET /monitor/poll_now/{monitor_id}

Poll a monitor.

Request Example

$ curl https://www.site24x7.com/api/monitor/poll_now/165519000002945001\
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-authtoken a12345b6c8de901f2gh3456ij78k901l"

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data":{
      "status":"Polling Initialized",
      "monitor_id":"165519000002945001"
    }
}

When a request is made it initializes polling and returns the status of polling.

Path Parameters

Param Type Description
monitor_id string Mandatory
Unique ID of the monitor.
You can find monitor_id using the monitor list api.

Response Attributes

Attribute Type Description
status string Status of polling.
monitor_id string Unique ID of the monitor. Use retrieve monitor API to get the details of this monitor.

Polling Status

GET /monitor/status_poll_now/{monitor_id}

Retrieve the status of your polled monitor.

Request Example

$ curl https://www.site24x7.com/api/monitor/status_poll_now/165519000002945001\
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-authtoken a12345b6c8de901f2gh3456ij78k901l"

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data":{
      "status":"Completed",
      "monitor_id":"165519000002945001"
    }
}

Path Parameters

Param Type Description
monitor_id string Mandatory
Unique ID of the monitor.
You can find monitor_id using the monitor list api.

Response Attributes

Attribute Type Description
status string Status of your poll.
monitor_id string Unique ID of the monitor. Use retrieve monitor API to get the details of this monitor.

Generate AWS External ID

GET /aws/external_id

Generate the external ID for creating AWS role ARN.

Request Example

$ curl https://www.site24x7.com/api/aws/external_id\
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-authtoken a12345b6c8de901f2gh3456ij78k901l"

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data":{
      external_id: "S247307782834"
    }
}

Response Attributes

Attribute Type Description
aws_external_id string The unique external ID required to enable cross account access.

Mute Monitor Alerts

Use mute alerts API to suppress all alerts relevant to a monitor, monitor groups, or all resources for a specified time duration.

Retrieve details about Muted Alerts

Obtain details about the muted alerts, viz., mute period, muted category (Monitors{M}, Monitor Groups{G} or All{A}), the reason for muting alerts.

GET /mute_alerts

Request Example

$ curl "https://www.site24x7.com/api/mute_alerts" \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-authtoken a12345b6c8de901f2gh3456ij78k901l"

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{  
   "code":0,
   "message":"success",
   "data":{  
         "muted_resource_list":["6000000000118"],
         "category":"M",
         "resource_group_list":[],
         "mute_time_iso":"2017-01-20T13:10:13+0530",
         "reason":"Alerts for a few of the monitors are muted for a specified time duration."
        }
}


Response Attributes

Attribute Type Description
muted_resource_list array A list containing all the muted Monitor IDs.
resource_group_list array A list containing all the muted Monitor group IDs.
category string Mute alerts based on the specified resource category. It can be either an individual Monitor (M), Monitor Group (G), or all the Monitors (A).
mute_time_iso string The time (in ISO date & time format), until when you will suppress all the alerts for the monitor.
reason string The reason provided by the user for muting the Monitor’s alerts.

Mute Monitor Alerts

Suppress monitor alerts for a particular monitor, monitor group, or all the resources for a specified time duration.

PUT /mute_alerts

Request Example

$ curl https://www.site24x7.com/api/mute_alerts \
    -X PUT \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-authtoken a12345b6c8de901f2gh3456ij78k901l" \
    -d '{  
           "mute_time":60,
           "extend_mute":false,
           "muted_resource_list":[  
              "6000000000118"
           ],
           "resource_group_list":[],
           "reason":"Alerts for a few of the monitors are muted for a specified time duration.",
           "category":"M"
        }'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{  
   "code":0,
   "message":"success",
   "data":{  
         "muted_resource_list":["6000000000118"],
         "category":"M",
         "resource_group_list":[],
         "mute_time_iso":"2017-01-20T13:10:13+0530",
         "reason":"Alerts for a few of the monitors are muted for a specified time duration."
         }
}

Request Parameters

Param Type Description
mute_time int Specify the mute time duration in minutes (5, 15, 30, 45, 60, 120, 180, 360, 720, 1440). No new minute integer values other than the ones provided here are accepted.
reason string The reason provided for muting the Monitor’s alerts.
muted_resource_list array A list of all the Monitor IDs (in JSON array format). You must pass an empty array if you wish to specify mute category as ‘A’ (All Monitors.)
resource_group_list array A list containing all the muted Monitor group IDs. You must pass an empty array if you wish to specify mute category as ‘A’ (All Monitors.)
category string Mute alerts based on the specified resource category. It can be either an individual Monitor (M), Monitor Group (G), or all the Monitors (A).
extend_mute boolean Extend your existing mute time duration. Pass ‘true’ if you want to extend your mute period.

Response Attributes

Attribute Type Description
muted_resource_list array A list containing all the muted Monitor IDs.
resource_group_list array A list containing all the muted Monitor group IDs.
category string Mute alerts based on the specified resource category. It can be either an individual Monitor (M), Monitor Group (G), or all the Monitors (A).
mute_time_iso string The time (in ISO date and time format), until when you will suppress all the alerts for the monitor.
reason string The reason provided by the user for muting the Monitor’s alerts.

Unmute Monitor Alerts

Unmute all the suppressed monitor alerts.

DELETE /unmute_alerts

Request Example

$ curl https://www.site24x7.com/api/unmute_alerts \
    -X DELETE \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-authtoken a12345b6c8de901f2gh3456ij78k901l"

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success"
}

AWS Management Actions

Use management action APIs to invoke start, stop and reboot actions for Amazon Web Services.

EC2 INSTANCE

AWS management actions to start, stop and reboot Amazon EC2 Instance.

Actions With Monitor ID

PUT /aws/management_actions/ec2/{monitor_id}?action={aws_management_actions}

Invokes AWS management action using monitor ID.

Request Example

$ curl https://www.site24x7.com/api/aws/management_actions/ec2/165519000002945001?action=1\
    -X PUT\
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-authtoken a12345b6c8de901f2gh3456ij78k901l" \

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": {
    "instance_id": "i-0836fd4f6b43e65cb",
    "monitor_id": "165519000002945001",
    "instance_state": "pending",
    "display_name": "ec2"
  }
}
Path Parameters
Param Type Description
monitor_id string Mandatory
Unique ID of the monitor.
You can find monitor_id using the monitor list api.
Query Parameters
Param Type Description
action int Mandatory
AWS Action to be performed.
Response Attributes
Attribute Type Description
instance_id string System generated ID of the EC2 Instance.
monitor_id string Unique ID of the monitor. Use retrieve monitor API to get the details of this monitor.
instance_state string Current state of the instance.
display_name string Name of the monitor.

Actions With EC2 Instance ID

PUT /aws/management_actions/ec2/name/{instance_id}?action={aws_management_actions}

Invokes AWS management action using EC2 Instance ID.

Request Example

$ curl https://www.site24x7.com/api/aws/management_actions/ec2/name/i-0836fd4f6b43e65cb?action=1\
    -X PUT\
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-authtoken a12345b6c8de901f2gh3456ij78k901l" \

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": {
    "instance_id": "i-0836fd4f6b43e65cb",
    "monitor_id": "165519000002945001",
    "instance_state": "pending",
    "display_name": "ec2"
  }
}
Path Parameters
Param Type Description
instance_id string Mandatory
System generated ID of the EC2 Instance.
Query Parameters
Param Type Description
action int Mandatory
AWS Action to be performed.
Response Attributes
Attribute Type Description
instance_id string System generated ID of the EC2 Instance.
monitor_id string Unique ID of the monitor. Use retrieve monitor API to get the details of this monitor.
instance_state string Current state of the instance.
display_name string Name of the monitor.

RDS INSTANCE

AWS management action to reboot Amazon RDS Instance.

Action With Monitor ID

PUT /aws/management_actions/rds/{monitor_id}?action={aws_management_actions}

Invokes AWS management action using monitor ID.

Request Example

$ curl https://www.site24x7.com/api/aws/management_actions/rds/165519000002945001?action=3\
    -X PUT\
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-authtoken a12345b6c8de901f2gh3456ij78k901l" \

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": {
    "instance_id":"myrdsinstance",
    "monitor_id": "165519000002945001",
    "instance_state": "rebooting",
    "display_name": "rds"
  }
}
Path Parameters
Param Type Description
monitor_id string Mandatory
Unique ID of the monitor.
You can find monitor_id using the monitor list api.
Query Parameters
Param Type Description
action int Mandatory
AWS Action to be performed.
Response Attributes
Attribute Type Description
instance_id string System generated ID of the RDS Instance.
monitor_id string Unique ID of the monitor. Use retrieve monitor API to get the details of this monitor.
instance_state string Current state of the instance.
display_name string Name of the monitor.

Action With RDS Instance ID

PUT /aws/management_actions/rds/name/{instance_id}?action={aws_management_actions}

Invokes AWS management action using RDS Instance ID.

Request Example

$ curl https://www.site24x7.com/api/aws/management_actions/rds/name/myrdsinstance?action=3\
    -X PUT\
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-authtoken a12345b6c8de901f2gh3456ij78k901l" \

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": {
    "instance_id":"myrdsinstance",
    "monitor_id": "165519000002945001",
    "instance_state": "Rebooting",
    "display_name": "rds"
  }
}
Path Parameters
Param Type Description
instance_id string Mandatory
System generated ID of the RDS Instance.
Query Parameters
Param Type Description
action int Mandatory
AWS Action to be performed.
Response Attributes
Attribute Type Description
instance_id string System generated ID of the RDS Instance.
monitor_id string Unique ID of the monitor. Use retrieve monitor API to get the details of this monitor.
instance_state string Current state of the instance.
display_name string Name of the monitor.

Current Status

Find the current status of your monitor or monitor group using the current status API

Retrieve Current Status

GET /current_status

Request Example

$ curl "https://www.site24x7.com/api/current_status?apm_required=true" \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-authtoken a12345b6c8de901f2gh3456ij78k901l"

Response Example

{
  "code": 0,
  "message": "success",
  "data": {
    "monitors": [
      {
        "name": "monitor1",
        "down_reason": "Agent service monitor1 could not establish communication with the Server. Please check if there is a problem with the Network Communication. This could also happen if the Agent Service or the host itself is down.",
        "duration": "12 days 4 Hrs 55 Mins ",
        "attribute_key": "cpu_used",
        "status": 0,
        "last_polled_time": "2015-07-21T16:37:41+0530",
        "server_type": "WINDOWS",
        "attribute_label": "CPU",
        "monitor_type": "SERVER",
        "unit": "%",
        "attribute_value": "-",
        "monitor_id": "355000001863001"
      }
    ],
    "monitor_groups": [
      {
        "status": 0,
        "monitors": [
          {
            "name": "monitor2",
            "down_reason": "SSL Connection Error",
            "duration": "5 days 23 Hrs 24 Mins ",
            "attribute_key": "response_time",
            "status": 0,
            "last_polled_time": "2015-07-21T16:35:36+0530",
            "locations": [
              {
                "status": 0,
                "last_polled_time": "2015-07-21T16:35:36+0530",
                "attribute_value": "-",
                "location_name": "California - US"
              }
            ],
            "attribute_label": "Response Time",
            "monitor_type": "URL",
            "unit": "ms",
            "attribute_value": "-",
            "monitor_id": "355000002424041"
          }
        ],
        "group_id": "355000002275032",
        "group_name": "group1"
      }
    ]
  }
}

Retrieve a comprehensive location based-report, which details various current parameters like status (up/down/trouble), performance, poll duration, poll frequency etc. of all your configured monitors.

Query Parameters

Param Type Description Default
group_required boolean Describes whether to send monitor groups or not. true
apm_required boolean Provides current status of apm monitors along with other monitors. false
suspended_required boolean Provides suspended monitors list along with the current status of other monitors. false

Response Attributes

Attribute Type Description
name string Name of the monitor.
monitor_id string Unique ID of the monitor. Use retrieve monitor API to get the details of this monitor.
monitor_type string Type of the monitor.
status int Status of a monitor.
last_polled_time string Last polled time for monitor in ISO format.
attribute_label string Name of the report attribute.
attribute_key string API key for the report attribute.
attribute_value string Value of the report attribute.
unit string Unit for the report attribute.
outage_id string Unique ID of the outage.
downtime_millis string Downtime in milliseconds.
down_reason string Reason for which the monitor is down or in trouble.
duration string Duration for which the monitor is down or in trouble.
server_type string Applicable for server monitor where it tells the type of server monitor (Windows or Linux).
group_id string Unique ID of the monitor group.
group_name string Name of monitor group.
plugin_info json Plugin details
JSON Format: {PLUGIN_NAME: “$plugin_name”, CONFXML_KEY: “$confxml_key”, LOCID:“$location_id”, VERSION:“$version”, HEARTBEAT:true/false}
parent_info json JSON Format: {serverid: “$server_id”, url: “$confxml_key”, name:“$location_id”, type:“$monitor_type”}
locations JSON array Location based current status.
JSON Format: {status:“$status”, last_polled_time:“$last_polled_time”, attribute_value:“$attribute_value”, location_name:“$location_name”}

Current Status of Monitor

GET /current_status/{monitor_id}

Request Example

$ curl https://www.site24x7.com/api/current_status/355000002275036 \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-authtoken a12345b6c8de901f2gh3456ij78k901l"

Response Example

{
    "code": 0,
    "message": "success",
    "data": {
        "name": "Monitor_current status",
        "attribute_key": "response_time",
        "status": 1,
        "last_polled_time": "2015-07-21T15:16:17+0530",
        "locations": [
            {
                "status": 1,
                "last_polled_time": "2015-07-21T15:16:17+0530",
                "attribute_value": 4,
                "location_name": "New Jersey - US"
            }
        ],
        "monitor_type": "URL",
        "attribute_label": "Response Time",
        "attribute_value": 4,
        "unit": "ms",
        "monitor_id": "355000002275036"
    }
}

Retrieve the overall and location based real time status of your selected monitor by initiating a “current_status/{monitor_id}” GET API call. The “monitor_id” is a mandatory attribute. Execute a “monitors” GET API call to retrieve your relevant “monitor_id” from its JSON response.

Path Parameters

Param Type Description
monitor_id string Mandatory
Unique ID of the monitor.
You can find monitor_id using the monitor list api.

Response Attributes

Attribute Type Description
name string Name of the monitor.
monitor_id string Unique ID of the monitor. Use retrieve monitor API to get the details of this monitor.
monitor_type string Type of the monitor.
status int Status of a monitor.
last_polled_time string Last polled time for monitor in ISO format.
attribute_label string Name of the report attribute.
attribute_key string API key for the report attribute.
attribute_value string Value of the report attribute.
unit string Unit for the report attribute.
outage_id string Unique ID of the outage.
downtime_millis string Downtime in milliseconds.
down_reason string Reason for which the monitor is down or in trouble.
duration string Duration for which the monitor is down or in trouble.
server_type string Applicable for server monitor where it tells the type of server monitor (Windows or Linux).
plugin_info json Plugin details
JSON Format: {PLUGIN_NAME: “$plugin_name”, CONFXML_KEY: “$confxml_key”, LOCID:“$location_id”, VERSION:“$version”, HEARTBEAT:true/false}
parent_info json JSON Format: {serverid: “$server_id”, url: “$confxml_key”, name:“$location_id”, type:“$monitor_type”}
locations JSON array Location based current status.
JSON Format: {status:“$status”, last_polled_time:“$last_polled_time”, attribute_value:“$attribute_value”, location_name:“$location_name”}

Current Status of Monitor Group

GET /current_status/group/{group_id}

Request Example

$ curl https://www.site24x7.com/api/current_status/group/355000002275032 \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-authtoken a12345b6c8de901f2gh3456ij78k901l"

Response Example

{
  "code": 0,
  "message": "success",
  "data": {
    "status": 0,
    "monitors": [
      {
        "name": "Monitor one",
        "down_reason": "SSL Connection Error",
        "duration": "5 days 22 Hrs 16 Mins ",
        "attribute_key": "response_time",
        "status": 0,
        "last_polled_time": "2015-07-21T15:26:32+0530",
        "locations": [
          {
            "status": 0,
            "last_polled_time": "2015-07-21T15:26:32+0530",
            "attribute_value": "-",
            "location_name": "California - US"
          }
        ],
        "attribute_label": "Response Time",
        "monitor_type": "URL",
        "unit": "ms",
        "attribute_value": "-",
        "monitor_id": "355000002424041"
      }
    ],
    "group_id": "355000002275032",
    "group_name": "Group_monitor1"
  }
}

Retrieve the overall and location based real time status of your monitor group by initiating a “current_status/group/{group_id}” GET API call. The “group_id” is a mandatory attribute. Execute a “monitor_groups” GET API call to extract your relevant “group_id” from its corresponding JSON response.

Path Parameters

Param Type Description
group_id string Mandatory
Unique ID of the monitor group.
You can find group_id using the monitor group list api.

Response Attributes

Attribute Type Description
name string Name of the monitor.
monitor_id string Unique ID of the monitor. Use retrieve monitor API to get the details of this monitor.
monitor_type string Type of the monitor.
status int Status of a group. ‘status’ inside the ‘monitors’ JSON array is monitor status.
last_polled_time string Last polled time for monitor in ISO format.
attribute_label string Name of the report attribute.
attribute_key string API key for the report attribute.
attribute_value string Value of the report attribute.
unit string Unit for the report attribute.
outage_id string Unique ID of the outage.
downtime_millis string Downtime in milliseconds.
down_reason string Reason for which the monitor is down or in trouble.
duration string Duration for which the monitor is down or in trouble.
server_type string Applicable for server monitor where it tells the type of server monitor (Windows or Linux).
group_id string Unique ID of the monitor group.
group_name string Name of monitor group.
plugin_info json Plugin details
JSON Format: {PLUGIN_NAME: “$plugin_name”, CONFXML_KEY: “$confxml_key”, LOCID:“$location_id”, VERSION:“$version”, HEARTBEAT:true/false}
parent_info json JSON Format: {serverid: “$server_id”, url: “$confxml_key”, name:“$location_id”, type:“$monitor_type”}
locations JSON array Location based current status.
JSON Format: {status:“$status”, last_polled_time:“$last_polled_time”, attribute_value:“$attribute_value”, location_name:“$location_name”}

Current Status by Monitor Type

GET /current_status/type/{monitor_type}

Request Example

$ curl https://www.site24x7.com/api/current_status/type/DNS \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-authtoken a12345b6c8de901f2gh3456ij78k901l"

Response Example

{
  "code": 0,
  "message": "success",
  "data": {
    "monitors": [
      {
        "status": 1,
        "attributes": [
          {
            "attribute_label": "global.responsetime",
            "attribute_key": "response_time",
            "attribute_value": "-"
          }
        ],
        "name": "DNS",
        "down_reason": "Network error",
        "serverinfo": "site24x7.com",
        "monitor_type": "DNS",
        "last_polled_time": "2016-04-08T20:38:42+0530",
        "monitor_id": "113770000000191032"
      },
      {
        "status": 1,
        "attributes": [
          {
            "attribute_label": "global.responsetime",
            "attribute_key": "response_time",
            "attribute_value": "-"
          }
        ],
        "name": "testdns",
        "serverinfo": "site24x7.com",
        "monitor_type": "DNS",
        "last_polled_time": "2016-04-14T22:19:34+0530",
        "monitor_id": "113770000010290043"
      }
    ]
  }
}

Retrieve the overall and location based real time status of a particular monitor type. The “monitor_type” is a mandatory attribute.

Path Parameters

Param Type Description
monitor_type string Mandatory
Type of the monitor.

Response Attributes

Attribute Type Description
name string Name of the monitor.
monitor_id string Unique ID of the monitor. Use retrieve monitor API to get the details of this monitor.
monitor_type string Type of the monitor.
status int Status of a monitor.
last_polled_time string Last polled time for monitor in ISO format.
attribute_label string Name of the report attribute.
attribute_key string API key for the report attribute.
attribute_value string Value of the report attribute.
unit string Unit for the report attribute.
outage_id string Unique ID of the outage.
downtime_millis string Downtime in milliseconds.
down_reason string Reason for which the monitor is down or in trouble.
duration string Duration for which the monitor is down or in trouble.
server_type string Applicable for server monitor where it tells the type of server monitor (Windows or Linux).
plugin_info json Plugin details
JSON Format: {PLUGIN_NAME: “$plugin_name”, CONFXML_KEY: “$confxml_key”, LOCID:“$location_id”, VERSION:“$version”, HEARTBEAT:true/false}
parent_info json JSON Format: {serverid: “$server_id”, url: “$confxml_key”, name:“$location_id”, type:“$monitor_type”}
locations JSON array Location based current status.
JSON Format: {status:“$status”, last_polled_time:“$last_polled_time”, attribute_value:“$attribute_value”, location_name:“$location_name”}

Retrieve Monitor Count Based on Status

GET /monitors/status/count

Request Example

$ curl https://www.site24x7.com/api/monitors/status/count \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-authtoken a12345b6c8de901f2gh3456ij78k901l"

Response Example

{
    "code": 0,
    "message": "success",
    "data": {
        "down": {
            "count": 4,
            "status_name": "Down",
            "status": 0
        },
        "up": {
            "count": 10,
            "status_name": "Up",
            "status": 1
        },
        "trouble": {
            "count": 2,
            "status_name": "Trouble",
            "status": 2
        },
        "suspended": {
            "count": 7,
            "status_name": "Suspended",
            "status": 5
        },
        "maintenance": {
            "count": 0,
            "status_name": "Maintenance",
            "status": 7
        },
        "discovery": {
            "count": 50,
            "status_name": "Discovery",
            "status": 9
        },
        "configuration_error": {
            "count": 0,
            "status_name": "Configuration Error",
            "status": 10
        },
        "total": {
            "count": 73,
            "status_name": "Total"
        }
    }
}

Retrieve the count of monitors based on individual monitor status.

Response Attributes

Attribute Type Description
down json Details about Down status.
JSON Format: {count:$count, status:$status, status_name:“$status_name”}
up json Details about Up status.
JSON Format: {count:$count, status:$status, status_name:“$status_name”}
trouble json Details about Trouble status.
JSON Format: {count:$count, status:$status, status_name:“$status_name”}
suspended json Details about Suspended status.
JSON Format: {count:$count, status:$status, status_name:“$status_name”}
maintenance json Details about Maintenance status.
JSON Format: {count:$count, status:$status, status_name:“$status_name”}
discovery json Details about Discovery status.
JSON Format: {count:$count, status:$status, status_name:“$status_name”}
configuration_error json Details about Configuration Error status.
JSON Format: {count:$count, status:$status, status_name:“$status_name”}
total json Total monitor count.
JSON Format: {count:$count, status_name:“Total”}

JSON Format

Attribute Type Description
status int Status of monitors.
status_name string Name of the corresponding monitor status.
count int Number of monitors in the corresponding status.

Retrieve Monitor Count Based on Status in a Monitor Group

GET /monitor_groups/status/count/{group_id}

Request Example

$ curl https://www.site24x7.com/api/monitor_groups/status/count/19000000063006 \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-authtoken a12345b6c8de901f2gh3456ij78k901l"

Response Example

{
    "code": 0,
    "message": "success",
    "data": {
        "group_id": "19000000063006",
        "group_name": "Group 1",
        "down": {
            "count": 3,
            "status_name": "Down",
            "status": 0
        },
        "up": {
            "count": 7,
            "status_name": "Up",
            "status": 1
        },
        "trouble": {
            "count": 0,
            "status_name": "Trouble",
            "status": 2
        },
        "suspended": {
            "count": 0,
            "status_name": "Suspended",
            "status": 5
        },
        "maintenance": {
            "count": 0,
            "status_name": "Maintenance",
            "status": 7
        },
        "discovery": {
            "count": 2,
            "status_name": "Discovery",
            "status": 9
        },
        "configuration_error": {
            "count": 0,
            "status_name": "Configuration Error",
            "status": 10
        },
        "total": {
            "count": 12,
            "status_name": "Total"
        }
    }
}

Retrieve the count of monitors based on individual monitor status in a Monitor Group. The “group_id” is a mandatory attribute. Execute a “monitor_groups” GET API call to extract your relevant “group_id” from its corresponding JSON response.

Path Parameters

Param Type Description
group_id string Mandatory
Unique ID of the monitor group.
You can find group_id using the monitor group list API.

Response Attributes

Attribute Type Description
group_id string Unique ID of monitor group.
group_name string Name of the monitor group.
down json Details about Down status.
JSON Format: {count:$count, status:$status, status_name:“$status_name”}
up json Details about Up status.
JSON Format: {count:$count, status:$status, status_name:“$status_name”}
trouble json Details about Trouble status.
JSON Format: {count:$count, status:$status, status_name:“$status_name”}
suspended json Details about Suspended status.
JSON Format: {count:$count, status:$status, status_name:“$status_name”}
maintenance json Details about Maintenance status.
JSON Format: {count:$count, status:$status, status_name:“$status_name”}
discovery json Details about Discovery status.
JSON Format: {count:$count, status:$status, status_name:“$status_name”}
configuration_error json Details about Configuration Error status.
JSON Format: {count:$count, status:$status, status_name:“$status_name”}
total json Total monitor count.
JSON Format: {count:$count, status_name:“Total”}

JSON Format

Attribute Type Description
status int Status of monitors.
status_name string Name of the corresponding monitor status.
count int Number of monitors in the corresponding status.

Retrieve Monitor Status Count grouped by Monitor Type

GET /monitor_types/status/count

Request Example

$ curl https://www.site24x7.com/api/monitor_types/status/count \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-authtoken a12345b6c8de901f2gh3456ij78k901l"

Response Example

{
  "code": 0,
  "message": "success",
  "data": [
    {
      "monitor_type": "URL",
      "status": 0,
      "monitor_type_name": "Website",
      "status_name": "Down",
      "down": {
        "count": 9,
        "status_name": "Down",
        "status": 0
      },
      "up": {
        "count": 119,
        "status_name": "Up",
        "status": 1
      },
      "trouble": {
        "count": 6,
        "status_name": "Trouble",
        "status": 2
      },
      "suspended": {
        "count": 0,
        "status_name": "Suspended",
        "status": 5
      },
      "maintenance": {
        "count": 0,
        "status_name": "Maintenance",
        "status": 7
      },
      "discovery": {
        "count": 0,
        "status_name": "Discovery",
        "status": 9
      },
      "configuration_error": {
        "count": 0,
        "status_name": "Configuration Error",
        "status": 10
      },
      "total": {
        "count": 134,
        "status_name": "Total"
      }
    },
    {
      "monitor_type": "SERVER",
      "monitor_type_name": "Server Monitor",
      "status_name": "Up",
      "status": 1,
      "down": {
        "count": 0,
        "status_name": "Down",
        "status": 0
      },
      "up": {
        "count": 0,
        "status_name": "Up",
        "status": 1
      },
      "trouble": {
        "count": 0,
        "status_name": "Trouble",
        "status": 2
      },
      "suspended": {
        "count": 0,
        "status_name": "Suspended",
        "status": 5
      },
      "maintenance": {
        "count": 1,
        "status_name": "Maintenance",
        "status": 7
      },
      "discovery": {
        "count": 0,
        "status_name": "Discovery",
        "status": 9
      },
      "configuration_error": {
        "count": 0,
        "status_name": "Configuration Error",
        "status": 10
      },
      "total": {
        "count": 1,
        "status_name": "Total"
      }
    }
  ]
}

Retrieve the count of monitors based on their operational status grouped by monitor type.

Response Attributes

Attribute Type Description
monitor_type string Type of the monitor.
monitor_type_name string Name of the monitor type.
status int Overall Status of monitors belonging to a specific monitor type.
status_name string Name of the corresponding monitor type’s status.
down json Details about Down status.
JSON Format: {count:$count, status:$status, status_name:“$status_name”}
up json Details about Up status.
JSON Format: {count:$count, status:$status, status_name:“$status_name”}
trouble json Details about Trouble status.
JSON Format: {count:$count, status:$status, status_name:“$status_name”}
suspended json Details about Suspended status.
JSON Format: {count:$count, status:$status, status_name:“$status_name”}
maintenance json Details about Maintenance status.
JSON Format: {count:$count, status:$status, status_name:“$status_name”}
discovery json Details about Discovery status.
JSON Format: {count:$count, status:$status, status_name:“$status_name”}
configuration_error json Details about Configuration Error status.
JSON Format: {count:$count, status:$status, status_name:“$status_name”}
total json Total monitor count.
JSON Format: {count:$count, status_name:“Total”}

JSON Format

Attribute Type Description
status int Status of monitors.
status_name string Name of the corresponding monitor’s status.
count int Number of monitors in the corresponding status.

Summary Reports

Obtain the overall availability and performance data of your monitors for a give time period.

Summary by monitor

GET /reports/summary/{monitor_id}?period={report_period_constants}

Request Example

$ curl "https://www.site24x7.com/api/reports/summary/113770000025720011?period=4&unit_of_time=1" \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-authtoken a12345b6c8de901f2gh3456ij78k901l"

Response Example

{
  "code": 0,
  "message": "success",
  "data": {
    "performance_details": [
      {
        "attribute_name": "RESPONSETIME",
        "attribute_value": 1036
      }
    ],
    "summary_details": {
      "down_count": 0,
      "downtime_duration": "0 Mins 0 Secs",
      "availability_percentage": 100,
      "mtbf": "0 Mins 0 Secs",
      "unmanaged_duration": "0 Mins 0 Secs",
      "alarm_count": 0,
      "mttr": "0 Mins 0 Secs",
      "maintenance_percentage": 0,
      "maintenance_duration": "0 Mins 0 Secs",
      "availability_duration": "1 days 0 Hrs 0 Mins ",
      "unmanaged_percentage": 0,
      "downtime_percentage": 0
    },
    "info": {
      "resource_name": "custom period reports",
      "end_time": "2016-08-22T00:00:00+0530",
      "resource_type_name": "Monitor",
      "report_name": "Summary Report",
      "period_name": "Yesterday",
      "formatted_start_time": "August 21, 2016 12:00 AM IST",
      "formatted_end_time": "August 22, 2016 12:00 AM IST",
      "generated_time": "2016-08-22T15:08:56+0530",
      "segment_type": 1,
      "start_time": "2016-08-21T00:00:00+0530",
      "resource_type": 2,
      "period": 4,
      "formatted_generated_time": "August 22, 2016 3:08 PM IST",
      "resource_id": "113770000025720011",
      "monitor_type": "URL",
      "report_type": 17,
      "segment_type_name": "Hour of Day"
    }
  }
}

Get the overall summary details of a particular monitor over the specified period of time.

Path Parameters

Param Type Description
monitor_id string Mandatory
Unique ID of the monitor

Query Parameters

Param Type Description
period int Mandatory
Availability and performance details are generated within this predefined interval.
unit_of_time int The granularity of the report to be generated.
start_date string Mandatory, if period chosen is Custom.Start date for a custom period. Outage details report is generated from this date.
Format - yyyy-mm-dd
end_date string Mandatory, if period chosen is Custom.End date for a custom period. Outage details report is generated until this date.
Format - yyyy-mm-dd
business_hours_id int The predefined business hours during which critical outage details reports are generated.

Response Attributes

Attribute Type Description
performance_details JSON array Contains monitor type’s primary attribute name and value.
summary_details json The overall summary details of the monitor for the specified period.
outage_id string Unique ID of the outage
start_time string Outage start time.
end_time string Outage end time.
type int Type of outage.
duration string The total outage duration.
display_name string Name of the monitor for which the outage occured.
monitor_id string Unique ID of the monitor. Use retrieve monitor API to get the details of this monitor.

Summary by monitor group

GET /reports/summary/group/{group_id}?period={report_period_constants}

Request Example

$ curl "https://www.site24x7.com/api/reports/summary/group/113770000026704011?period=3&unit_of_time=1" \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-authtoken a12345b6c8de901f2gh3456ij78k901l"

Response Example

{
  "code": 0,
  "message": "success",
  "data": {
    "performance_details": {
      "REALBROWSER": {
        "name": [
          "RBM_TD3"
        ],
        "attribute_data": [
          {
            "0": {
              "RESPONSETIME": 4210
            }
          }
        ],
        "availability": [
          "100.0"
        ]
      },
      "RDSINSTANCE": {
        "name": [
          "yyyyyy"
        ],
        "attribute_data": [
          {
            "0": {
              "CPUUTILIZATION": "-"
            }
          }
        ],
        "availability": [
          "0.0"
        ]
      },
      "EC2INSTANCE": {
        "name": [
          "i-01f6bfa2",
          "i-1e9ed6bd",
          "i-2f0a438c",
          "i-4dbf04ee",
          "i-bf642f1c",
          "i-ca0eb43d"
        ],
        "attribute_data": [
          {
            "0": {
              "CPUUTILIZATION": "-"
            }
          },
          {
            "0": {
              "CPUUTILIZATION": "-"
            }
          },
          {
            "0": {
              "CPUUTILIZATION": "-"
            }
          },
          {
            "0": {
              "CPUUTILIZATION": "-"
            }
          },
          {
            "0": {
              "CPUUTILIZATION": "-"
            }
          },
          {
            "0": {
              "CPUUTILIZATION": "-"
            }
          }
        ],
        "availability": [
          "100.0",
          "0.0",
          "100.0",
          "0.0",
          "0.0",
          "0.0"
        ]
      },
      "FTP": {
        "name": [
          "FTPRTT_TD3"
        ],
        "attribute_data": [
          {
            "0": {
              "RESPONSETIME": 40
            }
          }
        ],
        "availability": [
          "99.32"
        ]
      },
      "VMWAREVM": {
        "name": [
          "New Virtual Machine"
        ],
        "attribute_data": [
          {
            "0": {
              "AVGCPUUTIL": "-"
            }
          }
        ],
        "availability": [
          "0.0"
        ]
      },
      "SERVER": {
        "name": [
          "localhost",
          "site24x7-win2012.site24x7.com"
        ],
        "attribute_data": [
          {
            "0": {
              "CPUUSEDPERCENT": "-"
            }
          },
          {
            "0": {
              "CPUUSEDPERCENT": "-"
            }
          }
        ],
        "availability": [
          "1.14",
          "1.14"
        ]
      },
      "IISSERVER": {
        "name": [
          "site24x7-win7-IIS- Don't delete"
        ],
        "attribute_data": [
          {
            "0": {
              "NWTRAFFIC": 0
            }
          }
        ],
        "availability": [
          "98.99"
        ]
      }
    },
    "summary_details": {
      "down_count": 12,
      "downtime_duration": "5 days 0 Hrs 49 Mins ",
      "availability_percentage": 50.04,
      "mtbf": "10 Hrs 7 Mins ",
      "unmanaged_duration": "1 days 6 Hrs 21 Mins ",
      "alarm_count": 12,
      "mttr": "10 Hrs 4 Mins ",
      "maintenance_percentage": 0.19,
      "maintenance_duration": "27 Mins 28 Secs",
      "availability_duration": "5 days 1 Hrs 28 Mins ",
      "unmanaged_percentage": 12.5,
      "downtime_percentage": 49.77
    },
    "info": {
      "resource_name": "Amazon Instance",
      "end_time": "2016-08-23T00:00:00+0530",
      "resource_type_name": "Group",
      "report_name": "Summary Report",
      "period_name": "Today",
      "formatted_start_time": "August 22, 2016 12:00 AM IST",
      "formatted_end_time": "August 23, 2016 12:00 AM IST",
      "generated_time": "2016-08-22T15:10:21+0530",
      "segment_type": 1,
      "start_time": "2016-08-22T00:00:00+0530",
      "resource_type": 1,
      "period": 3,
      "formatted_generated_time": "August 22, 2016 3:10 PM IST",
      "resource_id": "113770000026704011",
      "monitor_type": "",
      "report_type": 17,
      "segment_type_name": "Hour of Day"
    }
  }
}

Get the overall summary and performance details of a particular monitor group for a specified period of time.

Path Parameters

Param Type Description
group_id int Mandatory
Unique ID of the monitor group.
You can find group_id using the monitor group list api.

Query Parameters

Param Type Description
period int Mandatory
Availability and performance details are generated within this predefined interval.
unit_of_time int The granularity of the report to be generated.
start_date string Mandatory, if period chosen is Custom.Start date for a custom period. Outage details report is generated from this date.
Format - yyyy-mm-dd
end_date string Mandatory, if period chosen is Custom.End date for a custom period. Outage details report is generated until this date.
Format - yyyy-mm-dd
business_hours_id int The predefined business hours during which critical outage details reports are generated.

Response Attributes

Attribute Type Description
performance_details JSON array Contains monitor type’s primary attribute name and value.
summary_details json The overall summary details of the monitor for the specified period.
outage_id string Unique ID of the outage
start_time string Outage start time.
end_time string Outage end time.
type int Type of outage.
duration string The total outage duration.
display_name string Name of the monitor for which the outage occured.
monitor_id string Unique ID of the monitor. Use retrieve monitor API to get the details of this monitor.

Summary by monitor type

GET /reports/summary/type/{monitor_type}?period={report_period_constants}

Request Example

$ curl "https://www.site24x7.com/api/reports/summary/type/PING?period=3&unit_of_time=2" \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-authtoken a12345b6c8de901f2gh3456ij78k901l"

Response Example

{
  "code": 0,
  "message": "success",
  "data": {
    "performance_details": {
      "PING": {
        "name": [
          "Ping 1",
          "Ping Single location",
          "PING_PROBEprobe10aprpre"
        ],
        "attribute_data": [
          {
            "0": {
              "RESPONSETIME": 112
            }
          },
          {
            "0": {
              "RESPONSETIME": 0
            }
          },
          {
            "0": {
              "RESPONSETIME": 0
            }
          }
        ],
        "availability": [
          "100.0",
          "100.0",
          "100.0"
        ]
      }
    },
    "summary_details": {
      "down_count": 0,
      "downtime_duration": "0 Mins 0 Secs",
      "availability_percentage": 100,
      "mtbf": "1 days 21 Hrs 43 Mins ",
      "unmanaged_duration": "0 Mins 0 Secs",
      "alarm_count": 0,
      "mttr": "0 Mins 0 Secs",
      "maintenance_percentage": 0,
      "maintenance_duration": "0 Mins 0 Secs",
      "availability_duration": "1 days 21 Hrs 43 Mins ",
      "unmanaged_percentage": 0,
      "downtime_percentage": 0
    },
    "info": {
      "resource_name": "Ping Monitor",
      "end_time": "2016-08-23T00:00:00+0530",
      "resource_type_name": "All Monitors",
      "report_name": "Summary Report",
      "period_name": "Today",
      "formatted_start_time": "August 22, 2016 12:00 AM IST",
      "generated_time": "2016-08-22T15:14:22+0530",
      "formatted_end_time": "August 23, 2016 12:00 AM IST",
      "segment_type": 2,
      "start_time": "2016-08-22T00:00:00+0530",
      "resource_type": 0,
      "period": 3,
      "formatted_generated_time": "August 22, 2016 3:14 PM IST",
      "monitor_type": "PING",
      "report_type": 17,
      "segment_type_name": "Day of Week"
    }
  }
}

Get the overall summary and performance details of all the monitors of a particular type for the specified period of time.

Path Parameters

Param Type Description
monitor_type string Mandatory
Type of the monitor.

Query Parameters

Param Type Description
period int Mandatory
Availability and performance details are generated within this predefined interval.
unit_of_time int The granularity of the report to be generated.
start_date string Mandatory, if period chosen is Custom.Start date for a custom period. Outage details report is generated from this date.
Format - yyyy-mm-dd
end_date string Mandatory, if period chosen is Custom.End date for a custom period. Outage details report is generated until this date.
Format - yyyy-mm-dd
business_hours_id int The predefined business hours during which critical outage details reports are generated.

Response Attributes

Attribute Type Description
performance_details JSON array Contains monitor type’s primary attribute name and value.
summary_details json The overall summary details of the monitor for the specified period.
outage_id string Unique ID of the outage
start_time string Outage start time.
end_time string Outage end time.
type int Type of outage.
duration string The total outage duration.
display_name string Name of the monitor for which the outage occured.
monitor_id string Unique ID of the monitor. Use retrieve monitor API to get the details of this monitor.

Summary for all monitors

GET /reports/summary?period={report_period_constants}

Request Example

$ curl https://www.site24x7.com/api/reports/summary?period=3 \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-authtoken a12345b6c8de901f2gh3456ij78k901l"

Response Example

{
  "code": 0,
  "message": "success",
  "data": {
    "performance_details": {
      "EC2INSTANCE": {
        "name": [
          "i-01f6bfa2",
          "i-1e9ed6bd",
          "i-2f0a438c",
          "i-4dbf04ee",
          "i-bf642f1c",
          "i-ca0eb43d"
        ],
        "attribute_data": [
          {
            "0": {
              "NETWORKIN": "-",
              "DISKREADOPS": "-",
              "CPUCREDITUSAGE": "-",
              "CPUUTILIZATION": "-"
            }
          },
          {
            "0": {
              "NETWORKIN": "-",
              "DISKREADOPS": "-",
              "CPUCREDITUSAGE": "-",
              "CPUUTILIZATION": "-"
            }
          },
          {
            "0": {
              "NETWORKIN": "-",
              "DISKREADOPS": "-",
              "CPUCREDITUSAGE": "-",
              "CPUUTILIZATION": "-"
            }
          },
          {
            "0": {
              "NETWORKIN": "-",
              "DISKREADOPS": "-",
              "CPUCREDITUSAGE": "-",
              "CPUUTILIZATION": "-"
            }
          },
          {
            "0": {
              "NETWORKIN": "-",
              "DISKREADOPS": "-",
              "CPUCREDITUSAGE": "-",
              "CPUUTILIZATION": "-"
            }
          },
          {
            "0": {
              "NETWORKIN": "-",
              "DISKREADOPS": "-",
              "CPUCREDITUSAGE": "-",
              "CPUUTILIZATION": "-"
            }
          }
        ],
        "availability": [
          "100.0",
          "0.0",
          "100.0",
          "0.0",
          "0.0",
          "0.0"
        ]
      },
      "SQLSERVER": {
        "name": [
          "site24x7-win2012.site24x7.com-ADK",
          "site24x7-win2012.site24x7.com-SQLEXPRESS",
          "site24x7-win7-SQLEXPRESS -don't delete"
        ],
        "attribute_data": [
          {
            "0": {
              "PLANCACHEHIT": "-",
              "BATCHREQ": "-",
              "BUFCACHEHIT": "-",
              "TOTSERVERMEM": "-",
              "USERCONNECTIONS": "-",
              "SUCCESSJOBRATE": "-"
            }
          },
          {
            "0": {
              "PLANCACHEHIT": "-",
              "BATCHREQ": "-",
              "BUFCACHEHIT": "-",
              "TOTSERVERMEM": "-",
              "USERCONNECTIONS": "-",
              "SUCCESSJOBRATE": "-"
            }
          },
          {
            "0": {
              "PLANCACHEHIT": "-",
              "BATCHREQ": "-",
              "BUFCACHEHIT": "-",
              "TOTSERVERMEM": "-",
              "USERCONNECTIONS": "-",
              "SUCCESSJOBRATE": "-"
            }
          }
        ],
        "availability": [
          "1.14",
          "1.14",
          "0.76"
        ]
      },
      "SERVER": {
        "name": [
          "Don't upgrade this server yamini-0511.csez.zohocorpin.com",
          "localhost",
          "opman-f13-64-2",
          "s24x7-w2k8r2.site24x7.com",
          "Server Monitor",
          "Server-PC - TD3",
          "site24x7-cent6-64-1.csez.zohocorpin.com",
          "site24x7-w7-32 - TD1",
          "site24x7-w7-64.site24x7.com",
          "site24x7-win2012.site24x7.com",
          "site24x7-win7 - don't down"
        ],
        "attribute_data": [
          {
            "0": {
              "DISKUSEDPERCENT": "-",
              "MEMUSEDPERCENT": "-",
              "CPUUSEDPERCENT": "-"
            }
          },
          {
            "0": {
              "DISKUSEDPERCENT": "-",
              "MEMUSEDPERCENT": "-",
              "CPUUSEDPERCENT": "-"
            }
          },
          {
            "0": {
              "DISKUSEDPERCENT": "-",
              "MEMUSEDPERCENT": "-",
              "CPUUSEDPERCENT": "-"
            }
          },
          {
            "0": {
              "DISKUSEDPERCENT": "-",
              "MEMUSEDPERCENT": "-",
              "CPUUSEDPERCENT": "-"
            }
          },
          {
            "0": {
              "DISKUSEDPERCENT": 11,
              "MEMUSEDPERCENT": 28.05,
              "CPUUSEDPERCENT": 9.26
            }
          },
          {
            "0": {
              "DISKUSEDPERCENT": "-",
              "MEMUSEDPERCENT": "-",
              "CPUUSEDPERCENT": "-"
            }
          },
          {
            "0": {
              "DISKUSEDPERCENT": "-",
              "MEMUSEDPERCENT": "-",
              "CPUUSEDPERCENT": "-"
            }
          },
          {
            "0": {
              "DISKUSEDPERCENT": "-",
              "MEMUSEDPERCENT": "-",
              "CPUUSEDPERCENT": "-"
            }
          },
          {
            "0": {
              "DISKUSEDPERCENT": "-",
              "MEMUSEDPERCENT": "-",
              "CPUUSEDPERCENT": "-"
            }
          },
          {
            "0": {
              "DISKUSEDPERCENT": "-",
              "MEMUSEDPERCENT": "-",
              "CPUUSEDPERCENT": "-"
            }
          },
          {
            "0": {
              "DISKUSEDPERCENT": 51,
              "MEMUSEDPERCENT": 68.68,
              "CPUUSEDPERCENT": 8.31
            }
          }
        ],
        "availability": [
          "100.0",
          "1.13",
          "1.13",
          "1.13",
          "36.59",
          "1.13",
          "1.14",
          "1.13",
          "1.13",
          "1.14",
          "99.0"
        ]
      },
      "NETWORKDEVICE": {
        "name": [
          "CiscoRouter.melab.net - updated",
          "MEJuniper4200",
          "MEJuniper4200_apr19",
          "SSH@Mlfoundry624"
        ],
        "attribute_data": [
          {
            "0": {
              "RESPONSETIME": "-"
            }
          },
          {
            "0": {
              "RESPONSETIME": "-"
            }
          },
          {
            "0": {
              "RESPONSETIME": "-"
            }
          },
          {
            "0": {
              "RESPONSETIME": "-"
            }
          }
        ],
        "availability": [
          "100.0",
          "100.0",
          "100.0",
          "100.0"
        ]
      },
      "APM-Insight-Application": {
        "name": [
          "My Application"
        ],
        "attribute_data": [
          {
            "0": {
              "RESPONSETIME": "-"
            }
          }
        ],
        "availability": [
          "100.0"
        ]
      },
      "VMWAREVM": {
        "name": [
          "Amazon-EC2-VM-Import-Connector-1.2.0",
          "athavan-Device42",
          "demo",
          "ela1",
          "ela7",
          "Jagan",
          "New Virtual Machine",
          "NithyaVM",
          "Opm1",
          "OpmNfaMs1",
          "OPMUnified",
          "raamesh-m11-64-2",
          "raamesh-u12-64-1 (1)",
          "RaamUClone'14",
          "RajaVM_Rename",
          "sprasad-u12",
          "sprasad-w7",
          "SubPoolVM",
          "TD 3 light'20-'14",
          "TD1 - Kunal-w2k8-1 ",
          "TD2 - UCS Test1",
          "Test247",
          "test3",
          "test5",
          "TestSite24x7",
          "TestSite24x7",
          "TestSite24x7",
          "UCS Central",
          "UCS Platform Emulator",
          "UCS Test2",
          "UCS Test3_M10",
          "vf vf vf"
        ],
        "attribute_data": [
          {
            "0": {
              "MEMUTIL": "-",
              "AVGCPUUTIL": "-",
              "DISKUTIL": "-"
            }
          },
          {
            "0": {
              "MEMUTIL": "-",
              "AVGCPUUTIL": "-",
              "DISKUTIL": "-"
            }
          },
          {
            "0": {
              "MEMUTIL": "-",
              "AVGCPUUTIL": "-",
              "DISKUTIL": "-"
            }
          },
          {
            "0": {
              "MEMUTIL": "-",
              "AVGCPUUTIL": "-",
              "DISKUTIL": "-"
            }
          },
          {
            "0": {
              "MEMUTIL": "-",
              "AVGCPUUTIL": "-",
              "DISKUTIL": "-"
            }
          },
          {
            "0": {
              "MEMUTIL": "-",
              "AVGCPUUTIL": "-",
              "DISKUTIL": "-"
            }
          },
          {
            "0": {
              "MEMUTIL": "-",
              "AVGCPUUTIL": "-",
              "DISKUTIL": "-"
            }
          },
          {
            "0": {
              "MEMUTIL": "-",
              "AVGCPUUTIL": "-",
              "DISKUTIL": "-"
            }
          },
          {
            "0": {
              "MEMUTIL": "-",
              "AVGCPUUTIL": "-",
              "DISKUTIL": "-"
            }
          },
          {
            "0": {
              "MEMUTIL": "-",
              "AVGCPUUTIL": "-",
              "DISKUTIL": "-"
            }
          },
          {
            "0": {
              "MEMUTIL": "-",
              "AVGCPUUTIL": "-",
              "DISKUTIL": "-"
            }
          },
          {
            "0": {
              "MEMUTIL": "-",
              "AVGCPUUTIL": "-",
              "DISKUTIL": "-"
            }
          },
          {
            "0": {
              "MEMUTIL": "-",
              "AVGCPUUTIL": "-",
              "DISKUTIL": "-"
            }
          },
          {
            "0": {
              "MEMUTIL": "-",
              "AVGCPUUTIL": "-",
              "DISKUTIL": "-"
            }
          },
          {
            "0": {
              "MEMUTIL": "-",
              "AVGCPUUTIL": "-",
              "DISKUTIL": "-"
            }
          },
          {
            "0": {
              "MEMUTIL": "-",
              "AVGCPUUTIL": "-",
              "DISKUTIL": "-"
            }
          },
          {
            "0": {
              "MEMUTIL": "-",
              "AVGCPUUTIL": "-",
              "DISKUTIL": "-"
            }
          },
          {
            "0": {
              "MEMUTIL": "-",
              "AVGCPUUTIL": "-",
              "DISKUTIL": "-"
            }
          },
          {
            "0": {
              "MEMUTIL": "-",
              "AVGCPUUTIL": "-",
              "DISKUTIL": "-"
            }
          },
          {
            "0": {
              "MEMUTIL": "-",
              "AVGCPUUTIL": "-",
              "DISKUTIL": "-"
            }
          },
          {
            "0": {
              "MEMUTIL": "-",
              "AVGCPUUTIL": "-",
              "DISKUTIL": "-"
            }
          },
          {
            "0": {
              "MEMUTIL": "-",
              "AVGCPUUTIL": "-",
              "DISKUTIL": "-"
            }
          },
          {
            "0": {
              "MEMUTIL": "-",
              "AVGCPUUTIL": "-",
              "DISKUTIL": "-"
            }
          },
          {
            "0": {
              "MEMUTIL": "-",
              "AVGCPUUTIL": "-",
              "DISKUTIL": "-"
            }
          },
          {
            "0": {
              "MEMUTIL": "-",
              "AVGCPUUTIL": "-",
              "DISKUTIL": "-"
            }
          },
          {
            "0": {
              "MEMUTIL": "-",
              "AVGCPUUTIL": "-",
              "DISKUTIL": "-"
            }
          },
          {
            "0": {
              "MEMUTIL": "-",
              "AVGCPUUTIL": "-",
              "DISKUTIL": "-"
            }
          },
          {
            "0": {
              "MEMUTIL": "-",
              "AVGCPUUTIL": "-",
              "DISKUTIL": "-"
            }
          },
          {
            "0": {
              "MEMUTIL": "-",
              "AVGCPUUTIL": "-",
              "DISKUTIL": "-"
            }
          },
          {
            "0": {
              "MEMUTIL": "-",
              "AVGCPUUTIL": "-",
              "DISKUTIL": "-"
            }
          },
          {
            "0": {
              "MEMUTIL": "-",
              "AVGCPUUTIL": "-",
              "DISKUTIL": "-"
            }
          },
          {
            "0": {
              "MEMUTIL": "-",
              "AVGCPUUTIL": "-",
              "DISKUTIL": "-"
            }
          }
        ],
        "availability": [
          "0.0",
          "0.0",
          "0.0",
          "100.0",
          "0.0",
          "0.0",
          "0.0",
          "0.0",
          "0.0",
          "0.0",
          "0.0",
          "0.0",
          "0.0",
          "100.0",
          "0.0",
          "100.0",
          "0.0",
          "100.0",
          "0.0",
          "0.0",
          "0.0",
          "100.0",
          "0.0",
          "0.0",
          "0.0",
          "0.0",
          "0.0",
          "0.0",
          "0.0",
          "100.0",
          "0.0",
          "100.0"
        ]
      },
      "URL-SEQ": {
        "name": [
          "M10-sequence_cccc-Alert"
        ],
        "attribute_data": [
          {
            "0": {
              "RESPONSETIME": 109
            }
          }
        ],
        "availability": [
          "100.0"
        ]
      },
      "RDSINSTANCE": {
        "name": [
          "rds-test-1",
          "rdssss",
          "test-rds",
          "test-sep-rds",
          "testing",
          "testyesu",
          "ttttttt",
          "yyyyyy"
        ],
        "attribute_data": [
          {
            "0": {
              "DATABASECONNECTIONS": "-",
              "FREESTORAGE": "-",
              "CPUUTILIZATION": "-"
            }
          },
          {
            "0": {
              "DATABASECONNECTIONS": "-",
              "FREESTORAGE": "-",
              "CPUUTILIZATION": "-"
            }
          },
          {
            "0": {
              "DATABASECONNECTIONS": "-",
              "FREESTORAGE": "-",
              "CPUUTILIZATION": "-"
            }
          },
          {
            "0": {
              "DATABASECONNECTIONS": "-",
              "FREESTORAGE": "-",
              "CPUUTILIZATION": "-"
            }
          },
          {
            "0": {
              "DATABASECONNECTIONS": "-",
              "FREESTORAGE": "-",
              "CPUUTILIZATION": "-"
            }
          },
          {
            "0": {
              "DATABASECONNECTIONS": "-",
              "FREESTORAGE": "-",
              "CPUUTILIZATION": "-"
            }
          },
          {
            "0": {
              "DATABASECONNECTIONS": "-",
              "FREESTORAGE": "-",
              "CPUUTILIZATION": "-"
            }
          },
          {
            "0": {
              "DATABASECONNECTIONS": "-",
              "FREESTORAGE": "-",
              "CPUUTILIZATION": "-"
            }
          }
        ],
        "availability": [
          "100.0",
          "100.0",
          "0.0",
          "0.0",
          "0.0",
          "0.0",
          "0.0",
          "0.0"
        ]
      },
      "PORT-POP": {
        "name": [
          "pop",
          "POP_PROBEprobe10aprpre"
        ],
        "attribute_data": [
          {
            "0": {
              "RESPONSETIME": 194
            }
          },
          {
            "0": {
              "RESPONSETIME": 220
            }
          }
        ],
        "availability": [
          "100.0",
          "100.0"
        ]
      },
      "PROBE": {
        "name": [
          "ac-u14-64-2",
          "android-52865c232bc68e47",
          "android-7733a53a4a935a83",
          "android-7733a53a4a935a83",
          "android-7733a53a4a935a83",
          "android-priya",
          "opman-f13-64-2",
          "priya-1711",
          "site24x7-win7"
        ],
        "attribute_data": [
          {
            "0": {
              "CPUUSAGE": "-",
              "MEMUSAGE": "-"
            }
          },
          {
            "0": {
              "CPUUSAGE": "-",
              "MEMUSAGE": "-"
            }
          },
          {
            "0": {
              "CPUUSAGE": "-",
              "MEMUSAGE": "-"
            }
          },
          {
            "0": {
              "CPUUSAGE": "-",
              "MEMUSAGE": "-"
            }
          },
          {
            "0": {
              "CPUUSAGE": "-",
              "MEMUSAGE": "-"
            }
          },
          {
            "0": {
              "CPUUSAGE": "-",
              "MEMUSAGE": "-"
            }
          },
          {
            "0": {
              "CPUUSAGE": "-",
              "MEMUSAGE": "-"
            }
          },
          {
            "0": {
              "CPUUSAGE": 0,
              "MEMUSAGE": 73.89
            }
          },
          {
            "0": {
              "CPUUSAGE": 0,
              "MEMUSAGE": 68.05
            }
          }
        ],
        "availability": [
          "0.0",
          "0.0",
          "0.0",
          "0.0",
          "0.0",
          "0.0",
          "0.0",
          "35.54",
          "100.0"
        ]
      },
      "URL": {
        "name": [
          "&amazon.com",
          "&test notification",
          "AUTHTOKEN-bfc032d5be5215135e70f2dedbfdae2f",
          "custom period reports",
          "Delete",
          "ES-FEB-18",
          "FEB18-2Multilocation",
          "htz14.gpserver.dk",
          "htz14.gpserver.dk - primary changed",
          "IP_Address",
          "mobile - changed primary location",
          "Mobileeee2222",
          "New",
          "new monitor",
          "other+poll+probe",
          "poller+probe",
          "poller_nov7",
          "Priya",
          "Priya",
          "Priya config",
          "rrr",
          "Samp",
          "sample",
          "samplechennai",
          "samplelocation2",
          "site24x7",
          "site24x7",
          "site24x7",
          "suhma",
          "switchu",
          "test",
          "Test",
          "test - poller",
          "Test web",
          "test6",
          "testing",
          "testng",
          "top n unable to connect",
          "vtitan",
          "vtitan",
          "vtitan123",
          "vtitan123",
          "vtitan123",
          "WEB PROBE probe10aprpre",
          "Website-check.com",
          "Website-fog.com",
          "Website-he.com",
          "Website-he.net",
          "Website-hshs.com",
          "zoho",
          "Zoho",
          "Zoho"
        ],
        "attribute_data": [
          {
            "0": {
              "RESPONSETIME": 430
            }
          },
          {
            "0": {
              "RESPONSETIME": 2
            }
          },
          {
            "0": {
              "RESPONSETIME": "-"
            }
          },
          {
            "0": {
              "RESPONSETIME": 1030
            }
          },
          {
            "0": {
              "RESPONSETIME": "-"
            }
          },
          {
            "0": {
              "RESPONSETIME": 1015
            }
          },
          {
            "0": {
              "RESPONSETIME": "-"
            }
          },
          {
            "0": {
              "RESPONSETIME": "-"
            }
          },
          {
            "0": {
              "RESPONSETIME": "-"
            }
          },
          {
            "0": {
              "RESPONSETIME": 1041
            }
          },
          {
            "0": {
              "RESPONSETIME": "-"
            }
          },
          {
            "0": {
              "RESPONSETIME": "-"
            }
          },
          {
            "0": {
              "RESPONSETIME": "-"
            }
          },
          {
            "0": {
              "RESPONSETIME": "-"
            }
          },
          {
            "0": {
              "RESPONSETIME": 858
            }
          },
          {
            "0": {
              "RESPONSETIME": 960
            }
          },
          {
            "0": {
              "RESPONSETIME": "-"
            }
          },
          {
            "0": {
              "RESPONSETIME": 2
            }
          },
          {
            "0": {
              "RESPONSETIME": "-"
            }
          },
          {
            "0": {
              "RESPONSETIME": 1805
            }
          },
          {
            "0": {
              "RESPONSETIME": 731
            }
          },
          {
            "0": {
              "RESPONSETIME": "-"
            }
          },
          {
            "0": {
              "RESPONSETIME": 1042
            }
          },
          {
            "0": {
              "RESPONSETIME": "-"
            }
          },
          {
            "0": {
              "RESPONSETIME": "-"
            }
          },
          {
            "0": {
              "RESPONSETIME": "-"
            }
          },
          {
            "0": {
              "RESPONSETIME": 1041
            }
          },
          {
            "0": {
              "RESPONSETIME": "-"
            }
          },
          {
            "0": {
              "RESPONSETIME": "-"
            }
          },
          {
            "0": {
              "RESPONSETIME": 1858
            }
          },
          {
            "0": {
              "RESPONSETIME": 212
            }
          },
          {
            "0": {
              "RESPONSETIME": 174
            }
          },
          {
            "0": {
              "RESPONSETIME": 75
            }
          },
          {
            "0": {
              "RESPONSETIME": "-"
            }
          },
          {
            "0": {
              "RESPONSETIME": 3008
            }
          },
          {
            "0": {
              "RESPONSETIME": "-"
            }
          },
          {
            "0": {
              "RESPONSETIME": 335
            }
          },
          {
            "0": {
              "RESPONSETIME": 582
            }
          },
          {
            "0": {
              "RESPONSETIME": 378
            }
          },
          {
            "0": {
              "RESPONSETIME": 385
            }
          },
          {
            "0": {
              "RESPONSETIME": 378
            }
          },
          {
            "0": {
              "RESPONSETIME": 387
            }
          },
          {
            "0": {
              "RESPONSETIME": 379
            }
          },
          {
            "0": {
              "RESPONSETIME": 506
            }
          },
          {
            "0": {
              "RESPONSETIME": 1555
            }
          },
          {
            "0": {
              "RESPONSETIME": 538
            }
          },
          {
            "0": {
              "RESPONSETIME": 18
            }
          },
          {
            "0": {
              "RESPONSETIME": 45
            }
          },
          {
            "0": {
              "RESPONSETIME": 1070
            }
          },
          {
            "0": {
              "RESPONSETIME": "-"
            }
          },
          {
            "0": {
              "RESPONSETIME": 815
            }
          },
          {
            "0": {
              "RESPONSETIME": "-"
            }
          }
        ],
        "availability": [
          "100.0",
          "35.99",
          "100.0",
          "100.0",
          "100.0",
          "99.89",
          "0.0",
          "0.0",
          "0.0",
          "100.0",
          "100.0",
          "100.0",
          "100.0",
          "100.0",
          "100.0",
          "99.89",
          "100.0",
          "100.0",
          "100.0",
          "100.0",
          "100.0",
          "0.0",
          "100.0",
          "100.0",
          "100.0",
          "100.0",
          "100.0",
          "0.0",
          "100.0",
          "100.0",
          "100.0",
          "100.0",
          "100.0",
          "100.0",
          "100.0",
          "100.0",
          "100.0",
          "100.0",
          "100.0",
          "100.0",
          "100.0",
          "100.0",
          "100.0",
          "100.0",
          "100.0",
          "100.0",
          "100.0",
          "100.0",
          "100.0",
          "0.0",
          "100.0",
          "100.0"
        ]
      },
      "PING": {
        "name": [
          "Ping 1",
          "Ping Single location",
          "PING_PROBEprobe10aprpre"
        ],
        "attribute_data": [
          {
            "0": {
              "RESPONSETIME": 112
            }
          },
          {
            "0": {
              "RESPONSETIME": 0
            }
          },
          {
            "0": {
              "RESPONSETIME": 0
            }
          }
        ],
        "availability": [
          "100.0",
          "100.0",
          "100.0"
        ]
      },
      "IISSERVER": {
        "name": [
          "s24x7-w2k8r2.site24x7.com-IIS",
          "site24x7-w7-64.site24x7.com-IIS",
          "site24x7-win2012.site24x7.com-IIS",
          "site24x7-win7-IIS- Don't delete"
        ],
        "attribute_data": [
          {
            "0": {
              "NWTRAFFIC": "-"
            }
          },
          {
            "0": {
              "NWTRAFFIC": "-"
            }
          },
          {
            "0": {
              "NWTRAFFIC": "-"
            }
          },
          {
            "0": {
              "NWTRAFFIC": 0
            }
          }
        ],
        "availability": [
          "100.0",
          "1.13",
          "1.13",
          "99.0"
        ]
      },
      "DNS": {
        "name": [
          "DNS - dns1.hichina.com - hshs.com",
          "DNS - dns2.hichina.com - hshs.com",
          "DNS - ns1.fastdns.de - check.com",
          "DNS - ns1.he.net - he.com",
          "DNS - ns1.he.net - he.net",
          "DNS - ns1.vtitan.com - zohocorp.com",
          "DNS - ns10.dnsmadeeasy.com - did.com",
          "DNS - ns11.dnsmadeeasy.com - did.com",
          "DNS - ns12.dnsmadeeasy.com - did.com",
          "DNS - ns13.dnsmadeeasy.com - did.com",
          "DNS - ns14.dnsmadeeasy.com - did.com",
          "DNS - ns15.dnsmadeeasy.com - did.com",
          "DNS - ns2.fastdns.de - check.com",
          "DNS - ns2.he.net - he.com",
          "DNS - ns2.he.net - he.net",
          "DNS - ns3.fastdns.de - check.com",
          "DNS - ns3.he.net - he.com",
          "DNS - ns3.he.net - he.net",
          "DNS - ns3.vtitan.com - vtitan.com",
          "DNS - ns3.vtitan.com - zohocorp.com",
          "DNS - ns4.he.net - he.net",
          "DNS - ns5.he.net - he.net",
          "DNS - pat.ns.cloudflare.com - fog.com",
          "DNS - theo.ns.cloudflare.com - fog.com",
          "DNS-NS2",
          "DNS-NS4",
          "DNS-NS4"
        ],
        "attribute_data": [
          {
            "0": {
              "RESPONSETIME": 320
            }
          },
          {
            "0": {
              "RESPONSETIME": "-"
            }
          },
          {
            "0": {
              "RESPONSETIME": 170
            }
          },
          {
            "0": {
              "RESPONSETIME": 4
            }
          },
          {
            "0": {
              "RESPONSETIME": 105
            }
          },
          {
            "0": {
              "RESPONSETIME": "-"
            }
          },
          {
            "0": {
              "RESPONSETIME": 5
            }
          },
          {
            "0": {
              "RESPONSETIME": 4
            }
          },
          {
            "0": {
              "RESPONSETIME": 4
            }
          },
          {
            "0": {
              "RESPONSETIME": 3
            }
          },
          {
            "0": {
              "RESPONSETIME": 4
            }
          },
          {
            "0": {
              "RESPONSETIME": 4
            }
          },
          {
            "0": {
              "RESPONSETIME": 157
            }
          },
          {
            "0": {
              "RESPONSETIME": 11
            }
          },
          {
            "0": {
              "RESPONSETIME": 5
            }
          },
          {
            "0": {
              "RESPONSETIME": 147
            }
          },
          {
            "0": {
              "RESPONSETIME": 6
            }
          },
          {
            "0": {
              "RESPONSETIME": 104
            }
          },
          {
            "0": {
              "RESPONSETIME": "-"
            }
          },
          {
            "0": {
              "RESPONSETIME": 222
            }
          },
          {
            "0": {
              "RESPONSETIME": 117
            }
          },
          {
            "0": {
              "RESPONSETIME": 99
            }
          },
          {
            "0": {
              "RESPONSETIME": "-"
            }
          },
          {
            "0": {
              "RESPONSETIME": 9
            }
          },
          {
            "0": {
              "RESPONSETIME": 38
            }
          },
          {
            "0": {
              "RESPONSETIME": 294
            }
          },
          {
            "0": {
              "RESPONSETIME": 53
            }
          }
        ],
        "availability": [
          "100.0",
          "0.0",
          "100.0",
          "100.0",
          "100.0",
          "100.0",
          "100.0",
          "100.0",
          "100.0",
          "100.0",
          "100.0",
          "100.0",
          "100.0",
          "100.0",
          "100.0",
          "100.0",
          "100.0",
          "100.0",
          "100.0",
          "100.0",
          "100.0",
          "100.0",
          "0.0",
          "100.0",
          "100.0",
          "100.0",
          "100.0"
        ]
      },
      "VMWAREESX": {
        "name": [
          "esx-1 - Main threshold",
          "esx-2.csez.zohocorpin.com"
        ],
        "attribute_data": [
          {
            "0": {
              "MEMUTIL": "-",
              "DISKUSAGE": "-",
              "CPUUTIL": "-"
            }
          },
          {
            "0": {
              "MEMUTIL": "-",
              "DISKUSAGE": "-",
              "CPUUTIL": "-"
            }
          }
        ],
        "availability": [
          "0.0",
          "0.0"
        ]
      },
      "REALBROWSER": {
        "name": [
          "MAY7_RBM_TD1",
          "milano",
          "RBM_TD2",
          "RBM_TD3"
        ],
        "attribute_data": [
          {
            "0": {
              "RESPONSETIME": "-"
            }
          },
          {
            "0": {
              "RESPONSETIME": 13332
            }
          },
          {
            "0": {
              "RESPONSETIME": 10582
            }
          },
          {
            "0": {
              "RESPONSETIME": 4210
            }
          }
        ],
        "availability": [
          "0.0",
          "100.0",
          "100.0",
          "100.0"
        ]
      },
      "SOAP": {
        "name": [
          "FEB22-soap",
          "M10-soap test-alert",
          "sample_apr14_soo"
        ],
        "attribute_data": [
          {
            "0": {
              "RESPONSETIME": "-"
            }
          },
          {
            "0": {
              "RESPONSETIME": 378
            }
          },
          {
            "0": {
              "RESPONSETIME": 87
            }
          }
        ],
        "availability": [
          "100.0",
          "100.0",
          "100.0"
        ]
      },
      "FTP": {
        "name": [
          "FTPRTT_PROBEprobe10aprpre",
          "FTPRTT_TD2",
          "FTPRTT_TD3",
          "M10-FTPRTT_TD1"
        ],
        "attribute_data": [
          {
            "0": {
              "RESPONSETIME": "-"
            }
          },
          {
            "0": {
              "RESPONSETIME": 35
            }
          },
          {
            "0": {
              "RESPONSETIME": 40
            }
          },
          {
            "0": {
              "RESPONSETIME": 39
            }
          }
        ],
        "availability": [
          "100.0",
          "96.56",
          "99.33",
          "98.24"
        ]
      },
      "MSEXCHANGE": {
        "name": [
          "s24x7-w2k8r2.site24x7.com-MSExchange"
        ],
        "attribute_data": [
          {
            "0": {
              "SMTPINBOUND": "-",
              "OWARPCAVGLATENCY": "-",
              "OWAAVGRESPONSETIME": "-",
              "MBXACCESSFAILURE": "-"
            }
          }
        ],
        "availability": [
          "0.0"
        ]
      },
      "VCENTERCLUSTER": {
        "name": [
          "172.21.10.64",
          "172.21.10.64",
          "172.21.10.65",
          "172.21.10.65",
          "172.21.145.240",
          "Cluster",
          "ME",
          "MECluster",
          "SureshCluster",
          "test",
          "test247",
          "testCluster",
          "testing123"
        ],
        "attribute_data": [
          {
            "0": {
              "MEMUTIL": "-",
              "CPUUTIL": "-"
            }
          },
          {
            "0": {
              "MEMUTIL": "-",
              "CPUUTIL": "-"
            }
          },
          {
            "0": {
              "MEMUTIL": "-",
              "CPUUTIL": "-"
            }
          },
          {
            "0": {
              "MEMUTIL": "-",
              "CPUUTIL": "-"
            }
          },
          {
            "0": {
              "MEMUTIL": "-",
              "CPUUTIL": "-"
            }
          },
          {
            "0": {
              "MEMUTIL": "-",
              "CPUUTIL": "-"
            }
          },
          {
            "0": {
              "MEMUTIL": "-",
              "CPUUTIL": "-"
            }
          },
          {
            "0": {
              "MEMUTIL": "-",
              "CPUUTIL": "-"
            }
          },
          {
            "0": {
              "MEMUTIL": "-",
              "CPUUTIL": "-"
            }
          },
          {
            "0": {
              "MEMUTIL": "-",
              "CPUUTIL": "-"
            }
          },
          {
            "0": {
              "MEMUTIL": "-",
              "CPUUTIL": "-"
            }
          },
          {
            "0": {
              "MEMUTIL": "-",
              "CPUUTIL": "-"
            }
          },
          {
            "0": {
              "MEMUTIL": "-",
              "CPUUTIL": "-"
            }
          }
        ],
        "availability": [
          "100.0",
          "100.0",
          "100.0",
          "100.0",
          "100.0",
          "100.0",
          "100.0",
          "100.0",
          "100.0",
          "100.0",
          "100.0",
          "100.0",
          "100.0"
        ]
      },
      "PORT": {
        "name": [
          "PORT",
          "PORT_PROBEprobe10aprpre"
        ],
        "attribute_data": [
          {
            "0": {
              "RESPONSETIME": 3331
            }
          },
          {
            "0": {
              "RESPONSETIME": 246
            }
          }
        ],
        "availability": [
          "100.0",
          "100.0"
        ]
      },
      "HOMEPAGE": {
        "name": [
          "apr14_",
          "bijlu-test-wpa",
          "FEB22-WPA-ES",
          "HomePage-check.com",
          "HomePage-did.com",
          "HomePage-fog.com",
          "HomePage-he.com",
          "HomePage-hshs.com",
          "HomePage-zohocorp.com",
          "HomePage-zohocorp.com",
          "MAR28-WPA",
          "mobile testing",
          "WPA",
          "wpa1",
          "WPA2",
          "wpa3",
          "wpanew",
          "WPA_ALL_threshold",
          "WPA_TD2"
        ],
        "attribute_data": [
          {
            "0": {
              "RESPONSETIME": 512
            }
          },
          {
            "0": {
              "RESPONSETIME": "-"
            }
          },
          {
            "0": {
              "RESPONSETIME": 923
            }
          },
          {
            "0": {
              "RESPONSETIME": 3088
            }
          },
          {
            "0": {
              "RESPONSETIME": 584
            }
          },
          {
            "0": {
              "RESPONSETIME": "-"
            }
          },
          {
            "0": {
              "RESPONSETIME": 200
            }
          },
          {
            "0": {
              "RESPONSETIME": 4711
            }
          },
          {
            "0": {
              "RESPONSETIME": 934
            }
          },
          {
            "0": {
              "RESPONSETIME": 2029
            }
          },
          {
            "0": {
              "RESPONSETIME": 1644
            }
          },
          {
            "0": {
              "RESPONSETIME": 10975
            }
          },
          {
            "0": {
              "RESPONSETIME": 1508
            }
          },
          {
            "0": {
              "RESPONSETIME": 4619
            }
          },
          {
            "0": {
              "RESPONSETIME": "-"
            }
          },
          {
            "0": {
              "RESPONSETIME": "-"
            }
          },
          {
            "0": {
              "RESPONSETIME": "-"
            }
          },
          {
            "0": {
              "RESPONSETIME": 2968
            }
          },
          {
            "0": {
              "RESPONSETIME": 4265
            }
          }
        ],
        "availability": [
          "100.0",
          "0.0",
          "11.89",
          "100.0",
          "100.0",
          "100.0",
          "100.0",
          "95.33",
          "100.0",
          "100.0",
          "100.0",
          "0.0",
          "100.0",
          "100.0",
          "100.0",
          "100.0",
          "100.0",
          "100.0",
          "100.0"
        ]
      },
      "SMTP": {
        "name": [
          "FEB20-MailServer",
          "M13",
          "mailserver imap",
          "mailserver-g",
          "newmailserver",
          "system mail",
          "Zoho1111"
        ],
        "attribute_data": [
          {
            "0": {
              "RESPONSETIME": "-"
            }
          },
          {
            "0": {
              "RESPONSETIME": "-"
            }
          },
          {
            "0": {
              "RESPONSETIME": "-"
            }
          },
          {
            "0": {
              "RESPONSETIME": "-"
            }
          },
          {
            "0": {
              "RESPONSETIME": 99
            }
          },
          {
            "0": {
              "RESPONSETIME": "-"
            }
          },
          {
            "0": {
              "RESPONSETIME": "-"
            }
          }
        ],
        "availability": [
          "0.0",
          "0.0",
          "0.0",
          "0.0",
          "100.0",
          "0.0",
          "0.0"
        ]
      },
      "RESTAPI": {
        "name": [
          "REST API Monitor",
          "Zylker"
        ],
        "attribute_data": [
          {
            "0": {
              "RESPONSETIME": 12556
            }
          },
          {
            "0": {
              "RESPONSETIME": 839
            }
          }
        ],
        "availability": [
          "80.23",
          "100.0"
        ]
      },
      "PORT_FTP": {
        "name": [
          "FEB20-ftp-server",
          "FTP_PROBEprobe10aprpre",
          "FTP_Service_TD1"
        ],
        "attribute_data": [
          {
            "0": {
              "RESPONSETIME": "-"
            }
          },
          {
            "0": {
              "RESPONSETIME": 2
            }
          },
          {
            "0": {
              "RESPONSETIME": 186
            }
          }
        ],
        "availability": [
          "0.0",
          "35.35",
          "100.0"
        ]
      },
      "PORT-SMTP": {
        "name": [
          "M10_FEB22-smtp_Alert",
          "sampt",
          "SMTP - aspmx2.googlemail.com - fog.com",
          "SMTP - aspmx3.googlemail.com - fog.com",
          "SMTP - aspmx4.googlemail.com - fog.com",
          "SMTP - aspmx5.googlemail.com - fog.com",
          "SMTP - mx3.zohomail.com - zohocorp.com",
          "SMTP - wh4.megaspace.de - check.com",
          "SMTP-MX",
          "SMTP-MX",
          "SMTP-MX2",
          "SMTP_PROBEprobe10aprpre"
        ],
        "attribute_data": [
          {
            "0": {
              "RESPONSETIME": 308
            }
          },
          {
            "0": {
              "RESPONSETIME": "-"
            }
          },
          {
            "0": {
              "RESPONSETIME": 47
            }
          },
          {
            "0": {
              "RESPONSETIME": 66
            }
          },
          {
            "0": {
              "RESPONSETIME": 85
            }
          },
          {
            "0": {
              "RESPONSETIME": 91
            }
          },
          {
            "0": {
              "RESPONSETIME": "-"
            }
          },
          {
            "0": {
              "RESPONSETIME": 337
            }
          },
          {
            "0": {
              "RESPONSETIME": 2
            }
          },
          {
            "0": {
              "RESPONSETIME": 6
            }
          },
          {
            "0": {
              "RESPONSETIME": 4
            }
          },
          {
            "0": {
              "RESPONSETIME": 220
            }
          }
        ],
        "availability": [
          "100.0",
          "100.0",
          "100.0",
          "100.0",
          "100.0",
          "100.0",
          "0.09",
          "100.0",
          "100.0",
          "100.0",
          "100.0",
          "100.0"
        ]
      },
      "VCENTERRP": {
        "name": [
          "APM1",
          "APM1",
          "eeee",
          "PlusSite24x7",
          "RPtest1",
          "S247",
          "S247",
          "S247",
          "Subpool",
          "SubPool",
          "Test247",
          "Test247",
          "Test247",
          "Testing",
          "Testing",
          "TestingResourcePool",
          "testpriya",
          "TestRPool",
          "TestRP_Site24x7",
          "TestS247",
          "Tests247",
          "TestS247",
          "TestS247",
          "TESTS247",
          "TESTS247"
        ],
        "attribute_data": [
          {
            "0": {
              "CPUOVERALL": "-",
              "MEMOVERALL": "-"
            }
          },
          {
            "0": {
              "CPUOVERALL": "-",
              "MEMOVERALL": "-"
            }
          },
          {
            "0": {
              "CPUOVERALL": "-",
              "MEMOVERALL": "-"
            }
          },
          {
            "0": {
              "CPUOVERALL": "-",
              "MEMOVERALL": "-"
            }
          },
          {
            "0": {
              "CPUOVERALL": "-",
              "MEMOVERALL": "-"
            }
          },
          {
            "0": {
              "CPUOVERALL": "-",
              "MEMOVERALL": "-"
            }
          },
          {
            "0": {
              "CPUOVERALL": "-",
              "MEMOVERALL": "-"
            }
          },
          {
            "0": {
              "CPUOVERALL": "-",
              "MEMOVERALL": "-"
            }
          },
          {
            "0": {
              "CPUOVERALL": "-",
              "MEMOVERALL": "-"
            }
          },
          {
            "0": {
              "CPUOVERALL": "-",
              "MEMOVERALL": "-"
            }
          },
          {
            "0": {
              "CPUOVERALL": "-",
              "MEMOVERALL": "-"
            }
          },
          {
            "0": {
              "CPUOVERALL": "-",
              "MEMOVERALL": "-"
            }
          },
          {
            "0": {
              "CPUOVERALL": "-",
              "MEMOVERALL": "-"
            }
          },
          {
            "0": {
              "CPUOVERALL": "-",
              "MEMOVERALL": "-"
            }
          },
          {
            "0": {
              "CPUOVERALL": "-",
              "MEMOVERALL": "-"
            }
          },
          {
            "0": {
              "CPUOVERALL": "-",
              "MEMOVERALL": "-"
            }
          },
          {
            "0": {
              "CPUOVERALL": "-",
              "MEMOVERALL": "-"
            }
          },
          {
            "0": {
              "CPUOVERALL": "-",
              "MEMOVERALL": "-"
            }
          },
          {
            "0": {
              "CPUOVERALL": "-",
              "MEMOVERALL": "-"
            }
          },
          {
            "0": {
              "CPUOVERALL": "-",
              "MEMOVERALL": "-"
            }
          },
          {
            "0": {
              "CPUOVERALL": "-",
              "MEMOVERALL": "-"
            }
          },
          {
            "0": {
              "CPUOVERALL": "-",
              "MEMOVERALL": "-"
            }
          },
          {
            "0": {
              "CPUOVERALL": "-",
              "MEMOVERALL": "-"
            }
          },
          {
            "0": {
              "CPUOVERALL": "-",
              "MEMOVERALL": "-"
            }
          },
          {
            "0": {
              "CPUOVERALL": "-",
              "MEMOVERALL": "-"
            }
          }
        ],
        "availability": [
          "100.0",
          "100.0",
          "100.0",
          "100.0",
          "100.0",
          "100.0",
          "100.0",
          "100.0",
          "100.0",
          "100.0",
          "100.0",
          "100.0",
          "100.0",
          "100.0",
          "100.0",
          "100.0",
          "100.0",
          "100.0",
          "100.0",
          "100.0",
          "100.0",
          "100.0",
          "100.0",
          "100.0",
          "100.0"
        ]
      }
    },
    "summary_details": {
      "down_count": 116,
      "downtime_duration": "52 days 0 Hrs 59 Mins ",
      "availability_percentage": 65.41,
      "mtbf": "20 Hrs 24 Mins ",
      "unmanaged_duration": "6 days 8 Hrs 42 Mins ",
      "alarm_count": 159,
      "mttr": "10 Hrs 46 Mins ",
      "maintenance_percentage": 0.08,
      "maintenance_duration": "2 Hrs 54 Mins ",
      "availability_duration": "98 days 15 Hrs 11 Mins ",
      "unmanaged_percentage": 4.22,
      "downtime_percentage": 34.51
    },
    "info": {
      "end_time": "2016-08-23T00:00:00+0530",
      "resource_type_name": "Monitor",
      "report_name": "Summary Report",
      "period_name": "Today",
      "formatted_start_time": "August 22, 2016 12:00 AM IST",
      "generated_time": "2016-08-22T15:16:24+0530",
      "formatted_end_time": "August 23, 2016 12:00 AM IST",
      "segment_type": 2,
      "start_time": "2016-08-22T00:00:00+0530",
      "resource_type": 2,
      "period": 3,
      "formatted_generated_time": "August 22, 2016 3:16 PM IST",
      "monitor_type": "",
      "report_type": 17,
      "segment_type_name": "Day of Week"
    }
  }
}

Get the overall summary and performance details of all the monitors in your account for the specified period of time.

Query Parameters

Param Type Description
period int Mandatory
Availability and performance details are generated within this predefined interval.
start_date string Mandatory, if period chosen is Custom.Start date for a custom period. Outage details report is generated from this date.
Format - yyyy-mm-dd
end_date string Mandatory, if period chosen is Custom.End date for a custom period. Outage details report is generated until this date.
Format - yyyy-mm-dd

Response Attributes

Attribute Type Description
performance_details JSON array Contains monitor type’s primary attribute name and value.
summary_details json The overall summary details of the monitor for the specified period.
outage_id string Unique ID of the outage
start_time string Outage start time.
end_time string Outage end time.
type int Type of outage.
duration string The total outage duration.
display_name string Name of the monitor for which the outage occured.
monitor_id string Unique ID of the monitor. Use retrieve monitor API to get the details of this monitor.
availability_details json The individual location summary details of the monitor for the specified period.
down_count int Number of downtimes
name string Location name
downtime_duration string Duration of downtime
availability_percentage int Availability percentage of the monitor in a specific location
mtbf string Mean Time To Failure
mttr string Mean Time To Repair
unmanaged_duration string Monitor suspended time
unmanaged_percentage int Monitor suspended time in percentage
maintenance_percentage string Monitor maintenance percentage
maintenance_duration string Monitor maintenance duration
availability_duration string Monitor availability duration
downtime_percentage int Downtime Percentage

Availability Summary Reports

Obtain the availability status of your monitors for a specified period of time.

Availability Summary by monitor

GET /reports/availability_summary/{monitor_id}?period={report_period_constants}

Request Example

$ curl "https://www.site24x7.com/api/reports/availability_summary/113770000025720011?period=8&unit_of_time=3" \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-authtoken ba4604e8e433g9c892e360d53463oec5"

Response Example

{
  "code": 0,
  "message": "success",
  "data": {
    "summary_details": {
      "down_count": 19,
      "downtime_duration": "7 days 15 Hrs 36 Mins ",
      "availability_percentage": 93.37,
      "mtbf": "6 days 18 Hrs 6 Mins ",
      "unmanaged_duration": "0 Mins 1 Secs",
      "alarm_count": 229,
      "mttr": "9 Hrs 40 Mins ",
      "maintenance_percentage": 1.07,
      "maintenance_duration": "1 days 11 Hrs 12 Mins ",
      "availability_duration": "128 days 7 Hrs 57 Mins ",
      "unmanaged_percentage": 0,
      "downtime_percentage": 5.57
    },
    "charts": [
      {
        "name": "Availability Percentage",
        "key": "percentage_chart",
        "data": [
          [
            "2017-01-01T00:00:00+0530",
            99.93,
            0.07,
            0
          ],
          [
            "2017-01-08T00:00:00+0530",
            99.96,
            0.04,
            0
          ],
          ...
        ]
      },
      {
        "name": "Downtime (count)",
        "key": "down_count_chart",
        "data": [
          [
            "2017-01-01T00:00:00+0530",
            4
          ],
          [
            "2017-01-08T00:00:00+0530",
            2
          ],
          ...
        ]
      }
    ],
    "outage_details": [
      {
        "display_name": "Zylker",
        "outages": [
          {
            "outage_id": "123123123",
            "rca": "zip_12345678.zip",
            "end_time": "2017-05-02T02:52:37+0530",
            "duration": "2 Mins 27 Secs",
            "reason": "This url is forbidden.",
            "start_time": "2017-05-02T02:50:09+0530",
            "acknowledgements": [
              {
                "zuid": "123123"
              },
              {
                "zuid": "111222"
              }
            ],
            "type": 0,
            "image_file": "https://www.site24x7.com/app/screenshot/hdhVYNCOxxGRnRL+2cB
                            9yBzEILa2bk4KO0iiYzDfYrsmqHxn+4zFwpWp4r7\nViNV13RuClfdDm"
          },
          {
            "outage_id": "11111222",
            "rca": "zip_1111222.zip",
            "end_time": "2017-04-13T05:12:30+0530",
            "duration": "2 Mins 10 Secs",
            "reason": "This url is forbidden.",
            "start_time": "2017-04-13T05:10:20+0530",
            "acknowledgements": [
              {
                "zuid": "111444"
              },
              {
                "zuid": "111555"
              }
            ],
            "type": 0,
            "image_file": "https://www.site24x7.com/app/screenshot/3amY1yVU/xxGRnRL
                            +2cB9yBzEILa2bk4KO0iiVxTBeC3YZn/0vyS7lcH93v7\nViNV13RuClfdD"
          },
          ...
        ],
        "monitor_id": "123123123"
      }
    ],
    "profile_details": {
      "threshold_profiles": [
        {
          "name": "Threshold Profile URL",
          "down_condition": "Report Site as Down on Failure from: 3 Locations"
        }
      ],
      "threshold_profile_details": [
        {
          "attributeid": 7,
          "threshold": "Yes",
          "units": "%",
          "label": "url.newmonitor.advanced.contentmodified",
          "alert_type": 2
        }
      ],
      "location_profiles": [
        {
          "locations": "New Jersey - US,Dallas - US",
          "name": "Location Profile - US"
        }
      ]
    },
    "availability_details": [
      {
        "down_count": 26,
        "name": "New Jersey - US",
        "downtime_duration": "7 days 15 Hrs 51 Mins ",
        "availability_percentage": 93.36,
        "mtbf": "4 days 22 Hrs 27 Mins ",
        "unmanaged_duration": "91 days 17 Hrs 5 Mins ",
        "location_id": "2",
        "mttr": "7 Hrs 4 Mins ",
        "maintenance_percentage": 1.07,
        "last_down": "2017-05-02T02:50:09+0530",
        "maintenance_duration": "1 days 11 Hrs 12 Mins ",
        "availability_duration": "128 days 7 Hrs 42 Mins ",
        "monitor_id": "123123123",
        "unmanaged_percentage": 66.73,
        "downtime_percentage": 5.57
      },
      {
        "down_count": 21,
        "name": "Dallas - US",
        "downtime_duration": "7 days 16 Hrs 25 Mins ",
        "availability_percentage": 93.34,
        "mtbf": "6 days 2 Hrs 37 Mins ",
        "unmanaged_duration": "0 Mins 1 Secs",
        "location_id": "7",
        "mttr": "8 Hrs 47 Mins ",
        "maintenance_percentage": 1.07,
        "last_down": "2017-05-12T01:09:32+0530",
        "maintenance_duration": "1 days 11 Hrs 12 Mins ",
        "availability_duration": "128 days 7 Hrs 8 Mins ",
        "monitor_id": "123123123",
        "unmanaged_percentage": 0,
        "downtime_percentage": 5.59
      }
    ],
    "info": {
      "resource_name": "Zylker",
      "end_time": "2018-01-01T00:00:00+0530",
      "resource_type_name": "Monitor",
      "report_name": "Availability Summary Report",
      "period_name": "This Year",
      "formatted_start_time": "January 1, 2017 12:00 AM IST",
      "generated_time": "2017-05-18T10:44:38+0530",
      "formatted_end_time": "January 1, 2018 12:00 AM IST",
      "segment_type": 4,
      "start_time": "2017-01-01T00:00:00+0530",
      "resource_type": 2,
      "period": 8,
      "formatted_generated_time": "May 18, 2017 10:44 AM IST",
      "resource_id": "123123123",
      "report_type": 11
    }
  }
}

Get the overall summary details of a particular monitor over the specified period of time.

Path Parameters

Param Type Description
monitor_id string Mandatory
Unique ID of the monitor

Query Parameters

Param Type Description
period int Mandatory
Outage details report is generated within this predefined interval.
unit_of_time int The granularity of the report to be generated.
start_date string Mandatory, if period chosen is Custom. Start date for a custom period. Outage details report is generated from this date.
Format - yyyy-mm-dd
end_date string Mandatory, if period chosen is Custom. End date for a custom period. Outage details report is generated until this date.
Format - yyyy-mm-dd
business_hours_id int The predefined business hours during which critical outage details reports are generated.
location_id int The location for which the availability report is required.

Supported by Network Device, VMware ESX/ESXi Server, VMware VM, vCenter, Plugins, Website Monitor, Web Page Speed (Browser), DNS Server, Port (Custom Protocol), POP Server, Mail Delivery, SMTP Server, Ping, SSL/TLS Certificate, FTP Server, FTP Transfer, REST API, SOAP Web Service, Web Transaction (Browser) and Web Transaction

Response Attributes

Attribute Type Description
charts JSON array Has the json data containing the time, uptime, downtime and maintenance respectively.
outage_details JSON array The outages that the monitor suffered during the specified period.
summary_details json The overall summary details of the monitor for the specified period.
availability_details json The individual location summary details of the monitor for the specified period.
down_count int Number of downtimes
location_id string Unique ID of the location
name string Location name
downtime_duration string Duration of downtime
availability_percentage int Availability percentage of the monitor in a specific location
mtbf string Mean Time To Failure
mttr string Mean Time To Repair
unmanaged_duration string Monitor suspended time
unmanaged_percentage int Monitor suspended time in percentage
maintenance_percentage string Monitor maintenance percentage
maintenance_duration string Monitor maintenance duration
availability_duration string Monitor availability duration
downtime_percentage int Downtime
monitor_id string Unique ID of the monitor. Use retrieve monitor API to get the details of this monitor.
zuid String Unique Id of the user who acknowledged the outage.Use users list API to find out zuid of the user.

Availability Summary by monitor group

GET /reports/availability_summary/group/{group_id}?period={report_period_constants}

Request Example

$ curl "https://www.site24x7.com/api/reports/availability_summary/group/113770000000132048?period=3&unit_of_time=2" \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-authtoken a12345b6c8de901f2gh3456ij78k901l"

Response Example

{
  "code": 0,
  "message": "success",
  "data": {
    "summary_details": {
      "down_count": 2,
      "downtime_duration": "10 Hrs 59 Mins ",
      "availability_percentage": 94.74,
      "mtbf": "4 days 2 Hrs 53 Mins ",
      "unmanaged_duration": "10 Hrs 59 Mins ",
      "alarm_count": 5,
      "mttr": "5 Hrs 30 Mins ",
      "maintenance_percentage": 0,
      "maintenance_duration": "0 Mins 0 Secs",
      "availability_duration": "8 days 5 Hrs 47 Mins ",
      "unmanaged_percentage": 5.26,
      "downtime_percentage": 5.26
    },
    "charts": [
      {
        "name": "Availability Percentage",
        "key": "percentage_chart",
        "data": [
          [
            "2017-05-18T00:00:00+0530",
            94.74,
            5.26,
            0
          ],
          [
            "2017-05-18T01:00:00+0530",
            94.74,
            5.26,
            0
          ],
          ...
        ]
      },
      {
        "name": "Downtime (count)",
        "key": "down_count_chart",
        "data": [
          [
            "2017-05-18T00:00:00+0530",
            1
          ],
          [
            "2017-05-18T06:00:00+0530",
            1
          ]
        ]
      }
    ],
    "outage_details": [
      {
        "display_name": "Monitor 1",
        "outages": [
          {
            "outage_id": "123123123",
            "end_time": "2017-05-18T10:59:16+0530",
            "type": 0,
            "start_time": "2017-05-18T00:00:00+0530",
            "duration": "10 Hrs 59 Mins "
          },
          ...
        ],
        "monitor_id": "123123121"
      },
      {
        "display_name": "Monitor 2",
        "outages": [
          {
            "outage_id": "123123124",
            "end_time": "2017-05-18T06:25:39+0530",
            "type": 0,
            "start_time": "2017-05-18T06:25:39+0530",
            "duration": "0 Mins 0 Secs"
          },
          ...
        ],
        "monitor_id": "123123122"
      },
      ...
    ],
    "availability_details": [
      {
        "down_count": 0,
        "name": "Monitor 3",
        "downtime_duration": "0 Mins 0 Secs",
        "availability_percentage": 100,
        "mtbf": "0 Mins 0 Secs",
        "unmanaged_duration": "0 Mins 0 Secs",
        "mttr": "0 Mins 0 Secs",
        "maintenance_percentage": 0,
        "maintenance_duration": "0 Mins 0 Secs",
        "availability_duration": "10 Hrs 59 Mins ",
        "monitor_id": "123123125",
        "unmanaged_percentage": 0,
        "downtime_percentage": 0
      },
      {
        "down_count": 1,
        "name": "Monitor 1",
        "downtime_duration": "10 Hrs 59 Mins ",
        "availability_percentage": 0,
        "mtbf": "0 Mins 0 Secs",
        "unmanaged_duration": "0 Mins 0 Secs",
        "mttr": "10 Hrs 59 Mins ",
        "maintenance_percentage": 0,
        "last_down": "2017-05-17T15:49:09+0530",
        "maintenance_duration": "0 Mins 0 Secs",
        "availability_duration": "0 Mins 0 Secs",
        "monitor_id": "123123121",
        "unmanaged_percentage": 0,
        "downtime_percentage": 100
      },
      ...
    ],
    "info": {
      "resource_name": "Website monitor group",
      "end_time": "2017-05-19T00:00:00+0530",
      "resource_type_name": "Group",
      "report_name": "Availability Summary Report",
      "period_name": "Today",
      "formatted_start_time": "May 18, 2017 12:00 AM IST",
      "generated_time": "2017-05-18T10:59:16+0530",
      "formatted_end_time": "May 19, 2017 12:00 AM IST",
      "segment_type": 2,
      "start_time": "2017-05-18T00:00:00+0530",
      "resource_type": 1,
      "period": 3,
      "formatted_generated_time": "May 18, 2017 10:59 AM IST",
      "resource_id": "113770000057111003",
      "report_type": 11,
      "segment_type_name": "Day of Week"
    }
  }
}

Get the overall summary details of a particular monitor group for a specified period of time.

Path Parameters

Param Type Description
group_id int Mandatory
Unique ID of the monitor group.
You can find group_id using the monitor group list api.

Query Parameters

Param Type Description
period int Mandatory
Outage details report is generated within this predefined interval.
unit_of_time int The granularity of the report to be generated.
start_date string Mandatory, if period chosen is Custom. Start date for a custom period. Outage details report is generated from this date.
Format - yyyy-mm-dd
end_date string Mandatory, if period chosen is Custom. End date for a custom period. Outage details report is generated until this date.
Format - yyyy-mm-dd
business_hours_id int The predefined business hours during which critical outage details reports are generated.

Response Attributes

Attribute Type Description
charts JSON array Has the json data containing the time, uptime, downtime and maintenance respectively.
outage_details JSON array The outages that the monitor suffered during the specified period.
summary_details json The overall summary details of the monitor for the specified period.
availability_details json The individual location summary details of the monitor for the specified period.
down_count int Number of downtimes
location_id string Unique ID of the location
name string Location name
downtime_duration string Duration of downtime
availability_percentage int Availability percentage of the monitor in a specific location
mtbf string Mean Time To Failure
mttr string Mean Time To Repair
unmanaged_duration string Monitor suspended time
unmanaged_percentage int Monitor suspended time in percentage
maintenance_percentage string Monitor maintenance percentage
maintenance_duration string Monitor maintenance duration
availability_duration string Monitor availability duration
downtime_percentage int Downtime
monitor_id string Unique ID of the monitor. Use retrieve monitor API to get the details of this monitor.

Availability Summary by monitor type

GET /reports/availability_summary/type/{monitor_type}?period={report_period_constants}

Request Example

$ curl "https://www.site24x7.com/api/reports/availability_summary/type/URL?period=3&unit_of_time=2" \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-authtoken a12345b6c8de901f2gh3456ij78k901l"

Response Example

{
  "code": 0,
  "message": "success",
  "data": {
    "summary_details": {
      "down_count": 17,
      "downtime_duration": "3 days 16 Hrs 59 Mins ",
      "availability_percentage": 94.18,
      "mtbf": "3 days 12 Hrs 41 Mins ",
      "unmanaged_duration": "2 days 18 Hrs 28 Mins ",
      "alarm_count": 28,
      "mttr": "5 Hrs 14 Mins ",
      "maintenance_percentage": 0,
      "maintenance_duration": "0 Mins 0 Secs",
      "availability_duration": "59 days 23 Hrs 39 Mins ",
      "unmanaged_percentage": 4.35,
      "downtime_percentage": 5.82
    },
    "charts": [
      {
        "name": "Availability Percentage",
        "key": "percentage_chart",
        "data": [
          [
            "2017-05-18T00:00:00+0530",
            94.2,
            5.8,
            0
          ],
          [
            "2017-05-18T01:00:00+0530",
            94.15,
            5.85,
            0
          ],
          ...
        ]
      },
      {
        "name": "Downtime (count)",
        "key": "down_count_chart",
        "data": [
          [
            "2017-05-18T00:00:00+0530",
            8
          ],
          [
            "2017-05-18T01:00:00+0530",
            1
          ],
          ...
        ]
      }
    ],
    "outage_details": [
      {
        "display_name": "Monitor 1",
        "outages": [
          {
            "outage_id": "1231231234",
            "end_time": "2017-05-18T10:24:03+0530",
            "type": 0,
            "start_time": "2017-05-18T10:21:33+0530",
            "duration": "2 Mins 30 Secs"
          },
          ...
        ],
        "monitor_id": "123123121"
      },
      {
        "display_name": "Monitor 2",
        "outages": [
          {
            "outage_id": "1231231235",
            "end_time": "2017-05-18T11:04:37+0530",
            "type": 0,
            "start_time": "2017-05-18T00:00:00+0530",
            "duration": "11 Hrs 5 Mins "
          },
          ...
        ],
        "monitor_id": "123123122"
      },
      ...
    ],
    "availability_details": [
      {
        "down_count": 0,
        "name": "Monitor 3",
        "downtime_duration": "0 Mins 0 Secs",
        "availability_percentage": 100,
        "mtbf": "0 Mins 0 Secs",
        "unmanaged_duration": "0 Mins 0 Secs",
        "mttr": "0 Mins 0 Secs",
        "maintenance_percentage": 0,
        "maintenance_duration": "0 Mins 0 Secs",
        "availability_duration": "11 Hrs 5 Mins ",
        "monitor_id": "113770000041718011",
        "unmanaged_percentage": 0,
        "downtime_percentage": 0
      },
      {
        "down_count": 1,
        "name": "Monitor 1",
        "downtime_duration": "2 Mins 30 Secs",
        "availability_percentage": 99.62,
        "mtbf": "11 Hrs 2 Mins ",
        "unmanaged_duration": "0 Mins 0 Secs",
        "mttr": "2 Mins 30 Secs",
        "maintenance_percentage": 0,
        "last_down": "2017-05-18T10:21:33+0530",
        "maintenance_duration": "0 Mins 0 Secs",
        "availability_duration": "11 Hrs 2 Mins ",
        "monitor_id": "123123121",
        "unmanaged_percentage": 0,
        "downtime_percentage": 0.38
      },
      ...
    ],
    "info": {
      "resource_name": "Website",
      "end_time": "2017-05-19T00:00:00+0530",
      "resource_type_name": "All Monitors",
      "report_name": "Availability Summary Report",
      "period_name": "Today",
      "formatted_start_time": "May 18, 2017 12:00 AM IST",
      "generated_time": "2017-05-18T11:04:37+0530",
      "formatted_end_time": "May 19, 2017 12:00 AM IST",
      "segment_type": 2,
      "start_time": "2017-05-18T00:00:00+0530",
      "resource_type": 0,
      "period": 3,
      "formatted_generated_time": "May 18, 2017 11:04 AM IST",
      "report_type": 11,
      "segment_type_name": "Day of Week"
    }
  }
}

Get the overall summary details of all the monitors of a particular type for the specified period of time.

Path Parameters

Param Type Description
monitor_type string Mandatory
Type of the monitor.

Query Parameters

Param Type Description
period int Mandatory
Outage details report is generated within this predefined interval.
unit_of_time int The granularity of the report to be generated.
start_date string Mandatory, if period chosen is Custom. Start date for a custom period. Outage details report is generated from this date.
Format - yyyy-mm-dd
end_date string Mandatory, if period chosen is Custom. End date for a custom period. Outage details report is generated until this date.
Format - yyyy-mm-dd
business_hours_id int The predefined business hours during which critical outage details reports are generated.
location_id int The location for which the availability report is required. If you do not pass location_id, then overall data will be retrieved.

Response Attributes

Attribute Type Description
charts JSON array Has the json data containing the time, uptime, downtime and maintenance respectively.
outage_details JSON array The outages that the monitor suffered during the specified period.
summary_details json The overall summary details of the monitor for the specified period.
availability_details json The individual location summary details of the monitor for the specified period.
down_count int Number of downtimes
location_id string Unique ID of the location
name string Location name
downtime_duration string Duration of downtime
availability_percentage int Availability percentage of the monitor in a specific location
mtbf string Mean Time To Failure
mttr string Mean Time To Repair
unmanaged_duration string Monitor suspended time
unmanaged_percentage int Monitor suspended time in percentage
maintenance_percentage string Monitor maintenance percentage
maintenance_duration string Monitor maintenance duration
availability_duration string Monitor availability duration
downtime_percentage int Downtime
monitor_id string Unique ID of the monitor. Use retrieve monitor API to get the details of this monitor.

Availability Summary for all monitors

GET /reports/availability_summary?period={report_period_constants}

Request Example


$ curl https://www.site24x7.com/api/reports/availability_summary?period=3 \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-authtoken a12345b6c8de901f2gh3456ij78k901l"

Response Example

{
  "code": 0,
  "message": "success",
  "data": {
    "summary_details": {
      "down_count": 146,
      "downtime_duration": "46 days 14 Hrs 36 Mins ",
      "availability_percentage": 85.8,
      "mtbf": "1 days 22 Hrs 17 Mins ",
      "unmanaged_duration": "13 days 3 Hrs 54 Mins ",
      "alarm_count": 198,
      "mttr": "7 Hrs 40 Mins ",
      "maintenance_percentage": 0,
      "maintenance_duration": "0 Mins 0 Secs",
      "availability_duration": "281 days 12 Hrs 33 Mins ",
      "unmanaged_percentage": 4.01,
      "downtime_percentage": 14.2
    },
    "charts": [
      {
        "name": "Availability Percentage",
        "key": "percentage_chart",
        "data": [
          [
            "2017-05-18T00:00:00+0530",
            85.87,
            14.13,
            0
          ],
          [
            "2017-05-18T01:00:00+0530",
            85.84,
            14.16,
            0
          ],
          ...
        ]
      },
      {
        "name": "Downtime (count)",
        "key": "down_count_chart",
        "data": [
          [
            "2017-05-18T00:00:00+0530",
            101
          ],
          [
            "2017-05-18T01:00:00+0530",
            5
          ],
          ...
        ]
      }
    ],
    "outage_details": [
      {
        "display_name": "Monitor 1",
        "outages": [
          {
            "outage_id": "123123124",
            "end_time": "2017-05-18T11:16:56+0530",
            "type": 0,
            "start_time": "2017-05-18T00:00:00+0530",
            "duration": "11 Hrs 17 Mins "
          }
        ],
        "monitor_id": "123123121"
      },
      {
        "display_name": "Monitor 2",
        "outages": [
          {
            "outage_id": "1231231221",
            "end_time": "2017-05-18T07:23:06+0530",
            "type": 0,
            "start_time": "2017-05-18T06:46:14+0530",
            "duration": "36 Mins 52 Secs"
          },
          {
            "outage_id": "1231231222",
            "end_time": "2017-05-18T01:21:30+0530",
            "type": 0,
            "start_time": "2017-05-18T01:03:11+0530",
            "duration": "18 Mins 18 Secs"
          },
          ...
        ],
        "monitor_id": "123123122"
      },
      ...
    ],
    "availability_details": [
      {
        "down_count": 0,
        "name": "Monitor 3",
        "downtime_duration": "0 Mins 0 Secs",
        "availability_percentage": 100,
        "mtbf": "0 Mins 0 Secs",
        "unmanaged_duration": "0 Mins 0 Secs",
        "mttr": "0 Mins 0 Secs",
        "maintenance_percentage": 0,
        "maintenance_duration": "0 Mins 0 Secs",
        "availability_duration": "11 Hrs 17 Mins ",
        "monitor_id": "123123123",
        "unmanaged_percentage": 0,
        "downtime_percentage": 0
      },
      {
        "down_count": 1,
        "name": "Monitor 1",
        "downtime_duration": "11 Hrs 17 Mins ",
        "availability_percentage": 0,
        "mtbf": "0 Mins 0 Secs",
        "unmanaged_duration": "0 Mins 0 Secs",
        "mttr": "11 Hrs 17 Mins ",
        "maintenance_percentage": 0,
        "last_down": "2017-05-03T15:24:50+0530",
        "maintenance_duration": "0 Mins 0 Secs",
        "availability_duration": "0 Mins 0 Secs",
        "monitor_id": "123123121",
        "unmanaged_percentage": 0,
        "downtime_percentage": 100
      },
      ...
    ],
    "info": {
      "resource_name": "",
      "end_time": "2017-05-19T00:00:00+0530",
      "resource_type_name": "All Monitors",
      "report_name": "Availability Summary Report",
      "period_name": "Today",
      "formatted_start_time": "May 18, 2017 12:00 AM IST",
      "generated_time": "2017-05-18T11:16:58+0530",
      "formatted_end_time": "May 19, 2017 12:00 AM IST",
      "segment_type": 2,
      "start_time": "2017-05-18T00:00:00+0530",
      "resource_type": 0,
      "period": 3,
      "formatted_generated_time": "May 18, 2017 11:16 AM IST",
      "report_type": 11,
      "segment_type_name": "Day of Week"
    }
  }
}

Get the overall summary details of all the monitors in your account for the specified period of time.

Query Parameters

Param Type Description
period int Mandatory
Outage details report is generated within this predefined interval.
start_date string Mandatory, if period chosen is Custom. Start date for a custom period. Outage details report is generated from this date.
Format - yyyy-mm-dd
end_date string Mandatory, if period chosen is Custom. End date for a custom period. Outage details report is generated until this date.
Format - yyyy-mm-dd

Response Attributes

Attribute Type Description
charts JSON array Has the json data containing the time, uptime, downtime and maintenance respectively.
outage_details JSON array The outages that the monitor suffered during the specified period.
summary_details json The overall summary details of the monitor for the specified period.
availability_details json The individual location summary details of the monitor for the specified period.
down_count int Number of downtimes
name string Location name
downtime_duration string Duration of downtime
availability_percentage int Availability percentage of the monitor in a specific location
mtbf string Mean Time To Failure
mttr string Mean Time To Repair
unmanaged_duration string Monitor suspended time
unmanaged_percentage int Monitor suspended time in percentage
maintenance_percentage string Monitor maintenance percentage
maintenance_duration string Monitor maintenance duration
availability_duration string Monitor availability duration
downtime_percentage int Downtime Percentage
monitor_id string Unique ID of the monitor. Use retrieve monitor API to get the details of this monitor.

Busy Hours Report

GET /reports/busy_hours/{monitor_id}?period={report_period_constants}&segment_type={segment_types}

Request Example

$ curl "https://www.site24x7.com/api/reports/busy_hours/123412341234123411?period=3&segment_type=2" \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-authtoken a12345b6c8de901f2gh3456ij78k901l"

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": {
    "info": {
      "formatted_end_time": "April 20, 2016 6:28 PM IST",
      "resource_id": "113770000025720011",
      "resource_type_name": "Monitor",
      "period_name": "Today",
      "generated_time": "2016-04-20T18:28:51+0530",
      "report_name": "Busy Hours Report",
      "end_time": "2016-04-20T18:28:51+0530",
      "unit": "ms",
      "start_time": "2016-04-20T00:00:00+0530",
      "segment_type": 2,
      "report_type": 14,
      "period": 3,
      "resource_name": "custom period reports",
      "segment_type_name": "Day of Week",
      "formatted_start_time": "April 20, 2016 12:00 AM IST",
      "attribute_name": "Response Time",
      "formatted_generated_time": "April 20, 2016 6:28 PM IST",
      "resource_type": 2
    },
    "busy_hours": [
      {
        "value": 1892,
        "period": 3
      },
      {
        "value": 1891,
        "period": 4
      }
    ]
  }
}

Retrieve Busy Hours report of the monitor for the given period.

Path Parameters

Param Type Description
monitor_id string Mandatory
Unique ID of the monitor.
You can find monitor_id using the monitor list api.

Query Parameters

Param Type Description
period int Mandatory
Busy hours report is generated within this predefined interval.
segment_type int Mandatory
To specifiy how the busy hours reports has to be segmented.

Response Attributes

Attribute Type Description
busy_hours JSON array JSON Format
: {value:$value, period:$period_constant}
resource_id string ID of the monitor or monitor group
resource_name string Name of the monitor or monitor group
period string ID of the period
period_name string Name of the period
generated_time string Report generation time
report_name string Name of the report
report_type string Report Types
start_time string The start time of the data displayed in the report
end_time string The end time of the data displayed in the report
attribute_name string Name of the report attribute
unit string Unit of the report attribute
segment_type string Segment Types
segment_type_name string Name of the segment

Health Trend Report

Obtain the total downtimes, alarms and average performance of the monitor for each month of the year.

Health Trend Report by Monitor

GET /reports/trend/{monitor_id}

Request Example

$ curl https://www.site24x7.com/api/reports/trend/113770000023198049 \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-authtoken a12345b6c8de901f2gh3456ij78k901l"

Response Example

{
  "code": 0,
  "message": "success",
  "data": {
    "trend": [
      {
        "availability_percentage": 74.68,
        "year": 2016,
        "alarm_count": 1,
        "down_count": 1,
        "month": 3,
        "attribute_value": 692
      },
      {
        "availability_percentage": 100,
        "year": 2016,
        "alarm_count": 0,
        "down_count": 0,
        "month": 4
      }
    ],
    "info": {
      "resource_name": "Test web",
      "end_time": "2016-04-26T11:03:38+0530",
      "resource_type_name": "Monitor",
      "report_name": "Trend Report",
      "period_name": "Custom Period",
      "formatted_start_time": "March 4, 2016 11:58 AM IST",
      "generated_time": "2016-04-26T11:03:38+0530",
      "formatted_end_time": "April 26, 2016 11:03 AM IST",
      "attribute_name": "Response Time",
      "start_time": "2016-03-04T11:58:31+0530",
      "resource_type": 2,
      "period": 50,
      "formatted_generated_time": "April 26, 2016 11:03 AM IST",
      "resource_id": "113770000023198049",
      "unit": "ms",
      "report_type": 13
    }
  }
}

Get the overall health trend report of a particular monitor.

Path Parameters

Param Type Description
monitor_id string Mandatory
Unique ID of the monitor

Response Attributes

Attribute Type Description
availability_percentage float Gives the total availability percentage of the monitor for the month.
year int Year for which the report is generated.
alarm_count int Total alarms for the monitor for the month.
down_count int Total outages for the monitor for the month.
attribute_value float Average performance of the monitor for the month.
month int Month ID

Health Trend Report by Monitor group

GET /reports/trend/group/{group_id}

Request Example

$ curl https://www.site24x7.com/api/reports/trend/group/113770000026704011 \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-authtoken a12345b6c8de901f2gh3456ij78k901l"

Response Example

{
  "code": 0,
  "message": "success",
  "data": {
    "trend": [
      {
        "availability_percentage": 100,
        "year": 2015,
        "alarm_count": 0,
        "down_count": 0,
        "month": 8
      },
      {
        "availability_percentage": 58.44,
        "year": 2015,
        "alarm_count": 10,
        "down_count": 10,
        "month": 9
      },
      {
        "availability_percentage": 21.71,
        "year": 2015,
        "alarm_count": 1,
        "down_count": 1,
        "month": 10
      },
      {
        "availability_percentage": 0,
        "year": 2015,
        "alarm_count": 2,
        "down_count": 2,
        "month": 11
      },
      {
        "availability_percentage": 0,
        "year": 2015,
        "alarm_count": 6,
        "down_count": 6,
        "month": 12
      },
      {
        "availability_percentage": 0,
        "year": 2016,
        "alarm_count": 0,
        "down_count": 0,
        "month": 1
      },
      {
        "availability_percentage": 0,
        "year": 2016,
        "alarm_count": 5,
        "down_count": 5,
        "month": 2
      },
      {
        "availability_percentage": 0,
        "year": 2016,
        "alarm_count": 0,
        "down_count": 0,
        "month": 3
      },
      {
        "availability_percentage": 0,
        "year": 2016,
        "alarm_count": 0,
        "down_count": 0,
        "month": 4
      }
    ],
    "info": {
      "resource_name": "Amazon Instance",
      "end_time": "2016-04-26T11:23:55+0530",
      "resource_type_name": "Group",
      "report_name": "Trend Report",
      "period_name": "Custom Period",
      "formatted_start_time": "August 25, 2015 6:05 PM IST",
      "generated_time": "2016-04-26T11:23:58+0530",
      "formatted_end_time": "April 26, 2016 11:23 AM IST",
      "start_time": "2015-08-25T18:05:18+0530",
      "resource_type": 1,
      "period": 50,
      "formatted_generated_time": "April 26, 2016 11:23 AM IST",
      "resource_id": "113770000026704011",
      "report_type": 13
    }
  }
}

Get the overall health trend report of a particular monitor group.

Path Parameters

Param Type Description
group_id int Mandatory
Unique ID of the monitor group.
You can find group_id using the monitor group list api.

Response Attributes

Attribute Type Description
availability_percentage float Gives the total availability percentage of the monitor for the month.
year int Year for which the report is generated.
alarm_count int Total alarms for the monitor for the month.
down_count int Total outages for the monitor for the month.
month int Month ID

Health Trend Report by monitor type

GET /reports/trend/type/{monitor_type}

Request Example

$ curl https://www.site24x7.com/api/reports/trend/type/PORT \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-authtoken a12345b6c8de901f2gh3456ij78k901l"

Response Example

{
  "code": 0,
  "message": "success",
  "data": {
    "trend": [
      {
        "availability_percentage": 100,
        "year": 2014,
        "alarm_count": 0,
        "down_count": 0,
        "month": 5
      },
      {
        "availability_percentage": 100,
        "year": 2014,
        "alarm_count": 0,
        "down_count": 0,
        "month": 6
      },
      {
        "availability_percentage": 100,
        "year": 2014,
        "alarm_count": 0,
        "down_count": 0,
        "month": 7
      },
      {
        "availability_percentage": 100,
        "year": 2014,
        "alarm_count": 0,
        "down_count": 0,
        "month": 8
      },
      {
        "availability_percentage": 100,
        "year": 2014,
        "alarm_count": 0,
        "down_count": 0,
        "month": 9
      },
      {
        "availability_percentage": 100,
        "year": 2014,
        "alarm_count": 0,
        "down_count": 0,
        "month": 10
      },
      {
        "availability_percentage": 100,
        "year": 2014,
        "alarm_count": 0,
        "down_count": 0,
        "month": 11
      },
      {
        "availability_percentage": 100,
        "year": 2014,
        "alarm_count": 0,
        "down_count": 0,
        "month": 12
      },
      {
        "availability_percentage": 100,
        "year": 2015,
        "alarm_count": 0,
        "down_count": 0,
        "month": 1
      },
      {
        "availability_percentage": 100,
        "year": 2015,
        "alarm_count": 0,
        "down_count": 0,
        "month": 2
      },
      {
        "availability_percentage": 100,
        "year": 2015,
        "alarm_count": 0,
        "down_count": 0,
        "month": 3
      },
      {
        "availability_percentage": 100,
        "year": 2015,
        "alarm_count": 0,
        "down_count": 0,
        "month": 4
      },
      {
        "availability_percentage": 100,
        "year": 2015,
        "alarm_count": 0,
        "down_count": 0,
        "month": 5
      },
      {
        "availability_percentage": 97.97,
        "year": 2015,
        "alarm_count": 7,
        "down_count": 7,
        "month": 6
      },
      {
        "availability_percentage": 99.95,
        "year": 2015,
        "alarm_count": 3,
        "down_count": 3,
        "month": 7
      },
      {
        "availability_percentage": 0,
        "year": 2015,
        "alarm_count": 7,
        "down_count": 7,
        "month": 8
      },
      {
        "availability_percentage": 0,
        "year": 2015,
        "alarm_count": 1,
        "down_count": 1,
        "month": 9
      },
      {
        "availability_percentage": 0,
        "year": 2015,
        "alarm_count": 3,
        "down_count": 1,
        "month": 10
      },
      {
        "availability_percentage": 0,
        "year": 2015,
        "alarm_count": 45,
        "down_count": 18,
        "month": 11
      },
      {
        "availability_percentage": 0,
        "year": 2015,
        "alarm_count": 37,
        "down_count": 8,
        "month": 12
      },
      {
        "availability_percentage": 0,
        "year": 2016,
        "alarm_count": 5,
        "down_count": 1,
        "month": 1
      },
      {
        "availability_percentage": 0,
        "year": 2016,
        "alarm_count": 7,
        "down_count": 1,
        "month": 2
      },
      {
        "availability_percentage": 0,
        "year": 2016,
        "alarm_count": 8,
        "down_count": 1,
        "month": 3
      },
      {
        "availability_percentage": 0,
        "year": 2016,
        "alarm_count": 34,
        "down_count": 15,
        "month": 4
      }
    ],
    "info": {
      "resource_name": "Port Monitor",
      "end_time": "2016-04-26T11:29:49+0530",
      "resource_type_name": "All Monitors",
      "report_name": "Trend Report",
      "period_name": "Custom Period",
      "formatted_start_time": "May 8, 2014 5:36 PM IST",
      "generated_time": "2016-04-26T11:29:53+0530",
      "formatted_end_time": "April 26, 2016 11:29 AM IST",
      "start_time": "2014-05-08T17:36:57+0530",
      "resource_type": 0,
      "period": 50,
      "formatted_generated_time": "April 26, 2016 11:29 AM IST",
      "report_type": 13
    }
  }
}

Get the overall health trend report of a particular type.

Path Parameters

Param Type Description
monitor_type string Mandatory
Type of the monitor.

Response Attributes

Attribute Type Description
availability_percentage float Gives the total availability percentage of the monitor for the month.
year int Year for which the report is generated.
alarm_count int Total alarms for the monitor for the month.
down_count int Total outages for the monitor for the month.
month int Month ID

Health trend Report for all monitors

GET /reports/trend

Request Example

$ curl https://www.site24x7.com/api/reports/trend \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-authtoken a12345b6c8de901f2gh3456ij78k901l"

Response Example

{
  "code": 0,
  "message": "success",
  "data": {
    "trend": [
      {
        "availability_percentage": 100,
        "year": 2014,
        "alarm_count": 0,
        "down_count": 0,
        "month": 4
      },
      {
        "availability_percentage": 100,
        "year": 2014,
        "alarm_count": 0,
        "down_count": 0,
        "month": 5
      },
      {
        "availability_percentage": 100,
        "year": 2014,
        "alarm_count": 0,
        "down_count": 0,
        "month": 6
      },
      {
        "availability_percentage": 100,
        "year": 2014,
        "alarm_count": 0,
        "down_count": 0,
        "month": 7
      },
      {
        "availability_percentage": 100,
        "year": 2014,
        "alarm_count": 0,
        "down_count": 0,
        "month": 8
      },
      {
        "availability_percentage": 100,
        "year": 2014,
        "alarm_count": 0,
        "down_count": 0,
        "month": 9
      },
      {
        "availability_percentage": 100,
        "year": 2014,
        "alarm_count": 0,
        "down_count": 0,
        "month": 10
      },
      {
        "availability_percentage": 100,
        "year": 2014,
        "alarm_count": 0,
        "down_count": 0,
        "month": 11
      },
      {
        "availability_percentage": 100,
        "year": 2014,
        "alarm_count": 0,
        "down_count": 0,
        "month": 12
      },
      {
        "availability_percentage": 99.32,
        "year": 2015,
        "alarm_count": 5,
        "down_count": 4,
        "month": 1
      },
      {
        "availability_percentage": 95.17,
        "year": 2015,
        "alarm_count": 1,
        "down_count": 0,
        "month": 2
      },
      {
        "availability_percentage": 90.99,
        "year": 2015,
        "alarm_count": 79,
        "down_count": 60,
        "month": 3
      },
      {
        "availability_percentage": 84.84,
        "year": 2015,
        "alarm_count": 171,
        "down_count": 132,
        "month": 4
      },
      {
        "availability_percentage": 80.87,
        "year": 2015,
        "alarm_count": 1520,
        "down_count": 178,
        "month": 5
      },
      {
        "availability_percentage": 65.32,
        "year": 2015,
        "alarm_count": 3263,
        "down_count": 487,
        "month": 6
      },
      {
        "availability_percentage": 64.05,
        "year": 2015,
        "alarm_count": 2476,
        "down_count": 1287,
        "month": 7
      },
      {
        "availability_percentage": 26.91,
        "year": 2015,
        "alarm_count": 2716,
        "down_count": 421,
        "month": 8
      },
      {
        "availability_percentage": 16.88,
        "year": 2015,
        "alarm_count": 5480,
        "down_count": 1689,
        "month": 9
      },
      {
        "availability_percentage": 15.51,
        "year": 2015,
        "alarm_count": 5920,
        "down_count": 2853,
        "month": 10
      },
      {
        "availability_percentage": 12.75,
        "year": 2015,
        "alarm_count": 4188,
        "down_count": 2066,
        "month": 11
      },
      {
        "availability_percentage": 11.75,
        "year": 2015,
        "alarm_count": 4404,
        "down_count": 1943,
        "month": 12
      },
      {
        "availability_percentage": 12.92,
        "year": 2016,
        "alarm_count": 3036,
        "down_count": 541,
        "month": 1
      },
      {
        "availability_percentage": 20.99,
        "year": 2016,
        "alarm_count": 3657,
        "down_count": 1600,
        "month": 2
      },
      {
        "availability_percentage": 22.6,
        "year": 2016,
        "alarm_count": 6338,
        "down_count": 5283,
        "month": 3
      },
      {
        "availability_percentage": 28.22,
        "year": 2016,
        "alarm_count": 1705,
        "down_count": 1303,
        "month": 4
      }
    ],
    "info": {
      "resource_name": "",
      "end_time": "2016-04-26T11:32:22+0530",
      "resource_type_name": "All Monitors",
      "report_name": "Trend Report",
      "period_name": "Custom Period",
      "formatted_start_time": "April 10, 2014 12:44 PM IST",
      "generated_time": "2016-04-26T11:32:32+0530",
      "formatted_end_time": "April 26, 2016 11:32 AM IST",
      "start_time": "2014-04-10T12:44:18+0530",
      "resource_type": 0,
      "period": 50,
      "formatted_generated_time": "April 26, 2016 11:32 AM IST",
      "report_type": 13
    }
  }
}

Get the overall health trend report for all the monitors in your account.

Response Attributes

Attribute Type Description
availability_percentage float Gives the total availability percentage of the monitor for the month.
year int Year for which the report is generated.
alarm_count int Total alarms for the monitor for the month.
down_count int Total outages for the monitor for the month.
month int Month ID

Top N Reports

Obtain the Top N monitors of a particular monitor type by attribute over a specified period of time.

Top N Report by Monitor Type

GET /reports/top_n/{monitor_type}?limit={N}&period={report_period_constants}

Request Example

$ curl "https://www.site24x7.com/api/reports/top_n/PORT?limit=10&period=3" \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-authtoken a12345b6c8de901f2gh3456ij78k901l"

Response Example

{
  "code": 0,
  "message": "success",
  "data": {
    "report": [
      {
        "max": "10436",
        "min": "3272",
        "monitor_name": "PORT",
        "average": "3294",
        "monitor_id": "113770000000132190"
      },
      {
        "max": "421",
        "min": "208",
        "monitor_name": "PORT_PROBEprobe10aprpre",
        "average": "271",
        "monitor_id": "113770000005174001"
      }
    ],
    "info": {
      "end_time": "2016-04-26T11:54:23+0530",
      "report_name": "Top N Reports",
      "limit": "10",
      "formatted_start_time": "April 26, 2016 12:00 AM IST",
      "period_name": "Today",
      "formatted_end_time": "April 26, 2016 11:54 AM IST",
      "generated_time": "2016-04-26T11:54:23+0530",
      "attribute_name": "response_time",
      "start_time": "2016-04-26T00:00:00+0530",
      "timezone": "IST",
      "units": {
        "response_time": "ms"
      },
      "period": 3,
      "formatted_generated_time": "April 26, 2016 11:54 AM IST",
      "monitor_type": "PORT",
      "report_type": 15
    }
  }
}

Get the top N report for a particular monitor types.

Path Parameters

Param Type Description
monitor_type string Mandatory
Type of the monitor.

Query Parameters

Param Type Description
period int Mandatory
Top N report is generated within this predefined interval.
limit int Mandatory
Number of monitors to be retreived. N = 10,25,50,100. Default limit is 10.

Response Attributes

Attribute Type Description
max float Maximum value of the selected attribute in the given period.
min float Minimum value of the selected attribute in the given period.
average float Average value of the selected attribute in the given period.
monitor_name string Name of the monitor corresponding to the monitor.
monitor_id string Unique ID of the monitor. Use retrieve monitor API to get the details of this monitor.

Top N Report by Monitor Type and Attribute Type

GET /reports/top_n/{monitor_type}/{attribute_name}?limit={N}&period={report_period_constants}

Request Example

$ curl "https://www.site24x7.com/api/reports/top_n/PORT/response_time?limit=10&period=3" \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-authtoken a12345b6c8de901f2gh3456ij78k901l"

Response Example

{
  "code": 0,
  "message": "success",
  "data": {
    "report": [
      {
        "max": "10436",
        "min": "3272",
        "monitor_name": "PORT",
        "average": "3294",
        "monitor_id": "113770000000132190"
      },
      {
        "max": "421",
        "min": "208",
        "monitor_name": "PORT_PROBEprobe10aprpre",
        "average": "271",
        "monitor_id": "113770000005174001"
      }
    ],
    "info": {
      "end_time": "2016-04-26T11:54:23+0530",
      "report_name": "Top N Reports",
      "limit": "10",
      "formatted_start_time": "April 26, 2016 12:00 AM IST",
      "period_name": "Today",
      "formatted_end_time": "April 26, 2016 11:54 AM IST",
      "generated_time": "2016-04-26T11:54:23+0530",
      "attribute_name": "response_time",
      "start_time": "2016-04-26T00:00:00+0530",
      "timezone": "IST",
      "units": {
        "response_time": "ms"
      },
      "period": 3,
      "formatted_generated_time": "April 26, 2016 11:54 AM IST",
      "monitor_type": "PORT",
      "report_type": 15
    }
  }
}

Get the top N report for a particular attribute of a particular monitor types.

Path Parameters

Param Type Description
monitor_type string Mandatory
Type of the monitor.
attribute_name string Mandatory
Top N Attribute list

Query Parameters

Param Type Description
period int Mandatory
Top N report is generated within this predefined interval.
limit int Mandatory
Number of monitors to be retreived. N = 10,25,50,100. Default limit is 10.

Response Attributes

Attribute Type Description
max float Maximum value of the selected attribute in the given period.
min float Minimum value of the selected attribute in the given period.
average float Average value of the selected attribute in the given period.
monitor_name string Name of the monitor corresponding to the monitor.
monitor_id string Unique ID of the monitor. Use retrieve monitor API to get the details of this monitor.

Top N Report by Monitor Type in a particular Monitor Group

GET /reports/top_n/{monitor_type}?limit={N}&period={report_period_constants}&group_id={group_id}

Request Example

$ curl "https://www.site24x7.com/api/reports/top_n/URL?limit=10&period=3&group_id=113770000005151225" \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-authtoken a12345b6c8de901f2gh3456ij78k901l"

Response Example

{
  "code": 0,
  "message": "success",
  "data": {
    "report": [
      {
        "throughput": {
          "max": 298.03,
          "min": 42.87,
          "average": 271
        },
        "firstbyte_time": {
          "max": "823",
          "min": "235",
          "average": "248"
        },
        "monitor_name": "Website",
        "responsetime": {
          "max": "9236",
          "min": "2816",
          "average": "3151"
        },
        "monitor_id": "113770000055242267"
      },
      {
        "throughput": {
          "max": 314.77,
          "min": 42.63,
          "average": 271
        },
        "firstbyte_time": {
          "max": "275",
          "min": "218",
          "average": "245"
        },
        "monitor_name": "Website_1",
        "responsetime": {
          "max": "7470",
          "min": "2836",
          "average": "3096"
        },
        "monitor_id": "113770000063069023"
      }
    ],
    "info": {
      "end_time": "2017-06-20T00:00:00+0530",
      "report_name": "Top N Reports",
      "limit": "10",
      "formatted_start_time": "June 19, 2017 12:00 AM IST",
      "period_name": "Yesterday",
      "formatted_end_time": "June 20, 2017 12:00 AM IST",
      "generated_time": "2017-06-20T14:25:14+0530",
      "start_time": "2017-06-19T00:00:00+0530",
      "timezone": "IST",
      "units": {
        "firstbyte_time": "ms",
        "throughput": "KB/sec",
        "responsetime": "ms"
      },
      "period": 4,
      "formatted_generated_time": "June 20, 2017 2:25 PM IST",
      "monitor_type": "URL",
      "report_type": 15
    }
  }
}

Get the top N report for a specific monitor type in a Monitor group.

Path Parameters

Param Type Description
monitor_type string Mandatory
Type of the monitor.

Query Parameters

Param Type Description
period int Mandatory
Top N report is generated within this predefined interval.
limit int Mandatory
Number of monitors to be retreived. N = 10,25,50,100. Default limit is 10.
group_id string Mandatory
Unique ID of the monitor group.
You can find group_id using the monitor group list API.

Response Attributes

Attribute Type Description
max float Maximum value of the selected attribute in the given period.
min float Minimum value of the selected attribute in the given period.
average float Average value of the selected attribute in the given period.
monitor_name string Name of the monitor corresponding to the monitor.
monitor_id string Unique ID of the monitor. Use retrieve monitor API to get the details of this monitor.

Top N Report by Monitor Type and Attribute Type in a particular Monitor group

GET /reports/top_n/{monitor_type}/{attribute_name}?limit={N}&period={report_period_constants}&group_id={group_id}

Request Example

$ curl "https://www.site24x7.com/api/reports/top_n/URL/response_time?limit=10&period=3&group_id=113770000005151225" \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-authtoken a12345b6c8de901f2gh3456ij78k901l"

Response Example

{
  "code": 0,
  "message": "success",
  "data": {
    "report": [
      {
        "max": "9236",
        "min": "2816",
        "monitor_name": "Website",
        "average": "3151",
        "monitor_id": "113770000055242267"
      },
      {
        "max": "7470",
        "min": "2836",
        "monitor_name": "Website_1",
        "average": "3096",
        "monitor_id": "113770000063069023"
      }
    ],
    "info": {
      "end_time": "2017-06-20T00:00:00+0530",
      "report_name": "Top N Reports",
      "limit": "10",
      "formatted_start_time": "June 19, 2017 12:00 AM IST",
      "period_name": "Yesterday",
      "formatted_end_time": "June 20, 2017 12:00 AM IST",
      "generated_time": "2017-06-20T14:25:14+0530",
      "start_time": "2017-06-19T00:00:00+0530",
      "timezone": "IST",
      "units": {
        "firstbyte_time": "ms",
        "throughput": "KB/sec",
        "responsetime": "ms"
      },
      "period": 4,
      "formatted_generated_time": "June 20, 2017 2:25 PM IST",
      "monitor_type": "URL",
      "report_type": 15
    }
  }
}

Get the top N report for a particular attribute of a specific monitor type in a Monitor group.

Path Parameters

Param Type Description
monitor_type string Mandatory
Type of the monitor.
attribute_name string Mandatory
Top N Attribute list

Query Parameters

Param Type Description
period int Mandatory
Top N report is generated within this predefined interval.
limit int Mandatory
Number of monitors to be retreived. N = 10,25,50,100. Default limit is 10.
group_id string Mandatory
Unique ID of the monitor group.
You can find group_id using the monitor group list API.

Response Attributes

Attribute Type Description
max float Maximum value of the selected attribute in the given period.
min float Minimum value of the selected attribute in the given period.
average float Average value of the selected attribute in the given period.
monitor_name string Name of the monitor corresponding to the monitor.
monitor_id string Unique ID of the monitor. Use retrieve monitor API to get the details of this monitor.

Performance Reports

Obtain the overall performance reports of your monitors over a specified period of time.

Performance Report by Monitor

GET /reports/performance/{monitor_id}?granularity={unit_of_time}&locations={location_id}&period={report_period_constants}

Request Example

$ curl "https://www.site24x7.com/api/reports/performance/113770000021171001?granularity=5&locations=113770000000073133&period=8" \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-authtoken a12345b6c8de901f2gh3456ij78k901l"

Response Example

{
  "code": 0,
  "message": "success",
  "data": {
    "table_data": {
      "113770000000073133": {
        "RESPONSETIME": {
          "max": 1895,
          "min": 1780,
          "average": 1868,
          "unit": "alerts.time.milliseconds",
          "average_description": "reports.average.time",
          "title": "global.responsetime",
          "chart_data": [
            [
              "2016-02-01T00:00:00-0800",
              1780
            ],
            [
              "2016-03-01T00:00:00-0800",
              1890
            ],
            [
              "2016-04-01T00:00:00-0700",
              1895
            ]
          ]
        }
      }
    },
    "info": {
      "resource_name": "FEB-12",
      "end_time": "2017-01-01T00:00:00-0800",
      "resource_type_name": "Monitor",
      "report_name": "Performance Report",
      "period_name": "This Year",
      "formatted_start_time": "January 1, 2016 12:00 AM PST",
      "generated_time": "2016-04-26T05:25:36-0700",
      "formatted_end_time": "January 1, 2017 12:00 AM PST",
      "segment_type": 5,
      "start_time": "2016-01-01T00:00:00-0800",
      "resource_type": 2,
      "period": 8,
      "formatted_generated_time": "April 26, 2016 5:25 AM PDT",
      "resource_id": "113770000021171001",
      "monitor_type": "URL",
      "report_type": 16
    },
    "chart_data": [
      {
        "ResponseTimeReportChart": [
          {
            "113770000000073133": {
              "max": [
                1896
              ],
              "label": "priya-1711",
              "min": [
                1780
              ],
              "95_percentile": [
                1895
              ],
              "average": [
                1868
              ],
              "chart_data": [
                [
                  "2016-04-01T00:00:00-0700",
                  4,
                  229,
                  226,
                  1436
                ],
                [
                  "2016-03-01T00:00:00-0800",
                  2,
                  222,
                  222,
                  1445
                ],
                [
                  "2016-02-01T00:00:00-0800",
                  10,
                  217,
                  217,
                  1336
                ]
              ]
            }
          }
        ]
      },
      {
        "ThroughputChart": [
          {
            "113770000000073133": {
              "max": [
                28
              ],
              "label": "priya-1711",
              "min": [
                22
              ],
              "95_percentile": [
                28
              ],
              "average": [
                27
              ],
              "chart_data": [
                [
                  "2016-04-01T00:00:00-0700",
                  22
                ],
                [
                  "2016-03-01T00:00:00-0800",
                  28
                ],
                [
                  "2016-02-01T00:00:00-0800",
                  27
                ]
              ]
            }
          }
        ]
      },
      {
        "LocationResponseTimeChart": [
          {
            "113770000000073133": {
              "max": [
                1895
              ],
              "label": "priya-1711",
              "min": [
                1780
              ],
              "95_percentile": [
                1895
              ],
              "average": [
                1868
              ],
              "chart_data": [
                [
                  "2016-04-01T00:00:00-0700",
                  1895
                ],
                [
                  "2016-03-01T00:00:00-0800",
                  1890
                ],
                [
                  "2016-02-01T00:00:00-0800",
                  1780
                ]
              ]
            }
          }
        ]
      }
    ]
  }
}

Get the overall performance report of a particular monitor.

Path Parameters

Param Type Description
monitor_id string Mandatory
Unique ID of the monitor

Query Parameters

Param Type Description
period int Mandatory
Performance details report is generated within this predefined interval.
granularity int The interval in which the data points in the response have to be divided.
start_date string Mandatory, if period chosen is Custom. Start date for a custom period. Performance details report is generated from this date.
Format - yyyy-mm-dd
end_date string Mandatory, if period chosen is Custom. End date for a custom period. Performance details report is generated until this date.
Format - yyyy-mm-dd
business_hours_id int The predefined business hours during which performance details reports are generated.
moving_average int Used to specify if we need the moving averages for the performance report. N=3,5.
child_id long Get the performance reports for any of the child’s of a particular monitor.
report_attribute string Used to genrate report for a particular attribute instead of the default attribute.
locations int The location for which the performance report is required.

Supported by Network Device, VMware ESX/ESXi Server, VMware VM, vCenter, Website, Web Page Speed (Browser), DNS Server, Port (Custom Protocol), POP Server, Mail Delivery, SMTP Server, Ping, SSL/TLS Certificate, FTP Server, FTP Transfer, REST API, SOAP Web Service, Web Transaction (Browser) and Web Transaction

Response Attributes

Attribute Type Description
table_data json Consists of the tabular data for the primary attribute of the monitor.
max float Maximum value for the selected period.
min float Minimum value for the selected period.
avg float Average value for the selected period.
chart_data JSON array Consists of array of all the data points in the selected period and granularity. The first element in the array is the collection time followed by the performance values of the attributes.
95_percentile float The 95th percentile value for the selected period.
unit string The unit for the values in the report generated.
label string The name of the location or the child for the individual chart data.

Note : The key for the each of the charts in the chart_data is the location ID.

Performance Report by Monitor group

GET /reports/performance/group/{group_id}?period=3

Request Example

$ curl https://www.site24x7.com/api/reports/performance/group/113770000005189687?period=3 \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-authtoken a12345b6c8de901f2gh3456ij78k901l"

Response Example

{
  "code": 0,
  "message": "success",
  "data": {
    "group_data": {
      "FTP": {
        "name": [
          "FTPRTT_TD1",
          "FTPRTT_TD2",
          "FTPRTT_TD3"
        ],
        "attribute_data": [
          {
            "15": {
              "RESPONSETIME": 62
            }
          },
          {
            "15": {
              "RESPONSETIME": 51
            }
          },
          {
            "15": {
              "RESPONSETIME": 69
            }
          }
        ],
        "availability": [
          "91.5",
          "95.97",
          "99.36"
        ]
      }
    },
    "info": {
      "resource_name": "FTPRTT",
      "end_time": "2016-04-27T00:00:00-0700",
      "resource_type_name": "Group",
      "report_name": "Performance Report",
      "period_name": "Today",
      "formatted_start_time": "April 26, 2016 12:00 AM PDT",
      "generated_time": "2016-04-26T06:13:22-0700",
      "formatted_end_time": "April 27, 2016 12:00 AM PDT",
      "start_time": "2016-04-26T00:00:00-0700",
      "resource_type": 1,
      "period": 3,
      "formatted_generated_time": "April 26, 2016 6:13 AM PDT",
      "resource_id": "113770000005189687",
      "report_type": 16
    }
  }
}

Get the overall performance reports of a particular monitor group.

Path Parameters

Param Type Description
group_id int Mandatory
Unique ID of the monitor group.
You can find group_id using the monitor group list api.

Query Parameters

Param Type Description
period int Mandatory
Performance details report is generated within this predefined interval.

Response Attributes

Attribute Type Description
name string array It contains the name of all the monitors in the group.
attribute_data JSON array Consists of json objects which has key as the location ID which in turn has the values for all the primary monitor attributes.
availability float array It is the overall availability of each monitor in the group for the specified period.

Performance Report by Monitor type

GET /reports/performance/type/PORT?period=3

Request Example

$ curl https://www.site24x7.com/api/reports/performance/type/PORT?period=3 \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-authtoken a12345b6c8de901f2gh3456ij78k901l"

Response Example

{
  "code": 0,
  "message": "success",
  "data": {
    "group_data": {
      "PORT": {
        "name": [
          "PORT",
          "PORT_PROBEprobe10aprpre",
          "Hubnuhu"
        ],
        "attribute_data": [
          {
            "1": {
              "RESPONSETIME": 3298
            }
          },
          {
            "37": {
              "RESPONSETIME": 140
            },
            "113770000010018001": {
              "RESPONSETIME": 242
            }
          },
          {
            "113770000000073133": {
              "RESPONSETIME": "-"
            }
          }
        ],
        "availability": [
          "100.0",
          "100.0",
          "100.0"
        ]
      }
    },
    "info": {
      "resource_name": "Port Monitor",
      "end_time": "2016-04-28T00:00:00+0530",
      "resource_type_name": "All Monitors",
      "report_name": "Performance Report",
      "period_name": "Today",
      "formatted_start_time": "April 27, 2016 12:00 AM IST",
      "generated_time": "2016-04-27T11:10:45+0530",
      "formatted_end_time": "April 28, 2016 12:00 AM IST",
      "start_time": "2016-04-27T00:00:00+0530",
      "resource_type": 0,
      "period": 3,
      "formatted_generated_time": "April 27, 2016 11:10 AM IST",
      "report_type": 16
    }
  }
}

Get the overall performance reports of all monitors of a particular type.

Path Parameters

Param Type Description
monitor_type string Mandatory
Type of the monitor.

Query Parameters

Param Type Description
period int Mandatory
Performance details report is generated within this predefined interval.

Response Attributes

Attribute Type Description
name string array It contains the name of all the monitors in the group.
attribute_data JSON array Consists of json objects which has key as the location ID which in turn has the values for all the primary monitor attributes.
availability float array It is the overall availability of each monitor in the group for the specified period.

Performance Report of all monitors

GET /reports/performance?period={report_period_constants}

Request Example

$ curl https://www.site24x7.com/api/reports/performance?period=3 \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-authtoken a12345b6c8de901f2gh3456ij78k901l"

Response Example


{
  "code": 0,
  "message": "success",
  "data": {
    "group_data": {
      "URL": {
        "name": [
          "Sample",
          "Sawi",
          "Amazon",
          "Apple"
        ],
        "attribute_data": [
          {
            "1": {
              "RESPONSETIME": "-"
            }
          },
          {
            "1": {
              "RESPONSETIME": "-"
            }
          },
          {
            "1": {
              "RESPONSETIME": 745
            }
          },
          {
            "1": {
              "RESPONSETIME": 444
            }
          }
        ],
        "availability": [
          "100.0",
          "100.0",
          "100.0",
          "100.0"
        ]
      }
    },
    "info": {
      "resource_name": "",
      "end_time": "2016-04-28T00:00:00+0530",
      "resource_type_name": "All Monitors",
      "report_name": "Performance Report",
      "period_name": "Today",
      "formatted_start_time": "April 27, 2016 12:00 AM IST",
      "generated_time": "2016-04-27T11:15:21+0530",
      "formatted_end_time": "April 28, 2016 12:00 AM IST",
      "start_time": "2016-04-27T00:00:00+0530",
      "resource_type": 0,
      "period": 3,
      "formatted_generated_time": "April 27, 2016 11:15 AM IST",
      "report_type": 16
    }
  }
}

Get overall performance reportS of all monitors in your account.

Query Parameters

Param Type Description
period int Mandatory
Performance details report is generated within this predefined interval.

Response Attributes

Attribute Type Description
name string array It contains the name of all the monitors in the group.
attribute_data JSON array Consists of json objects which has key as the location ID which in turn has the values for all the primary monitor attributes.
availability float array It is the overall availability of each monitor in the group for the specified period.

Custom Reports

Compile precise metrics of your chosen monitors for specified time periods to generate a personalized comparison report for your business needs.

Retrieve Custom Report attribute data

/reports/custom/tabular/{report_id}

Retrieve Custom Report’s attribute data by report_id.

Request Example

$ curl "https://www.site24x7.com/api//reports/custom/tabular/106173000007272003" \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-authtoken a12345b6c8de901f2gh3456ij78k901l"

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": {
    "report_data": [
      {
        "period": 0,
        "period_data": [
          {
            "monitor_id": "106173000006371042",
            "attribute_data": [
              {
                "unit": "ms",
                "attribute_name": "Response Time",
                "attribute": "RESPONSETIME",
                "value": "290"
              }
            ],
            "monitor_name": "DNS_Monitor"
          }
        ],
        "period_name": "Last Hour"
      },
      {
        "period": 5,
        "period_data": [
          {
            "monitor_id": "106173000006371042",
            "attribute_data": [
              {
                "unit": "ms",
                "attribute_name": "Response Time",
                "attribute": "RESPONSETIME",
                "value": "288"
              }
            ],
            "monitor_name": "DNS_Monitor"
          }
        ],
        "period_name": "Last 30 days"
      },
      {
        "period": 50,
        "period_data": [
          {
            "monitor_id": "106173000006371042",
            "custom": {
              "start_time": "2017-03-11T17:38:06-0700",
              "end_time": "2017-03-15T17:38:06-0700"
            },
            "attribute_data": [
              {
                "unit": "ms",
                "attribute_name": "Response Time",
                "attribute": "RESPONSETIME",
                "value": "286"
              }
            ],
            "monitor_name": "DNS_Monitor"
          }
        ],
        "period_name": "28-Feb-2017 15:00 to 10-Mar-2017 15:00"
      },
      {
        "period": 21,
        "period_data": [
          {
            "monitor_id": "106173000006371042",
            "attribute_data": [
              {
                "unit": "ms",
                "attribute_name": "Response Time",
                "attribute": "RESPONSETIME",
                "value": "294"
              }
            ],
            "monitor_name": "DNS_Monitor"
          }
        ],
        "period_name": "12 Hours ago"
      }
    ],
    "info": {
      "report_id": "106173000007272003",
      "description": "",
      "report_name": "My Custom Report",
      "formatted_generated_time": "April 10, 2017 8:19 PM CEST",
      "generated_time": "2017-04-10T20:19:37+0200"
    }
  }
}

Path Parameters

Param Type Description
report_id long Mandatory
Unique Report Id for your Custom Report.

Response Attributes

Attribute Type Description
period int Generate the report for this specified time period.
period_name string Name of the time period.
unit string Measure the performance attribute with this unit.
attribute_name string Name of the performance attribute.
attribute string Selected attribute’s name.
value string Performance attribute’s value for the selected time period.
monitor_name string Name of the monitor corresponding to the monitor type.
monitor_id string Unique ID of the monitor. Use retrieve monitor API to get the details of this monitor.
start_time string Start date for a custom period.
ISO format .
end_time string End date for a custom period.
ISO format .

Create a new Custom Report

POST /reports/custom

Create a new Custom Report.

Request Example for Creating new Custom Report

$ curl https://www.site24x7.com/api/reports/custom \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-authtoken a12345b6c8de901f2gh3456ij78k901l" \
    -d '{
          "report_name": "My Custom Report",
          "description": "",
          "type": 1,
          "config_data": [
            {
              "monitor_id": "106173000006371042",
              "attributes": [
                "RESPONSETIME"
              ],
              "periods": {
                "predefined": [
                  0,
                  21,
                  5
                ],
                "custom": [
                  {
                    "start_time": "2017-03-11T17:38:06-0700",
                    "end_time": "2017-03-15T17:38:06-0700"
                  }
                ]
              }
            }
          ]
        }'

Response Example

HTTP/1.1 201 Created
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": {
    "config_data": [
      {
        "monitor_id": "106173000006371042",
        "periods": {
          "custom": [
            {
              "start_time": "2017-03-11T17:38:06-0700",
              "end_time": "2017-03-15T17:38:06-0700"
            }
          ],
          "predefined": [
            "0",
            "21",
            "5"
          ]
        },
        "attributes": [
          "RESPONSETIME"
        ]
      }
    ],
    "report_id": "106173000007272003",
    "description": "",
    "report_name": "My Custom Report",
    "type": "1"
  }
}

Request Parameters

Param Type Description
report_name string Mandatory
Name of the custom report.
type int Mandatory
Type of the Custom Report.
Table format (1).
monitor_id string Mandatory
Unique ID of the monitor. Use retrieve monitor API to get the details of this monitor.
attributes JSON array Mandatory
The performance attribute of the monitor, which will be recorded in the report.
description string Description for the Custom Report.
predefined JSON array Report time period constants.
start_time string Start date for a custom period.
ISO format .
end_time string End date for a custom period.
ISO format .

Response Attributes

Param Type Description
report_id long Unique Report Id for your Custom Report.
report_name string Name of the custom report.
description string Description for the Custom Report.
type int Type of the Custom Report.
Table format (1).
monitor_id string Unique ID of the monitor. Use retrieve monitor API to get the details of this monitor.
attributes JSON array The performance attribute of the monitor, which will be recorded in the report.
predefined JSON array Report time period constants.
start_time string Start date for a custom period.
ISO format .
end_time string End date for a custom period.
ISO format .

Modify Custom Report

PUT /reports/custom/{report_id}

Update your existing Custom Report.

Request example for updating an existing Custom Report.

$ curl https://www.site24x7.com/api/reports/custom/106173000007272003 \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-authtoken a12345b6c8de901f2gh3456ij78k901l" \
    -d '{
          "report_name": "My Custom Report",
          "description": "",
          "type": 1,
          "config_data": [
            {
              "monitor_id": "106173000006371042",
              "attributes": [
                "RESPONSETIME"
              ],
              "periods": {
                "predefined": [
                  21,
                  5
                ],
                "custom": [
                  {
                    "start_time": "2017-03-11T17:38:06-0700",
                    "end_time": "2017-03-15T17:38:06-0700"
                  }
                ]
              }
            }
          ]
        }'

Response Example

HTTP/1.1 201 Created
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": {
    "config_data": [
      {
        "monitor_id": "106173000006371042",
        "periods": {
          "custom": [
            {
              "start_time": "2017-03-11T17:38:06-0700",
              "end_time": "2017-03-15T17:38:06-0700"
            }
          ],
          "predefined": [
            "21",
            "5"
          ]
        },
        "attributes": [
          "RESPONSETIME"
        ]
      }
    ],
    "report_id": "106173000007272003",
    "description": "",
    "report_name": "My Custom Report",
    "type": "1"
  }
}

Path Parameters

Param Type Description
report_id long Mandatory
Unique Report Id for your Custom Report.

Request Parameters

Param Type Description
report_name string Mandatory
Name of the custom report.
type int Mandatory
Type of the Custom Report.
Table format (1).
monitor_id string Mandatory
Unique ID of the monitor. Use retrieve monitor API to get the details of this monitor.
attributes JSON array Mandatory
The performance attribute of the monitor, which will be recorded in the report.
description string Description for the Custom Report.
predefined JSON array Report time period constants.
start_time string Start date for a custom period.
ISO format .
end_time string End date for a custom period.
ISO format .

Response Attributes

Param Type Description
report_id long Unique Report Id for your Custom Report.
report_name string Name of the custom report.
description staring Description for the Custom Report.
type int Type of the Custom Report.
Table format (1).
monitor_id string Unique ID of the monitor. Use retrieve monitor API to get the details of this monitor.
attributes JSON array The performance attribute of the monitor, which will be recorded in the report.
predefined JSON array Report time period constants.
start_time string Start date for a custom period.
ISO format .
end_time string End date for a custom period.
ISO format .

Retrieve Custom Report’s configuration by type

/reports/custom?type={type}

Retrieve Custom Report’s configuration data by type.

Request Example

$ curl "https://www.site24x7.com/api/reports/custom?type=1" \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-authtoken a12345b6c8de901f2gh3456ij78k901l"

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": [
    {
      "report_id": "106173000007272003",
      "description": "",
      "report_config": [
        {
          "monitor_id": "106173000006371042",
          "periods": {
            "custom": [
              {
                "start_time": "2017-03-11T17:38:06-0700",
                "end_time": "2017-03-15T17:38:06-0700"
              }
            ],
            "predefined": [
              "0",
              "21",
              "5"
            ]
          },
          "attributes": [
            "RESPONSETIME"
          ]
        }
      ],
      "report_name": "My Custom Report",
      "type": 1
    }
  ]
}

Path Parameters

Param Type Description
type int Mandatory
Type of the Custom Report.
Table format (1).

Response Attributes

Param Type Description
report_id long Unique Report Id for your Custom Report.
report_name string Name of the custom report.
description string Description for the Custom Report.
type int Type of the Custom Report.
Table format (1).
monitor_id string Unique ID of the monitor. Use retrieve monitor API to get the details of this monitor.
attributes JSON array The performance attribute of the monitor, which will be recorded in the report.
predefined JSON array Report time period constants.
start_time string Start date for a custom period.
ISO format .
end_time string End date for a custom period.
ISO format .

Retrieve Custom Report configuration by report Id

/reports/custom/{report_id}

Retrieve Custom Report configuration data by custom report_id..

Request Example

$ curl "https://www.site24x7.com/api/reports/custom/106173000007272003" \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-authtoken a12345b6c8de901f2gh3456ij78k901l"

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": {
    "report_id": "106173000007272003",
    "description": "",
    "report_config": [
      {
        "monitor_id": "106173000006371042",
        "periods": {
          "custom": [
            {
              "start_time": "2017-03-11T17:38:06-0700",
              "end_time": "2017-03-15T17:38:06-0700"
            }
          ],
          "predefined": [
            "0",
            "21",
            "5"
          ]
        },
        "attributes": [
          "RESPONSETIME"
        ]
      }
    ],
    "report_name": "My Custom Report",
    "type": 1
  }
}

Path Parameters

Param Type Description
report_id long Mandatory
Unique Report Id for your Custom Report.

Response Attributes

Param Type Description
report_id long Unique Report Id for your Custom Report.
report_name string Name of the custom report.
description string Description for the Custom Report.
type int Type of the Custom Report.
Table format (1).
monitor_id string Unique ID of the monitor. Use retrieve monitor API to get the details of this monitor.
attributes JSON array The performance attribute of the monitor, which will be recorded in the report.
predefined JSON array Report time period constants.
start_time string Start date for a custom period.
ISO format .
end_time string End date for a custom period.
ISO format .

Delete Custom Report

DELETE /reports/custom/{report_id}

Delete a Custom Report.

Request Example

$ curl https://www.site24x7.com/api/reports/custom/106173000007272003 \
    -X DELETE \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-authtoken a12345b6c8de901f2gh3456ij78k901l"

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "success"
}

Path Parameters

Param Type Description
report_id long Mandatory
Unique Report Id for your Custom Report.

Global Benchmark Report

Create a new Global Benchmark Report to analyze the Availability or Response time trends of your website from multiple global locations. You can compare the trends among 25 website monitors or 25 monitor groups and a maximum of 8 locations for the specified time period.

Retrieve Global Benchmark Report metric data

/reports/custom/global_benchmark_report/{report_id}

Retrieve Global Benchmark Report’s metric comparison data by report_id.

Request Example

$ curl "https://www.site24x7.com/api/reports/custom/global_benchmark_report/106173000007272003" \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-authtoken a12345b6c8de901f2gh3456ij78k901l"

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "success",
    "data": {
        "report_data": [{
            "resource_id": "106173000007272112",
            "display_name": "My monitor Group 1",
            "location_metrics": {
                "1": {
                    "average": 98.7,
                    "location_name": "California - US",
                    "95_percentile": 98.7
                },
                "20": {
                    "average": "-",
                    "location_name": "Ireland - IE",
                    "95_percentile": "-"
                }
            }
        }, {
            "resource_id": "106173000007272115",
            "display_name": "My Monitor group 2",
            "location_metrics": {
                "1": {
                    "average": "-",
                    "location_name": "California - US",
                    "95_percentile": "-"
                },
                "20": {
                    "average": 96.2,
                    "location_name": "Ireland - IE",
                    "95_percentile": 96.5
                }
            }
        }],
        "info": {
            "report_id": "106173000007272003",
            "report_name": "Global Benchmark Report",
            "description": "Global Benchmark Report for Reponse Time",
            "selection_type": 1,
            "selection_type_name": "Monitor Groups",
            "monitor_groups": ["106173000007272112", "106173000007272115"],
            "period": 13,
            "locations": [1, 20],
            "attribute": 1
            "attribute_name": "Response Time",
            "type": 2,
            "generated_time": "2017-07-11T16:33:06+0530",
            "formatted_generated_time": "11 July, 2017 4:33 PM IST"
        }
    }
}

Path Parameters

Param Type Description
report_id long Mandatory
Unique Report ID for your Global Benchmark Report.

Response Attributes

Attribute Type Description
report_id long Unique Report ID for your Global Benchmark Report.
report_name string Name of the Global Benchmark Report.
description string Description for the Global Benchmark Report.
type int Type of the Custom Report.
selection_type int The Resources type to be compared in the report.
selection_type_name string The selected Resources type label name.
monitors array If the chosen selection_type is 2 i.e Monitors It will list an array of all the URL type monitor names
monitor_groups array If the chosen selection_type is 1 i.e Monitor Groups
It will list an array of all the associated monitor group IDs.
locations array An array of location IDs to be compared for the choosen metric in the report.
period int Global Benchmark Report is generated for this time period.
attribute int The metric to be compared, returns 1 for Response time comparison and returns 2 for Availability comparison.
attribute_name string The selected attribute label name.
average string Average value for the selected metric (Availability (%) or Response Time (ms) ).
95_percentile string The 95th Percentile value in milliseconds if the above selected attribute is Response Time.

Create a new Global Benchmark Report

POST /reports/custom/global_benchmark_report

Create a new Global Benchmark Report to analyze the Availability or Response time trends for your website monitors from global locations. Compare among 25 monitors or 25 monitor groups from a maximum of 8 locations for your specified time period.

Request example for creating a new Global Benchmark Report

$ curl https://www.site24x7.com/api/reports/custom/global_benchmark_report \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-authtoken a12345b6c8de901f2gh3456ij78k901l" \
    -d '{
          "report_name": "My Global Benchmark Report",
          "description": "A Global Benchmark Report for the response time for Phoenix and California locations",
          "type": 2,
          "config_data": 
            {
              "selection_type" : 1,
              "monitor_groups": ["106173000116371040", "106173000116371043"],
              "attribute": 1,
              "period": 9,
              "locations" :[1,32]
            }
        }'

Response Example

HTTP/1.1 201 Created
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": {
    "report_id": "106173000007272001",
    "description": "A Global Benchmark Report for the response time for Phoenix and California locations",
    "report_name": "My Global Benchmark Report",
    "type": 2,
    "config_data": 
            {
              "selection_type" : 1,
              "monitor_groups": ["106173000116371040", "106173000116371043"],
              "attribute": 1,
              "period": 9,
              "locations" :[1,32]
            },
  }
}

Request Parameters

Param Type Description
report_name string Name of the Global Benchmark Report.
description string Description for the Global Benchmark Report.
type int Type of the Custom Report.
selection_type int The Resources type to be compared in the report.
monitors array If the chosen selection_type is 2 i.e Monitors It will list an array of all the URL type monitor names
monitor_groups array If the chosen selection_type is 1 i.e Monitor Groups
It will list an array of all the associated monitor group IDs.
locations array An array of location IDs to be compared for the choosen metric in the report.
period int Global Benchmark Report is generated for this time period.
attribute int Mandatory
The metric to be compared, choose 1 for Response time comparison and choose 2 for Availability comparison.

Response Attributes

Param Type Description
report_id long Unique Report Id for your Global Benchmark Report.
report_name string Name of the Global Benchmark Report.
description string Description for the Global Benchmark Report.
type int Type of the Custom Report.
selection_type int The Resources type to be compared in the report.
monitors array If the chosen selection_type is 2 i.e Monitors It will list an array of all the URL type monitor names
monitor_groups array If the chosen selection_type is 1 i.e Monitor Groups
It will list an array of all the associated monitor group IDs.
locations array An array of location IDs to be compared for the choosen metric in the report.
period int Global Benchmark Report is generated for this time period.
attribute int Mandatory
The metric to be compared, returns 1 for Response time comparison and returns 2 for Availability comparison.

Modify Global Benchmark Report

PUT /reports/custom/global_benchmark_report/{report_id}

Update your existing Global Benchmark Report.

Request example for updating an existing Global Benchmark Report.

$ curl https://www.site24x7.com/api/reports/custom/global_benchmark_report/106173000007272001 \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-authtoken a12345b6c8de901f2gh3456ij78k901l" \
    -d '{
          "report_name": "Modify Global Benchmark Report",
          "description": "A modified Global Benchmark Reportfor the response time for Phoenix and California locations",
          "type": 2,
          "config_data": 
            {
              "selection_type" : 1,
              "monitor_groups": ["106173000116371040", "106173000116371043"],
              "attribute": 1,
              "period": 9,
              "locations" :[1,32]
            }
        }'

Response Example

HTTP/1.1 201 Created
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": {
    "report_id": "106173000007272001",
    "description": "A modified Global Benchmark Report for the response time for Phoenix and California locations",
    "report_name": "Modify Global Benchmark Report",
    "type": 2,
    "config_data": 
            {
              "selection_type" : 1,
              "monitor_groups": ["106173000116371040", "106173000116371043"],
              "attribute": 1,
              "period": 9,
              "locations" :[1,32]
            },
    }
}

Path Parameters

Param Type Description
report_id long Mandatory
Unique Report ID for your Global Benchmark Report.

Request Parameters

Param Type Description
report_name string Name of the Global Benchmark Report.
description string Description for the Global Benchmark Report.
type int Type of the Custom Report.
selection_type int The Resources type to be compared in the report.
monitors array If the chosen selection_type is 2 i.e Monitors It will list an array of all the URL type monitor names
monitor_groups array If the chosen selection_type is 1 i.e Monitor Groups
It will list an array of all the associated monitor group IDs.
locations array An array of location IDs to be compared for the choosen metric in the report.
period int Global Benchmark Report is generated for this time period.
attribute int Mandatory
The metric to be compared, choose 1 for Response time comparison and choose 2 for Availability comparison.

Response Attributes

Param Type Description
report_id long Unique Report Id for your Global Benchmark Report.
report_name string Name of the Global Benchmark Report.
description string Description for the Global Benchmark Report.
type int Type of the Custom Report.
selection_type int The Resources type to be compared in the report.
monitors array If the chosen selection_type is 2 i.e Monitors It will list an array of all the URL type monitor names
monitor_groups array If the chosen selection_type is 1 i.e Monitor Groups
It will list an array of all the associated monitor group IDs.
locations array An array of location IDs to be compared for the choosen metric in the report.
period int Global Benchmark Report is generated for this time period.
attribute int Mandatory
The metric to be compared, returns 1 for Response time comparison and returns 2 for Availability comparison.

Outage and Alarms

With Outages API, obtain detailed information on the down status of your configured monitor. Alarms API provides you with insights on your monitor’s down, trouble or maintenance status.

Get Outage Details

Obtain the actual down period and the total down duration of your monitors for a specified duration of time.

The Outage Details API response will always have “0” as the outage constant type.

GET /reports/outage?period={report_period_constants}

Request Example

$ curl "https://www.site24x7.com/api/reports/outage?period=2&business_hours_id=113770000019678086" \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-authtoken 07783c4ec295f0ae5123f7f7b56e9517"

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": {
    "outage_details": [
      {
        "outages": [
          {
            "outage_id": "1437045147021",
            "end_time": "2015-07-21T18:54:14-1100",
            "type": 0,
            "start_time": "2015-07-16T00:12:27-1100",
            "duration": "5 days 18 Hrs 42 Mins "
          }
        ],
        "display_name": "apr14",
        "monitor_id": "113770000008080001"
      },
      {
        "outages": [
          {
            "outage_id": "1437376372832",
            "end_time": "2015-07-21T18:54:14-1100",
            "type": 0,
            "start_time": "2015-07-19T20:12:52-1100",
            "duration": "1 days 22 Hrs 41 Mins "
          },
          {
            "outage_id": "1436794673738",
            "end_time": "2015-07-15T09:16:01-1100",
            "type": 0,
            "start_time": "2015-07-15T00:00:00-1100",
            "duration": "9 Hrs 16 Mins "
          }
        ],
        "display_name": "AkhilVM!@#$",
        "monitor_id": "113770000009636043"
      }
    ],
    "info": {
      "formatted_end_time": "July 22, 2015 12:00 AM GMT-11:00",
      "generated_time": "2015-07-21T18:54:14-1100",
      "end_time": "2015-07-22T00:00:00-1100",
      "period_name": "Last 7 days",
      "start_time": "2015-07-15T00:00:00-1100",
      "timezone": "Etc/GMT+11",
      "period": 2,
      "formatted_start_time": "July 15, 2015 12:00 AM GMT-11:00"
    }
  }
}

Query Parameters

Param Type Description
period int Mandatory
Outage details report is generated within this predefined interval.
start_date string Mandatory, if period chosen is Custom.
Start date for a custom period. Outage details report is generated from this date.
Format - yyyy-mm-dd
end_date string Mandatory, if period chosen is Custom.
End date for a custom period. Outage details report is generated until this date.
Format - yyyy-mm-dd
business_hours_id int The predefined business hours during which critical outage details reports are generated.

Response Attributes

Attribute Type Description
outage_id string Unique ID of the outage.
start_time string Outage start time.
end_time string Outage end time.
type int Type of outage.
duration string The total outage duration.
display_name string Name of the monitor for which the outage occured.
monitor_id string Unique ID of the monitor. Use retrieve monitor API to get the details of this monitor.

Get Outage Details of Monitor

Obtain the actual down period and the total down duration of your chosen monitor for a specified duration of time.

The Individual monitor outage details API response will always have “0” as the outage constant type.

GET /reports/outage/{monitor_id}?period={report_period_constants}

Request Example

$ curl "https://www.site24x7.com/api/reports/outage/113770000021689043?period=2&business_hours_id=113770000019678086" \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-authtoken a12345b6c8de901f2gh3456ij78k901l"

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": {
    "outage_details": [
      {
        "display_name": "FEB18-3",
        "outages": [
          {
            "outage_id": "1460988728491",
            "end_time": "2016-04-19T15:19:36+0530",
            "type": 0,
            "start_time": "2016-04-19T00:00:00+0530",
            "reason": "Unable to connect to http://myesuraj-0551:9090/manager/status.",
            "duration": "15 Hrs 20 Mins "
          }
        ],
        "monitor_id": "113770000021689043"
      }
    ],
    "summary_details": {
      "down_count": 1,
      "threshold_profile_details": [],
      "downtime_duration": "15 Hrs 20 Mins ",
      "availability_percentage": 0,
      "threshold_profiles": [
        {
          "name": "TH-ES-FEB18",
          "show_name": false,
          "down_condition": "Report Site as Down on Failure from: All Locations"
        }
      ],
      "mtbf": "0 Mins 0 Secs",
      "unmanaged_duration": "0 Mins 0 Secs",
      "location_profiles": [
        {
          "locations": "Dallas - US,Chicago - US,Chennai - IN,Los Angeles - US,Denver - US,Kansas - US",
          "name": "ES-LP-FEB18"
        }
      ],
      "alarm_count": 1,
      "mttr": "15 Hrs 20 Mins ",
      "maintenance_percentage": 0,
      "maintenance_duration": "0 Mins 0 Secs",
      "availability_duration": "0 Mins 0 Secs",
      "unmanaged_percentage": 0,
      "downtime_percentage": 100
    },
    "info": {
      "resource_name": "FEB18-3",
      "end_time": "2016-04-20T00:00:00+0530",
      "resource_type_name": "Monitor",
      "report_name": "Outage Report",
      "period_name": "Today",
      "formatted_start_time": "April 19, 2016 12:00 AM IST",
      "generated_time": "2016-04-19T15:19:36+0530",
      "formatted_end_time": "April 20, 2016 12:00 AM IST",
      "start_time": "2016-04-19T00:00:00+0530",
      "resource_type": 2,
      "period": 3,
      "formatted_generated_time": "April 19, 2016 3:19 PM IST",
      "resource_id": "113770000021689043",
      "report_type": 12
    }
  }
}

Path Parameters

Param Type Description
monitor_id string Mandatory
Unique ID of the monitor

Query Parameters

Param Type Description
period int Mandatory
Outage details report is generated within this predefined interval.
start_date string Mandatory, if period chosen is Custom.
Start date for a custom period. Outage details report is generated from this date.
Format - yyyy-mm-dd
end_date string Mandatory, if period chosen is Custom.
End date for a custom period. Outage details report is generated until this date.
Format - yyyy-mm-dd
business_hours_id int The predefined business hours during which critical outage details reports are generated.

Response Attributes

Attribute Type Description
outage_id string Unique ID of the outage.
start_time string Outage start time.
end_time string Outage end time.
type int Type of outage.
duration string The total outage duration.
display_name string Name of the monitor for which the outage occured.
monitor_id string Unique ID of the monitor. Use retrieve monitor API to get the details of this monitor.

Get Outage Details of Monitor Groups

Obtain the actual down period and the total down duration of your chosen monitor group during a selected duration of time.

The API response for Monitor Groups outage details will always have “0” as the outage constant type.

GET /reports/outage/group/{group_id}?period={report_period_constants}

Request Example

$ curl https://www.site24x7.com/api/reports/outage/group/113770000005151207?period=3 \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-authtoken ba4604e8e433g9c892e360d53463oec5"

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": {
    "outage_details": [
      {
        "display_name": "MAY7_RBM_TD1",
        "outages": [
          {
            "outage_id": "1460363579476",
            "end_time": "2016-04-19T15:14:13+0530",
            "type": 0,
            "start_time": "2016-04-19T00:00:00+0530",
            "duration": "15 Hrs 14 Mins "
          }
        ],
        "monitor_id": "113770000000198003"
      }
    ],
    "summary_details": {
      "down_count": 1,
      "downtime_duration": "15 Hrs 14 Mins ",
      "availability_percentage": 66.67,
      "mtbf": "1 days 6 Hrs 28 Mins ",
      "unmanaged_duration": "0 Mins 0 Secs",
      "alarm_count": 1,
      "mttr": "15 Hrs 14 Mins ",
      "maintenance_percentage": 0,
      "maintenance_duration": "0 Mins 0 Secs",
      "availability_duration": "1 days 6 Hrs 28 Mins ",
      "unmanaged_percentage": 0,
      "downtime_percentage": 33.33
    },
    "info": {
      "resource_name": "RBM",
      "end_time": "2016-04-20T00:00:00+0530",
      "resource_type_name": "Group",
      "report_name": "Outage Report",
      "period_name": "Today",
      "formatted_start_time": "April 19, 2016 12:00 AM IST",
      "generated_time": "2016-04-19T15:14:13+0530",
      "formatted_end_time": "April 20, 2016 12:00 AM IST",
      "start_time": "2016-04-19T00:00:00+0530",
      "resource_type": 1,
      "period": 3,
      "formatted_generated_time": "April 19, 2016 3:14 PM IST",
      "resource_id": "113770000005151207",
      "report_type": 12
    }
  }
}

Path Parameters

Param Type Description
group_id string Mandatory
Unique ID of the monitor group.
You can find group_id using the monitor group list api.

Query Parameters

Param Type Description
period int Mandatory
Outage details report is generated within this predefined interval.
start_date string Mandatory, if period chosen is Custom.
Start date for a custom period. Outage details report is generated from this date.
Format - yyyy-mm-dd
end_date string Mandatory, if period chosen is Custom.
End date for a custom period. Outage details report is generated until this date.
Format - yyyy-mm-dd
business_hours_id int The predefined business hours during which critical outage details reports are generated.

Response Attributes

Attribute Type Description
outage_id string Unique ID of the outage.
start_time string Outage start time.
end_time string Outage end time.
type int Type of outage.
duration string The total outage duration.
display_name string Name of the monitor for which the outage occured.
monitor_id string Unique ID of the monitor. Use retrieve monitor API to get the details of this monitor.

Mark Outage as maintenance

Update the monitor’s status from downtime to its correct state of maintenance.

PUT /reports/mark_maintenance/{monitor_id}/{outage_id}

Request Example

$ curl https://www.site24x7.com/api/reports/mark_maintenance/113770000009636043/1436794673738 \
    -X PUT \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-authtoken a12345b6c8de901f2gh3456ij78k901l"

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success"
}

Path Parameters

Param Type Description
monitor_id string Mandatory
Unique ID of the monitor
outage_id string Mandatory
Unique ID of the outage

Create Outage by Monitor ID

Mark a monitor’s status as DOWN for a specified time period.

PUT /reports/outage/{monitor_id}

Request Example

$ curl https://www.site24x7.com/api/reports/outage/8000000009005 \
    -X PUT \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-authtoken a12345b6c8de901f2gh3456ij78k901l" \
    -d '{
          "start_time": "2017-03-24T08:05:00+0530",
          "end_time": "2017-03-24T08:30:00+0530",
          "reason": "Unable to connect to http://zylker-0551:9090/manager/status."
        }'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": {
    "outage_id": "1490323020000",
    "end_time": "2017-03-24T08:30:00+0530",
    "start_time": "2017-03-24T08:05:00+0530",
    "reason": "Unable to connect to http://zylker-0551:9090/manager/status.",
    "monitor_id": "8000000009005"
  }
}

Path Parameters

Param Type Description
monitor_id string Mandatory
Unique ID of the monitor

Request Parameters

Param Type Description
start_time string Mandatory
Outage start time in ISO format.
end_time string Mandatory
Outage end time in ISO format.
reason string Mandatory
Reason for the outage.

Response Attributes

Attribute Type Description
outage_id string Unique ID of the outage.
start_time string Outage start time in ISO format.
end_time string Outage end time in ISO format.
monitor_id string Unique ID of the monitor.
reason string Reason for the outage.

Create Outage by Monitor’s Display Name

Mark a monitor’s status as DOWN for a specified time period.

PUT /reports/outage/name/{display_name}

Request Example

$ curl https://www.site24x7.com/api/reports/outage/name/Zylker \
    -X PUT \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-authtoken a12345b6c8de901f2gh3456ij78k901l" \
    -d '{
          "start_time": "2017-03-24T08:05:00+0530",
          "end_time": "2017-03-24T08:30:00+0530",
          "reason": "Unable to connect to http://zylker-0551:9090/manager/status."
        }'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": {
    "outage_id": "1490323020000",
    "end_time": "2017-03-24T08:30:00+0530",
    "display_name": "Zylker",
    "start_time": "2017-03-24T08:05:00+0530",
    "reason": "Unable to connect to http://zylker-0551:9090/manager/status.",
    "monitor_id": "8000000009005"
  }
}

Path Parameters

Param Type Description
display_name string Mandatory
Name of the monitor.

Request Parameters

Param Type Description
start_time string Mandatory
Outage start time in ISO format.
end_time string Mandatory
Outage end time in ISO format.
reason string Mandatory
Reason for the outage.

Response Attributes

Attribute Type Description
outage_id string Unique ID of the outage.
start_time string Outage start time in ISO format.
end_time string Outage end time in ISO format.
display_name string Name of the monitor for which the