Introduction

API Root Endpoint

United States
https://www.site24x7.com/api

Europe
https://www.site24x7.eu/api

China
https://www.site24x7.cn/api

India
https://www.site24x7.in/api

Australia
https://www.site24x7.net.au/api

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

The API requires OAuthtoken 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.

We have multiple data centers in Site24x7:

• United States - .com
• Europe - .eu
• China - .cn
• India - .in
• Australia - .net.au

All examples in the document are based on COM domain. You can change the DC Root endpoint of any example from COM to any DC you want to access.

Getting Started

Example

$ curl https://www.site24x7.com/api/monitors \
    -H 'Accept: application/json; version=2.0' \ 
    -H 'Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f' \ 

All Site24x7 APIs require a Authorization request header for authentication.

Authentication

Zoho Accounts Root Endpoint

United States
https://accounts.zoho.com

Europe
https://accounts.zoho.eu

China
https://accounts.zoho.com.cn

India
https://accounts.zoho.in

Australia
https://accounts.zoho.com.au

Site24x7 REST APIs uses the OAuth 2.0 protocol to authorize and authenticate calls. The OAuth protocol provides a more secure access to protect resources, thereby reducing the hassle of asking for a username and password every time a user logs in.

We have multiple data centers in Zoho:

• United States - .com
• Europe - .eu
• China - .com.cn
• India - .in
• Australia - .com.au

All examples in PART 1 - 4 are based on COM domain. You can change the DC Root endpoint of any example from COM to any DC you want to access.

Please follow the steps below to access Site24x7’s APIs using OAuth 2.0:

Part 1: Registering New Client Application

Register your application with Site24x7 to get your Client ID and Client Secret. For script-based API calls, the Self Client option in the Zoho Developer Console is preferrable or check out the other options based on your client types.

To register your application using the Self Client option,

1. Go to Zoho Developer Console and click on Get Started Now > Self Client > Create Now.
   • United States
   • Europe
   • China
   • India
   • Australia
2. Click on Create. Confirm the process. On successful registration, you will be provided with a set of OAuth 2.0 credentials such as Client ID and Client Secret, that are known to both Zoho and your application.

Note: Do not share these credentials to anyone.

Part 2: Generating Grant Token

Once you have successfully registered the client application, generate a grant token to obtain authorization to use the APIs based on your requirement.

If you have generated the OAuth 2.0 credentials using the Self Client option, then please follow the steps below:

1. Go to Zoho Developer Console and click on the created Self Client.

2. Navigate to the Generate Code tab and provide the Scope(based on the API calls that you are going to use), Description, and the Time Duration for its validity (from 3 minutes to 10 minutes). Get the scopes for the APIs from their respective API document and separate multiple scopes with commas.

3. Click Generate. Copy the code for the mentioned scope.

For other client types (such as web-based), refer here.

Note: Generating a Grant Token is a one-time process. It cannot be generated via API call. Once the Grant Token is generated, refer Part 3 to create a Refresh Token immediately before the former expires. Please note that the Refresh Token is permanent and has no expiry.

Part 3: Generate Access and Refresh Token

After getting the grant token from the above step, make a POST request for the following URL with the given params to generate the access_token:

https://accounts.zoho.com/oauth/v2/token?

Request Example

$ curl  https://accounts.zoho.com/oauth/v2/token \
        -X POST \
        -d "client_id=1000.0SRSZSY37WMZ69405H3TMYI2239V" \
        -d "client_secret=fb0196010f2b70df8db2a173ca2cf59388798abf"\
        -d "code=1000.dd7e47321d48b8a7e312e3d6eb1a9bb8.b6c07ac766ec11da98bf6a261e24dca4"\
        -d "grant_type=authorization_code" \

Response Example

{
    "access_token":"1000.2deaf8d0c268e3c85daa2a013a843b10.703adef2bb337b 8ca36cfc5d7b83cf24",
    "refresh_token":"1000.18e983526f0ca8575ea9c53b0cd5bb58.1bd83a6f2e22c3a7e1309d96ae439cc1",
    "expires_in":3600,
    "api_domain":"https://www.zohoapis.com",
    "token_type":"Bearer"
}

Parameter	Description
client_id	Mandatory Client ID obtained during Client Registration.
client_secret	Mandatory Client Secret obtained during Client Registration.
code	Mandatory The grant token that is obtained in the above step.
grant_type	Mandatory Value must be authorization_code

In the response, you will get both access_token and refresh_token.

• The access_token will expire after some specified seconds (represented by expires_in param in the response). You can regenerate a new access_token using the refresh_token (Refer Part 5: Generate Access Token from Refresh Token).
• The refresh_token is permanent. To revoke a refresh_token, refer Part 6: Revoking a Refresh Token.

Note:

• Each time a re-consent page is accepted, a new refresh token is generated.
• The maximum limit is 20 refresh tokens per user. If this limit is crossed, the first refresh token is automatically deleted to accommodate the latest one. This is done irrespective of whether the first refresh token is in use or not.
• You can only generate a maximum of five refresh tokens in a minute.
• Each refresh token can have a maximum of 15 active access tokens (non expired). When the user creates the 16th access token, the first created access token is automatically deleted to accommodate the latest one.

You can also refer to sample scripts in the community post. Read the kbase article to know about the common OAuth Errors.

Part 4: Calling An API

Once the access and the refresh tokens are generated, API calls can be made by passing the access token in the header.

• Header name should be Authorization
• Header value should be Zoho-oauthtoken {access_token}

To access an MSP Customer or a BU’s data you need to pass their ZAAID in the header. For more information.

• Header name should be Cookie
• Header value should be zaaid={zaaid of the customer/bu}

Note: Access tokens cannot be passed in the request param.

Example

$ curl https://www.site24x7.com/api/monitors \
    -H 'Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f' \ 

List of scopes available in Site24x7:

Scope	Description
account	To access, add, edit, delete users and license related data. Availabe types: Site24x7.Account.Read, Site24x7.Account.Create, Site24x7.Account.Update, Site24x7.Account.Delete, Site24x7.Account.All
admin	To access, add, edit, delete monitors, configuration profiles, third party integrations etc. Availabe types: Site24x7.Admin.Read, Site24x7.Admin.Create, Site24x7.Admin.Update, Site24x7.Admin.Delete, Site24x7.Admin.All
reports	To access, add, edit, delete reports and monitor status. Availabe types: Site24x7.Reports.Read, Site24x7.Reports.Create, Site24x7.Reports.Update, Site24x7.Reports.Delete, Site24x7.Reports.All
operations	To access, add, edit, delete operation related data such as IT Automation, maintenance, status page announcements etc. Availabe types: Site24x7.Operations.Read, Site24x7.Operations.Create, Site24x7.Operations.Update, Site24x7.Operations.Delete, Site24x7.Operations.All
msp	To access, add, edit, delete MSP related data. Availabe types: Site24x7.Msp.Read, Site24x7.Msp.Create, Site24x7.Msp.Update, Site24x7.Msp.Delete, Site24x7.Msp.All
bu	To access, add, edit, delete Business Units related data. Availabe types: Site24x7.Bu.Read, Site24x7.Bu.Create, Site24x7.Bu.Update, Site24x7.Bu.Delete, Site24x7.Bu.All

Part 5: Generate Access Token From Refresh Token

Access tokens have limited validity. In most of the cases, the access tokens expire in one hour. Until then, the access token has unlimited usage. Once it expires, your app will have to use the refresh token to request for a new access token.

Make the following POST request with the given params to get a new access token:

https://accounts.zoho.com/oauth/v2/token?

Request Example

$ curl https://accounts.zoho.com/oauth/v2/token \
        -X POST \
        -d "client_id=1000.0SRSZSY37WMZ69405H3TMYI2239V" \
        -d "client_secret=fb0196010f2b70df8db2a173ca2cf59388798abf" \
        -d "refresh_token=1000.8ecd474019e31d52d2f94aad6c5cb7.4638677ebc14f2f2ee0b6dfb6cebdc"\
        -d "grant_type=refresh_token" \

Response Example

{
    "access_token":"1000.2deaf8d0c268e3c85daa2a013a843b10.703adef2bb337b 8ca36cfc5d7b83cf24",
    "expires_in":3600,
    "api_domain":"https://www.zohoapis.com",
    "token_type":"Bearer"
}

Parameter	Description
client_id	Mandatory Client ID obtained during Client Registration.
client_secret	Mandatory Client Secret obtained during Client Registration.
refresh_token	Mandatory REFRESH TOKEN using which a new access token has to be generated.
grant_type	Mandatory Value must be refresh_token.

Part 6: Revoking a Refresh Token

To revoke a refresh token, make the following POST request with the given params:

https://accounts.zoho.com/oauth/v2/token/revoke?

Request Example

$ curl https://accounts.zoho.com/oauth/v2/token/revoke?token=1000.8ecd474019e31d522f94aad6c5cb7.4638677ebc14f2f2ee0b6dfb6cebdc \
    -X POST

Response Example

{
    "status": "success"
}

Parameter	Description
token	REFRESH TOKEN which is to be revoked

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.

API Versioning

Access the appropriate version of the API using the access header. Unless specified in the respective api section, all our APIs are using version 2.0.

We recommend you to use the current version mentioned for the respective api. The latest version will be better than the previous version in terms of features and performance. Attribute details and examples will be based on the current version.

We will also maintain the details of attributes supported in the previous versions in a separate table in the respective api section for reference of the users who are still using old versions

When will we create a new version for an API?

In general, we make changes to the documented API in a backward compatible manner to ensure that your existing automation does not fail unexpectedly. By backward compatible we mean that we’ll not be removing any existing attributes or changing their data type. However we will add new attributes to the api response, without changing the version. Ensure that your code is flexible to new attributes.

If we make a breaking change such as removing attributes or changing data type for a documented API, we will create a new version of the API and allow the old version to work with the old format.

If at all we plan to make changes without any versioning, we will be notifying you via our community in advance, so that you can make necessary changes to your automation.

API Inspector

An API Inspector helps you check the API response without generating an authtoken.

To access the API Inspector from a web client:
1. Log in to Site24x7.
2. Click on the ? icon next to your profile and choose API Inspector.
3. Provide necessary details:

Request type: Choose from the available list of HTTP Request options. While using POST and PUT methods use proper JSON request payloads to receive the expected response. Based on your role the number of supported HTTP request types might vary, and you can view only those APIs for which you’ve access permissions. Only Super Admins and Admins will have access to POST and PUT requests.

Request URI: Provide the Request URI. For instance : https://www.site24x7.com/api/admin/monitors

Version: Choose the API version of your preference. The version supported by default is 2.0. You can view the latest version of your API in the respective section of the API document.

Note: Using the Delete request can delete the chosen entity and it will be an irretrievable action.

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-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" ^
    -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-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" ^
    -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.

• Use double quotes to wrap your JSON data or use a file to import your JSON data.

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.

• Replace \ at the end of each line with ^

MSP API

Example for MSP Account Operation Request

  $ curl https://www.site24x7.com/api/short/msp/customers \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response

{
  "code": 0,
  "message": "success",
  "data": [{  
        "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-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \
    -H "Cookie: 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 OAuthtoken.

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 “zaaid”. You can obtain this unique “zaaid” parameter for your individual customer accounts by initiating a GET API request “/api/short/msp/customers”. You can use the “zaaid” parameter received in this API response.

Business Units API

Example for Business Units Portal Operation Request

  $ curl https://www.site24x7.com/api/short/bu/business_units \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response

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

Example for Business Unit 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-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \
    -H "Cookie: zaaid=657637305"

Site24x7 Business Units Portal users can use APIs to manage their associated Business Unit 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 OAuthtoken.

Business Units Portal Account:

By default, all API requests executed as part of the Business Units Portal 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 Business Units Portal operation, the following error message will be shown “You are not authorized to perform this operation.”

Business Unit Account:

To operate your Business Unit account using APIs, you must pass an additional cookie header parameter “zaaid”. You can obtain this unique “zaaid” parameter for your individual Business Unit accounts by initiating a GET API request “/api/short/bu/business_units”. 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-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f' \
    -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-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f' \
    -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.

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

HTTP status codes help identify failure in the server’s response to your API call

HTTP Status Code

Status Code	Description
200	Success
201	Created
400	Bad Request
401	Unauthorized
403	Forbidden URL
404	URL Not found
405	Method Not Allowed (Method you have called is not supported for the invoked API)
500	Internal Server Error

Responses will be in the JSON format.

JSON Response Parameters

Node Name	Description
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

Errors

Request Example

$ curl https://www.site24x7.com/api/invoices/700000007942 \
    -H 'Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f' 

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.Please refer to HTTP Status Codes under Response section for more information related to codes.

JSON Response Parameters

Node Name	Description
code	The error code returned by the server, for the invoked API.
message	Status Message for the invoked API.

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.
SpokesPerson	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.

Device Key

Get the device key for your Site24x7 account.

GET /api/device_key

Request Example

$ curl "https://www.site24x7.com/api/device_key" \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \

Response Example

{
    "code": 0,
    "message": "success",
    "data": {
        "device_key": "ab_309ad3387385345ef6eba3458573300"
    }
}

oauthscope : Site24x7.Admin.Read

Response Attributes

Attribute	Type	Description
device_key	string	Contains the device key for the account in Site24x7.

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
42	Bottom N Reports
16	Performance Report
17	Summary Report
18	Availability Trend Report
19	Executive Summary SLA Report
21	AWS Guidance Report
23	Advisor Report
25	AWS Inventory Report
31	Server Resources Report
32	Server Inventory Report
33	Hadoop Inventory Report
34	Monitor Status Report

Schedule Report Status Constants

ID	Resource
0	Active
5	Suspend

Schedule Report Criteria Constants

ID	Resource
0	Availability
1	Outage Count
2	Outage Duration

Schedule Report operator Constants

ID	Resource
1	>
2	<
3	>=
4	<=

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
4	Quarterly

Business Quarter Months Constants

ID	Resource
0	Jan - Apr - Jul - Oct
1	Feb - May - Aug - Nov
2	Mar - Jun - Sep - Dec

Schedule Maintenance Constants

ID	Resource
1	Daily
2	Weekly(By Time)
8	Weekly(By Day)
3	Once
5	Monthly(By Date)
6	Monthly(By Day)
9	Yearly

Schedule Maintenance Status Constants

ID	Resource
I	Maintenance In Progress
C	Maintenance Completed
V	Recurring Maintenance that will run on next scheduled maintenance cycle (Daily/Weekly/Monthly)

Day Constants

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

Week Constants

ID	Resource	Description
1	First	First week of the month
2	Second	Second week of the month
3	Third	Third week of the month
4	Fourth	Fourth week of the month
5	Last	Last/fourth week of the month. Supported in Schedule Maintenance

Maintenane End Constants

ID	Resource	Description
0	Never	The maintenance should never end.
1	After ‘n’ times	The maintenance should end after ‘n’ number of executions.
2	On the specified date	The maintenance should end on the specified date.

Period Constants

ID	Resource	Description
0	Last 1 hour	From 60 minutes ago until the current time.
1	Last 24 hours	From 24 hours ago until the current time.
2	Last 7 Days	For example, if the current date is April 15 2018, data will be shown from 12 am of April 08 2018 until 12 am of the current day.
3	Today	From 12 am of the current calendar day until the current time.
4	Yesterday	From 12 am of the previous calendar day until 12 am of the current calendar day.
5	Last 30 Days	For example, if the current date is April 20 2020, data will be shown from 12 am of March 15 2020 until 12 am of the current day.
7	Last Month	For example, if the current month is April, data will be shown from 12 am of March 1st until 12 am of April 1st.
8	This Year	For example, if the current year is April 2020, data will be shown from 12 am of January 1st 2020 until 12 am of the current day.
9	This Quarter	For example, if the current month is April, data will be shown from 12 am of April 1st until 12 am of the current day in the quarter.
11	This Week	For example, if the current day is Wednesday, data will be shown from 12 am of Sunday of the current calendar week until 12 am of the current calendar day (Wednesday).
12	Last Week	For example, if the current day is Wednesday, data will be shown from 12 am of Sunday of the previous calendar week until 12 am of Sunday of the current week.
13	This Month	For example, if the current month is April, data will be shown from 12 am of April 1st until 12 am of the current day.
17	Last 6 hours	From 6 hours ago until the current time.
18	Last 12 hours	From 12 hours ago until the current time.
22	Last Quarter	For example, if the current month is April, data will be shown from 12 am of January 1st until 12 am of April 1st.
25	Last 3 Months	For example, if the current month is April, data will be shown from 12 am of January 1st until 12 am of April 1st. This will exclude the current month.
50	Custom Period	Allows the start and end date for the report based on user’s choice.
51	Last Poll	Last Polled values. This time period is available only for Top N/Bottom N reports and widgets for certain important performance metrics in a monitor type.

Unit of time constants

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

Period and Supported Granularities

ID	Period	Raw (1)	Hourly (2)	Daily (3)	Weekly (4)	Monthly (5)
0	Last 1 hour	✓	✓	×	×	×
1	Last 24 hours	✓	✓	×	×	×
2	Last 7 Days	✓	✓	✓	×	×
3	Today	✓	✓	×	×	×
4	Yesterday	✓	✓	×	×	×
5	Last 30 Days	✓	✓	✓	✓	×
7	Last Month	×	✓	✓	✓	×
8	This Year	×	✓	✓	✓	✓
9	This Quarter	×	✓	✓	✓	✓
11	This Week	✓	✓	✓	×	×
12	Last Week	✓	✓	✓	×	×
13	This Month	✓	✓	✓	✓	×
17	Last 6 hours	✓	✓	×	×	×
18	Last 12 hours	✓	✓	×	×	×
22	Last Quarter	×	✓	✓	✓	✓
25	Last 3 Months	×	✓	✓	✓	✓
51	Last Poll	✓	×	×	×	×

For Custom period, the granularity will be calculated based on the selected start and end dates. Note: Raw granularity will be considered only if the start and end dates are within the last 30 days.

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

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

Metric Aggregation Constants

ID	Metric Aggregation
0	Average
1	95th Percentile

Metrics

ID	Metrics
1	Overall
2	By Day

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
4	Twilio
Voice Call Provider
1	Twilio
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

Product Constants

ID	Resource
0	Site24x7
1	StatusIQ
2	CloudSpend

Site24x7 User Access Constants

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

CloudSpend User Access Constants

Role ID	Role Name
11	Cost Administrator
12	Cost User

StatusIQ User Access Constants

Role ID	Role Name
21	StatusIQ Super Administrator
22	StatusIQ Administrator
23	StatusIQ SpokesPerson
24	StatusIQ Billing Contact
25	StatusIQ Read Only

Job Title Constants

ID	Type
1	IT Engineer
2	Cloud Engineer
3	DevOps Engineer
4	Webmaster
5	CEO/CTO
6	Internal IT
7	Others

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)
UDP	UDP
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
NETWORK-LOADBALANCER	Network Load Balancer
GATEWAY-LOADBALANCER	Gateway Load Balancer
LAMBDAFUNCTION	Lambda Function Monitor
EC-MEMCACHED	EC Memcached Cluster
EC-MEM-NODE	EC Memcached Node
EC-REDIS	EC Redis Node
S3BUCKET	S3 Bucket Monitor
S3ENDPOINT	S3 Object Monitor
S3FOLDER	S3 Folder Monitor
CLOUDFRONT	CloudFront Distribution Monitor
SQS	SQS Queue Monitor
KINESIS-DATA	Kinesis Data Stream Monitor
KINESIS-FIREHOSE	Kinesis Firehose Delivery Stream Monitor
KINESIS-ANALYTICS	Kinesis Analytics Application Monitor
KINESIS-VIDEO	Kinesis Video Stream Monitor
EBSENVIRONMENT	Elastic Beanstalk Environment Monitor
DIRECTCONNECT	Direct Connect Monitor
VPC-VPN	VPC - Virtual Private Network Monitor
APIGATEWAY-STAGE	API Gateway stage Monitor
APIGATEWAY-RESOURCE	API Gateway resource Monitor
ECSCLUSTER	ECS Cluster Monitor
ECSCLUSTERSERVICE	ECS Cluster Service Monitor
REDSHIFT-CLUSTER	Redshift Cluster Monitor
REDSHIFT-NODE	Redshift Node Monitor
EFS	Elastic File System Monitor
SES	Simple Email Service Monitor
STEPFUNCTION	Step Function State Machine Monitor
WAF	Web Application Firewall Monitor
CLOUDSEARCH	CloudSearch Domain Monitor
KMS	Key Management Service Monitor
R53_HEALTHCHECK	Route 53 Health Check Monitor
R53_RESOLVER	Route 53 Resolver Monitor
R53_HOSTEDZONE	Route 53 Hosted Zone Monitor
R53_RECORDSET	Route 53 Hosted Zone Record Set Monitor
ESD	Elasticsearch Monitor
ESDNODE	Elasticsearch Domain Monitor
VPC_NATGATEWAY	NAT Gateway Monitor
EMR	Elastic MapReduce Monitor
WORKSPACE	WorkSpace Monitor
EC2AUTOSCALING	EC2 Auto Scaling Group Monitor
NEPTUNE-CLUSTER	Neptune Cluster Monitor
NEPTUNE-INSTANCE	Neptune Instance Monitor
ACM	Certificate Manager
LIGHTSAIL-INSTANCE	Lightsail Instance Monitor
EKSCLUSTER	EKS Cluster Monitor
EKSNAMESPACE	EKS Namespace Monitor
EKSNODE	EKS Node Monitor
AMQ	Amazon MQ Broker
AMQTOPIC	Amazon MQ Topic
AMQQUEUE	Amazon MQ Queue
AMQNC	Amazon MQ Network Connector
LIGHTSAIL-DATABASE	Lightsail Database Monitor
LIGHTSAIL-LB	Lightsail Load Balancer Monitor
STORAGEGATEWAY	Storage Gateway Monitor
SGFILE	Storage Gateway File Share Monitor
SGVOLUME	Storage Gateway Volume Monitor
TRANSITGATEWAY	Transit Gateway Monitor
TGWATTACHMENT	Transit Gateway Attachment Monitor
DIRECTCONNECTVI	Direct Connect Virtual Interface Monitor
DMSTASK	DMS Replication Task
DMSINSTANCE	DMS Replication Instance
FSX	Amazon FSx
LAMBDA-EDGE	Lambda@Edge Function
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
GUARD-DUTY	Guarduty Monitor
INSPECTOR	Inspector Monitor
SFTP	SFTP Monitor
APIGATEWAY-ROUTE	API Gateway Route Monitor
EC2_CWAGENT	EC2 Cloudwatch Agent Monitor
APPSTREAM	AppStream 2.0 Monitor
AWSHEALTH	AWS Health Monitor
APPSYNC	AWS APPSYNC

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

Secondary Location Check interval

Check Interval	Description
60000	1 min
180000	3 mins
300000	5 mins
600000	10 mins
900000	15 mins
1800000	30 mins
3600000	1 hr
10800000	3 hrs
21600000	6 hrs
86400000	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
14	CloudFront Distribution
15	SQS
16	Elastic Beanstalk
17	Kinesis Data Stream
18	Kinesis Firehose
19	Kinesis Analytics
20	Kinesis Video Stream
21	Direct Connect
22	VPC-VPN
23	API Gateway stage
25	Elastic Container Service
27	Redshift
29	Elastic File System
30	Simple Email Service
31	Step Function State Machine
32	Web Application Firewall
33	CloudSearch Domain
34	Key Management Service
35	Route 53
39	Elasticsearch
40	NAT Gateway
41	Elastic MapReduce
42	WorkSpace
43	EC2 Auto Scaling Group
45	Neptune
46	Certificate Manager
47	Lightsail Instance
48	Amazon MQ
49	EKS
53	Lightsail Database
56	Storage Gateway
57	Storage Gateway File Share
58	Storage Gateway Volume
59	Lightsail Load Balancer
60	Guardduty
61	Transit Gateway
62	Direct Connect Virtual Interface
63	DMS Replication Task
64	DMS Replication Instance
65	Amazon FSx
68	Amazon DocumentDB
69	Lambda@Edge Function
70	Inspector
75	SFTP
79	Systems Manager
82	AWS Health
83	AppSync

AWS Child Types

ID	Type
1	EC2 Instance
2	RDS Instance
3	S3 Bucket
4	DynamoDB
5	SNS Topic
6	Classic Load Balancer
7	Application Load Balancer
8	EC Redis Node
9	EC Memcached Cluster
10	EC Memcached Node
11	Lambda Function
12	S3 Object
13	Network Load Balancer
14	CloudFront Distribution
15	SQS
16	Elastic Beanstalk
17	Kinesis Data Stream
18	Kinesis Firehose
19	Kinesis Analytics
20	Kinesis Video Stream
21	Direct Connect
22	VPC-VPN
23	API Gateway stage
24	API Gateway Resource
25	ECS Cluster
26	ECS Cluster Service
27	Redshift Cluster
28	Redshift Node
29	Elastic File System
30	Simple Email Service
31	Step Function State Machine
32	Web Application Firewall
33	CloudSearch Domain
34	Key Management Service
35	Route 53 Health Check
36	Route 53 Hosted Zone
37	Route 53 Resolver
38	Route 53 Hosted Zone Record Set
39	Elasticsearch
40	NAT Gateway
41	Elastic MapReduce
42	WorkSpace
43	EC2 Auto Scaling Group
44	Neptune Instance
45	Neptune Cluster
46	Certificate Manager
47	Lightsail Instance
48	Amazon MQ Broker
49	EKS Cluster
50	EKS Namespace
51	Amazon MQ Topic
52	Amazon MQ Queue
53	Lightsail Database
54	Amazon MQ Network Connector
55	EKS Node
59	Lightsail Load Balancer
69	Lambda@Edge Function
70	Inspector
75	SFTP
80	API Gateway Route
81	S3 Folder
83	AppSync

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

HTTP Protocol Constants

ID	HTTP Protocol
H1.1	HTTP/1.1
H2	HTTP/2

SSL Protocol Constants

ID	SSL Protocol
Auto	Use all the below SSL protocols
SSLv3	SSLv3
TLSv1	TLSv1
TLSv1.1	TLSv1.1
TLSv1.2	TLSv1.2
TLSv1.3	TLSv1.3

WEBSITE TYPES

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

Browser Type Constants

Indicates which browser will be used for monitoring.

ID	Type
1	Firefox
2	Chrome

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
W	Web Token

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
16	TXT
48	DNSKEY
257	CAA
43	DS

DNS Server Search Config JSON Formats

ID	Type	Description
Lookup Type : A
addr	string	IP address of the host.
ttlo	int	Select an operation to applied on a resolved TTL value.
ttl	int	TTL of the resolved Record.
Lookup Type : AAAA
addr	string	IP address of the host.
ttlo	int	Select an operation to applied on a resolved TTL value.
ttl	int	TTL of the resolved Record.
Lookup Type : NS
target	string	Canonical hostname of the authoritative name server.
ttlo	int	Select an operation to applied on a resolved TTL value.
ttl	int	TTL of the resolved Record.
Lookup Type : CNAME
target	string	Canonical name.
ttlo	int	Select an operation to applied on a resolved TTL value.
ttl	int	TTL of the resolved Record.
Lookup Type : PTR
target	string	Associated domain name.
ttlo	int	Select an operation to applied on a resolved TTL value.
ttl	int	TTL of the resolved Record.
Lookup Type : MX
target	string	Domain name of the authoritative name server.
priority	int	Value of the Priority field.
ttlo	int	Select an operation to applied on a resolved TTL value.
ttl	int	TTL of the resolved Record.
Lookup Type : SRV
port	int	Port.
target	string	Canonical hostname of the machine providing the service.
priority	int	Value of the Priority field.
wt	int	Weight.
ttlo	int	Select an operation to applied on a resolved TTL value.
ttl	int	TTL of the resolved Record.
Lookup Type : TXT
rcvd	string	Record Value.
ttlo	int	Select an operation to applied on a resolved TTL value.
ttl	int	TTL of the resolved Record.
Lookup Type : SOA
pns	string	Primary master name server for this zone.
admin	string	Email address of the administrator responsible for this zone.
serial	int	Serial number.
rff	int	Number of seconds after which secondary name servers should query the master for the SOA record to detect zone changes.
rtf	int	Number of seconds after which secondary name servers should retry to request for the serial number from the master if the master does not respond.
expt	int	Number of seconds after which secondary name servers should stop answering requests for this zone if the master does not respond.
mttl	int	TTL used for negative caching.
ttlo	int	Select an operation to applied on a resolved TTL value.
ttl	int	TTL of the resolved Record.
Lookup Type : DNSKEY
flg	int	Flag (256 for “ZSK” and 257 for “KSK”).
prtcl	int	Protocol.
kalg	int	Algorithm.
kid	int	Key Id.
key	string	Key.
ttlo	int	Select an operation to applied on a resolved TTL value.
ttl	int	TTL of the resolved Record.
Lookup Type : CAA
tag	string	Tag.
certauth	string	Value associated with the chosen tag.
flg	int	Flag.
ttlo	int	Select an operation to applied on a resolved TTL value.
ttl	int	TTL of the resolved Record.
Lookup Type : DS
kid	int	Key Id.
kalg	int	Key algorithm.
halg	int	Hash algorithm.
hash	string	Hash.
ttlo	int	Select an operation to applied on a resolved TTL value.
ttl	int	TTL of the resolved Record.

DNS TTL Operations

ID	Operation
1	Greater than (>)
2	Equal to (=)
3	Less Than (<)

Defacement type Constants

ID	Name
Text	Text Defacement
Script	Script Defacement
Anchor	Anchor Defacement
Image	Image Defacement
Link	Link Defacement
IFrame	IFrame Defacement

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 Profile Types

ID	Profile Type
1	Static Threshold
2	AI-based Threshold

Threshold Condition Constants

ID	Strategy
1	Greater than (>)
2	Less than (<)
3	Greater than or equal to (>=)
4	Less than or equal to (<=)
5	Equal to (=)
6	Not Equal to (≠)

Text Threshold Condition Constants

ID	Strategy
1	Equals
2	Not equals
3	Contains
4	Doesn’t contain
5	On change

Threshold Strategy Constants

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

Threshold Severity Constants

ID	Severity
0	Down
3	Critical
2	Trouble

Anomaly Threshold Constants

ID	Severity
1	Confirmed
2	Likely

Bytes Supporting Units

ID	Unit
1	bytes
2	KB
3	MB
4	GB
5	TB

Time Supporting Units

ID	Unit
1	ms
2	Secs
3	Mins
4	Hrs

Bits Per Second Supporting Units

ID	Unit
1	bps
2	Kbps
3	Mbps
4	Gbps
5	Tbps

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
3	Critical
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)

APM Insight Agent Types

ID	Type
JAVA	For Java Applications
DOTNET	For .NET Applications
DOTNET_SERVICE	For .NET Windows Services
DOTNET_DESKTOP	For .NET Windows Desktop Applications
DOTNET_AZURE_APP_SERVICE	For ASP.NET Applications in Azure App Services
DOTNET_CORE	For ASP.NET Core Applications
PHP	For PHP Applications on Linux
PHP_WINDOWS	For PHP Applications on Windows
RUBY	For Ruby Applications
NODEJS	For Node.js Applications

Resource Type

ID	Type
app	Application
ins	Instance

Geographic Map Attributes

ID	Type
responsetime	Response Time Aggregate for a particular geographic location.
apdex	Apdex Score for a particular geographic location.
errCnt	Error count Aggregate for a particular geographic location.
pageViews	Pageviews Aggregate for a particular geographic location.

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
9	Start/Stop/Stop-Hibernate/Reboot EC2
10	Start/Stop/Reboot/Reboot With Failover RDS
11	Trigger Lambda Function
12	Publish to SNS Topic
13	EC Memcached Node Reboot
14	EC Memcached Cluster Reboot
15	EC Redis Node Reboot
16	Send Message to SQS Queue
17	Start/Stop Kinesis Analytics
19	Elastic Beanstalk Actions
20	Invoke API Gateway Resource URL
21	Reboot Redshift Cluster
22	SES - Send Email
23	Push Data to Kinesis Data Stream
24	Execute Step Function
25	Add Step to EMR Cluster
26	Start/Stop/Reboot/Rebuild Workspace
27	Reboot Neptune Instance
28	Start/Stop/Reboot Lightsail Instance
29	Reboot Amazon MQ Broker
30	Start/Stop/Reboot Lightsail Database
34	Lambda@Edge Function Actions
35	Start/Stop SFTP Server

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
0	All Monitors
1	Monitor Group
2	Monitor
3	Tags
4	Monitor Type

Monitor Group Type Constants

ID	Resource
1	All types
2	Web
3	Server
4	Database
5	Synthetic Transaction
6	Web API
7	APM Insight
8	Network Devices
9	RUM

Monitor Group Resource Type Constants

ID	Resource
0	Monitor Group
1	Subgroup

Outage and Alarms Type Constants

ID	Type
0	Down
2	Trouble
3	Critical
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 Authentication Method Constants

ID	Type
B	Basic Authentication
P	POST Request Body

OAuth Send Token As Method Constants

ID	Type
H	HTTP Request Headers
Q	Query Parameters

Webtoken Send Token As Method Constants

ID	Type
H	HTTP Request Headers
Q	Query Parameters

AWS Discovery Criteria

ID	Type
1	OR
2	AND

Resource File checks constants

CHECK TYPE	CHECKS
2001	Resource Check File Access
2002	Resource Check File Permission
2003	Resource Check File Size
2004	Resource Check File Modify
2005	Resource Check File Content

Resource Directory checks constants

CHECK TYPE	CHECKS
3001	Resource Check Directory Access
3002	Resource Check Directory Permission
3003	Resource Check Directory Size
3004	Resource Check Directory File
3005	Resource Check Directory SubDirectory

TOP N & BOTTOM 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.
S3BUCKET
bucket_size	Bucket size.
num_of_objects	Number of objects.
all_requests	Total number of requests.
head_requests	Number of Head requests.
list_requests	Number of List requests.
post_requests	Number of Post requests.
get_requests	Number of Get requests.
put_requests	Number of Put requests.
delete_requests	Number of Delete requests.
bytes_downloaded	Bytes downloaded.
bytes_uploaded	Bytes uploaded.
first_byte_latency	Latency of first byte.
total_request_latency	Latency of total requests
S3ENDPOINT
response_time	Response time of the configured Object URL.
S3FOLDER
num_of_objects	The number of objects.
total_num_of_objects	The total number of objects.
num_of_objects_modified	The number of objects modified.
num_of_folders	The number of folders.
total_num_of_folders	The total number of folders.
max_object_size	The maximum object size.
min_object_size	The minimum object size.
LOADBALANCER
unhealthy_host_count	Number of unhealthy hosts.
healthy_host_count	Number of healthy hosts.
latency	Latency of sent requests.
request_count_avg	Number of requests sent.
APPLN-LOADBALANCER
unhealthy_host_count	Number of unhealthy hosts.
healthy_host_count	Number of healthy hosts.
latency	Latency of sent requests.
request_count_avg	Number of requests sent.
NETWORK-LOADBALANCER
unhealthy_host_count	Number of unhealthy hosts.
healthy_host_count	Number of healthy hosts.
active_flow_count	Number of TCP active flows.
processed_bytes	Total bytes processed.
GATEWAY-LOADBALANCER
active_flow_count	Number of concurrent flows from clients to targets.
processed_bytes	Number of bytes processed by load balancer.
consumed_lcus_sum	Number of load balancer capacity units used by your load balancer.
new_flow_count	Number of new connections established from clients to targets.
total_healthy_host_count_target	Total number of targets that are considered healthy.
total_unhealthy_host_count_target	Total number of targets that are considered healthy.
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
CLOUDFRONT
requests	Number of requests.
bytes_downloaded	Total bytes downloaded.
bytes_uploaded	Total bytes uploaded.
SQS
sqs_num_of_msgs_sent	Number of sent messages
sqs_num_of_msgs_received	Number of received messages
sqs_num_of_empty_msgs	Number of empty messages
sqs_approx_age_of_oldest_messages	Approximate age of oldest messages
KINESIS-DATA
getrecords_bytes	Number of bytes received in records
putrecord_bytes	Number of bytes sent per record
putrecords_bytes	Number of bytes sent in records
incoming_bytes	Total number of bytes received
getrecords_latency	Time taken to receive records
putrecord_latency	Time taken to send a record
putrecords_latency	Time taken to send records
KINESIS-FIREHOSE
delivery_stream_latency	Time taken per DescribeDeliveryStream operation
incoming_bytes	Total number of bytes received
put_record_bytes	Number of bytes sent in record
put_batch_bytes	Number of bytes sent in batch
put_batch_records	Number of records sent in batch
incoming_records	Total number of records received
KINESIS-ANALYTICS
read_bytes	Number of bytes received
write_bytes	Number of bytes sent
read_records	Number of records received
write_records	Number of records sent
input_duration	Time taken to receive input data
input_success	Success count of Input data
KINESIS-VIDEO
put_bytes	Number of bytes sent
get_bytes	Number of bytes received
fragmentlist_bytes	Number of bytes received for Media fragment
put_requests	Number of requests sent
get_requests	Number of requests received
fragmentlist_requests	Number of requests received for Media fragment
EBSENVIRONMENT
environment_health	Health status of the environment
instances_ok	Number of instances with Ok health status
instances_severe	Number of instances with Severe health status
application_requests_total	Number of requests completed by the environment
DIRECTCONNECT
bps_ingress	Bit rate for inbound data to the AWS side of connection
bps_egress	Bit rate for outbound data from the AWS side of connection
pps_ingress	Packet rate for inbound data to the AWS side of connection
pps_egress	Packet rate for outbound data from the AWS side of connection
crc_error_count	Number of cyclic redundancy check errors
VPC-VPN
total_data_in	Total bytes received through the connection
total_data_out	Total bytes sent through the connection
tunnel_data_in	Bytes received through each tunnel
tunnel_data_out	Bytes sent through each tunnel
APIGATEWAY-STAGE
latency	Time between the receipt of a request and returned response
integration_latency	Time between the relay of a request to backend and returned response
count	Number of API requests
miss_count	Number of requests served from back end
hit_count	Number of requests served from API cache
data_processed	The amount of data processed
connect_count	The number of messages sent to the $connect route integration
message_count	The number of messages sent to the WebSocket API
APIGATEWAY-RESOURCE
latency	Time between the receipt of a request and returned response
integration_latency	Time between the relay of a request to backend and returned response
count	Number of API requests
miss_count	Number of requests served from back end
hit_count	Number of requests served from API cache
ECSCLUSTER
cpu_reservation	Percentage of CPU units that are reserved by running tasks in the cluster
cpu_utilization	Percentage of CPU units that are used in the cluster
memory_reservation	Percentage of memory that is reserved by running tasks in the cluster
memory_utilization	Percentage of memory that is used in the cluster
ECSCLUSTERSERVICE
cpu_utilization	Percentage of CPU units that are used in the service
memory_utilization	Percentage of memory that is used in the service
REDSHIFT-CLUSTER
cpu_utilization	The percentage of CPU utilization.
redshift_database_connections	The number of database connections to a cluster
redshift_network_receive_throughput	The rate at which the node or cluster receives data
redshift_network_transmit_throughput	The rate at which the node or cluster writes data
REDSHIFT-NODE
cpu_utilization	The percentage of CPU utilization.
redshift_node_disk_used	The percent of disk space used
redshift_network_receive_throughput	The rate at which the node or cluster receives data
redshift_network_transmit_throughput	The rate at which the node or cluster writes data
EFS
burst_balance	Number of burst credits in the file system
permitted_throughput	Amount of throughput allowed to the file system
total_io_bytes	Total number of bytes with all file system operations
file_size	File metered size
percent_io_limit	I/O limit of the general purpose performance mode
SES
send	Number of successful email sending API requests.
delivery	Number of emails delivered successfully
reject	Number of rejected send requests
bounce	Number of bounced emails
complaint	Number of emails marked as spam
STEPFUNCTION
execution_time	Time interval between execution start and end
execution_throttled	Number of executions that timed out
execution_started	Number of started executions
execution_failed	Number of failed executions
execution_succeeded	Number of successfully completed executions
WAF
allowed_requests	Total number of allowed requests
blocked_requests	Total number of blocked requests
passed_requests	Total number of passed requests
counted_requests	Total number of counted requests
CLOUDSEARCH
successful_requests	Total number of successful requests
searchable_documents	Total number of searchable documents
index_utilization	The percentage of index utilization
partitions	Total number of partitions
KMS
key_age	Number of days from creation date
days_until_keydelete	Number of days until key deletion
hours_until_keydelete	Hours until key deletion
minutes_until_keydelete	Minutes until key deletion
days_until_expirekeymaterial	Number of days until key material expiration
hours_until_expirekeymaterial	Hours until key material expiration
minutes_until_expirekeymaterial	Minutes until key material expiration
R53_HEALTHCHECK
status	Status of the health check endpoint
health_percent	Percentage of health checker endpoint to be healthy
connection_time	Time taken by health checker to establish a TCP connection with the endpoint
R53_RESOLVER
total_inbound_query	Number of DNS queries forwarded from network to VPCs
total_outbound_query	Number of DNS queries forwarded from VPCs to network
R53_HOSTEDZONE
request_count	Total number of DNS queries received by domain
dns_noerror	Number of DNS queries completed successfully
dns_refused	Number of DNS queries refused by the server
query_cname	Number of queries received for CNAME record type
query_a	Number of queries received for A record type
R53_RECORDSET
request_count	Total number of DNS queries received by record set
dns_noerror	Number of DNS queries completed successfully
dns_refused	Number of DNS queries refused by the server
ESD
es_clusterstatus_green	Indicates status of the cluster.
es_cluster_nodes	The number of nodes in the Amazon ES cluster, including dedicated master nodes.
es_searchable_documents	The total number of searchable documents across all indices in the cluster.
es_cpu_utilization	The percentage of CPU utilization.
VPC_NATGATEWAY
active_connection_count	The total number of concurrent active TCP connections through the NAT Gateway.
conn_attempt_count	The number of connection attempts made through the NAT Gateway.
conn_establishment_count	The number of connections established through the NAT Gateway.
connection_errport_alloc	The number of times the NAT Gateway could not allocate a source port.
idle_time_out_count	The number of connections that transitioned from the active state to the idle state.
packet_drop_count	The number of packets dropped by the NAT Gateway.
EMR
capacity_remaining_gb	Amount of remaining HDFS disk capacity.
stepsfailed_count	Total number of steps that failed between two polls
total_load	Total number of readers and writers reported by all DataNodes in a cluster.
jobs_failed	Number of jobs in the cluster that have failed.
apps_failed	Number of applications submitted to YARN that have failed to complete.
s3bytes_read	Number of bytes read from Amazon S3.
s3bytes_written	Number of bytes written to Amazon S3
hdfsbytes_read	Number of bytes read from HDFS.
hdfsbytes_written	Number of bytes written to HDFS.
WORKSPACE
connection_success	The number of successful connections.
session_launch_time	The amount of time it takes to initiate a WorkSpaces session.
session_latency	The round trip time between the WorkSpaces client and the WorkSpace.
EC2AUTOSCALING
cpu_utilization	CPU Usage
bytes_received	Number of bytes received
bytes_sent	Number of bytes sent
disk_read_operations	Disk read operations
disk_write_operations	Disk write operations
NEPTUNE-CLUSTER
cpu_utilization	The percentage of CPU utilization.
gremlin_requests	The number of requests to Gremlin engine
sparql_requests	The number of requests to the SPARQL engine.
volumebytes_used	The amount of storage used by Neptune DB instances.
NEPTUNE-INSTANCE
cpu_utilization	The percentage of CPU utilization.
gremlin_requests	The number of requests to Gremlin engine
sparql_requests	The number of requests to the SPARQL engine.
ACM
certificate_age	Number of days from creation date.
days_until_expiry	Number of days until certificate expiration.
hours_until_expiry	Number of hours until certificate expiration.
minutes_until_expiry	Number of minutes until certificate expiration.
LIGHTSAIL-INSTANCE
cpu_utilization	The percentage of CPU Usage.
network_in	Number of bytes received.
network_out	Number of bytes sent.
EKSCLUSTER
node_cpu_utilized	Total CPU utilized by nodes.
node_memory_utilized	Total Memory utilized by nodes.
pod_cpu_utilized	Total CPU utilized by pods.
pod_memory_utilized	Total Memory utilized by pods.
EKSNAMESPACE
cpu_utilized	CPU utilized by namespace.
memory_utilized	Memory utilized by namespace.
network_tx	Total bytes transmitted from namespace.
network_rx	Total bytes received by namespace.
EKSNODE
cpu_utilized_per_node	CPU utilized by node.
cpu_reserved_per_node	CPU reserved for node.
memory_utilized_per_node	Memory utilized by node.
memory_reserved_per_node	Memory reserved for node.
AMQ
cpu_utilization	The percentage of allocated EC2 compute units that the broker currently uses.
heap_usage	The percentage of the ActiveMQ JVM memory limit that the broker currently uses.
store_percent_usage	The percent used by the storage limit. If this reaches 100 the broker will refuse messages.
total_consumer_count	The number of message consumers subscribed to destinations on the current broker.
total_message_count	The number of messages stored on the broker.
total_producer_count	The number of message producers active on destinations on the current broker.
AMQTOPIC
consumer_count	The number of consumers subscribed to the destination.
producer_count	The number of producers for the destination.
memory_usage	The percentage of the memory limit that the destination currently uses.
enqueue_count	The number of messages sent to the destination, per minute.
dequeue_count	The number of messages acknowledged by consumers, per minute.
inflight_count	The number of messages sent to consumers that have not been acknowledged.
AMQQUEUE
consumer_count	The number of consumers subscribed to the destination.
producer_count	The number of producers for the destination.
memory_usage	The percentage of the memory limit that the destination currently uses.
enqueue_count	The number of messages sent to the destination, per minute.
dequeue_count	The number of messages acknowledged by consumers, per minute.
inflight_count	The number of messages sent to consumers that have not been acknowledged.
queue_size	The number of messages in the queue.
AMQNC
enqueue_count	The number of messages sent to the destination, per minute.
dequeue_count	The number of messages acknowledged by consumers, per minute.
receive_count	The number of messages that have been received from the remote broker for a duplex network connector.
LIGHTSAIL-DATABASE
cpu_utilization	The percentage of CPU Usage.
db_connections	The number of database connections in use.
network_receive_throughput	The incoming network traffic to the database.
network_transmit_throughput	The outgoing network traffic to the database.
LIGHTSAIL-LB
request_count	The number of requests processed over IPv4.
rejected_connection_count	The number of rejected connections to the Load balancer
STORAGEGATEWAY
user_cpu_percent	Percent of CPU time spent on gateway processing, averaged across all cores.
mem_used_bytes	Amount of RAM currently in use by the gateway VM, in bytes.
io_wait_percent	Percent of time that the gateway is waiting on a response from the local disk.
cloud_bytes_uploaded	The total number of bytes that the gateway uploaded to AWS during the reporting period.
cloud_bytes_downl	The total number of bytes that the gateway downloaded from AWS during the reporting period.
SGFILE
cache_hit_percent	Percent of application read operations from the file shares that are served from cache.
cache_percent_dirty	The file share’s contribution to the overall percentage of the gateway’s cache that has not been persisted to AWS.
cache_percent_used	The file share’s contribution to the overall percent use of the gateway’s cache storage.
cloud_bytes_uploaded	The total number of bytes that the gateway uploaded to AWS during the reporting period.
cloud_bytes_downl	The total number of bytes that the gateway downloaded from AWS during the reporting period.
SGVOLUME
cpu_usage	The percentage of allocated CPU compute units that are currently used by the volume.
memory_usage	The percentage of allocated memory that is currently used by the volume.
cloud_traffic	The number of bytes uploaded and downloaded from the cloud to the volume.
client_traffic	The number of bytes that the volume sent and received from on-premises clients.
TRANSITGATEWAY
tg_bytes_in	The number of bytes received by the transit gateway.
tg_bytes_out	The number of bytes sent from the transit gateway.
DIRECTCONNECTVI
vi_bps_egress	The bitrate for outbound data from the AWS side of the virtual interface.
vi_bps_ingress	The bitrate for inbound data to the AWS side of the virtual interface.
vi_pps_egress	The packet rate for outbound data from the AWS side of the virtual interface.
vi_pps_ingress	The packet rate for inbound data to the AWS side of the virtual interface.
DMSTASK
task_cpu_utilization	The percent of CPU being used by a task.
task_memory_usage	It indicates the portion of memory occupied by a task held in main memory
flt_bw_total	The total full load throughput bandwidth at Target and Source.
flt_row_total	The total full load throughput rows at Target and Source.
cdc_changes_memory_total	The total number of CDC Changes in memory at Target and Source.
cdc_changes_disc_total	The total number of CDC Changes in disk at Target and Source.
DMSINSTANCE
cpu_utilization	The amount of CPU used.
free_storage_mb	The amount of available storage space.
disk_read_operations	The average number of disk read I/O operations per second.
disk_write_operations	The average number of disk write I/O operations per second.
bytes_read_from_disk	The average number of bytes read from disk per second.
bytes_write_to_disk	The average number of bytes write from disk per second.
FSX
total_throughput	The amount of CPU used.
total_iops	The average number of disk I/O operations per second.
free_storage_capacity	The amount of available storage capacity.
LAMBDA-EDGE
invocations_lambda	The number of times the function code is executed.
errors_lambda	The number of invocations that result in a function error.
throttles_lambda	The number of invocation requests that are throttled.
INSPECTOR
high_findings	Count of Inspector High Findings.
medium_findings	Count of Inspector Medium Findings.
low_findings	Count of Inspector Low Findings.
info_findings	Count of Inspector Info Findings.
findings_perrun	Count of Inspector Findings per run.
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
SFTP
bytes_in_average	Bytes In Average
bytes_out_average	Bytes Out Average
bytes_in_sum	Bytes In Sum
bytes_out_sum	Bytes Out Sum
APIGATEWAY-ROUTE
http_latency	Time between the receipt of a request and returned response
http_integration_latency	Time between the relay of a request to backend and returned response
http_count	Number of API requests
data_processed	The amount of data processed
connect_count	The number of messages sent to the $connect route integration
message_count	The number of messages sent to the WebSocket API
EC2_CWAGENT
memory_committed_bytes_in_use	The amount of memory used by Windows agent.
mem_used_percent	The amount of memory used by Linux/UNIX agent.
APPSTREAM
actual_capacity	The total number of instances that are available for streaming or are currently streaming.
available_capacity	The number of idle instances currently available for user sessions.
capacity_utilization	The percentage of instances in a fleet that are being used.
SSM
command_delivery_timed_out	The number of commands with Delivery Timed Out terminal status.
commands_failed	The number of commands with Failed terminal status.
commands_succeeded	The number of commands with Success terminal status.
AWSHEALTH
events_open	The number of health events with Open status.
events_upcoming	The number of health events with Upcoming status.
events_closed	The number of health events with Closed status.
APPSYNC
latency	The time between when AWS AppSync receives a request from a client and when it returns a response to the client.
connect_success	The number of successful WebSocket connections to AWS AppSync.
active_connections	The number of concurrent WebSocket connections from clients to AWS AppSync in 1 minute.
disconnect_success	The number of successful WebSocket disconnections from AWS AppSync.

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
CRON
DURATION	Duration (seconds)
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
NETWORK-LOADBALANCER
CONSUMEDLCUSUM	Number of consumed LCUs
HEALTHYHOSTCOUNT	Number of healthy hosts
UNHEALTHYHOSTCOUNT	Number of unhealthy hosts
ACTIVEFLOWCOUNT	Number of TCP active flows
NEWFLOWCOUNT	Number of TCP new flows
PROCESSEDBYTES	Total bytes processed
TCP_CLIENT_RESET	Number of TCP client reset
TCP_ELB_RESET	Number of TCP ELB reset
TCP_TARGET_RESET	Number of TCP target reset
GATEWAY-LOADBALANCER
ACTIVEFLOWCOUNT	Number of concurrent flows from clients to targets
PROCESSEDBYTES	Total bytes processed
CONSUMEDLCUSUM	Number of consumed LCUs
NEWFLOWCOUNT	Number Of new connections established from clients to targets
TOTALHEALTHYHOSTCOUNTTARGET	Total number of healthy hosts
TOTALUNHEALTHYHOSTCOUNTTARGET	Total number of unhealthy hosts
AVAILABILITYZONEPROCESSEDBYTES	Total bytes processed (Per Availability Zone)
AVAILABILITYZONEACTIVEFLOWCOUNT	Number of concurrent flows from clients to targets (per Availability Zone)
AVAILABILITYZONEACTIVEFLOWCOUNT	Number of concurrent flows from clients to targets (per Availability Zone)
TOTALCOUNTOFCONNECTEDENDPOINTS	Total endpoint connected to gateway load balancer
S3BUCKET
NUMBEROFOBJECTS	Number of objects
BUCKETSIZE	Bucket size
ALLREQUESTS	Total number of requests
GETREQUESTS	Number of get requests
BYTESDOWNLOADED	Total bytes downloaded
HTTP4XXERRORS	Number of HTTP 4xx errors
FIRSTBYTELATENCY	Latency of first byte
S3ENDPOINT
RESPONSETIME	Response Time
S3FOLDER
num_of_objects	The number of objects.
total_num_of_objects	The total number of objects.
num_of_objects_modified	The number of objects modified.
num_of_folders	The number of folders.
total_num_of_folders	The total number of folders.
max_object_size	The maximum object size.
min_object_size	The minimum object size.
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
SQS
APPROXAGEOFOLDESTMSG	The approximate age of the oldest non-deleted message in the queue for last 5 minutes
APPROXNUMOFMSGSDELAYED	The approximate number of messages in the queue that are delayed for last 5 minutes
APPROXNUMOFMSGNOTVISIBLE	The approximate number of messages that are not visible in the queue for last 5 minutes
APPROXNUMOFMSGVISIBLE	The approximate number of messages available for retrieval from the queue for last 5 minutes
NUMOFEMPTYMSGS	Total number of empty receives during the last 5 minutes
NUMOFMSGSDELETED	Total number of messages that were deleted during the last 5 minutes
NUMOFMSGSRECEIVED	Total number of messages that were received during the last 5 minutes
NUMOFMSGSSENT	Total number of messages that were sent during the last 5 minutes
SENTMSGSIZE	Average size of sent messages during the last 5 minutes
CLOUDFRONT
REQUESTS	Number of requests
BYTESDOWNLOADED	Total bytes downloaded
TOTALERRORRATE	Total error rate
KINESIS-DATA
GRLATENCY	Time taken to receive record
GRBYTES	Number of bytes received in record
GRITERATORAGE	Iterator age in receiving record
GRRECORDS	Number of records received from record operation
GRSUCCESS	Success count for Get record
INCOMINGBYTES	Total number of bytes received
INCOMINGRECORDS	Total number of records received
KINESIS-FIREHOSE
INCOMINGBYTES	Total number of bytes received
PUTRECORDBYTES	Number of bytes sent in record
PUTBATCHBYTES	Number of bytes sent in batch
PUTRECORDLATENCY	Time taken to send record
PUTBATCHLATENCY	Time taken to send batch
KINESIS-ANALYTICS
READBYTES	Total number of bytes received
WRITEBYTES	Total number of bytes sent
READRECORDS	Total number of records received
WRITERECORDS	Total number of records sent
INPUT_DURATION	Time taken to send input data
INPUT_SUCCESS	Success count for input data
KINESIS-VIDEO
PUT_BYTES	Total number of bytes sent
GET_BYTES	Total number of bytes received
FRAGMENT_BYTE	Total number of bytes received in media fragment
EBSENVIRONMENT
ENVIRONMENTHEALTH	Health status of the environment
DEBUGEVENTS	Total number of events with debug severity state
FATALEVENTS	Total number of events with fatal severity state
ERROREVENTS	Total number of events with error severity state
INFOEVENTS	Total number of events with info severity state
TRACEEVENTS	Total number of events with trace severity state
WARNEVENTS	Total number of events with warn severity state
INSTANCESOK	Total number of instances with ok health status
INSTANCESPENDING	Total number of instances with pending health status
INSTANCESINFO	Total number of instances with info health status
INSTANCESUNKNOWN	Total number of instances with unknown health status
INSTANCESNODATA	Total number of instances with nodata health status
INSTANCESWARNING	Total number of instances with warning health status
INSTANCESDEGRADED	Total number of instances with degraded health status
INSTANCESSEVERE	Total number of instances with severe health status
APPLICATIONREQUESTSTOTAL	Total number of requests completed by the environment
APPLICATIONREQUESTS2XX	Total number of requests that completed with a 2XX status code
APPLICATIONREQUESTS3XX	Total number of requests that completed with a 3XX status code
APPLICATIONREQUESTS4XX	Total number of requests that completed with a 4XX status code
APPLICATIONREQUESTS5XX	Total number of requests that completed with a 5XX status code
APPLICATIONLATENCYP10	Average time to complete the fastest 10 percent of requests
APPLICATIONLATENCYP50	Average time to complete the fastest 50 percent of requests
APPLICATIONLATENCYP75	Average time to complete the fastest 75 percent of requests
APPLICATIONLATENCYP85	Average time to complete the fastest 85 percent of requests
APPLICATIONLATENCYP90	Average time to complete the fastest 90 percent of requests
APPLICATIONLATENCYP95	Average time to complete the fastest 95 percent of requests
APPLICATIONLATENCYP99	Average time to complete the fastest 99 percent of requests
APPLICATIONLATENCYP99.9	Average time to complete the fastest X percent of requests
DIRECTCONNECT
BPSEGRESS	Bit rate for outbound data from the AWS side of connection
PPSEGRESS	Packet rate for outbound data from the AWS side of connection
CRCERROR	Number of cyclic redundancy check errors
LIGHTLEVELRX	Health of the fiber connection for inbound traffic
CONNECTIONSTATE	State of the connection
VPC-VPN
DATAIN	Total bytes received through the connection
STATE	State of the connection
TUNNELSTATE	State of the tunnel
TUNNELDATAIN	Bytes received through each tunnel
TUNNELDATAOUT	Bytes sent through each tunnel
APIGATEWAY-STAGE
LATENCY	Time between the receipt of a request and returned response
INTEGRATIONLATENCY	Time between the relay of a request to backend and returned response
COUNT	Number of API requests
HITCOUNT	Number of requests served from API cache
MISSCOUNT	Number of requests served from back end
ERROR5XX	Number of server-side errors
ERROR4XX	Number of client-side errors
DATAPROCESSED	The amount of data processed
CONNECTCOUNT	The number of messages sent to the $connect route integration
MESSAGECOUNT	The number of messages sent to the WebSocket API
INTEGRATIONERROR	The number of requests that return a 4XX/5XX response from the integration
CLIENTERROR	The number of requests that have a 4XX response returned by API Gateway before the integration is invoked
EXECUTIONERROR	Errors that occurred when calling the integration
APIGATEWAY-RESOURCE
LATENCY	Time between the receipt of a request and returned response
INTEGRATIONLATENCY	Time between the relay of a request to backend and returned response
COUNT	Number of API requests
HITCOUNT	Number of requests served from API cache
MISSCOUNT	Number of requests served from back end
ERROR5XX	Number of server-side errors
ERROR4XX	Number of client-side errors
TOTALREQUESTCOUNT	Total number of API requests for all methods
TOTALMISSCOUNT	Total number of requests served from API for all methods
TOTALHITCOUNT	Total number of requests served from back end for all methods
ECSCLUSTER
CPURESERVATION	Percentage of CPU units that are reserved by running tasks in the cluster
CPUUTILIZATION	Percentage of CPU units that are used in the cluster
MEMORYRESERVATION	Percentage of memory that is reserved by running tasks in the cluster
MEMORYUTILIZATION	Percentage of memory that is used in the cluster
ECSCLUSTERSERVICE
CPUUTILIZATION	Percentage of CPU units that are used in the service
MEMORYUTILIZATION	Percentage of memory that is used in the service
REDSHIFT-CLUSTER
CPUUTILIZATION	The percentage of CPU utilization
DATABASECONNETIONS	The number of database connections to a cluster
HEALTHSTATUS	Indicates the health of the cluster.
MAINTENANCEMODE	Indicates whether the cluster is in maintenance mode
NETWORKRECEIVETHROUGHPUT	The rate at which the node or cluster receives data
NETWORKTRANSMITTHROUGHPUT	The rate at which the node or cluster writes data
SHORTQUERIESCOMPLETEDPERSECOND	Average number of short queries completed per second
MEDIUMQUERIESCOMPLETEDPERSECOND	Average number of medium queries completed per second
LONGQUERIESCOMPLETEDPERSECOND	Average number of long queries completed per second
SHORTQUERYDURATION	The average amount of time to complete a short query
MEDIUMQUERYDURATION	The average amount of time to complete a medium query
LONGQUERYDURATION	The average amount of time to complete a long query
PLANNINGQUERYRUNTIMEBREAKDOWN	The amount of time all active queries have spent in planning stage of execution
WAITINGQUERYRUNTIMEBREAKDOWN	The amount of time all active queries have spent in waiting stage of execution
READQUERYRUNTIMEBREAKDOWN	The amount of time all active queries have spent in read stage of execution
INSERTQUERYRUNTIMEBREAKDOWN	The amount of time all active queries have spent in insert stage of execution
DELETEQUERYRUNTIMEBREAKDOWN	The amount of time all active queries have spent in delete stage of execution
UPDATEQUERYRUNTIMEBREAKDOWN	The amount of time all active queries have spent in update stage of execution
CTASQUERYRUNTIMEBREAKDOWN	The amount of time all active queries have spent in Create Table AS stage of execution
UNLOADQUERYRUNTIMEBREAKDOWN	The amount of time all active queries have spent in unload stage of execution
COPYQUERYRUNTIMEBREAKDOWN	The amount of time all active queries have spent in copy stage of execution
COMMITQUERYRUNTIMEBREAKDOWN	The amount of time all active queries have spent in commit stage of execution
PERCENTAGEDISKSPACEUSED	The percent of disk space used
READIOPS	The average number of disk read operations
WRITEIOPS	The average number of disk write operations
READLATENCY	The average amount of time taken for disk read I/O operations
WRITELATENCY	The average amount of time taken for disk write I/O operations
READTHROUGHPUT	The average number of bytes read from disk
WRITETHROUGHPUT	The average number of bytes write from disk
REDSHIFT-NODE
CPUUTILIZATION	The percentage of CPU utilization
NETWORKRECEIVETHROUGHPUT	The rate at which the node or cluster receives data
NETWORKTRANSMITTHROUGHPUT	The rate at which the node or cluster writes data
PERCENTAGEDISKSPACEUSED	The percent of disk space used
READIOPS	The average number of disk read operations
WRITEIOPS	The average number of disk write operations
READLATENCY	The average amount of time taken for disk read I/O operations
WRITELATENCY	The average amount of time taken for disk write I/O operations
READTHROUGHPUT	The average number of bytes read from disk
WRITETHROUGHPUT	The average number of bytes write from disk
EFS
BURSTCREDITBALANCE	Number of burst credits in the file system
CLIENTCONNECTION	Number of client connections to the file system
FILESIZE	File metered size
TOTALIO_BYTES	Total number of bytes with all file system operations
PERCENTIOLIMIT	I/O limit of the general purpose performance mode
PERMITTEDTHROUGHPUT	Amount of throughput allowed to the file system
SES
SEND	Number of successful email sending API requests
SENT_EMAILS	Number of emails sent in last 24 hrs
REJECT	Number of rejected send requests
BOUNCE	Number of bounced emails
COMPLAINT	Number of emails marked as spam
DELIVERY	Number of emails delivered successfully
OPEN	Number of emails opened by recipient
CLICK	One or more links contained in the email clicked by recipient
RENDERINGFAILURE	Number of emails not sent because of a template rendering issue
REPUTATION_BOUNCE	Reputation bounce rate
STEPFUNCTION
EXECUTION_STARTED	Number of started executions
EXECUTION_TIME	Time interval between execution start and end
EXECUTION_THROTTLED	Number of throttled StateEntered events and retries
EXECUTION_SUCCEEDED	Number of successfully completed executions
EXECUTION_FAILED	Number of failed executions
EXECUTION_ABORTED	Number of aborted executions
EXECUTION_TIMEDOUT	Number of executions that timed out
WAF
TOTALALLOWEDREQUESTS	Total number of allowed requests
TOTALBLOCKEDREQUESTS	Total number of blocked requests
TOTALPASSEDREQUESTS	Total number of passed requests
TOTALCOUNTEDREQUESTS	Total number of counted requests
CLOUDSEARCH
SUCCESSFULREQUESTS	Total number of successful requests
SEARCHABLEDOCUMENTS	Total number of searchable documents
INDEXUTILIZATION	Percentage of index utilization
PARTITIONS	Total number of partitions
KMS
KMSKEYAGE	Number of days from creation date
DAYSUNTILDELETEKEY	Number of days until key deletion
HOURSUNTILDELETEKEY	Hours until key deletion
MINUTESUNTILDELETEKEY	Minutes until key deletion
DAYSUNTILEXPIREKEYMATERIAL	Number of days until key material expiration
HOURSUNTILEXPIREKEYMATERIAL	Hours until key material expiration
MINUTESUNTILEXPIREKEYMATERIAL	Minutes until key material expiration
R53_HEALTHCHECK
STATUS	Status of the health check endpoint
HEALTH_PERCENT	Percentage of health checker endpoint to be healthy
CONNECTION_TIME	Time taken by health checker to establish a TCP connection with the endpoint
SSL_HANDSHAKE	Time taken by health checker to complete the SSL handshake
TIMETOFIRST	Time taken by health checker to receive the first byte of the response
CHILD_HEALTHCHECK	Number of healthy health checkers
R53_RESOLVER
TOTAL_INBOUND_QUERY	Number of DNS queries forwarded from network to VPCs
TOTAL_OUTBOUND_QUERY	Number of DNS queries forwarded from VPCs to network
R53_HOSTEDZONE
REQUEST_COUNT	Total number of DNS queries received by domain
QUERY_A	Number of queries received for A record type
QUERY_AAAA	Number of queries received for AAAA record type
QUERY_CAA	Number of queries received for CAA record type
QUERY_CNAME	Number of queries received for CNAME record type
QUERY_MX	Number of queries received for MX record type
QUERY_NAPTR	Number of queries received for NAPTR record type
QUERY_NS	Number of queries received for NS record type
QUERY_PTR	Number of queries received for PTR record type
QUERY_SOA	Number of queries received for SOA record type
QUERY_SPF	Number of queries received for SPF record type
QUERY_SRV	Number of queries received for SRV record type
QUERY_TXT	Number of queries received for TXT record type
DNS_NOERROR	Number of DNS queries completed successfully
DNS_FORMERR	Number of DNS query format errors
DNS_SERVFAIL	Number of DNS queries failed by server
DNS_NXDOMAIN	Number of responses that return domain name does not exist
DNS_NOTIMP	Number of DNS queries failed due to not implemented function
DNS_REFUSED	Number of DNS queries refused by the server
DNS_YXDOMAIN	Number of invalid domain name queries
DNS_XRRSET	Number of invalid RRset queries
DNS_NOTAUTH	Number of unauthorized DNS queries
DNS_NOTZONE	Number of invalid zone DNS queries
R53_RECORDSET
REQUEST_COUNT	Total number of DNS queries received by record set
DNS_NOERROR	Number of DNS queries completed successfully
DNS_FORMERR	Number of DNS query format errors
DNS_SERVFAIL	Number of DNS queries failed by server
DNS_NXDOMAIN	Number of responses that return domain name does not exist
DNS_NOTIMP	Number of DNS queries failed due to not implemented function
DNS_REFUSED	Number of DNS queries refused by the server
DNS_YXDOMAIN	Number of invalid domain name queries
DNS_XRRSET	Number of invalid RRset queries
DNS_NOTAUTH	Number of unauthorized DNS queries
DNS_NOTZONE	Number of invalid zone DNS queries
ESD
CLUSTERSTATUSGREEN	Indicates shard allocation status
CLUSTERSTATUSYELLOW	Indicates shard allocation status
CLUSTERSTATUSRED	Indicates shard allocation status
NODES	The number of nodes in the Amazon ES cluster, including dedicated master nodes
SEARCHABLEDOCUMENTS	The total number of searchable documents across all indices in the cluster
DELETEDDOCUMENTS	The total number of documents marked for deletion across all indices in the cluster
CPUUTILIZATION	The maximum percentage of CPU resources used for data nodes in the cluster
FREESTORAGESPACE	The free space, in GiB, for nodes in the cluster
CLUSTERUSEDSPACE	The total used space, in GiB, for the cluster
CLUSTERINDEXWRITESBLOCKED	Indicates whether your cluster is accepting or blocking incoming write requests
JVMMEMORYPRESSURE	The maximum percentage of the Java heap used for all data nodes in the cluster
AUTOMATEDSNAPSHOTFAILURE	The number of failed automated snapshots for the cluster
CPUCREDITBALANCE	The remaining CPU credits available for data nodes in the cluster
KIBANAHEALTHYNODES	A health check for Kibana
KMSKEYERROR	Indicates whether KMS customer master key used to encrypt data is enabled or not
KMSKEYINACCESSIBLE	Indicates whether KMS customer master key used to encrypt data at rest has been deleted or revoked its grants to elasticsearch
INVALIDHOSTHEADERREQUESTS	The number of HTTP requests made to the Elasticsearch cluster that included an invalid (or missing) host header
ELASTICSEARCHREQUESTS	The number of requests made to the Elasticsearch cluster
ES_2XX	The number of requests to a domain and the 2xx HTTP response code for each request
ES_3XX	The number of requests to a domain and the 3xx HTTP response code for each request
ES_4XX	The number of requests to a domain and the 4xx HTTP response code for each request
ES_5XX	The number of requests to a domain and the 5xx HTTP response code for each request
READLATENCY	The latency, in seconds, for read operations on EBS volumes
WRITELATENCY	The latency, in seconds, for write operations on EBS volumes
READTHROUGHPUT	The throughput, in bytes per second, for read operations on EBS volumes
WRITETHROUGHPUT	The throughput, in bytes per second, for write operations on EBS volumes
DISKQUEUEDEPTH	The number of pending input and output (I/O) requests for an EBS volume
READIOPS	The number of input and output (I/O) operations per second for read operations on EBS volumes
WRITEIOPS	The number of input and output (I/O) operations per second for write operations on EBS volumes.
VPC_NATGATEWAY
ACTIVECONNECTIONCOUNT	The total number of concurrent active TCP connections through the NAT Gateway.
BYTESINFROMDESTINATION	The number of bytes received by the NAT Gateway from the destination.
BYTESINFROMSOURCE	The number of bytes received by the NAT Gateway from clients in your VPC.
BYTESOUTTODESTINATION	The number of bytes sent out through the NAT Gateway to the destination.
BYTESOUTTOSOURCE	The number of bytes sent through the NAT Gateway to the clients in your VPC.
CONNECTIONATTEMPTCOUNT	The number of connection attempts made through the NAT Gateway.
CONNECTIONESTABLISHMENT	The number of connections established through the NAT Gateway.
ERRORPORTALLOCATION	The number of times the NAT Gateway could not allocate a source port.
IDLETIMEOUTCOUNT	The number of connections that transitioned from the active state to the idle state.
PACKETSDROPCOUNT	The number of packets dropped by the NAT Gateway.
PACKETSINFROMDESTINATION	The number of packets received by the NAT Gateway from the destination.
PACKETSINFROMSOURCE	The number of packets received by the NAT Gateway from clients in your VPC.
PACKETSOUTTODESTINATION	The number of packets sent out through the NAT Gateway to the destination.
PACKETSOUTTOSOURCE	The number of packets sent through the NAT Gateway to the clients in your VPC.
EMR
CORENODESPENDING	Number of core nodes waiting to be assigned
CORENODERUNNING	Number of core nodes working
TASKNODESPENDING	Number of task nodes waiting to be assigned
TASKNODESRUNNING	Number of task nodes working
MULTINODESRUNNING	Number of running master nodes
MULTINODESRUNNINGPERCENTAGE	Total percentage of master nodes that are running over the requested master node instance count
MULTINODESREQUESTED	Number of requested master nodes
CAPACITYREMAINING	Amount of remaining HDFS disk capacity
CORRUPTBLOCKS	Number of blocks that HDFS reports as corrupted
FSNAMESYSTEMBLOCKS	Indicates the status of block replication
HDFSBYTESREAD	Number of bytes read from HDFS
HDFSBYTESWRITTEN	Number of bytes written to HDFS
HDFSUTILIZATION	Percentage of HDFS storage currently used
ISIDLE	Indicates that a cluster is no longer performing work
LIVEDATANODES	Percentage of data nodes that are receiving work from Hadoop
MISSINGBLOCKS	Number of blocks in which HDFS has no replicas
PENDINGDELETIONBLOCKS	Number of blocks marked for deletion
S3BYTESREAD	Number of bytes read from Amazon S3
S3BYTESWRITTEN	Number of bytes written to Amazon S3
TOTALLOAD	Total number of readers and writers reported by all DataNodes in a cluster
UNDERREPLICATEDBLOCKS	Number of blocks that need to be replicated one or more times
JOBSFAILED	Number of jobs in the cluster that have failed
JOBSRUNNING	Number of jobs in the cluster that are currently running
LIVETASKTRACKERS	Percentage of task trackers that are functional
MAPSLOTSOPEN	Total number of unused map task capacity
BLACKLISTEDTASKTRACKERS	Number of blacklisted tasktrackers
GRAYLISTEDTASKTRACKERS	Number of graylisted tasktrackers
REDUCESLOTSOPEN	Total number of unused reduce task capacity
REMAININGMAPTASKS	Number of remaining map tasks
REMAININGMAPTASKSPERSLOT	Ratio of the total map tasks remaining to the total map slots available in the cluster
REMAININGREDUCETASKS	Number of remaining reduce tasks
RUNNINGMAPTASKS	Number of running map tasks
RUNNINGREDUCETASKS	Number of running reduce tasks
APPSCOMPLETED	Number of applications submitted to YARN that have completed
APPSFAILED	Number of applications submitted to YARN that have failed to complete
APPSKILLED	Number of applications submitted to YARN that have been killed
APPSPENDING	Number of applications submitted to YARN that are in a pending state
APPSRUNNING	Number of applications submitted to YARN that are running
APPSSUBMITTED	Number of applications submitted to YARN
CONTAINERALLOCATED	Number of resource containers allocated by the ResourceManager
CONTAINERPENDING	Number of containers in the queue that have not yet been allocated
CONTAINERRESERVED	Number of containers reserved
MEMORYALLOCATEDMB	Amount of memory allocated to the cluster
MEMORYAVAILABLEMB	Amount of memory available to be allocated
MEMORYRESERVEDMB	Amount of memory reserved
MEMORYTOTALMB	Total amount of memory in the cluster
MRACTIVENODES	Number of DNS queries completed successfully
MRDECOMMISSIONEDNODES	Number of nodes allocated to MapReduce applications that have been marked in a DECOMMISSIONED state
MRLOSTNODES	Number of nodes allocated to MapReduce that have been marked in a LOST state
MRREBOOTEDNODES	Number of nodes available to MapReduce that have been rebooted and marked in a REBOOTED state
MRTOTALNODES	Number of nodes presently available to MapReduce jobs
MRUNHEALTHYNODES	Number of nodes available to MapReduce jobs marked in an UNHEALTHY state
CONTAINERPENDINGRATIO	Ratio of pending containers to containers allocated
YARNMEMORYAVAILABLEPERCENTAGE	Percentage of remaining memory available to YARN
HBASEBACKUPFAILED	Indicates the last HBase backup failed
HBASEBACKUPDURATION	Amount of time it took the previous backup to complete
TIMESINCELASTBACKUP	Number of elapsed minutes after the last successful HBase backup
STEPSFAILEDCOUNT	Total number of steps that failed between two polls
WorkSpace
AVAILABLE	The number of available requests sent to WorkSpaces.
UNHEALTHY	The number of available requests rejected by the WorkSpaces.
CONNECTIONATTEMPT	The number of connection attempts.
CONNECTIONSUCCESS	The number of successful connections.
CONNECTIONFAILURE	The number of failed connections.
SESSIONLAUNCHTIME	The amount of time it takes to initiate a WorkSpaces session.
INSESSIONLATENCY	The round trip time between the WorkSpaces client and the WorkSpace.
SESSIONDISCONNECT	The number of connections that were closed, including user-initiated and failed connections.
USERCONNECTED	Number of times a user connected to the WorkSpace.
STOPPED	The number of times the WorkSpaces has been stopped.
MAINTENANCE	The number of times the WorkSpaces was under maintenance.
EC2AUTOSCALING
CPUUTILIZATION	CPU Usage
NETWORKIN	Number of bytes received
NETWORKOUT	Number of bytes sent
NETWORKPACKETSIN	Number of packets received
NETWORKPACKETSOUT	Number of packets sent
DISKREADOPS	Disk read operations
DISKWRITEOPS	Disk write operations
DISKREADBYTES	Bytes read from all instance store volumes
DISKWRITEBYTES	Bytes written to all instance store volumes
STATUSCHECK_FAILED	Overall status check
STATUSCHECK_INSTANCE	Instance status check
STATUSCHECK_SYSTEM	System status check
MIN_SIZE	Minimum group size
MAX_SIZE	Maximum group size
DESIRED_CAPACITY	Desired capacity of Group
INSTANCES_INSERVICE	Number of instances that are running
PENDING_INSTANCES	Number of instances in pending state
STANDBY_INSTANCES	Number of instances in standby state
TERMINATING_INSTANCES	Number of instances that are in the process of termination
TOTAL_INSTANCES	Total number of instances in the group
NEPTUNE-CLUSTER
CPUUTILIZATION	The percentage of CPU utilization.
CLUSTERREPLICALAGMAX	The maximum amount of lag between the primary instance and each Neptune DB instance in the DB cluster.
CLUSTERREPLICALAGMIN	The minimum amount of lag between the primary instance and each Neptune DB instance in the DB cluster.
CLUSTERREPLICALAG	For a read replica, the amount of lag when replicating updates from the primary instance.
FREEABLEMEMORY	The amount of available random access memory.
FREELOCALSTORAGE	The amount of storage available for temporary tables and logs.
GREMLINERRORS	The number of errors in Gremlin traversals.
GREMLINREQUESTS	The number of requests to Gremlin engine.
GREMLINWEBSOCKETAVAILABLE	The number of potential WebSocket connections currently available.
GREMLINWEBSOCKETCLIENTERRORS	The number of WebSocket client errors on the Gremlin endpoint per second.
GREMLINWEBSOCKETSERVERERRORS	The number of WebSocket server errors on the Gremlin endpoint per second.
GREMLINWEBSOCKETSUCCESS	The number of successful WebSocket connections to the Gremlin endpoint per second.
GREMLINREQUESTSPERSEC	The number of requests to Gremlin engine per second.
LOADERERRORS	The number of errors from Loader requests.
LOADERREQUESTS	The number of Loader Requests.
NETWORKTHROUGHPUT	The amount of network throughput both received from and transmitted to clients by each instance in the Neptune DB cluster.
NETWORKRECEIVETHROUGHPUT	The incoming (Receive) network traffic on the DB instance, including both customer database traffic and Neptune traffic used for monitoring and replication.
NETWORKTRANSMITTHROUGHPUT	The outgoing (Transmit) network traffic on the DB instance, including both customer database traffic and Neptune traffic used for monitoring and replication.
SPARQLERRORS	The number of errors in the SPARQL queries.
SPARQLREQUESTS	The number of requests to the SPARQL engine.
SPARQLREQUESTSPERSEC	The number of requests to the SPARQL engine per second.
STATUSERRORS	The number of errors from the status endpoint.
STATUSREQUESTS	The number of requests to the status endpoint.
HTTP1XX	The number of HTTP 1xx errors for the endpoint per second.
HTTP2XX	The number of HTTP 2xx errors for the endpoint per second.
HTTP4XX	The number of HTTP 4xx errors for the endpoint per second.
HTTP5XX	The number of HTTP 5xx errors for the endpoint per second.
GREMLINHTTP1XX	The number of HTTP 1xx errors for the Gremlin endpoint per second.
GREMLINHTTP2XX	The number of HTTP 2xx errors for the Gremlin endpoint per second.
GREMLINHTTP4XX	The number of HTTP 4xx errors for the Gremlin endpoint per second.
GREMLINHTTP5XX	The number of HTTP 5xx errors for the Gremlin endpoint per second.
SPARQLHTTP1XX	The number of HTTP 1xx errors for the SPARQL endpoint per second.
SPARQLHTTP2XX	The number of HTTP 2xx errors for the SPARQL endpoint per second.
SPARQLHTTP4XX	The number of HTTP 4xx errors for the SPARQL endpoint per second.
SPARQLHTTP5XX	The number of HTTP 5xx errors for the SPARQL endpoint per second.
BACKUPRETENTIONPERIODSTORAGE	Measures the amount of billed backup storage used to support the point-in-time restore feature within backup retention window.
TOTALBACKUPSTORAGE	The total amount of billed backup storage.
VOLUMEREADIOPS	The average number of billed read I/O operations from a cluster volume.
VOLUMEWRITEIOPS	The average number of write disk I/O operations to the cluster volume.
VOLUMEBYTESUSED	The amount of storage used by your Neptune DB instance
NEPTUNE-INSTANCE
CPUUTILIZATION	The percentage of CPU utilization.
CLUSTERREPLICALAGMAX	The maximum amount of lag between the primary instance and each Neptune DB instance in the DB cluster.
CLUSTERREPLICALAGMIN	The minimum amount of lag between the primary instance and each Neptune DB instance in the DB cluster.
FREEABLEMEMORY	The amount of available random access memory.
FREELOCALSTORAGE	The amount of storage available for temporary tables and logs.
GREMLINERRORS	The number of errors in Gremlin traversals.
GREMLINREQUESTS	The number of requests to Gremlin engine.
GREMLINWEBSOCKETAVAILABLE	The number of potential WebSocket connections currently available.
GREMLINWEBSOCKETCLIENTERRORS	The number of WebSocket client errors on the Gremlin endpoint per second.
GREMLINWEBSOCKETSERVERERRORS	The number of WebSocket server errors on the Gremlin endpoint per second.
GREMLINWEBSOCKETSUCCESS	The number of successful WebSocket connections to the Gremlin endpoint per second.
GREMLINREQUESTSPERSEC	The number of requests to Gremlin engine per second.
LOADERERRORS	The number of errors from Loader requests.
LOADERREQUESTS	The number of Loader Requests.
NETWORKTHROUGHPUT	The amount of network throughput both received from and transmitted to clients by each instance in the Neptune DB cluster.
NETWORKRECEIVETHROUGHPUT	The incoming (Receive) network traffic on the DB instance, including both customer database traffic and Neptune traffic used for monitoring and replication.
NETWORKTRANSMITTHROUGHPUT	The outgoing (Transmit) network traffic on the DB instance, including both customer database traffic and Neptune traffic used for monitoring and replication.
SPARQLERRORS	The number of errors in the SPARQL queries.
SPARQLREQUESTS	The number of requests to the SPARQL engine.
SPARQLREQUESTSPERSEC	The number of requests to the SPARQL engine per second.
STATUSERRORS	The number of errors from the status endpoint.
STATUSREQUESTS	The number of requests to the status endpoint.
HTTP1XX	The number of HTTP 1xx errors for the endpoint per second.
HTTP2XX	The number of HTTP 2xx errors for the endpoint per second.
HTTP4XX	The number of HTTP 4xx errors for the endpoint per second.
HTTP5XX	The number of HTTP 5xx errors for the endpoint per second.
GREMLINHTTP1XX	The number of HTTP 1xx errors for the Gremlin endpoint per second.
GREMLINHTTP2XX	The number of HTTP 2xx errors for the Gremlin endpoint per second.
GREMLINHTTP4XX	The number of HTTP 4xx errors for the Gremlin endpoint per second.
GREMLINHTTP5XX	The number of HTTP 5xx errors for the Gremlin endpoint per second.
SPARQLHTTP1XX	The number of HTTP 1xx errors for the SPARQL endpoint per second.
SPARQLHTTP2XX	The number of HTTP 2xx errors for the SPARQL endpoint per second.
SPARQLHTTP4XX	The number of HTTP 4xx errors for the SPARQL endpoint per second.
SPARQLHTTP5XX	The number of HTTP 5xx errors for the SPARQL endpoint per second.
ACM
CERTIFICATEAGE	Number of days from creation date.
DAYSUNTILEXPIRY	Number of days until certificate expiry date.
HOURSUNTILEXPIRY	Number of hours until certificate expiry date.
MINUTESUNTILEXPIRY	Number of minutes until certificate expiry date
LIGHTSAIL-INSTANCE
CPUUTILIZATION	The percentage of CPU Usage.
NETWORKIN	Number of bytes received.
NETWORKOUT	Number of bytes sent.
CPU_BURSTCAPACITY_PERCENTAGE	The percentage of CPU performance available to your instance.
CPU_BURSTCAPACITY_TIME	The amount of time available for your instance to burst at 100% CPU utilization.
EKSCLUSTER
NODE_CPULIMIT	CPU units assigned to nodes.
NODE_CPURESERVED	CPU reserved for nodes.
NODE_CPUUSAGE	CPU units used by nodes.
NODE_CPUUTILIZED	CPU utilized by nodes.
NODE_FILEUTILIZED	File system capacity on nodes.
NODE_MEMORYLIMIT	Memory assigned to nodes.
NODE_MEMORYRESERVED	Memory reserved for nodes.
NODE_MEMORYUTILIZED	Memory utilized by nodes.
NODE_MEMORYSETS	Memory used in working sets of nodes
NODE_NETWORKBYTES	Total network traffic in nodes.
POD_CPURESERVED	CPU reserved for pods.
POD_CPUUTILIZED	CPU utilized by pods.
POD_CPUUTILIZEDOVERLIMIT	CPU utilized over pod limit.
POD_MEMORYRESERVED	Memory reserved for pods.
POD_MEMORYUTILIZED	Memory utilized by pods.
POD_MEMORYUTILIZEDOVERLIMIT	Memory utilized over pod limit.
POD_NETWORKRX	Total bytes received by pods.
POD_NETWORKTX	Total bytes sent by pods.
EKSNAMESPACE
CPU_UTILIZED	CPU utilized by pods.
CPU_OVER_LIMIT	CPU utilized over pod limit.
MEMORY_UTILIZED	Memory utilized by pods.
MEMORY_OVER_LIMIT	Memory utilized over pod limit.
NETWORK_RX	Total bytes received by pods.
NETWORK_TX	Total bytes sent by pods.
EKSNODE
CPUUTILIZED_PER_NODE	CPU utilized by node.
CPURESERVED_PER_NODE	CPU reserved for node.
FILEUTILIZED_PER_NODE	File system capacity.
MEMRESERVED_PER_NODE	Memory reserved for node.
MEMUTILIZED_PER_NODE	Memory utilized by node.
NETWORK_PER_NODE	Total network traffic in node.
AMQ
CPUUTILIZATION	The percentage of allocated EC2 compute units that the broker currently uses.
CPUCREDITBALANCE	The number of earned CPU credits that an instance has accrued since it was launched or started (including the number of launch credits).
CURRENTCONNECTIONSCOUNT	The current number of active connections on the current broker.
ESTABLISHEDCONNECTIONSCOUNT	The total number of connections, active and inactive, that have been established on the broker.
INACTIVEDRTOPICSUBCOUNT	The number of inactive durable topic subscribers, up to a maximum of 2000.
JOURNALFILESFORFASTRECOVERY	The number of journal files that will be replayed after a clean shutdown.
JOURNALFILESFORFULLRECOVERY	The number of journal files that will be replayed after an unclean shutdown.
NETWORKIN	The volume of incoming traffic for the broker.
NETWORKOUT	The volume of outgoing traffic for the broker.
OPENTRANSACTIONSCOUNT	The total number of transactions in progress.
NETWORKOUT	The volume of outgoing traffic for the broker.
HEAPUSAGE	The percentage of the ActiveMQ JVM memory limit that the broker currently uses.
STOREPERCENTUSAGE	The percent used by the storage limit. If this reaches 100 the broker will refuse messages.
TOTALCONSUMERCOUNT	The number of message consumers subscribed to destinations on the current broker.
TOTALMESSAGECOUNT	The number of messages stored on the broker.
TOTALPRODUCERCOUNT	The number of message producers active on destinations on the current broker.
TOTALENQUEUECOUNT	The total number of messages that have been sent to the broker.
TOTALDEQUEUECOUNT	The total number of messages that have been consumed by clients.
AMQTOPIC
CONSUMERCOUNT	The number of consumers subscribed to the destination.
PRODUCERCOUNT	The number of producers for the destination.
ENQUEUETIME	The end-to-end latency from when a message arrives at a broker until it is delivered to a consumer.
DISPATCHCOUNT	The number of producers for the destination.
MEMORYUSAGE	The percentage of the memory limit that the destination currently uses.
ENQUEUECOUNT	The number of messages sent to the destination, per minute.
DEQUEUECOUNT	The number of messages acknowledged by consumers, per minute.
INFLIGHTCOUNT	The number of messages sent to consumers that have not been acknowledged.
EXPIREDCOUNT	The number of messages that couldn’t be delivered because they expired, per minute.
AMQQUEUE
CONSUMERCOUNT	The number of consumers subscribed to the destination.
PRODUCERCOUNT	The number of producers for the destination.
ENQUEUETIME	The end-to-end latency from when a message arrives at a broker until it is delivered to a consumer.
DISPATCHCOUNT	The number of producers for the destination.
MEMORYUSAGE	The percentage of the memory limit that the destination currently uses.
ENQUEUECOUNT	The number of messages sent to the destination, per minute.
DEQUEUECOUNT	The number of messages acknowledged by consumers, per minute.
INFLIGHTCOUNT	The number of messages sent to consumers that have not been acknowledged.
EXPIREDCOUNT	The number of messages that couldn’t be delivered because they expired, per minute.
QUEUESIZE	The number of messages in the queue.
AMQNC
ENQUEUECOUNT	The number of messages sent to the destination, per minute.
DEQUEUECOUNT	The number of messages acknowledged by consumers, per minute.
RECEIVECOUNT	The number of messages that have been received from the remote broker for a duplex network connector.
LIGHTSAIL-DATABASE
CPUUTILIZATION	The percentage of CPU Usage.
DBCONNECTIONS	The number of database connections in use.
DISKQUEUEDEPTH	The number of outstanding read/write requests waiting to access the disk.
FREESTORAGESPACE	The amount of available storage space.
NETWORK_RECEIVETHROUGHPUT	The incoming network traffic to the database.
NETWORK_TRANSMITTHROUGHPUT	The outgoing network traffic to the database.
LIGHTSAIL-LB
CLIENTTLSERRORCOUNT	The number of TLS connections failed to establish a session with the load balancer.
HEALTHYHOSTCOUNT	The number of target instances that are considered healthy.
UNHEALTHYHOSTCOUNT	The number of target instances that are considered unhealthy.
HTTPCODE4XX_LB	The number of HTTP 4XX client error codes that originate from the load balancer.
HTTPCODE5XX_LB	The number of HTTP 5XX server error codes that originate from the load balancer.
HTTPCODE2XX_INSTANCE	The number of HTTP 2xx response codes generated by the target instances.
HTTPCODE3XX_INSTANCE	The number of HTTP 3xx response codes generated by the target instances.
HTTPCODE4XX_INSTANCE	The number of HTTP 4xx response codes generated by the target instances.
HTTPCODE5XX_INSTANCE	The number of HTTP 5xx response codes generated by the target instances.
REJECTEDCONNECTION	The number of rejected connections to the Load balancer.
REQUESTCOUNT	The number of requests processed over IPv4.
INSTANCERESPONSE_TIME	The time elapsed, in seconds, after the request leaves the load balancer until a response from the target instance is received.
STORAGEGATEWAY
CACHEHITPERCENT	Percent of application reads served from the cache. The sample is taken at the end of the reporting period.
UPLOADBUFFERPERCENTUSED	Percent use of the gateway’s upload buffer.
UPLOADBUFFERUSED	The total number of bytes being used in the gateway’s upload buffer.
CACHEUSED	The total number of bytes being used in the gateway’s cache storage. The sample is taken at the end of the reporting period.
QUEUEDWRITES	The number of bytes waiting to be written to AWS, sampled at the end of the reporting period for all volumes in the gateway. These bytes are kept in your gateway’s working storage.
READBYTESSUM	The total number of bytes read from your on-premises applications in the reporting period for all volumes in the gateway.
READTIME	Total time in milliseconds, spent to do read operations from your on-premises applications in the reporting period for all volumes in the gateway.
TOTALCACHESIZE	The total size of the cache in bytes.
WRITEBYTESSUM	The total number of bytes written to your on-premises applications in the reporting period for all volumes in the gateway.
WRITETIME	Total time in milliseconds, spent to do write operations from your on-premises applications in the reporting period for all volumes in the gateway.
TIMESINCELASTRECOVERYPOINT	The time since the last available recovery point.
WORKINGSTORAGEFREE	The total amount of unused space in the gateway’s working storage.
WORKINGSTORAGEPERCENTUSED	Percent use of the gateway’s upload buffer.
WORKINGSTORAGEUSED	The total number of bytes being used in the gateway’s upload buffer.
USERCPUPERCENT	Percent of CPU time spent on gateway processing, averaged across all cores.
IOWAITPERCENT	Percent of time that the gateway is waiting on a response from the local disk.
MEMTOTALBYTES	Amount of RAM provisioned to the gateway VM, in bytes.
MEMUSEDBYTES	Amount of RAM currently in use by the gateway VM, in bytes.
SMBV1SESSIONS	The number of Server Message Block (SMB) version 1 sessions that are active on the gateway.
SMBV2SESSIONS	The number of SMB version 2 sessions that are active on the gateway.
SMBV3SESSIONS	The number of SMB version 3 sessions that are active on the gateway.
INDEXEVICTIONSSUM	The number of files whose metadata was evicted from the cached index of file metadata to make room for new entries. The gateway maintains this metadata index, which is populated from the AWS Cloud on demand.
INDEXFETCHESSUM	The number of files for which metadata was fetched. The gateway maintains a cached index of file metadata, which is populated from the AWS Cloud on demand.
AVILABILITYNOTIFICATIONS	Number of availability-related health notifications generated by the gateway.
HEALTHNOTIFICATIONS	The number of health notifications sent by the gateway.
CLOUDBYTESUPLOADED	The total number of bytes that the gateway uploaded to AWS during the reporting period.
CLOUDBYTESDOWNLOADED	The total number of bytes that the gateway downloaded from AWS during the reporting period.
CLOUDDOWNLOADLATENCY	The latency while downloading bytes from the cloud.
CACHEPERCENTDIRTY	The volume’s contribution to the overall percentage of the gateway’s cache that isn’t persisted to AWS. The sample is taken at the end of the reporting period.
CACHEPERCENTUSED	the overall percent use of the gateway’s cache storage.
UPLOADBUFFERFREE	The amount of upload buffer that is not used.
CACHEFREE	The amount of cache that is not used.
SGFILE
CACHEHITPERCENT	Percent of application read operations from the file shares that are served from cache.
CACHEPERCENTDIRTY	The file share’s contribution to the overall percentage of the gateway’s cache that has not been persisted to AWS. The sample is taken at the end of the reporting period.
CACHEPERCENTUSED	The file share’s contribution to the overall percent use of the gateway’s cache storage. The sample is taken at the end of the reporting period.
READBYTESSUM	The total number of bytes read from your on-premises applications in the reporting period for a file share.
WRITEBYTESSUM	The total number of bytes written to your on-premises applications in the reporting period.
CLOUDBYTESDOWNLOADED	The total number of bytes that the gateway downloaded from AWS during the reporting period.
CLOUDBYTESUPLOADED	The total number of bytes that the gateway uploaded to AWS during the reporting period.
INDEXFETCHESSUM	The number of files for which metadata was fetched. The gateway maintains a cached index of file metadata, which is populated from the AWS Cloud on demand.
SGVOLUME
CACHEHITPERCENT	Percent of application read operations from the volume that are served from cache. The sample is taken at the end of the reporting period.
CACHEPERCENTDIRTY	The volume’s contribution to the overall percentage of the gateway’s cache that isn’t persisted to AWS. The sample is taken at the end of the reporting period.
CACHEPERCENTUSED	The volume’s contribution to the overall percent use of the gateway’s cache storage. The sample is taken at the end of the reporting period.
CPUUSAGE	The percentage of allocated CPU compute units that are currently used by the volume.
MEMEORYUSAGE	The percentage of allocated memory that is currently used by the volume.
CLOUDTRAFFIC	The number of bytes uploaded and downloaded from the cloud to the volume.
CLIENTTRAFFIC	The number of bytes that the tape sent and received from on-premises clients
HEALTHNOTIFICATIONCOUNT	The number of health notifications sent by the volume.
READBYTESSUM	The total number of bytes read from your on-premises applications in the reporting period.
WRITEBYTESSUM	The total number of bytes written to your on-premises applications in the reporting period.
READTIME	Total time in milliseconds, spent to do read operations from your on-premises applications in the reporting period.
WRITETIME	Total time in milliseconds, spent to do write operations from your on-premises applications in the reporting period.
QUEUEDWRITES	The number of bytes waiting to be written to AWS, sampled at the end of the reporting period.
TRANSITGATEWAY
BYTESIN	The number of bytes received by the transit gateway.
BYTESOUT	The number of bytes sent from the transit gateway.
PACKETSIN	The number of packets received by the transit gateway.
PACKETSOUT	The number of packets sent from the transit gateway.
PKTDRPCOUNTBLACKHOLE	The number of packets dropped because they matched a blackhole route.
PKTDRPCOUNTNOROUTE	The number of packets dropped because they did not match a route.
BYTEDRPCOUNTBLACKHOLE	The number of bytes dropped because they matched a blackhole route.
BYTEDRPCOUNTNOROUTE	The number of bytes dropped because they did not match a route.
DIRECTCONNECTVI
VIRTUALINTERFACEBPSEGRESS	The bitrate for outbound data from the AWS side of the virtual interface.
VIRTUALINTERFACEBPSINGRESS	The bitrate for inbound data to the AWS side of the virtual interface.
VIRTUALINTERFACEPPSEGRESS	The packet rate for outbound data from the AWS side of the virtual interface.
VIRTUALINTERFACEPPSINGRESS	The packet rate for inbound data to the AWS side of the virtual interface.
DMSTASK
FLTBANDWIDTHSOURCE	Incoming data received from a full load from the source, measured in kilobytes per second.
FLTBANDWIDTHTARGET	Outgoing data transmitted from a full load for the target, measured in kilobytes per second.
FLTBANDWIDTHTOTAL	The total full load throughput bandwidth at Target and Source.
FLTROWSSOURCE	Incoming changes from a full load from the source, measured in rows per second.
FLTROWSTARGET	Outgoing changes from a full load for the target, measured in rows per second.
FLTROWSTOTAL	The total full load throughput rows at Target and Source.
CDCINCOMINGCHANGES	The total number of change events at a point in time that are waiting to be applied to the target.
CDCCHANGESMEMORYSOURCE	The amount of rows accumulated in memory and waiting to be committed from the source.
CDCCHANGESMEMORYTARGET	The amount of rows accumulated in memory and waiting to be committed to the target.
CDCCHANGESMEMORYTOTAL	The total number of CDC Changes in memory at Target and Source.
CDCCHANGESDISKSOURCE	The amount of rows accumulated on the disk and waiting to be committed from the source.
CDCCHANGESDISKTARGET	The amount of rows accumulated on the disk and waiting to be committed to the target.
CDCCHANGESDISKTOTAL	The total number of CDC Changes in disk at Target and Source.
CDCTBANDWIDTHSOURCE	Incoming data received for the source, measured in kilobytes per second.
CDCTBANDWIDTHTARGET	Outgoing data transmitted for the target, measured in kilobytes per second.
CDCTBANDWIDTHTOTAL	The total CDC throughput bandwidth at Target and Source.
CDCTROWSSOURCE	Incoming task changes from the source, measured in rows per second.
CDCTROWSTARGET	Outgoing task changes for the target, measured in rows per second.
CDCTROWSTOTAL	The total CDC throughput bandwidth at Target and Source.
CDCLATENCYSOURCE	The gap, in seconds, between the last event captured from the source endpoint and current system time stamp of the AWS DMS instance.
CDCLATENCYTARGET	CDC Latency Target represents the latency between replication instance and target.
CDCLATENCYTOTAL	The total CDC latency at Target and Source.
MEMORYUSAGE	It indicates the portion of memory occupied by a task held in main memory.
CPUUTILIZATION	The percent of CPU being used by a task.
VSRCOUNT	The number of rows that AWS DMS validated per minute.
VARCOUNT	The number of rows where validation was attempted per minute.
VFOCOUNT	The number of rows where validation failed.
VSOCOUNT	The number of rows where validation was suspended.
VPOCOUNT	The number of rows where validation is still pending.
VBQSOURCELATENCY	This metric indicates the latency required to read a bulk set of data from the source endpoint.
VBQTARGETLATENCY	This metric indicates the latency required to read a bulk set of data on the target endpoint.
VBQTOTALLATENCY	The total latency of validation bulk query at Target and Source.
VIQSOURCELATENCY	This metric provides the latency in reading those ongoing changes from the source.
VIQTARGETLATENCY	This metric provides the latency in reading those ongoing changes from the target.
VIQTOTALLATENCY	The total latency of validation item query at Target and Source
SWAP_USAGE	The amount of swap used by the task.
MEMORYALLOCATEDMB	The maximum allocation of memory for the task (0 means no limit).
DMSINSTANCE
CPUUTILIZATION	The amount of CPU used.
FREESTORAGEMB	The amount of available storage space.
READIOPS	The average number of disk read I/O operations per second.
WRITEOPS	The average number of disk write I/O operations per second.
READLATENCY	The average amount of time taken per disk I/O (input) operation.
WRITELATENCY	The average amount of time taken per disk I/O (Output) operation.
READTHROUGHPUT	The average number of bytes read from disk per second.
WRITETHROUGHPUT	The average number of bytes written to disk per second.
RECEIVETHROUGHPUT	The incoming (Receive) network traffic on the replication instance, including both customer database traffic and AWS DMS traffic used for monitoring and replication.
TRANSMITTHROUGHPUT	The outgoing (Transmit) network traffic on the replication instance, including both customer database traffic and AWS DMS traffic used for monitoring and replication.
SWAP_USAGE	The amount of swap space used on the replication instance.
FREEABLE_MEM	The amount of available random access memory.
DISKQUEUEDEPTH	the number of outstanding IO requests that are waiting to be performed on a disk.
FSX
READBYTES	The number of bytes for file system read operations.
WRITEBYTES	The number of bytes for file system write operations.
READOPERATION	The number of read operations.
WRITEOPERATION	The number of write operations.
METADATAOPERATION	The number of metadata operations.
FREESTORAGECAPACITY	The amount of available storage capacity.
TOTALTHROUGHPUT	The average number of bytes read and write from disk.
READTHROUGHPUT	The average number of bytes read from disk.
WRITETHROUGHPUT	The average number of bytes write from disk
TOTALIOPS	The average number of disk I/O operations per second.
READIOPS	The average number of disk read I/O operations per second.
WRITEIOPS	The average number of disk write I/O operations per second.
METADATAIOPS	The average number of disk metadata I/O operations per second.
LAMBDA-EDGE
INVOCATIONS_LAMBDA	The number of times the function code is executed.
ERRORS_LAMBDA	The number of invocations that result in a function error.
DURATIONAVERAGE_LAMBDA	The amount of time that your function code spends processing an event.
THROTTLES_LAMBDA	The number of invocation requests that are throttled.
ITERATORAGE	For event source mappings that read from streams, the age of the last record in the event.
SUCCESSPERCENTAGE	The percentage of executions that completed without error.
CONCURRENTEXECUTIONS	The number of function instances that are processing events.
PROVISIONED_CON_INVOCATIONS	The number of times your function code is executed on provisioned concurrency.
PROVISIONED_CON_EXECUTIONS	The number of function instances that are processing events on provisioned concurrency.
PROVISIONED_CON_UTILIZATION	or a version or alias, the value of ProvisionedConcurrentExecutions divided by the total amount of provisioned concurrency allocated.
INSPECTOR
HIGH	Count of Inspector High Findings.
MEDIUM	Count of Inspector Medium Findings.
LOW	Count of Inspector Low Findings.
INFO	Count of Inspector Info Findings.
FINDINGPERRUN	Count of Inspector Findings per run.
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
SFTP
BYTESINAVERAGE	Bytes In Average(Bytes)
BYTESOUTAVERAGE	Bytes Out Average(Bytes)
BYTESINAVERAGEMB	Bytes In Average(MB)
BYTESOUTAVERAGEMB	Bytes Out Average(MB)
BYTESINAVERAGEGB	Bytes In Average(GB)
BYTESOUTAVERAGEGB	Bytes Out Average(GB)
APIGATEWAY-ROUTE
LATENCY	Time between the receipt of a request and returned response
INTEGRATIONLATENCY	Time between the relay of a request to backend and returned response
COUNT	Number of API requests
ERROR5XX	Number of server-side errors
ERROR4XX	Number of client-side errors
DATAPROCESSED	The amount of data processed
CONNECTCOUNT	The number of messages sent to the $connect route integration
MESSAGECOUNT	The number of messages sent to the WebSocket API
INTEGRATIONERROR	The number of requests that return a 4XX/5XX response from the integration
CLIENTERROR	The number of requests that have a 4XX response returned by API Gateway before the integration is invoked
EXECUTIONERROR	Errors that occurred when calling the integration
EC2_CWAGENT
memory_committed_bytes_in_use	MemoryCommittedBytesInUse
logicaldisk_free_space	LogicalDisk_Free_Space
paging_file_usage	Paging_File_Usage
processor_idle_time	Processor_Idle_Time
processor_interrupt_time	Processor_Interrupt_Time
processor_user_time	Processor_User_Time
physicaldisk_disk_time	PhysicalDisk_Disk_Time
physicaldisk_disk_write_bytes_sec	PhysicalDisk_Disk_Write_Bytes_sec
physicaldisk_disk_read_bytes_sec	PhysicalDisk_Disk_Read_Bytes_sec
physicaldisk_disk_writes_sec	PhysicalDisk_Disk_Writes_sec
physicaldisk_disk_reads_sec	PhysicalDisk_Disk_Reads_sec
tcpv4_connections_established	Tcpv4_Connections_Established
tcpv6_connections_established	Tcpv6_Connections_Established
mem_used_percent	Mem_Used_Percent
swap_used_percent	Swap_Used_Percent
disk_used_percent	Disk_Used_Percent
disk_inodes_free	Disk_Inodes_Free
cpu_usage_idle	Cpu_Usage_Idle
cpu_usage_iowait	Cpu_Usage_Iowait
cpu_usage_user	Cpu_Usage_User
cpu_usage_system	Cpu_Usage_System
diskio_io_time	Diskio_Io_Time
diskio_write_bytes	Diskio_Write_Bytes
diskio_read_bytes	Diskio_Read_Bytes
diskio_writes	Diskio_Writes
diskio_reads	Diskio_Reads
netstat_tcp_established	Netstat_Tcp_Established
netstat_tcp_time_wait	Netstat_Tcp_Time_Wait
APPSTREAM
ACTUALCAPACITY	The total number of instances that are available for streaming or are currently streaming.
AVAILABLECAPACITY	The number of idle instances currently available for user sessions.
CAPACITYUTILIZATION	The percentage of instances in a fleet that are being used.
DESIREDCAPACITY	The total number of instances that are either running or pending.
INUSECAPACITY	The number of instances currently being used for streaming sessions.
PENDINGCAPACITY	The number of instances being provisioned by AppStream 2.0.
RUNNINGCAPACITY	The total number of currently running instances.
INSUFFICIENTCAPACITYERROR	The number of session requests rejected due to lack of capacity.
ACTIVESESSIONCOUNTAPI	The number of active sessions with API authentication.
ACTIVESESSIONCOUNTSAML	The number of active sessions with SAML authentication.
ACTIVESESSIONCOUNTUSERPOOL	The number of active sessions with user pool authentication.
EXPIREDSESSIONCOUNTAPI	The number of expired sessions with API authentication.
EXPIREDSESSIONCOUNTSAML	The number of expired sessions with SAML authentication.
EXPIREDSESSIONCOUNTUSERPOOL	The number of expired sessions with user pool authentication.
CONNECTEDUSERAPI	The number of connected users with API authentication.
CONNECTEDUSERSAML	The number of connected users with SAML authentication.
CONNECTEDUSERPOOL	The number of connected users with user pool authentication.
SSM
COMMANDSDELIVERYTIMEDOUT	The number of commands that have a terminal status of Delivery Timed Out.
COMMANDSFAILED	The number of commands that have a terminal status of Failed.
COMMANDSSUCCEEDED	The number of commands that have a terminal status of Success.
AWSHEALTH
EVENTS_OPEN	The number of health events with an Open status.
EVENTS_UPCOMING	The number of health events with Upcoming status.
EVENTS_CLOSED	The number of health events with Closed status.
EVENTS_TOTAL	The total number of events captured.
APPSYNC
LATENCY	The time between when AWS AppSync receives a request from a client and when it returns a response to the client.
ERROR4XX	Errors resulting from requests that are not valid due to an incorrect client configuration.
ERROR5XX	Errors encountered during the running of a GraphQL query.
CONNECTSUCCESS	The number of successful WebSocket connections to AWS AppSync.
CONNECTCLIENTERROR	The number of WebSocket connections that were rejected by AWS AppSync because of client-side errors.
CONNECTSERVERERROR	The number of errors that originated from AWS AppSync while processing connections.
DISCONNECTSUCCESS	The number of successful WebSocket disconnections from AWS AppSync.
DISCONNECTCLIENTERROR	The number of client errors that originated from AWS AppSync while disconnecting WebSocket connections.
DISCONNECTSERVERERROR	The number of server errors that originated from AWS AppSync while disconnecting WebSocket connections.
SUBSCRIBESUCCESS	The number of subscriptions that were successfully registered to AWS AppSync through WebSocket.
SUBSCRIBECLIENTERROR	The number of subscriptions that were rejected by AWS AppSync because of client-side errors.
SUBSCRIBESERVERERROR	The number of errors that originated from AWS AppSync while processing subscriptions.
UNSUBSCRIBESUCCESS	The number of unsubscribe requests that were successfully processed.
UNSUBSCRIBECLIENTERROR	The number of unsubscribe requests that were rejected by AWS AppSync because of client-side errors.
UNSUBSCRIBESERVERERROR	The number of errors that originated from AWS AppSync while processing unsubscribe requests.
PUBLISHDATAMESSAGESUCCESS	The number of subscription event messages that were successfully published.
PUBLISHDATAMESSAGECLIENTERROR	The number of subscription event messages that failed to publish because of client-side errors.
PUBLISHDATAMESSAGESERVERERROR	The number of errors that originated from AWS AppSync while publishing subscription event messages
PUBLISHDATAMESSAGESIZE	The size of subscription event messages published.
ACTIVECONNECTIONS	The number of concurrent WebSocket connections from clients to AWS AppSync in 1 minute.
ACTIVESUBSCRIPTIONS	The number of concurrent subscriptions from clients in 1 minute.
CONNECTIONDURATION	The amount of time that the connection stays open.
INVALIDATIONSUCCESS	The number of subscriptions successfully invalidated by a mutation with $extensions.invalidateSubscriptions().
CACHEHITS	The number of successful read-only key lookups in the main dictionary.
CACHEMISSES	The number of unsuccessful read-only key lookups in the main dictionary.
CURRITEMS	The number of items in the cache.
EVICTIONS	The number of keys that have been evicted due to the maximum memory limit.
RECLAIMED	The total number of key expiration events.
BYTESUSEDFORCACHE	The total number of bytes allocated by Redis for all purposes, including the dataset, buffers, and so on.

Anomaly Severity Constants

ID	Severity
1	CONFIRMED
2	LIKELY
3	INFO

AWS WorkSpace Actions

ID	Type
1	Start
2	Stop
3	Reboot
4	Rebuild

AWS EC2 Instance Actions

ID	Type
1	Start
2	Stop
3	Reboot
4	Stop - Hibernate

AWS RDS Instance Actions

ID	Type
1	Start
2	Stop
3	Reboot
4	Reboot With Failover

ThirdParty Integrations

ID	Type
1	PAGERDUTY
2	ZAPIER
3	ALARMSONE
4	SDPOD
5	SLACK
6	HIPCHAT
7	SDP
8	CUSTOM_WEBHOOK
9	MICROSOFT_TEAMS
10	OPSGENIE
11	SERVICENOW
12	STRIDE
13	SDPMSP

Source Mode

ID	Type
1	LOCAL
2	EVENTLOG
3	AWS
4	AWS_LAMBDA
5	REMOTE
6	AZURE_FUNCTIONS

Bulk Action Types

Type	Description
0	Modify Threshold Profile
1	Modify Location Profile
2	Modify Notification Profile
3	Modify User Alert Groups
4	Modify Check Frequency
5	Modify IT Automations
6	Activate Monitors
7	Suspend Monitors
8	Delete Monitors
9	Upgrade Server Monitor Agents
11	Modify Server Syslog/Event Log Preference
16	Associate with Monitor Group(s)
19	Associate Tags
20	Disassociate Monitors from Monitor Group(s)
22	Modify Plugin to enable alert when data is not received
23	Modify Plugin waittime to alert if alert is enabled
24	Modify APM Agent Configuration Profile
25	Re-Register Plugins across servers
26	Suppress Container Alerts
27	Auto Discover Containers

Bulk Action Operation Types

Type	Description
0	Append
1	Overwrite
2	Remove

Bulk Action Task Status

Type	Description
0	Task Failed Completely/Task Completed with Partial Success
1	Task Completed Successfully
2	Task In Progress with Partial Success
3	Task In Progress without any Failures
4	Task Scheduled

Alert Log Mode Constants

ID	Type
1	EMAIL
2	SMS
3	VOICE
4	CHAT
5	ALARMSONE
6	SDPOD
7	SLACK
8	HIPCHAT
9	PAGERDUTY
10	SDP
11	WEBHOOK
12	MICROSOFT_TEAMS
13	OPSGENIE
14	SERVICENOW
15	STRIDE
16	SDPMSP
17	ZAPIER
18	CONNECTWISE
19	ZANALYTICS
20	JIRA
21	MOOGSOFT

Amazon FSx Actions

ID	Type
1	Create Backup for File System
2	Create Data Repository Task

Lambda@Edge Function Actions

ID	Type
4	Invoke Lambda@Edge Function

Start/Stop SFTP Server

ID	Type
1	Start
2	Stop

On-Call Rotation

ID	Rotation	on
0	No Rotation	-
2	Weekly	$days_of_week
5	Monthly	1-31 ($day_of_month)

On-Call Exclude Frequency

ID	Frequency
-2	None
0	Every
1	First
2	Second
3	Third
4	Fourth
5	Last

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 100+ 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	string	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, if on_call_schedule_id is not choosen User group to be notified on down. Create new user group or find your preferred user group’s ID.
on_call_schedule_id	string	Mandatory, if user_group_ids is not choosen On-Call Schedule of your choice. Create new On-Call Schedule or find your preferred On-Call Schedule 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.
request_param	string	Provide parameters to be passed while accessing the website.
auth_method	string	Authentication method to access the website.
credential_profile_id	string	Credential Profile to associate.
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.
jwt_id	string	Token ID of the Webtoken to be associated with the monitor.
ssl_protocol	string	Specify the version of the SSL protocol. If you are not sure about the version, use Auto. Default value is Auto
http_protocol	string	Specify the version of the HTTP protocol.
use_alpn	boolean	Enable ALPN to send supported protocols as part of the TLS handshake.
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.
response_headers_check	json	Check whether the HTTP response headers are present or verify header and corresponding values against predefined header and values. Trigger down or trouble alerts during failure. JSON Format: {value: [{name: “$Header Name”, value: “$Header 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”}
monitor_groups	array	Group IDs to associate monitor. Create new monitor group or find your preferred monitor group’s ID.
dependency_resource_ids	array	Suppress alert when dependent monitor(s) 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.
tag_ids	array	Tag IDs to associate monitor. Create new tag or find your preferred tag’s ID.
deep_discovery	boolean	Enable this attribute to auto discover and set up monitoring for all the related resources for the website.

WebSocket

Monitor availability and end user experience of the WebSocket from 100+ locations.

Attribute	Type	Description
display_name	string	Mandatory Name for the monitor.
type	string	Mandatory WEBSOCKET
websocket	string	Mandatory WebSocket address to monitor.
check_frequency	string	Mandatory Check interval for monitoring.
timeout	int	Mandatory Timeout for connecting to WebSocket. 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, if on_call_schedule_id is not choosen User group to be notified on down. Create new user group or find your preferred user group’s ID.
on_call_schedule_id	string	Mandatory, if user_group_ids is not choosen On-Call Schedule of your choice. Create new On-Call Schedule or find your preferred On-Call Schedule ID.
ignore_domain_mismatch	boolean	Handles domain name mismatch errors.
ignore_trust	boolan	Trust all SSL certificates.
use_ipv6	boolean	Select IPv6 for monitoring the WebSocket hosted with IPv6 address. If you choose non IPv6 supported locations, monitoring will happen through IPv4.
request_param	string	Provide parameters to be passed while accessing the WebSocket.
oauth2_provider	string	Provider ID of the OAuth Provider to be associated with the monitor.
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
monitor_groups	array	Group IDs of the associated monitors. Create new monitor group or find your preferred monitor group’s ID.
dependency_resource_ids	array	Suppress alert when dependent monitor(s) is down
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}. Create new action or find your preferred action’s ID.
forced_ips	String	Provide comma-separated list of IP addresses to override IP addresses resolved by the DNS server.
third_party_services	array	Third party services to be notified.
tag_ids	array	Tag IDs to associate monitor. Create new tag or find your preferred tag’s ID.
deep_discovery	boolean	Enable this attribute to auto discover and set up monitoring for all the related resources for the WebSocket.

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
browser_type	int	Choose the browser type. Default is value is 1.
website	string	Mandatory Website address to monitor.
check_frequency	string	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, if on_call_schedule_id is not choosen User group to be notified on down. Create new user group or find your preferred user group’s ID.
on_call_schedule_id	string	Mandatory, if user_group_ids is not choosen On-Call Schedule of your choice. Create new On-Call Schedule or find your preferred On-Call Schedule 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.
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.
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”}
link_validation	JSON Object	Enter the URL along with the type (Request Header, Response Header) that you wish to validate, and enter the Header name and value. (The Value can also be a regular expression.) JSON Format:{ value: “[{link: ”$URL", type: “Request or Response Header”, header_name: “$Header Name”, header_value: “$Header Value”}], severity: “$alert_type_constant”}
ignore_filetype	JSON Object	Provide the status code and file type or file name of those page resources for which you wish not to receive alerts. JSON Format:{“value”: [{“rc”:“$StatusCode”, “ft”:“$FileType or $FileName”}]}
monitor_groups	array	Group IDs to associate monitor. Create new monitor group or find your preferred monitor group’s ID.
dependency_resource_ids	array	Suppress alert when dependent monitor(s) 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.
tag_ids	array	Tag IDs to associate monitor. Create new tag or find your preferred tag’s ID.
deep_discovery	boolean	Enable this attribute to auto discover and set up monitoring for all the related resources for the website.

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	string	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, if on_call_schedule_id is not choosen User group to be notified on down. Create new user group or find your preferred user group’s ID.
on_call_schedule_id	string	Mandatory, if user_group_ids is not choosen On-Call Schedule of your choice. Create new On-Call Schedule or find your preferred On-Call Schedule 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.
graphql	json	Provide the GraphQL query and variables to get specific response from GraphQL based API service. JSON Format: {query: “$GRAPHQL_QUERY”, variables: “$GRAPHQL_VARIABLES_IN_JSON_FORMAT”} Note: The graphql attribute is applicable only if the http_method is G(GET) or P(POST) and the request_content_type is G(GraphQL).
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.
jwt_id	string	Token ID of the Web Token to be associated with the monitor.
ssl_protocol	string	Specify the version of the SSL protocol. If you are not sure about the version, use Auto. Default value is Auto
http_protocol	string	Specify the version of the HTTP protocol.
use_alpn	boolean	Enable ALPN to send supported protocols as part of the TLS handshake.
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_ids	array	Suppress alert when dependent monitor(s) 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: [{name: “$XPATH”}], severity: “$alert_type_constant”}
match_json	json	Check for the JSON in the in JSON response. JSON Format: {jsonpath: [{name: “$JSONPATH”}], severity: “$alert_type_constant”}
response_headers_check	json	Check whether the HTTP response headers are present or verify header and corresponding values against predefined header and values. Trigger down or trouble alerts during failure. JSON Format: {value: [{name: “$header_name”, value: “$header_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.
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”}
tag_ids	array	Tag IDs to associate monitor. Create new tag or find your preferred tag’s ID.
deep_discovery	boolean	Enable this attribute to auto discover and set up monitoring for all the related resources for the website.

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	string	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, if on_call_schedule_id is not choosen User group to be notified on down. Create new user group or find your preferred user group’s ID.
on_call_schedule_id	string	Mandatory, if user_group_ids is not choosen On-Call Schedule of your choice. Create new On-Call Schedule or find your preferred On-Call Schedule ID.
monitor_groups	array	Group IDs to associate monitor. Create new monitor group or find your preferred monitor group’s ID.
dependency_resource_ids	array	Suppress alert when dependent monitor(s) is down
lookup_type	int	Lookup Type
search_config	JSON array	Value to be checked against resolved values. Choose a JSON Format based on your configured lookup type.
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.
tag_ids	array	Tag IDs to associate monitor. Create new tag or find your preferred tag’s ID.
deep_discovery	boolean	Enable this attribute to auto discover and set up monitoring for all the related resources for the domain_name.

UDP

Monitor availability of critical services hosted over a UDP port.

Attribute	Type	Description
display_name	string	Mandatory Name of the monitor.
type	string	Mandatory UDP
host_name	string	Mandatory Hostname to be monitored.
port	int	Mandatory The Port the host is listening to. Default value: 53
check_frequency	string	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, if on_call_schedule_id is not choosen User group to be notified when the status is Down. Create new user group or find your preferred user group’s ID.
on_call_schedule_id	string	Mandatory, if user_group_ids is not choosen On-Call Schedule of your choice. Create new On-Call Schedule or find your preferred On-Call Schedule ID.
use_ipv6	boolean	Select IPv6 for monitoring the websites hosted with IPv6 address. If you choose non IPv6 supported locations, monitoring will be done through IPv4.
monitor_groups	array	Group IDs to associate the monitor with. Create new monitor group or find your preferred monitor group’s ID.
dependency_resource_ids	array	Suppress alerts when dependent monitor(s) is Down.
command	string	Sent this command as a UDP packet to execute the command.
matching_keyword	json	Check for the keyword in the website response. JSON Format: {value: “$value”, severity: “$alert_type_constant”}
action_ids	JSON array	Action to be performed when 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.
tag_ids	array	Tag IDs to associate monitor with. Create new tag or find your preferred tag’s ID.
deep_discovery	boolean	Enable this attribute to auto discover and set up monitoring for all the related resources for the host_name.

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	string	Mandatory Check interval for monitoring.
timeout	int	Mandatory Timeout for connecting to the host. Range 1 - 45.
use_ssl	boolean	Use secure connection (SSL).
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, if on_call_schedule_id is not choosen User group to be notified on down. Create new user group or find your preferred user group’s ID.
on_call_schedule_id	string	Mandatory, if user_group_ids is not choosen On-Call Schedule of your choice. Create new On-Call Schedule or find your preferred On-Call Schedule 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_ids	array	Suppress alert when dependent monitor(s) 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.
tag_ids	array	Tag IDs to associate monitor. Create new tag or find your preferred tag’s ID.
deep_discovery	boolean	Enable this attribute to auto discover and set up monitoring for all the related resources for the host_name.

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	string	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, if on_call_schedule_id is not choosen User group to be notified on down. Create new user group or find your preferred user group’s ID.
on_call_schedule_id	string	Mandatory, if user_group_ids is not choosen On-Call Schedule of your choice. Create new On-Call Schedule or find your preferred On-Call Schedule 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_ids	array	Suppress alert when dependent monitor(s) 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.
tag_ids	array	Tag IDs to associate monitor. Create new tag or find your preferred tag’s ID.

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	string	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, if on_call_schedule_id is not choosen User group to be notified on down. Create new user group or find your preferred user group’s ID.
on_call_schedule_id	string	Mandatory, if user_group_ids is not choosen On-Call Schedule of your choice. Create new On-Call Schedule or find your preferred On-Call Schedule 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_ids	array	Suppress alert when dependent monitor(s) 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.
tag_ids	array	Tag IDs to associate monitor. Create new tag or find your preferred tag’s ID.

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	string	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, if on_call_schedule_id is not choosen User group to be notified on down. Create new user group or find your preferred user group’s ID.
on_call_schedule_id	string	Mandatory, if user_group_ids is not choosen On-Call Schedule of your choice. Create new On-Call Schedule or find your preferred On-Call Schedule 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_ids	array	Suppress alert when dependent monitor(s) 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.
tag_ids	array	Tag IDs to associate monitor. Create new tag or find your preferred tag’s ID.
deep_discovery	boolean	Enable this attribute to auto discover and set up monitoring for all the related resources for the host_name.

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	string	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, if on_call_schedule_id is not choosen User group to be notified on down. Create new user group or find your preferred user group’s ID.
on_call_schedule_id	string	Mandatory, if user_group_ids is not choosen On-Call Schedule of your choice. Create new On-Call Schedule or find your preferred On-Call Schedule 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_ids	array	Suppress alert when dependent monitor(s) 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.
tag_ids	array	Tag IDs to associate monitor. Create new tag or find your preferred tag’s ID.

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	string	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, if on_call_schedule_id is not choosen User group to be notified on down. Create new user group or find your preferred user group’s ID.
on_call_schedule_id	string	Mandatory, if user_group_ids is not choosen On-Call Schedule of your choice. Create new On-Call Schedule or find your preferred On-Call Schedule 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_ids	array	Suppress alert when dependent monitor(s) 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.
tag_ids	array	Tag IDs to associate monitor. Create new tag or find your preferred tag’s ID.

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	string	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, if on_call_schedule_id is not choosen User group to be notified on down. Create new user group or find your preferred user group’s ID.
on_call_schedule_id	string	Mandatory, if user_group_ids is not choosen On-Call Schedule of your choice. Create new On-Call Schedule or find your preferred On-Call Schedule 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.
credential_profile_id	string	Credential Profile to be associated. Add a new profile or find the ID of your preferred Credential Profile.
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_ids	array	Suppress alert when dependent monitor(s) 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.
tag_ids	array	Tag IDs to associate monitor. Create new tag or find your preferred tag’s ID.

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. Range 1 - 999.
ignore_trust	boolean	To ignore the validation of SSL/TLS certificate chain.
start_tls	boolean	To establish a secure connection after an initial unencrypted connection using a single port.
forced_ips	string	Provide comma-separated list of IP addresses to override IP addresses resolved by the DNS server.
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, if on_call_schedule_id is not choosen User group to be notified on down. Create new user group or find your preferred user group’s ID.
on_call_schedule_id	string	Mandatory, if user_group_ids is not choosen On-Call Schedule of your choice. Create new On-Call Schedule or find your preferred On-Call Schedule 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.
tag_ids	array	Tag IDs to associate monitor. Create new tag or find your preferred tag’s ID.
deep_discovery	boolean	Enable this attribute to auto discover and set up monitoring for all the related resources for the domain_name.

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. Range 1 - 999.
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, if on_call_schedule_id is not choosen User group to be notified on down. Create new user group or find your preferred user group’s ID.
on_call_schedule_id	string	Mandatory, if user_group_ids is not choosen On-Call Schedule of your choice. Create new On-Call Schedule or find your preferred On-Call Schedule 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.
tag_ids	array	Tag IDs to associate monitor. Create new tag or find your preferred tag’s ID.
deep_discovery	boolean	Enable this attribute to auto discover and set up monitoring for all the related resources for the host_name.

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	string	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, if on_call_schedule_id is not choosen User group to be notified on down. Create new user group or find your preferred user group’s ID.
on_call_schedule_id	string	Mandatory, if user_group_ids is not choosen On-Call Schedule of your choice. Create new On-Call Schedule or find your preferred On-Call Schedule 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_ids	array	Suppress alert when dependent monitor(s) 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.
tag_ids	array	Tag IDs to associate monitor. Create new tag or find your preferred tag’s ID.

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

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	string	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, if on_call_schedule_id is not choosen User group to be notified on down. Create new user group or find your preferred user group’s ID.
on_call_schedule_id	string	Mandatory, if user_group_ids is not choosen On-Call Schedule of your choice. Create new On-Call Schedule or find your preferred On-Call Schedule ID.
monitor_groups	array	Mandatory Group IDs to associate monitor. Create new monitor group or find your preferred monitor group’s ID.
dependency_resource_ids	array	Suppress alert when dependent monitor(s) 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.
tag_ids	array	Tag IDs to associate monitor. Create new tag or find your preferred tag’s ID.

REST API Transaction Step - POST not allowed

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

GET /monitors/steps/{monitor_id}

Retrieve Step details of an existing REST API Transaction monitor.

Request Example

$ curl https://www.site24x7.com/api/monitors/steps/123412341234123411 \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "success",
    "data": [{
        "monitor_id": "123412341234123411",
        "step_id": "123412341234123311",
        "display_name": "landing page - zylker.com",
        "step_details": [{
            "severity": 0,
            "use_ipv6": false,
            "unmatching_keyword": {
                "value": "error",
                "severity": 2
            },
            "match_regex": {
                "value": "CountryCode: \w+",
                "severity": 2
            },
            "response_headers_check": {
                    "value":[{
                        "name":"content-encoding",
                        "value":"gzip"
                        }],
                    "severity":2
            },
            "response_type": "T",
            "step_id": "123412341234123332",
            "display_name": "landing page - zylker.com",
            "response_variables": {
                "response_type": "T",
                "variables": [{
                    "name": "CountryCode",
                    "value": "CountryCode: \w+"
                }]
            },
            "dynamic_header_params": {
                "variables": [{
                    "name": "Id", 
                    "value": "Set-Cookie: id="
                }]
             },
            "timeout": 30,
            "match_case": false,
            "up_status_codes": "0:200",
            "request_content_type": "G",
            "http_method": "G",
            "graphql":{
                    "variables":"{\n    \"FilmId\":\"12345ABC#\"\n}",
                    "query":"query GetFlimById($FilmId:ID!){\n        film(id:$FilmId){\n            id\n            title\n            director\n        }\n    }"
            },
            "use_name_server": false,
            "step_url": "https://zylker.com",
            "matching_keyword": {
                "value": "zylker.com",
                "severity": 2
            },
            "request_param": "",
            "user_agent": "Site24x7 - Monitoring",
            "ssl_protocol": "Auto",
            "custom_headers": [{
                "name": "Host",
                "value": "zylker.com"
            }]
        }]
    }]
}

oauthscope : Site24x7.Admin.Read

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
display_name	string	Name of the Step.
monitor_id	string	Unique ID of the monitor. Use retrieve monitor API to get the details of this monitor.
step_id	string	Unique ID for the Step.
step_details	JSONArray	Step stands for the API transactions for a single monitor. Create multiple steps and arrange them in order of execution. JSON Format [{step_url:“$step_url”, http_method:“$http_method”, timeout:$timeout, use_ipv6:“$use_ipv6”, request_content_type:“$request_content_type”, request_param:“$request_param”, auth_user:“$auth_user”, auth_pass:“$auth_pass”, oauth2_provider:“$oauth2_provider”, jwt_id:“$jwt_id”, response_type:“$response_type”, matching_keyword:“$matching_keyword”, unmatching_keyword:“$unmatching_keyword”, match_regex:“$match_regex”, match_case:“$match_case”, match_xml:“$match_xml”, match_json:“$match_json”, response_headers_check:“$response_headers_check”,user_agent:“$user_agent”, custom_headers:“$custom_headers”, use_name_server:“$use_name_server”, up_status_codes:“$up_status_codes”, response_variables:“$response_variables”, dynamic_header_params:“$dynamic_header_params”, severity:$severity, json_schema_check:“$json_schema_check”, json_schema:“$json_schema”}]

JSON Format

Attribute	Type	Description
step_url	string	Website address to monitor.
http_method	string	HTTP Method used for accessing the website. HTTP Methods
timeout	int	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.
graphql	json	Provide the GraphQL query and variables to get specific response from GraphQL based API service. JSON Format: {query: “$GRAPHQL_QUERY”, variables: “$GRAPHQL_VARIABLES_IN_JSON_FORMAT”} Note: The graphql attribute is applicable only if the http_method is G(GET) or P(POST) and the request_content_type is G(GraphQL).
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.
jwt_id	string	Token ID of the Webtoken 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: [{name: “$XPATH”}], severity: “$alert_type_constant”}
match_json	json	Check for the JSON in the in JSON response. JSON Format: {jsonpath: [{name: “$JSONPATH”}], severity: “$alert_type_constant”}
response_headers_check	json	Check whether the HTTP response headers are present or verify header and corresponding values against predefined header and values. Trigger down or trouble alerts during failure. JSON Format: {value: [{name: “$header_name”, value: “$header_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”}]“}
dynamic_header_params	json	These are parameter forwards from Headers used for the next step in the transaction. JSON Format:{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	string	Mandatory Check interval for monitoring.
async_dc_enabled	boolean	When asynchronous data collection is enabled, polling will be carried out from all the locations at the same time. If it is disabled, polling will be done consecutively from the selected locations. Default value is true
browser_type	int	Choose the browser type. Default is value is 1.
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, if on_call_schedule_id is not choosen User group to be notified on down. Create new user group or find your preferred user group’s ID.
on_call_schedule_id	string	Mandatory, if user_group_ids is not choosen On-Call Schedule of your choice. Create new On-Call Schedule or find your preferred On-Call Schedule ID.
monitor_groups	array	Group IDs to associate monitor. Create new monitor group or find your preferred monitor group’s ID.
dependency_resource_ids	array	Suppress alert when dependent monitor(s) 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.
tag_ids	array	Tag IDs to associate monitor. Create new tag or find your preferred tag’s ID.

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”}]

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, if on_call_schedule_id is not choosen User group to be notified on down. Create new user group or find your preferred user group’s ID.
on_call_schedule_id	string	Mandatory, if user_group_ids is not choosen On-Call Schedule of your choice. Create new On-Call Schedule or find your preferred On-Call Schedule ID.
log_needed	boolean	Mandatory Enable Eventlog / Syslog for monitoring.
monitor_groups	array	Group ids to associate monitor. Create new monitor group or find your preferred monitor group’s ID.
dependency_resource_ids	array	Suppress alert when dependent monitor(s) 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.
tag_ids	array	Tag IDs to associate monitor. Create new tag or find your preferred tag’s ID.
sm_poll_interval	int	Check server monitor poll interval for monitoring. Valid intervals should 1 min or 5 min.

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, if on_call_schedule_id is not choosen User group to be notified on down. Create new user group or find your preferred user group’s ID.
on_call_schedule_id	string	Mandatory, if user_group_ids is not choosen On-Call Schedule of your choice. Create new On-Call Schedule or find your preferred On-Call Schedule ID.
monitor_groups	array	Group IDs to associate monitor. Create new monitor group or find your preferred monitor group’s ID.
dependency_resource_ids	array	Suppress alert when dependent monitor(s) 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.
tag_ids	array	Tag IDs to associate monitor. Create new tag or find your preferred tag’s ID.

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, if on_call_schedule_id is not choosen User group to be notified on down. Create new user group or find your preferred user group’s ID.
on_call_schedule_id	string	Mandatory, if user_group_ids is not choosen On-Call Schedule of your choice. Create new On-Call Schedule or find your preferred On-Call Schedule ID.
monitor_groups	array	Group IDs to associate monitor. Create new monitor group or find your preferred monitor group’s ID.
dependency_resource_ids	array	Suppress alert when dependent monitor(s) 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.
tag_ids	array	Tag IDs to associate monitor. Create new tag or find your preferred tag’s ID.

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, if on_call_schedule_id is not choosen User group to be notified on down. Create new user group or find your preferred user group’s ID.
on_call_schedule_id	string	Mandatory, if user_group_ids is not choosen On-Call Schedule of your choice. Create new On-Call Schedule or find your preferred On-Call Schedule ID.
third_party_services	array	Third party services to be notified.

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
credential_profile_id	string	Mandatory Credential Profile to associate.
check_frequency	string	Mandatory Check interval for monitoring. Supported Frequencies : 3 min, 5 min, 10 min, 15 min.
restricted_vms	JSON array	Name of the restricted VM JSON Format: {name: “$Restricted VMName”}
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, if on_call_schedule_id is not choosen User group to be notified on down. Create new user group or find your preferred user group’s ID.
on_call_schedule_id	string	Mandatory, if user_group_ids is not choosen On-Call Schedule of your choice. Create new On-Call Schedule or find your preferred On-Call Schedule ID.
auto_discovery	boolean	Auto discover VMs.
auto_discovery_ds	boolean	Auto discover associated Datastores.
monitor_groups	array	Group IDs to associate monitor. Create new monitor group or find your preferred monitor group’s ID.
dependency_resource_ids	array	Suppress alert when dependent monitor(s) 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.
tag_ids	array	Tag IDs to associate monitor. Create new tag or find your preferred tag’s ID.

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
credential_profile_id	string	Mandatory Credential Profile to associate.
check_frequency	string	Mandatory Check interval for monitoring. Supported Frequencies : 3 min, 5 min, 10 min, 15 min.
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, if on_call_schedule_id is not choosen User group to be notified on down. Create new user group or find your preferred user group’s ID.
on_call_schedule_id	string	Mandatory, if user_group_ids is not choosen On-Call Schedule of your choice. Create new On-Call Schedule or find your preferred On-Call Schedule 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_ids	array	Suppress alert when dependent monitor(s) 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.
tag_ids	array	Tag IDs to associate monitor. Create new tag or find your preferred tag’s ID.

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, if on_call_schedule_id is not choosen 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.
on_call_schedule_id	string	Mandatory, if user_group_ids is not choosen On-Call Schedule of your choice. Create new On-Call Schedule or find your preferred On-Call Schedule ID.
aws_include_discovery_type	int	Discovery Criteria to include AWS resources using Tags
aws_include_tags	string	The tags that need to be configured to include AWS resources from discovery.
aws_exclude_discovery_type	int	Discovery Criteria to exclude AWS resources using Tags
aws_exclude_tags	string	The tags that need to be configured to exclude 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.
tag_ids	array	Tag IDs to associate monitor. Create new tag or find your preferred tag’s ID.
region_type	int	AWS Account Region Type. Default value: 0

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.
check_frequency	string	Mandatory Poll interval for monitoring.
aws_account_id	string	Mandatory AWS Monitor id.
aws_child_type	string	Mandatory AWS child type for the EC2 Instance.
enable_uptime_monitoring	boolean	Monitor the availability status of 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, if on_call_schedule_id is not choosen User group to be notified on down. Create new user group or find your preferred user group’s ID.
on_call_schedule_id	string	Mandatory, if user_group_ids is not choosen On-Call Schedule of your choice. Create new On-Call Schedule or find your preferred On-Call Schedule ID.
monitor_groups	array	Group IDs to associate monitor. Create new monitor group or find your preferred monitor group’s ID.
dependency_resource_ids	array	Suppress alert when dependent monitor(s) 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.
tag_ids	array	Tag IDs to associate monitor. Create new tag or find your preferred tag’s ID.

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.
check_frequency	string	Mandatory Poll interval for monitoring.
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.
enable_uptime_monitoring	boolean	Monitor the availability status of 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, if on_call_schedule_id is not choosen User group to be notified on down. Create new user group or find your preferred user group’s ID.
on_call_schedule_id	string	Mandatory, if user_group_ids is not choosen On-Call Schedule of your choice. Create new On-Call Schedule or find your preferred On-Call Schedule ID.
monitor_groups	array	Group IDs to associate monitor. Create new monitor group or find your preferred monitor group’s ID.
dependency_resource_ids	array	Suppress alert when dependent monitor(s) 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.
tag_ids	array	Tag IDs to associate monitor. Create new tag or find your preferred tag’s ID.

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.
check_frequency	string	Mandatory Poll interval for monitoring.
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.
enable_uptime_monitoring	boolean	Monitor the availability status of 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, if on_call_schedule_id is not choosen User group to be notified on down. Create new user group or find your preferred user group’s ID.
on_call_schedule_id	string	Mandatory, if user_group_ids is not choosen On-Call Schedule of your choice. Create new On-Call Schedule or find your preferred On-Call Schedule 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.
tag_ids	array	Tag IDs to associate monitor. Create new tag or find your preferred tag’s ID.

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.
check_frequency	string	Mandatory Poll interval for monitoring.
aws_account_id	string	Mandatory AWS account id for DynamoDB Table.
aws_child_type	int	Mandatory AWS child type for DynamoDB Table.
enable_uptime_monitoring	boolean	Monitor the availability status of 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, if on_call_schedule_id is not choosen User group to be notified on down. Create new user group or find your preferred user group’s ID.
on_call_schedule_id	string	Mandatory, if user_group_ids is not choosen On-Call Schedule of your choice. Create new On-Call Schedule or find your preferred On-Call Schedule ID.
monitor_groups	array	Group IDs to associate monitor. Create new monitor group or find your preferred monitor group’s ID.
dependency_resource_ids	array	Suppress alert when dependent monitors 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.
tag_ids	array	Tag IDs to associate monitor. Create new tag or find your preferred tag’s ID.

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.
check_frequency	string	Mandatory Poll interval for monitoring.
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.
enable_uptime_monitoring	boolean	Monitor the availability status of Classic Load Balancer.
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, if on_call_schedule_id is not choosen User group to be notified on down. Create new user group or find your preferred user group’s ID.
on_call_schedule_id	string	Mandatory, if user_group_ids is not choosen On-Call Schedule of your choice. Create new On-Call Schedule or find your preferred On-Call Schedule 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.
tag_ids	array	Tag IDs to associate monitor. Create new tag or find your preferred tag’s ID.

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.
check_frequency	string	Mandatory Poll interval for monitoring.
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.
enable_uptime_monitoring	boolean	Monitor the availability status of Application Load Balancer.
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, if on_call_schedule_id is not choosen User group to be notified on down. Create new user group or find your preferred user group’s ID.
on_call_schedule_id	string	Mandatory, if user_group_ids is not choosen On-Call Schedule of your choice. Create new On-Call Schedule or find your preferred On-Call Schedule 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.
tag_ids	array	Tag IDs to associate monitor. Create new tag or find your preferred tag’s ID.

Network Load Balancer - POST not allowed

Monitor availability and performance of Amazon Network Load Balancer.

Attribute	Type	Description
display_name	string	Mandatory Name for the Network Load Balancer.
type	string	Mandatory NETWORK-LOADBALANCER
region	string	Mandatory System discovered region of the Load Balancer.
check_frequency	string	Mandatory Poll interval for monitoring.
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.
enable_uptime_monitoring	boolean	Monitor the availability status of Network Load Balancer.
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, if on_call_schedule_id is not choosen User group to be notified on down. Create new user group or find your preferred user group’s ID.
on_call_schedule_id	string	Mandatory, if user_group_ids is not choosen On-Call Schedule of your choice. Create new On-Call Schedule or find your preferred On-Call Schedule 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.
tag_ids	array	Tag IDs to associate monitor. Create new tag or find your preferred tag’s ID.

Gateway Load Balancer - POST not allowed

Monitor availability and performance of Amazon Gateway Load Balancer.

Attribute	Type	Description
display_name	string	Mandatory Name for the Gateway Load Balancer.
type	string	Mandatory GATEWAY-LOADBALANCER
region	string	Mandatory System discovered region of the Load Balancer.
check_frequency	string	Mandatory Poll interval for monitoring.
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.
enable_uptime_monitoring	boolean	Monitor the availability status of Gateway Load Balancer.
threshold_profile_id	string	Mandatory Threshold Profile to be associated with the monitor. Create a 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, if on_call_schedule_id is not choosen User group to be notified on down. Create new user group or find your preferred user group’s ID.
on_call_schedule_id	string	Mandatory, if user_group_ids is not choosen On-Call Schedule of your choice. Create new On-Call Schedule or find your preferred On-Call Schedule 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.
tag_ids	array	Tag IDs to associate monitor. Create new tag or find your preferred tag’s ID.

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.
type	string	Mandatory LAMBDAFUNCTION
function_name	string	Mandatory Name for the Lambda Function.
region	string	Mandatory System discovered region of the Lambda Function.
check_frequency	string	Mandatory Poll interval for monitoring.
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.
enable_uptime_monitoring	boolean	Monitor the availability status of Lambda Function.
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, if on_call_schedule_id is not choosen User group to be notified on down. Create new user group or find your preferred user group’s ID.
on_call_schedule_id	string	Mandatory, if user_group_ids is not choosen On-Call Schedule of your choice. Create new On-Call Schedule or find your preferred On-Call Schedule 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.
tag_ids	array	Tag IDs to associate monitor. Create new tag or find your preferred tag’s ID.

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.
type	string	Mandatory EC-MEMCACHED
region	string	Mandatory System discovered region of the Memcached Cluster.
check_frequency	string	Mandatory Poll interval for monitoring.
aws_account_id	string	Mandatory AWS account id.
enable_uptime_monitoring	boolean	Monitor the availability status of Memcached Cluster.
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, if on_call_schedule_id is not choosen User group to be notified on down. Create new user group or find your preferred user group’s ID.
on_call_schedule_id	string	Mandatory, if user_group_ids is not choosen On-Call Schedule of your choice. Create new On-Call Schedule or find your preferred On-Call Schedule 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.
tag_ids	array	Tag IDs to associate monitor. Create new tag or find your preferred tag’s ID.

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.
type	string	Mandatory EC-MEM-NODE
region	string	Mandatory System discovered region of the Memcached Node.
check_frequency	string	Mandatory Poll interval for monitoring.
aws_account_id	string	Mandatory AWS account id.
enable_uptime_monitoring	boolean	Monitor the availability status of Memcached Node.
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, if on_call_schedule_id is not choosen User group to be notified on down. Create new user group or find your preferred user group’s ID.
on_call_schedule_id	string	Mandatory, if user_group_ids is not choosen On-Call Schedule of your choice. Create new On-Call Schedule or find your preferred On-Call Schedule 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.
tag_ids	array	Tag IDs to associate monitor. Create new tag or find your preferred tag’s ID.

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.
type	string	Mandatory EC-REDIS
region	string	Mandatory System discovered region of the Redis Node.
check_frequency	string	Mandatory Poll interval for monitoring.
aws_account_id	string	Mandatory AWS account id.
enable_uptime_monitoring	boolean	Monitor the availability status of Redis Node.
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, if on_call_schedule_id is not choosen User group to be notified on down. Create new user group or find your preferred user group’s ID.
on_call_schedule_id	string	Mandatory, if user_group_ids is not choosen On-Call Schedule of your choice. Create new On-Call Schedule or find your preferred On-Call Schedule 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.
tag_ids	array	Tag IDs to associate monitor. Create new tag or find your preferred tag’s ID.

S3 Bucket Monitor - POST not allowed

Monitor the usage and performance of Simple Storage Service (S3) Bucket.

Attribute	Type	Description
display_name	string	Mandatory Name of the monitor.
bucket_name	string	Mandatory Name of the S3 Bucket.
type	string	Mandatory S3BUCKET
region	string	Mandatory System discovered region of the S3 Bucket.
check_frequency	string	Mandatory Poll interval for monitoring.
aws_child_type	string	Mandatory AWS Child type of S3 Bucket.
aws_account_id	string	Mandatory AWS account id.
enable_uptime_monitoring	boolean	Monitor the availability status of S3 Bucket.
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, if on_call_schedule_id is not choosen User group to be notified on down. Create new user group or find your preferred user group’s ID.
on_call_schedule_id	string	Mandatory, if user_group_ids is not choosen On-Call Schedule of your choice. Create new On-Call Schedule or find your preferred On-Call Schedule ID.
aws_arn	string	Amazon Resource Name for the S3 Bucket.
monitor_groups	array	Group IDs to associate monitor. Create new monitor group or find your preferred monitor group’s ID.
s3_objects	json array	Objects to be checked for existence. JSON Format [{severity: $severity, objects: [{“value”:$value}]}].
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.
tag_ids	array	Tag IDs to associate monitor. Create new tag or find your preferred tag’s ID.

S3 Object Monitor - POST not allowed

Monitor availability and end user experience of the Simple Storage Service (S3) Objects from 100+ locations.

Attribute	Type	Description
display_name	string	Mandatory Name for the monitor.
type	string	Mandatory S3ENDPOINT
website	string	Mandatory Website address to S3Object.
check_frequency	string	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, if on_call_schedule_id is not choosen User group to be notified on down. Create new user group or find your preferred user group’s ID.
on_call_schedule_id	string	Mandatory, if user_group_ids is not choosen On-Call Schedule of your choice. Create new On-Call Schedule or find your preferred On-Call Schedule 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.
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.
monitor_groups	array	Group IDs to associate monitor. Create new monitor group or find your preferred monitor group’s ID.
dependency_resource_ids	array	Suppress alert when dependent monitors 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.
tag_ids	array	Tag IDs to associate monitor. Create new tag or find your preferred tag’s ID.

S3 Folder Monitor - POST not allowed

Monitor the usage and object modification of Simple Storage Service (S3) Folder.

Attribute	Type	Description
display_name	string	Mandatory The monitor name.
type	string	Mandatory S3FOLDER
region	string	Mandatory The system discovered region of the S3 Bucket.
aws_child_type	string	Mandatory The AWS child type of S3 Bucket.
aws_account_id	string	Mandatory The AWS account ID.
folder	string	Mandatory The folder path of the monitor.
resource_name	string	Mandatory The folder path of the monitor with bucket name.
check_frequency	string	Mandatory Check interval for monitoring.
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, if on_call_schedule_id is not choosen User group to be notified on down. Create new user group or find your preferred user group’s ID.
on_call_schedule_id	string	Mandatory, if user_group_ids is not choosen On-Call Schedule of your choice. Create new On-Call Schedule or find your preferred On-Call Schedule ID.
tag_ids	array	Tag IDs to associate monitor. Create new tag or find your preferred tag’s ID.

SQS Queue Monitor - POST not allowed

Monitor Amazon SQS performance and gain insight into queue health.

Attribute	Type	Description
display_name	string	Mandatory Name for the SQS Queue.
queue_url	string	Mandatory SQS Queue URL
region	string	Mandatory System discovered region of the SQS Queue.
check_frequency	string	Mandatory Poll interval for monitoring.
aws_monitor_id	string	Mandatory AWS Monitor ID.
aws_sqs_type	string	Mandatory AWS child type for the SQS Queue.
aws_arn	string	Mandatory Amazon Resource Name for the SQS Queue.
enable_uptime_monitoring	boolean	Monitor the availability status of SQS Queue.
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, if on_call_schedule_id is not choosen User group to be notified on down. Create new user group or find your preferred user group’s ID.
on_call_schedule_id	string	Mandatory, if user_group_ids is not choosen On-Call Schedule of your choice. Create new On-Call Schedule or find your preferred On-Call Schedule 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.
tag_ids	array	Tag IDs used to associate with a monitor. Create a new tag or find your preferred tag’s ID.

CloudFront Distribution Monitor - POST not allowed

Monitor the usage and performance of Amazon CloudFront Distribution.

Attribute	Type	Description
display_name	string	Mandatory Name for the CloudFront Distribution.
type	string	Mandatory CLOUDFRONT.
distribution_id	string	Mandatory CloudFront Distribution ID.
region	string	Mandatory System discovered region of the CloudFront Distribution.
check_frequency	string	Mandatory Poll interval for monitoring.
aws_account_id	string	Mandatory AWS Monitor ID.
aws_child_type	string	Mandatory AWS child type for the CloudFront Distribution.
aws_arn	string	Mandatory Amazon Resource Name for the CloudFront Distribution.
enable_uptime_monitoring	boolean	Monitor the availability status of CloudFront Distribution.
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, if on_call_schedule_id is not choosen User group to be notified on down. Create new user group or find your preferred user group’s ID.
on_call_schedule_id	string	Mandatory, if user_group_ids is not choosen On-Call Schedule of your choice. Create new On-Call Schedule or find your preferred On-Call Schedule 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.
tag_ids	array	Tag IDs used to associate with a monitor. Create a new tag or find your preferred tag’s ID.

Kinesis Data Stream Monitor - POST not allowed

Monitor the usage and performance of Amazon Kinesis Data Stream.

Attribute	Type	Description
display_name	string	Mandatory Name for the Kinesis Data Stream.
type	string	Mandatory KINESIS-DATA.
domain_name	string	Mandatory Kinesis Data Stream Name.
region	string	Mandatory System discovered region of the Kinesis Data Stream.
check_frequency	string	Mandatory Poll interval for monitoring.
aws_account_id	string	Mandatory AWS Monitor ID.
aws_child_type	string	Mandatory AWS child type for the Kinesis Data Stream.
aws_arn	string	Mandatory Amazon Resource Name for the Kinesis Data Stream.
enable_uptime_monitoring	boolean	Monitor the availability status of Kinesis Data Stream.
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, if on_call_schedule_id is not choosen User group to be notified on down. Create new user group or find your preferred user group’s ID.
on_call_schedule_id	string	Mandatory, if user_group_ids is not choosen On-Call Schedule of your choice. Create new On-Call Schedule or find your preferred On-Call Schedule 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.
tag_ids	array	Tag IDs used to associate with a monitor. Create a new tag or find your preferred tag’s ID.

Kinesis Firehose Delivery Stream Monitor - POST not allowed

Monitor the usage and performance of Amazon Kinesis Firehose Delivery Stream.

Attribute	Type	Description
display_name	string	Mandatory Name for the Kinesis Firehose Delivery Stream.
type	string	Mandatory KINESIS-FIREHOSE.
domain_name	string	Mandatory Kinesis Firehose Delivery Stream Name.
region	string	Mandatory System discovered region of the Kinesis Firehose Delivery Stream.
check_frequency	string	Mandatory Poll interval for monitoring.
aws_account_id	string	Mandatory AWS Monitor ID.
aws_child_type	string	Mandatory AWS child type for the Kinesis Firehose Delivery Stream.
aws_arn	string	Mandatory Amazon Resource Name for the Kinesis Firehose Delivery Stream.
enable_uptime_monitoring	boolean	Monitor the availability status of Kinesis Firehose Delivery Stream.
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, if on_call_schedule_id is not choosen User group to be notified on down. Create new user group or find your preferred user group’s ID.
on_call_schedule_id	string	Mandatory, if user_group_ids is not choosen On-Call Schedule of your choice. Create new On-Call Schedule or find your preferred On-Call Schedule 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.
tag_ids	array	Tag IDs used to associate with a monitor. Create a new tag or find your preferred tag’s ID.

Kinesis Analytics Application Monitor - POST not allowed

Monitor the usage and performance of Amazon Kinesis Analytics Application.

Attribute	Type	Description
display_name	string	Mandatory Name for the Kinesis Analytics Application.
type	string	Mandatory KINESIS-ANALYTICS.
domain_name	string	Mandatory Kinesis Analytics Application Name.
region	string	Mandatory System discovered region of the Kinesis Analytics Application.
check_frequency	string	Mandatory Poll interval for monitoring.
aws_account_id	string	Mandatory AWS Monitor ID.
aws_child_type	string	Mandatory AWS child type for the Kinesis Analytics Application.
aws_arn	string	Mandatory Amazon Resource Name for the Kinesis Analytics Application.
enable_uptime_monitoring	boolean	Monitor the availability status of Kinesis Analytics Application.
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, if on_call_schedule_id is not choosen User group to be notified on down. Create new user group or find your preferred user group’s ID.
on_call_schedule_id	string	Mandatory, if user_group_ids is not choosen On-Call Schedule of your choice. Create new On-Call Schedule or find your preferred On-Call Schedule 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.
tag_ids	array	Tag IDs used to associate with a monitor. Create a new tag or find your preferred tag’s ID.

Kinesis Video Stream Monitor - POST not allowed

Monitor the usage and performance of Amazon Kinesis Video Stream.

Attribute	Type	Description
display_name	string	Mandatory Name for the Kinesis Video Stream.
type	string	Mandatory KINESIS-VIDEO.
domain_name	string	Mandatory Kinesis Video Stream Name.
region	string	Mandatory System discovered region of the Kinesis Video Stream.
check_frequency	string	Mandatory Poll interval for monitoring.
aws_account_id	string	Mandatory AWS Monitor ID.
aws_child_type	string	Mandatory AWS child type for the Kinesis Video Stream.
aws_arn	string	Mandatory Amazon Resource Name for the Kinesis Video Stream.
enable_uptime_monitoring	boolean	Monitor the availability status of Kinesis Video Stream.
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, if on_call_schedule_id is not choosen User group to be notified on down. Create new user group or find your preferred user group’s ID.
on_call_schedule_id	string	Mandatory, if user_group_ids is not choosen On-Call Schedule of your choice. Create new On-Call Schedule or find your preferred On-Call Schedule 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.
tag_ids	array	Tag IDs used to associate with a monitor. Create a new tag or find your preferred tag’s ID.

Elastic Beanstalk environment Monitor - POST not allowed

Monitor the usage and performance of Amazon Elastic Beanstalk environment.

Attribute	Type	Description
display_name	string	Mandatory Name for the Elastic Beanstalk environment.
type	string	Mandatory EBSENVIRONMENT.
elastic_beanstalk_environment_name	string	Mandatory Elastic Beanstalk environment ID.
region	string	Mandatory System discovered region of the Elastic Beanstalk environment.
check_frequency	string	Mandatory Poll interval for monitoring.
aws_account_id	string	Mandatory AWS Monitor ID.
aws_child_type	string	Mandatory AWS child type for the Elastic Beanstalk environment.
aws_arn	string	Mandatory Amazon Resource Name for the Elastic Beanstalk environment.
enable_uptime_monitoring	boolean	Monitor the availability status of Elastic Beanstalk environment.
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, if on_call_schedule_id is not choosen User group to be notified on down. Create new user group or find your preferred user group’s ID.
on_call_schedule_id	string	Mandatory, if user_group_ids is not choosen On-Call Schedule of your choice. Create new On-Call Schedule or find your preferred On-Call Schedule 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.
tag_ids	array	Tag IDs used to associate with a monitor. Create a new tag or find your preferred tag’s ID.

Direct Connect Monitor - POST not allowed

Monitor the usage and performance of Amazon Direct Connect connection.

Attribute	Type	Description
display_name	string	Mandatory Name for the Direct Connect connection.
type	string	Mandatory DIRECTCONNECT.
resource_name	string	Mandatory Direct Connect connection ID.
region	string	Mandatory System discovered region of the Direct Connect connection.
check_frequency	string	Mandatory Poll interval for monitoring.
aws_account_id	string	Mandatory AWS Monitor ID.
aws_child_type	string	Mandatory AWS child type for the Direct Connect connection.
aws_arn	string	Mandatory Amazon Resource Name for the Direct Connect connection.
enable_uptime_monitoring	boolean	Monitor the availability status of Direct Connect connection.
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, if on_call_schedule_id is not choosen User group to be notified on down. Create new user group or find your preferred user group’s ID.
on_call_schedule_id	string	Mandatory, if user_group_ids is not choosen On-Call Schedule of your choice. Create new On-Call Schedule or find your preferred On-Call Schedule 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.
tag_ids	array	Tag IDs used to associate with a monitor. Create a new tag or find your preferred tag’s ID.

VPC - Virtual Private Network Monitor - POST not allowed

Monitor the usage and performance of Amazon VPC - Virtual Private Network.

Attribute	Type	Description
display_name	string	Mandatory Name for the VPC - Virtual Private Network connection.
type	string	Mandatory VPC-VPN.
resource_name	string	Mandatory VPC - Virtual Private Network connection ID.
region	string	Mandatory System discovered region of the VPC - Virtual Private Network connection.
check_frequency	string	Mandatory Poll interval for monitoring.
aws_account_id	string	Mandatory AWS Monitor ID.
aws_child_type	string	Mandatory AWS child type for the VPC - Virtual Private Network connection.
aws_arn	string	Mandatory Amazon Resource Name for the VPC - Virtual Private Network connection.
enable_uptime_monitoring	boolean	Monitor the availability status of VPC - Virtual Private Network connection.
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, if on_call_schedule_id is not choosen User group to be notified on down. Create new user group or find your preferred user group’s ID.
on_call_schedule_id	string	Mandatory, if user_group_ids is not choosen On-Call Schedule of your choice. Create new On-Call Schedule or find your preferred On-Call Schedule 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.
tag_ids	array	Tag IDs used to associate with a monitor. Create a new tag or find your preferred tag’s ID.

API Gateway Stage Monitor - POST not allowed

Monitor the usage and performance of Amazon API Gateway stage.

Attribute	Type	Description
display_name	string	Mandatory Name for the API Gateway stage.
type	string	Mandatory APIGATEWAY-STAGE.
resource_name	string	Mandatory API Gateway stage ID.
gateway_id	string	Mandatory API Gateway ID.
api_type	string	Mandatory API Gateway Type.
region	string	Mandatory System discovered region of the API Gateway stage.
check_frequency	string	Mandatory Poll interval for monitoring.
aws_account_id	string	Mandatory AWS Monitor ID.
aws_child_type	string	Mandatory AWS child type for the API Gateway stage.
aws_arn	string	Mandatory Amazon Resource Name for the API Gateway stage.
enable_uptime_monitoring	boolean	Monitor the availability status of API Gateway stage.
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, if on_call_schedule_id is not choosen User group to be notified on down. Create new user group or find your preferred user group’s ID.
on_call_schedule_id	string	Mandatory, if user_group_ids is not choosen On-Call Schedule of your choice. Create new On-Call Schedule or find your preferred On-Call Schedule 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.
tag_ids	array	Tag IDs used to associate with a monitor. Create a new tag or find your preferred tag’s ID.

API Gateway Route Monitor - POST not allowed

Monitor the usage and performance of Amazon API Gateway route.

Attribute	Type	Description
display_name	string	Mandatory Name for the API Gateway Route.
type	string	Mandatory APIGATEWAY-ROUTE.
resource_name	string	Mandatory API Gateway Route ID.
gateway_id	string	Mandatory API Gateway ID.
stage_name	string	Mandatory API Gateway stage name.
region	string	Mandatory System discovered region of the API Gateway Route.
check_frequency	string	Mandatory Poll interval for monitoring.
aws_account_id	string	Mandatory AWS Monitor ID.
aws_child_type	string	Mandatory AWS child type for the API Gateway Route.
aws_arn	string	Mandatory Amazon Resource Name for the API Gateway Route.
enable_uptime_monitoring	boolean	Monitor the availability status of API Gateway route.
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, if on_call_schedule_id is not choosen User group to be notified on down. Create new user group or find your preferred user group’s ID.
on_call_schedule_id	string	Mandatory, if user_group_ids is not choosen On-Call Schedule of your choice. Create new On-Call Schedule or find your preferred On-Call Schedule 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.
tag_ids	array	Tag IDs used to associate with a monitor. Create a new tag or find your preferred tag’s ID.

API Gateway Resource Monitor - POST not allowed

Monitor the usage and performance of Amazon API Gateway resource.

Attribute	Type	Description
display_name	string	Mandatory Name for the API Gateway resource.
type	string	Mandatory APIGATEWAY-RESOURCE.
resource_name	string	Mandatory API Gateway resource ID.
gateway_id	string	Mandatory API Gateway ID.
region	string	Mandatory System discovered region of the API Gateway resource.
check_frequency	string	Mandatory Poll interval for monitoring.
aws_account_id	string	Mandatory AWS Monitor ID.
aws_child_type	string	Mandatory AWS child type for the API Gateway resource.
aws_arn	string	Mandatory Amazon Resource Name for the API Gateway resource.
enable_uptime_monitoring	boolean	Monitor the availability status of API Gateway resource.
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, if on_call_schedule_id is not choosen User group to be notified on down. Create new user group or find your preferred user group’s ID.
on_call_schedule_id	string	Mandatory, if user_group_ids is not choosen On-Call Schedule of your choice. Create new On-Call Schedule or find your preferred On-Call Schedule 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.
tag_ids	array	Tag IDs used to associate with a monitor. Create a new tag or find your preferred tag’s ID.

ECS Cluster Monitor - POST not allowed

Monitor the usage and performance of Amazon Elastic Container Service cluster.

Attribute	Type	Description
display_name	string	Mandatory Name for the ECS cluster.
type	string	Mandatory ECSCLUSTER.
resource_name	string	Mandatory ECS cluster name.
region	string	Mandatory System discovered region of the ECS cluster.
check_frequency	string	Mandatory Poll interval for monitoring.
aws_account_id	string	Mandatory AWS Monitor ID.
aws_child_type	string	Mandatory AWS child type for the ECS cluster.
aws_arn	string	Mandatory Amazon Resource Name for the ECS cluster.
enable_uptime_monitoring	boolean	Monitor the availability status of ECS cluster.
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, if on_call_schedule_id is not choosen User group to be notified on down. Create new user group or find your preferred user group’s ID.
on_call_schedule_id	string	Mandatory, if user_group_ids is not choosen On-Call Schedule of your choice. Create new On-Call Schedule or find your preferred On-Call Schedule 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.
tag_ids	array	Tag IDs used to associate with a monitor. Create a new tag or find your preferred tag’s ID.

ECS Cluster Service Monitor - POST not allowed

Monitor the usage and performance of Amazon Elastic Container Service cluster service.

Attribute	Type	Description
display_name	string	Mandatory Name for the ECS cluster service.
type	string	Mandatory ECSCLUSTERSERVICE.
resource_name	string	Mandatory ECS cluster service name.
cluster_name	string	Mandatory ECS cluster name.
region	string	Mandatory System discovered region of the ECS cluster service.
check_frequency	string	Mandatory Poll interval for monitoring.
aws_account_id	string	Mandatory AWS Monitor ID.
aws_child_type	string	Mandatory AWS child type for the ECS cluster service.
aws_arn	string	Mandatory Amazon Resource Name for the ECS cluster service.
enable_uptime_monitoring	boolean	Monitor the availability status of ECS cluster service.
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, if on_call_schedule_id is not choosen User group to be notified on down. Create new user group or find your preferred user group’s ID.
on_call_schedule_id	string	Mandatory, if user_group_ids is not choosen On-Call Schedule of your choice. Create new On-Call Schedule or find your preferred On-Call Schedule 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.
tag_ids	array	Tag IDs used to associate with a monitor. Create a new tag or find your preferred tag’s ID.

Redshift Cluster Monitor - POST not allowed

Monitor the usage and performance of Amazon Redshift Cluster.

Attribute	Type	Description
display_name	string	Mandatory Name for the Redshift Cluster resource.
type	string	Mandatory REDSHIFT-CLUSTER.
resource_name	string	Mandatory Redshift cluster ID.
aws_redshift_nodeid	string	Mandatory Redshift Node ID.
region	string	Mandatory System discovered region of the Redshift Cluster.
check_frequency	string	Mandatory Poll interval for monitoring.
aws_account_id	string	Mandatory AWS Monitor ID.
aws_child_type	string	Mandatory AWS child type for the Redshift Cluster.
aws_arn	string	Mandatory Amazon Resource Name for the Redshift Cluster.
enable_uptime_monitoring	boolean	Monitor the availability status of Redshift Cluster.
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, if on_call_schedule_id is not choosen User group to be notified on down. Create new user group or find your preferred user group’s ID.
on_call_schedule_id	string	Mandatory, if user_group_ids is not choosen On-Call Schedule of your choice. Create new On-Call Schedule or find your preferred On-Call Schedule 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.
tag_ids	array	Tag IDs used to associate with a monitor. Create a new tag or find your preferred tag’s ID.

Redshift Node Monitor - POST not allowed

Monitor the usage and performance of Amazon Redshift Cluster.

Attribute	Type	Description
display_name	string	Mandatory Name for the Redshift Node.
type	string	Mandatory REDSHIFT-NODE.
resource_name	string	Mandatory Redshift Node ID.
aws_redshift_nodeid	string	Mandatory Redshift Node ID.
region	string	Mandatory System discovered region of the Redshift Node.
check_frequency	string	Mandatory Poll interval for monitoring.
aws_account_id	string	Mandatory AWS Monitor ID.
aws_child_type	string	Mandatory AWS child type for the Redshift Node.
aws_arn	string	Mandatory Amazon Resource Name for the Redshift Node.
enable_uptime_monitoring	boolean	Monitor the availability status of Redshift Node.
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, if on_call_schedule_id is not choosen User group to be notified on down. Create new user group or find your preferred user group’s ID.
on_call_schedule_id	string	Mandatory, if user_group_ids is not choosen On-Call Schedule of your choice. Create new On-Call Schedule or find your preferred On-Call Schedule 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.
tag_ids	array	Tag IDs used to associate with a monitor. Create a new tag or find your preferred tag’s ID.

Elastic File System Monitor - POST not allowed

Monitor the usage and performance of Amazon Elastic file system.

Attribute	Type	Description
display_name	string	Mandatory Name for the File system.
type	string	Mandatory EFS.
resource_name	string	Mandatory File system name.
region	string	Mandatory System discovered region of the File system.
check_frequency	string	Mandatory Poll interval for monitoring.
aws_account_id	string	Mandatory AWS Monitor ID.
aws_child_type	string	Mandatory AWS child type for the Elastic file system.
aws_arn	string	Mandatory Amazon Resource Name for the Elastic file system.
enable_uptime_monitoring	boolean	Monitor the availability status of Elastic file system.
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, if on_call_schedule_id is not choosen User group to be notified on down. Create new user group or find your preferred user group’s ID.
on_call_schedule_id	string	Mandatory, if user_group_ids is not choosen On-Call Schedule of your choice. Create new On-Call Schedule or find your preferred On-Call Schedule 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.
tag_ids	array	Tag IDs used to associate with a monitor. Create a new tag or find your preferred tag’s ID.

Simple Email Service Monitor - POST not allowed

Monitor the usage and performance of Amazon Simple Email Service.

Attribute	Type	Description
display_name	string	Mandatory Name for the Simple Email Service.
type	string	Mandatory SES.
resource_name	string	Mandatory Simple Email Service Name.
region	string	Mandatory System discovered region of the Simple Email Service.
check_frequency	string	Mandatory Poll interval for monitoring.
aws_account_id	string	Mandatory AWS Monitor ID.
aws_child_type	string	Mandatory AWS child type for the Simple Email Service.
aws_arn	string	Mandatory Amazon Resource Name for the Simple Email Service.
enable_uptime_monitoring	boolean	Monitor the availability status of Simple Email Service.
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, if on_call_schedule_id is not choosen User group to be notified on down. Create new user group or find your preferred user group’s ID.
on_call_schedule_id	string	Mandatory, if user_group_ids is not choosen On-Call Schedule of your choice. Create new On-Call Schedule or find your preferred On-Call Schedule 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.
tag_ids	array	Tag IDs used to associate with a monitor. Create a new tag or find your preferred tag’s ID.

Step Function State Machine Monitor - POST not allowed

Monitor the usage and performance of Amazon Step Function State Machine.

Attribute	Type	Description
display_name	string	Mandatory Name for the State Machine.
type	string	Mandatory STEPFUNCTION.
resource_name	string	Mandatory Step Function State Machine name.
region	string	Mandatory System discovered region of the Step Function State Machine.
check_frequency	string	Mandatory Poll interval for monitoring.
aws_account_id	string	Mandatory AWS Monitor ID.
aws_child_type	string	Mandatory AWS child type for the Step Function State Machine.
aws_arn	string	Mandatory Amazon Resource Name for the Step Function State Machine.
enable_uptime_monitoring	boolean	Monitor the availability status of Step Function State Machine.
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, if on_call_schedule_id is not choosen User group to be notified on down. Create new user group or find your preferred user group’s ID.
on_call_schedule_id	string	Mandatory, if user_group_ids is not choosen On-Call Schedule of your choice. Create new On-Call Schedule or find your preferred On-Call Schedule 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.
tag_ids	array	Tag IDs used to associate with a monitor. Create a new tag or find your preferred tag’s ID.

Web Application Firewall Monitor - POST not allowed

Monitor the usage and performance of Amazon Web Application Firewall.

Attribute	Type	Description
display_name	string	Mandatory Name for the Web ACL.
type	string	Mandatory WAF.
resource_name	string	Mandatory Web ACL ID.
region	string	Mandatory System discovered region of the Web Application Firewall.
check_frequency	string	Mandatory Poll interval for monitoring.
aws_account_id	string	Mandatory AWS Monitor ID.
aws_child_type	string	Mandatory AWS child type for the Web Application Firewall.
aws_arn	string	Mandatory Amazon Resource Name for the Web Application Firewall.
enable_uptime_monitoring	boolean	Monitor the availability status of Web Application Firewall.
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, if on_call_schedule_id is not choosen User group to be notified on down. Create new user group or find your preferred user group’s ID.
on_call_schedule_id	string	Mandatory, if user_group_ids is not choosen On-Call Schedule of your choice. Create new On-Call Schedule or find your preferred On-Call Schedule 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.
tag_ids	array	Tag IDs used to associate with a monitor. Create a new tag or find your preferred tag’s ID.

CloudSearch Domain Monitor - POST not allowed

Monitor the usage and performance of Amazon CloudSearch Domain.

Attribute	Type	Description
display_name	string	Mandatory Name of the CloudSearch Domain.
type	string	Mandatory CLOUDSEARCH.
resource_name	string	Mandatory Domain Name.
region	string	Mandatory System discovered region of the CloudSearch Domain.
check_frequency	string	Mandatory Poll interval for monitoring.
aws_account_id	string	Mandatory AWS Monitor ID.
aws_child_type	string	Mandatory AWS child type for the CloudSearch Domain.
aws_arn	string	Mandatory Amazon Resource Name for the CloudSearch Domain.
enable_uptime_monitoring	boolean	Monitor the availability status of CloudSearch Domain.
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, if on_call_schedule_id is not choosen User group to be notified on down. Create new user group or find your preferred user group’s ID.
on_call_schedule_id	string	Mandatory, if user_group_ids is not choosen On-Call Schedule of your choice. Create new On-Call Schedule or find your preferred On-Call Schedule 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.
tag_ids	array	Tag IDs used to associate with a monitor. Create a new tag or find your preferred tag’s ID.

Key Management Service Monitor - POST not allowed

Monitor the usage and performance of Amazon Key Management Service.

Attribute	Type	Description
display_name	string	Mandatory Name for the customer managed key.
type	string	Mandatory KMS.
resource_name	string	Mandatory Key ID.
region	string	Mandatory System discovered region of the Key Management Service.
check_frequency	string	Mandatory Poll interval for monitoring.
aws_account_id	string	Mandatory AWS Monitor ID.
aws_child_type	string	Mandatory AWS child type for the Key Management Service.
aws_arn	string	Mandatory Amazon Resource Name for the Key Management Service.
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, if on_call_schedule_id is not choosen User group to be notified on down. Create new user group or find your preferred user group’s ID.
on_call_schedule_id	string	Mandatory, if user_group_ids is not choosen On-Call Schedule of your choice. Create new On-Call Schedule or find your preferred On-Call Schedule 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.
tag_ids	array	Tag IDs used to associate with a monitor. Create a new tag or find your preferred tag’s ID.

Route 53 Health Check Monitor - POST not allowed

Monitor the usage and performance of Amazon Route 53 Health Check

Attribute	Type	Description
display_name	string	Mandatory Name for the health check.
type	string	Mandatory R53_HEALTHCHECK.
resource_name	string	Mandatory Route 53 Health Check ID.
region	string	Mandatory global
check_frequency	string	Mandatory Poll interval for monitoring.
aws_account_id	string	Mandatory AWS Monitor ID.
aws_child_type	string	Mandatory AWS child type for the Route 53 Health Check.
aws_arn	string	Mandatory Amazon Resource Name for the Route 53 Health Check.
enable_uptime_monitoring	boolean	Monitor the availability status of Route 53 Health Check.
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, if on_call_schedule_id is not choosen User group to be notified on down. Create new user group or find your preferred user group’s ID.
on_call_schedule_id	string	Mandatory, if user_group_ids is not choosen On-Call Schedule of your choice. Create new On-Call Schedule or find your preferred On-Call Schedule 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.
tag_ids	array	Tag IDs used to associate with a monitor. Create a new tag or find your preferred tag’s ID.

Route 53 Resolver Monitor - POST not allowed

Monitor the usage and performance of Amazon Route 53 Resolver

Attribute	Type	Description
display_name	string	Mandatory Name for the Route 53 Resolver.
type	string	Mandatory R53_RESOLVER.
resource_name	string	Mandatory Route 53 Resolver VPC ID.
region	string	Mandatory System discovered region of the Route 53 Resolver.
check_frequency	string	Mandatory Poll interval for monitoring.
aws_account_id	string	Mandatory AWS Monitor ID.
aws_child_type	string	Mandatory AWS child type for the Route 53 Resolver.
aws_arn	string	Mandatory Amazon Resource Name for the Route 53 Resolver.
enable_uptime_monitoring	boolean	Monitor the availability status of Route 53 Resolver.
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, if on_call_schedule_id is not choosen User group to be notified on down. Create new user group or find your preferred user group’s ID.
on_call_schedule_id	string	Mandatory, if user_group_ids is not choosen On-Call Schedule of your choice. Create new On-Call Schedule or find your preferred On-Call Schedule 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.
tag_ids	array	Tag IDs used to associate with a monitor. Create a new tag or find your preferred tag’s ID.

Route 53 Hosted Zone Monitor - POST not allowed

Monitor the usage and performance of Amazon Route 53 Hosted Zone

Attribute	Type	Description
display_name	string	Mandatory Name for the Hosted Zone.
type	string	Mandatory R53_HOSTEDZONE.
resource_name	string	Mandatory Route 53 Hosted Zone ID.
region	string	Mandatory global
check_frequency	string	Mandatory Poll interval for monitoring.
aws_account_id	string	Mandatory AWS Monitor ID.
aws_child_type	string	Mandatory AWS child type for the Route 53 Hosted Zone.
aws_arn	string	Mandatory Amazon Resource Name for the Route 53 Hosted Zone.
enable_uptime_monitoring	boolean	Monitor the availability status of Route 53 Hosted Zone.
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, if on_call_schedule_id is not choosen User group to be notified on down. Create new user group or find your preferred user group’s ID.
on_call_schedule_id	string	Mandatory, if user_group_ids is not choosen On-Call Schedule of your choice. Create new On-Call Schedule or find your preferred On-Call Schedule 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.
tag_ids	array	Tag IDs used to associate with a monitor. Create a new tag or find your preferred tag’s ID.

Route 53 Hosted Zone Record Set Monitor - POST not allowed

Monitor the usage and performance of Amazon Route 53 Hosted Zone Record Set

Attribute	Type	Description
display_name	string	Mandatory Name for the Hosted Zone Record Set.
type	string	Mandatory R53_HOSTEDZONE.
resource_name	string	Mandatory Route 53 Hosted Zone Record Set Name.
hostedzone_id	string	Mandatory Route 53 Hosted Zone ID.
region	string	Mandatory global
check_frequency	string	Mandatory Poll interval for monitoring.
aws_account_id	string	Mandatory AWS Monitor ID.
aws_child_type	string	Mandatory AWS child type for the Route 53 Hosted Zone Record Set.
aws_arn	string	Mandatory Amazon Resource Name for the Route 53 Hosted Zone Record Set.
enable_uptime_monitoring	boolean	Monitor the availability status of Route 53 Hosted Zone Record Set.
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, if on_call_schedule_id is not choosen User group to be notified on down. Create new user group or find your preferred user group’s ID.
on_call_schedule_id	string	Mandatory, if user_group_ids is not choosen On-Call Schedule of your choice. Create new On-Call Schedule or find your preferred On-Call Schedule 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.
tag_ids	array	Tag IDs used to associate with a monitor. Create a new tag or find your preferred tag’s ID.

Elasticsearch Monitor - POST not allowed

Monitor the usage and performance of Elasticsearch Domain.

Attribute	Type	Description
display_name	string	Mandatory Name for the Elasticsearch.
type	string	Mandatory ESD.
domain_name	string	Mandatory Elasticsearch Domain Name.
region	string	Mandatory System discovered region of the Elasticsearch Domain.
check_frequency	string	Mandatory Poll interval for monitoring.
aws_account_id	string	Mandatory AWS Monitor ID.
aws_child_type	string	Mandatory AWS child type for the Elasticsearch.
aws_arn	string	Mandatory Amazon Resource Name for the Elasticsearch.
enable_uptime_monitoring	boolean	Monitor the availability status of Elasticsearch.
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, if on_call_schedule_id is not choosen User group to be notified on down. Create new user group or find your preferred user group’s ID.
on_call_schedule_id	string	Mandatory, if user_group_ids is not choosen On-Call Schedule of your choice. Create new On-Call Schedule or find your preferred On-Call Schedule 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.
tag_ids	array	Tag IDs used to associate with a monitor. Create a new tag or find your preferred tag’s ID.

NAT Gateway Monitor - POST not allowed

Monitor the usage and performance of AWS VPC NAT Gateway.

Attribute	Type	Description
display_name	string	Mandatory Name of the NAT Gateway.
type	string	Mandatory VPC_NATGATEWAY.
resource_name	string	Mandatory Domain Name.
region	string	Mandatory System discovered region of the NAT Gateway.
check_frequency	string	Mandatory Poll interval for monitoring.
aws_account_id	string	Mandatory AWS Monitor ID.
aws_child_type	string	Mandatory AWS child type for the NAT Gateway.
aws_arn	string	Mandatory Amazon Resource Name for the NAT Gateway.
enable_uptime_monitoring	boolean	Monitor the availability status of NAT Gateway.
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, if on_call_schedule_id is not choosen User group to be notified on down. Create new user group or find your preferred user group’s ID.
on_call_schedule_id	string	Mandatory, if user_group_ids is not choosen On-Call Schedule of your choice. Create new On-Call Schedule or find your preferred On-Call Schedule 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.
tag_ids	array	Tag IDs used to associate with a monitor. Create a new tag or find your preferred tag’s ID.

Elastic MapReduce Monitor - POST not allowed

Monitor the usage and performance of Amazon Elastic MapReduce.

Attribute	Type	Description
display_name	string	Mandatory Name for the Cluster.
type	string	Mandatory EMR.
resource_name	string	Mandatory Cluster ID.
region	string	Mandatory System discovered region of the Elastic MapReduce.
aws_account_id	string	Mandatory AWS Monitor ID.
aws_child_type	string	Mandatory AWS child type for the Elastic MapReduce.
aws_arn	string	Mandatory Amazon Resource Name for the Elastic MapReduce.
enable_uptime_monitoring	boolean	Monitor the availability status of Elastic MapReduce.
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, if on_call_schedule_id is not choosen User group to be notified on down. Create new user group or find your preferred user group’s ID.
on_call_schedule_id	string	Mandatory, if user_group_ids is not choosen On-Call Schedule of your choice. Create new On-Call Schedule or find your preferred On-Call Schedule 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.
tag_ids	array	Tag IDs used to associate with a monitor. Create a new tag or find your preferred tag’s ID.

WorkSpace Monitor - POST not allowed

Monitor the usage and performance of Amazon WorkSpace.

Attribute	Type	Description
display_name	string	Mandatory Name of the WorkSpace.
type	string	Mandatory WORKSPACE.
resource_name	string	Mandatory Domain Name.
region	string	Mandatory System discovered region of the WorkSpace.
check_frequency	string	Mandatory Poll interval for monitoring.
aws_account_id	string	Mandatory AWS Monitor ID.
aws_child_type	string	Mandatory AWS child type for the WorkSpace.
aws_arn	string	Mandatory Amazon Resource Name for the WorkSpace.
enable_uptime_monitoring	boolean	Monitor the availability status of WorkSpace.
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, if on_call_schedule_id is not choosen User group to be notified on down. Create new user group or find your preferred user group’s ID.
on_call_schedule_id	string	Mandatory, if user_group_ids is not choosen On-Call Schedule of your choice. Create new On-Call Schedule or find your preferred On-Call Schedule 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.
tag_ids	array	Tag IDs used to associate with a monitor. Create a new tag or find your preferred tag’s ID.

EC2 Auto Scaling Group Monitor - POST not allowed

Monitor availability and performance of Amazon EC2 Auto Scaling Group.

Attribute	Type	Description
display_name	string	Mandatory Name for the EC2 Auto Scaling Group.
type	string	Mandatory EC2AUTOSCALING
resource_name	string	Mandatory Auto Scaling Group Name
region	string	Mandatory System discovered region of the EC2 Auto Scaling Group.
check_frequency	string	Mandatory Poll interval for monitoring.
aws_account_id	string	Mandatory AWS Monitor id.
aws_child_type	string	Mandatory AWS child type for the EC2 Auto Scaling Group.
enable_uptime_monitoring	boolean	Monitor the availability status of EC2 Auto Scaling Group.
notification_profile_id	string	Mandatory Notification profile to be associated with the monitor. Create a 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 a new threshold profile or find your preferred threshold profile’s ID.
user_group_ids	array	Mandatory, if on_call_schedule_id is not choosen User group to be notified on down. Create a new user group or find your preferred user group’s ID.
on_call_schedule_id	string	Mandatory, if user_group_ids is not choosen On-Call Schedule of your choice. Create new On-Call Schedule or find your preferred On-Call Schedule ID.
monitor_groups	array	Group IDs to associate with the monitor. Create a new monitor group or find your preferred monitor group’s ID.
dependency_resource_ids	array	Suppress alert when dependent monitors 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 a new action or find your preferred action’s ID.
third_party_services	array	Third party services to be notified.
tag_ids	array	Tag IDs to associate monitor. Create a new tag or find your preferred tag’s ID.

Neptune Cluster Monitor - POST not allowed

Monitor the usage and performance of Amazon Neptune Cluster.

Attribute	Type	Description
display_name	string	Mandatory Name for the Cluster.
type	string	Mandatory NEPTUNE-CLUSTER.
resource_name	string	Mandatory Cluster Identifier.
region	string	Mandatory System discovered region of the Neptune Cluster.
aws_account_id	string	Mandatory AWS Monitor ID.
aws_child_type	string	Mandatory AWS child type for the Neptune Cluster.
aws_arn	string	Mandatory Amazon Resource Name for the Neptune Cluster.
enable_uptime_monitoring	boolean	Monitor the availability status of Neptune Cluster.
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, if on_call_schedule_id is not choosen User group to be notified on down. Create new user group or find your preferred user group’s ID.
on_call_schedule_id	string	Mandatory, if user_group_ids is not choosen On-Call Schedule of your choice. Create new On-Call Schedule or find your preferred On-Call Schedule 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.
tag_ids	array	Tag IDs used to associate with a monitor. Create a new tag or find your preferred tag’s ID.

Neptune Instance Monitor - POST not allowed

Monitor the usage and performance of Amazon Neptune Instance.

Attribute	Type	Description
display_name	string	Mandatory Name for the Instance.
type	string	Mandatory NEPTUNE-INSTANCE.
resource_name	string	Mandatory Instance Identifier.
region	string	Mandatory System discovered region of the Neptune Instance.
aws_account_id	string	Mandatory AWS Monitor ID.
aws_child_type	string	Mandatory AWS child type for the Neptune Instance.
aws_arn	string	Mandatory Amazon Resource Name for the Neptune Instance.
enable_uptime_monitoring	boolean	Monitor the availability status of Neptune Instance.
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, if on_call_schedule_id is not choosen User group to be notified on down. Create new user group or find your preferred user group’s ID.
on_call_schedule_id	string	Mandatory, if user_group_ids is not choosen On-Call Schedule of your choice. Create new On-Call Schedule or find your preferred On-Call Schedule 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.
tag_ids	array	Tag IDs used to associate with a monitor. Create a new tag or find your preferred tag’s ID.

Certificate Manager Monitor - POST not allowed

Monitor the usage and performance of AWS Certificate Manager.

Attribute	Type	Description
display_name	string	Mandatory Name for the Certificate.
type	string	Mandatory ACM.
resource_name	string	Mandatory Certificate Identifier.
region	string	Mandatory System discovered region of the Certificate Manager.
aws_account_id	string	Mandatory AWS Monitor ID.
aws_child_type	string	Mandatory AWS child type for the Certificate Manager.
aws_arn	string	Mandatory Amazon Resource Name for the Certificate Manager.
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, if on_call_schedule_id is not choosen User group to be notified on down. Create new user group or find your preferred user group’s ID.
on_call_schedule_id	string	Mandatory, if user_group_ids is not choosen On-Call Schedule of your choice. Create new On-Call Schedule or find your preferred On-Call Schedule 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.
tag_ids	array	Tag IDs used to associate with a monitor. Create a new tag or find your preferred tag’s ID.

Lightsail Instance Monitor - POST not allowed

Monitor availability and performance of Amazon Lightsail Instances.

Attribute	Type	Description
display_name	string	Mandatory Name for the Lightsail Instance.
type	string	Mandatory LIGHTSAIL-INSTANCE
resource_name	string	Mandatory Name of the Lightsail Instance.
region	string	Mandatory System discovered region of the Lightsail Instance.
check_frequency	string	Mandatory Poll interval for monitoring.
aws_account_id	string	Mandatory AWS Monitor id You can find monitor id using the monitor list api.
aws_child_type	string	Mandatory 47 AWS child type for the Lightsail Instance.
enable_uptime_monitoring	boolean	Monitor the availability status of Lightsail 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, if on_call_schedule_id is not choosen User group to be notified on down. Create new user group or find your preferred user group’s ID.
on_call_schedule_id	string	Mandatory, if user_group_ids is not choosen On-Call Schedule of your choice. Create new On-Call Schedule or find your preferred On-Call Schedule ID.
monitor_groups	array	Group IDs to associate monitor. Create new monitor group or find your preferred monitor group’s ID.
dependency_resource_ids	array	Suppress alert when dependent monitor(s) 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.
tag_ids	array	Tag IDs to associate monitor. Create new tag or find your preferred tag’s ID.

EKS Cluster Monitor - POST not allowed

Monitor availability and performance of Amazon Elastic Kubernetes Service (EKS) Cluster.

Attribute	Type	Description
display_name	string	Mandatory Name for the EKS Cluster.
type	string	Mandatory EKSCLUSTER
resource_name	string	Mandatory Name of the EKS Cluster.
region	string	Mandatory System discovered region of the EKS Cluster.
check_frequency	string	Mandatory Poll interval for monitoring.
aws_account_id	string	Mandatory AWS Monitor id You can find monitor id using the monitor list api.
aws_child_type	string	Mandatory 49 AWS child type for the EKS Cluster.
enable_uptime_monitoring	boolean	Monitor the availability status of EKS Cluster.
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, if on_call_schedule_id is not choosen User group to be notified on down. Create new user group or find your preferred user group’s ID.
on_call_schedule_id	string	Mandatory, if user_group_ids is not choosen On-Call Schedule of your choice. Create new On-Call Schedule or find your preferred On-Call Schedule ID.
monitor_groups	array	Group IDs to associate monitor. Create new monitor group or find your preferred monitor group’s ID.
dependency_resource_ids	array	Suppress alert when dependent monitor(s) 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.
tag_ids	array	Tag IDs to associate monitor. Create new tag or find your preferred tag’s ID.

EKS Namespace Monitor - POST not allowed

Monitor availability and performance of Amazon Elastic Kubernetes Service (EKS) Namespace.

Attribute	Type	Description
display_name	string	Mandatory Name for the EKS Namespace.
type	string	Mandatory EKSNAMESPACE
resource_name	string	Mandatory Name of the EKS Namespace.
region	string	Mandatory System discovered region of the EKS Namespace.
check_frequency	string	Mandatory Poll interval for monitoring.
aws_account_id	string	Mandatory AWS Monitor id You can find monitor id using the monitor list api.
aws_child_type	string	Mandatory 50 AWS child type for the EKS Namespace.
enable_uptime_monitoring	boolean	Monitor the availability status of EKS Namespace.
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, if on_call_schedule_id is not choosen User group to be notified on down. Create new user group or find your preferred user group’s ID.
on_call_schedule_id	string	Mandatory, if user_group_ids is not choosen On-Call Schedule of your choice. Create new On-Call Schedule or find your preferred On-Call Schedule ID.
monitor_groups	array	Group IDs to associate monitor. Create new monitor group or find your preferred monitor group’s ID.
dependency_resource_ids	array	Suppress alert when dependent monitor(s) 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.
tag_ids	array	Tag IDs to associate monitor. Create new tag or find your preferred tag’s ID.

EKS Node Monitor - POST not allowed

Monitor availability and performance of Amazon Elastic Kubernetes Service (EKS) Node.

Attribute	Type	Description
display_name	string	Mandatory Name for the EKS Node.
type	string	Mandatory EKSNODE
resource_name	string	Mandatory Name of the EKS Node.
region	string	Mandatory System discovered region of the EKS Node.
check_frequency	string	Mandatory Poll interval for monitoring.
aws_account_id	string	Mandatory AWS Monitor id You can find monitor id using the monitor list api.
aws_child_type	string	Mandatory 55 AWS child type for the EKS Node.
enable_uptime_monitoring	boolean	Monitor the availability status of EKS Node.
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, if on_call_schedule_id is not choosen User group to be notified on down. Create new user group or find your preferred user group’s ID.
on_call_schedule_id	string	Mandatory, if user_group_ids is not choosen On-Call Schedule of your choice. Create new On-Call Schedule or find your preferred On-Call Schedule ID.
monitor_groups	array	Group IDs to associate monitor. Create new monitor group or find your preferred monitor group’s ID.
dependency_resource_ids	array	Suppress alert when dependent monitor(s) 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.
tag_ids	array	Tag IDs to associate monitor. Create new tag or find your preferred tag’s ID.

Amazon MQ Broker Monitor - POST not allowed

Monitor the usage and performance of Amazon MQ Broker.

Attribute	Type	Description
display_name	string	Mandatory Name for the Amazon MQ Broker.
type	string	Mandatory AMQ
resource_name	string	Mandatory Name of the Amazon MQ Broker.
region	string	Mandatory System discovered region of the Amazon MQ Broker.
check_frequency	string	Mandatory Poll interval for monitoring.
aws_account_id	string	Mandatory AWS Monitor id You can find monitor id using the monitor list api.
aws_child_type	string	Mandatory 48 AWS child type for the Amazon MQ Broker.
enable_uptime_monitoring	boolean	Monitor the availability status of Amazon MQ Broker.
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, if on_call_schedule_id is not choosen User group to be notified on down. Create new user group or find your preferred user group’s ID.
on_call_schedule_id	string	Mandatory, if user_group_ids is not choosen On-Call Schedule of your choice. Create new On-Call Schedule or find your preferred On-Call Schedule ID.
monitor_groups	array	Group IDs to associate monitor. Create new monitor group or find your preferred monitor group’s ID.
dependency_resource_ids	array	Suppress alert when dependent monitor(s) 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.
tag_ids	array	Tag IDs to associate monitor. Create new tag or find your preferred tag’s ID.

Amazon MQ Topic Monitor - POST not allowed

Monitor the usage and performance of Amazon MQ Topic.

Attribute	Type	Description
display_name	string	Mandatory Name for the Amazon MQ Topic.
type	string	Mandatory AMQTOPIC
resource_name	string	Mandatory Name of the Amazon MQ Topic.
region	string	Mandatory System discovered region of the Amazon MQ Topic.
check_frequency	string	Mandatory Poll interval for monitoring.
aws_account_id	string	Mandatory AWS Monitor id You can find monitor id using the monitor list api.
aws_child_type	string	Mandatory 50 AWS child type for the Amazon MQ Topic.
enable_uptime_monitoring	boolean	Monitor the availability status of Amazon MQ Topic.
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, if on_call_schedule_id is not choosen User group to be notified on down. Create new user group or find your preferred user group’s ID.
on_call_schedule_id	string	Mandatory, if user_group_ids is not choosen On-Call Schedule of your choice. Create new On-Call Schedule or find your preferred On-Call Schedule ID.
monitor_groups	array	Group IDs to associate monitor. Create new monitor group or find your preferred monitor group’s ID.
dependency_resource_ids	array	Suppress alert when dependent monitor(s) 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.
tag_ids	array	Tag IDs to associate monitor. Create new tag or find your preferred tag’s ID.

Amazon MQ Queue Monitor - POST not allowed

Monitor the usage and performance of Amazon MQ Queue.

Attribute	Type	Description
display_name	string	Mandatory Name for the Amazon MQ Queue.
type	string	Mandatory AMQQUEUE
resource_name	string	Mandatory Name of the Amazon MQ Queue.
region	string	Mandatory System discovered region of the Amazon MQ Queue.
check_frequency	string	Mandatory Poll interval for monitoring.
aws_account_id	string	Mandatory AWS Monitor id You can find monitor id using the monitor list api.
aws_child_type	string	Mandatory 51 AWS child type for the Amazon MQ Queue.
enable_uptime_monitoring	boolean	Monitor the availability status of Amazon MQ Queue.
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, if on_call_schedule_id is not choosen User group to be notified on down. Create new user group or find your preferred user group’s ID.
on_call_schedule_id	string	Mandatory, if user_group_ids is not choosen On-Call Schedule of your choice. Create new On-Call Schedule or find your preferred On-Call Schedule ID.
monitor_groups	array	Group IDs to associate monitor. Create new monitor group or find your preferred monitor group’s ID.
dependency_resource_ids	array	Suppress alert when dependent monitor(s) 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.
tag_ids	array	Tag IDs to associate monitor. Create new tag or find your preferred tag’s ID.

Amazon MQ Network Connector Monitor - POST not allowed

Monitor the usage and performance of Amazon MQ Network Connector.

Attribute	Type	Description
display_name	string	Mandatory Name for the Amazon MQ Network Connector.
type	string	Mandatory AMQNC
resource_name	string	Mandatory Name of the Amazon MQ Network Connector.
region	string	Mandatory System discovered region of the Amazon MQ Network Connector.
check_frequency	string	Mandatory Poll interval for monitoring.
aws_account_id	string	Mandatory AWS Monitor id You can find monitor id using the monitor list api.
aws_child_type	string	Mandatory 54 AWS child type for the Amazon MQ Network Connector.
enable_uptime_monitoring	boolean	Monitor the availability status of Amazon MQ Network Connector.
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, if on_call_schedule_id is not choosen User group to be notified on down. Create new user group or find your preferred user group’s ID.
on_call_schedule_id	string	Mandatory, if user_group_ids is not choosen On-Call Schedule of your choice. Create new On-Call Schedule or find your preferred On-Call Schedule ID.
monitor_groups	array	Group IDs to associate monitor. Create new monitor group or find your preferred monitor group’s ID.
dependency_resource_ids	array	Suppress alert when dependent monitor(s) 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.
tag_ids	array	Tag IDs to associate monitor. Create new tag or find your preferred tag’s ID.

Lightsail Database Monitor - POST not allowed

Monitor availability and performance of Amazon Lightsail Databases.

Attribute	Type	Description
display_name	string	Mandatory Name for the Lightsail Database.
type	string	Mandatory LIGHTSAIL-DATABASE
resource_name	string	Mandatory Name of the Lightsail Database.
region	string	Mandatory System discovered region of the Lightsail Database.
check_frequency	string	Mandatory Poll interval for monitoring.
aws_account_id	string	Mandatory AWS Monitor id You can find monitor id using the monitor list api.
aws_child_type	string	Mandatory 53 AWS child type for the Lightsail Database.
enable_uptime_monitoring	boolean	Monitor the availability status of Lightsail Database.
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, if on_call_schedule_id is not choosen User group to be notified on down. Create new user group or find your preferred user group’s ID.
on_call_schedule_id	string	Mandatory, if user_group_ids is not choosen On-Call Schedule of your choice. Create new On-Call Schedule or find your preferred On-Call Schedule ID.
monitor_groups	array	Group IDs to associate monitor. Create new monitor group or find your preferred monitor group’s ID.
dependency_resource_ids	array	Suppress alert when dependent monitor(s) 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.
tag_ids	array	Tag IDs to associate monitor. Create new tag or find your preferred tag’s ID.

Lightsail Load Balancer Monitor - POST not allowed

Monitor availability and performance of Amazon Lightsail Load Balancers.

Attribute	Type	Description
display_name	string	Mandatory Name for the Lightsail Load Balancer.
type	string	Mandatory LIGHTSAIL-LB
resource_name	string	Mandatory Name of the Lightsail Load Balancer.
region	string	Mandatory System discovered region of the Lightsail Load Balancer.
check_frequency	string	Mandatory Poll interval for monitoring.
aws_account_id	string	Mandatory AWS Monitor id You can find monitor id using the monitor list api.
aws_child_type	string	Mandatory 59 AWS child type for the Lightsail Load Balancer.
enable_uptime_monitoring	boolean	Monitor the availability status of Lightsail Load Balancer.
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, if on_call_schedule_id is not choosen User group to be notified on down. Create new user group or find your preferred user group’s ID.
on_call_schedule_id	string	Mandatory, if user_group_ids is not choosen On-Call Schedule of your choice. Create new On-Call Schedule or find your preferred On-Call Schedule ID.
monitor_groups	array	Group IDs to associate monitor. Create new monitor group or find your preferred monitor group’s ID.
dependency_resource_ids	array	Suppress alert when dependent monitor(s) 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.
tag_ids	array	Tag IDs to associate monitor. Create new tag or find your preferred tag’s ID.

Storage Gateway Monitor - POST not allowed

Monitor availability and performance of Storage Gateway.

Attribute	Type	Description
display_name	string	Mandatory Name for the Storage Gateway.
type	string	Mandatory STORAGEGATEWAY
resource_name	string	Mandatory Name of the Storage Gateway.
region	string	Mandatory System discovered region of the Storage Gateway.
check_frequency	string	Mandatory Poll interval for monitoring.
aws_account_id	string	Mandatory AWS Monitor id You can find monitor id using the monitor list api.
aws_child_type	string	Mandatory 56 AWS child type for the Storage Gateway.
enable_uptime_monitoring	boolean	Monitor the availability status of Storage Gateway.
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, if on_call_schedule_id is not choosen User group to be notified on down. Create new user group or find your preferred user group’s ID.
on_call_schedule_id	string	Mandatory, if user_group_ids is not choosen On-Call Schedule of your choice. Create new On-Call Schedule or find your preferred On-Call Schedule ID.
monitor_groups	array	Group IDs to associate monitor. Create new monitor group or find your preferred monitor group’s ID.
dependency_resource_ids	array	Suppress alert when dependent monitor(s) 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.
tag_ids	array	Tag IDs to associate monitor. Create new tag or find your preferred tag’s ID.

Storage Gateway File Share Monitor - POST not allowed

Monitor availability and performance of Storage Gateway File Share.

Attribute	Type	Description
display_name	string	Mandatory Name for the Storage Gateway File Share.
type	string	Mandatory SGFILE
resource_name	string	Mandatory Name of the Storage Gateway File Share.
region	string	Mandatory System discovered region of the Storage Gateway File Share.
check_frequency	string	Mandatory Poll interval for monitoring.
aws_account_id	string	Mandatory AWS Monitor id You can find monitor id using the monitor list api.
aws_child_type	string	Mandatory 57 AWS child type for the Storage Gateway File Share.
enable_uptime_monitoring	boolean	Monitor the availability status of Storage Gateway File Share.
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, if on_call_schedule_id is not choosen User group to be notified on down. Create new user group or find your preferred user group’s ID.
on_call_schedule_id	string	Mandatory, if user_group_ids is not choosen On-Call Schedule of your choice. Create new On-Call Schedule or find your preferred On-Call Schedule ID.
monitor_groups	array	Group IDs to associate monitor. Create new monitor group or find your preferred monitor group’s ID.
dependency_resource_ids	array	Suppress alert when dependent monitor(s) 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.
tag_ids	array	Tag IDs to associate monitor. Create new tag or find your preferred tag’s ID.

Storage Gateway Volume Monitor - POST not allowed

Monitor availability and performance of Storage Gateway Volume.

Attribute	Type	Description
display_name	string	Mandatory Name for the Storage Gateway Volume.
type	string	Mandatory SGVOLUME
resource_name	string	Mandatory Name of the Storage Gateway Volume.
region	string	Mandatory System discovered region of the Storage Gateway Volume.
check_frequency	string	Mandatory Poll interval for monitoring.
aws_account_id	string	Mandatory AWS Monitor id You can find monitor id using the monitor list api.
aws_child_type	string	Mandatory 58 AWS child type for the Storage Gateway Volume.
enable_uptime_monitoring	boolean	Monitor the availability status of Storage Gateway Volume.
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, if on_call_schedule_id is not choosen User group to be notified on down. Create new user group or find your preferred user group’s ID.
on_call_schedule_id	string	Mandatory, if user_group_ids is not choosen On-Call Schedule of your choice. Create new On-Call Schedule or find your preferred On-Call Schedule ID.
monitor_groups	array	Group IDs to associate monitor. Create new monitor group or find your preferred monitor group’s ID.
dependency_resource_ids	array	Suppress alert when dependent monitor(s) 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.
tag_ids	array	Tag IDs to associate monitor. Create new tag or find your preferred tag’s ID.

Transit Gateway Monitor - POST not allowed

Monitor availability and performance of Transit Gateway.

Attribute	Type	Description
display_name	string	Mandatory Name for the Transit Gateway.
type	string	Mandatory TRANSITGATEWAY
resource_name	string	Mandatory Name of the Transit Gateway.
region	string	Mandatory System discovered region of the Transit Gateway.
check_frequency	string	Mandatory Poll interval for monitoring.
aws_account_id	string	Mandatory AWS Monitor id You can find monitor id using the monitor list api.
aws_child_type	string	Mandatory 61 AWS child type for the Transit Gateway.
enable_uptime_monitoring	boolean	Monitor the availability status of Transit Gateway.
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, if on_call_schedule_id is not choosen User group to be notified on down. Create new user group or find your preferred user group’s ID.
on_call_schedule_id	string	Mandatory, if user_group_ids is not choosen On-Call Schedule of your choice. Create new On-Call Schedule or find your preferred On-Call Schedule ID.
monitor_groups	array	Group IDs to associate monitor. Create new monitor group or find your preferred monitor group’s ID.
dependency_resource_ids	array	Suppress alert when dependent monitor(s) 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.
tag_ids	array	Tag IDs to associate monitor. Create new tag or find your preferred tag’s ID.

Direct Connect Virtual Interface Monitor - POST not allowed

Monitor availability and performance of Direct Connect Virutal Interface.

Attribute	Type	Description
display_name	string	Mandatory Name for the Direct Connect Virutal Interface.
type	string	Mandatory DIRECTCONNECTVI
resource_name	string	Mandatory Name of the Direct Connect Virutal Interface.
region	string	Mandatory System discovered region of the Direct Connect Virutal Interface.
check_frequency	string	Mandatory Poll interval for monitoring.
aws_account_id	string	Mandatory AWS Monitor id You can find monitor id using the monitor list api.
aws_child_type	string	Mandatory 62 AWS child type for the Direct Connect Virutal Interface.
enable_uptime_monitoring	boolean	Monitor the availability status of Direct Connect Virutal Interface.
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, if on_call_schedule_id is not choosen User group to be notified on down. Create new user group or find your preferred user group’s ID.
on_call_schedule_id	string	Mandatory, if user_group_ids is not choosen On-Call Schedule of your choice. Create new On-Call Schedule or find your preferred On-Call Schedule ID.
monitor_groups	array	Group IDs to associate monitor. Create new monitor group or find your preferred monitor group’s ID.
dependency_resource_ids	array	Suppress alert when dependent monitor(s) 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.
tag_ids	array	Tag IDs to associate monitor. Create new tag or find your preferred tag’s ID.

DMS Replication Task Monitor - POST not allowed

Monitor the usage and performance of DMS Replication Task.

Attribute	Type	Description
display_name	string	Mandatory Name for the Replication Task.
type	string	Mandatory DMSTASK.
resource_name	string	Mandatory Replication Task Identifier.
region	string	Mandatory System discovered region of the Replication Task.
aws_account_id	string	Mandatory AWS Monitor ID.
aws_child_type	string	Mandatory 63 AWS child typefor the Replication Task.
aws_arn	string	Mandatory Amazon Resource Name for the Replication Task.
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, if on_call_schedule_id is not choosen User group to be notified on down. Create new user group or find your preferred user group’s ID.
on_call_schedule_id	string	Mandatory, if user_group_ids is not choosen On-Call Schedule of your choice. Create new On-Call Schedule or find your preferred On-Call Schedule 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.
tag_ids	array	Tag IDs used to associate with a monitor. Create a new tag or find your preferred tag’s ID.

DMS Replication Instance Monitor - POST not allowed

Monitor the usage and performance of DMS Replication Task.

Attribute	Type	Description
display_name	string	Mandatory Name for the Replication Instance.
type	string	Mandatory DMSINSTANCE.
resource_name	string	Mandatory Replication Instance Identifier.
region	string	Mandatory System discovered region of the Replication Instance.
aws_account_id	string	Mandatory AWS Monitor ID.
aws_child_type	string	Mandatory 64 AWS child type for the Replication Instance.
aws_arn	string	Mandatory Amazon Resource Name for the Replication Instance.
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, if on_call_schedule_id is not choosen User group to be notified on down. Create new user group or find your preferred user group’s ID.
on_call_schedule_id	string	Mandatory, if user_group_ids is not choosen On-Call Schedule of your choice. Create new On-Call Schedule or find your preferred On-Call Schedule 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.
tag_ids	array	Tag IDs used to associate with a monitor. Create a new tag or find your preferred tag’s ID.

Amazon FSx Monitor - POST not allowed

Monitor the usage and performance of Amazon FSx Monitor.

Attribute	Type	Description
display_name	string	Mandatory Name for the File System.
type	string	Mandatory DMSINSTANCE.
resource_name	string	Mandatory File System Identifier.
region	string	Mandatory System discovered region of the File System.
aws_account_id	string	Mandatory AWS Monitor ID.
aws_child_type	string	Mandatory 65 AWS child type for the Replication Instance.
aws_arn	string	Mandatory Amazon Resource Name for the File System.
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, if on_call_schedule_id is not choosen User group to be notified on down. Create new user group or find your preferred user group’s ID.
on_call_schedule_id	string	Mandatory, if user_group_ids is not choosen On-Call Schedule of your choice. Create new On-Call Schedule or find your preferred On-Call Schedule 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.
tag_ids	array	Tag IDs used to associate with a monitor. Create a new tag or find your preferred tag’s ID.

Lambda Edge Function Monitor - POST not allowed

Monitor the usage and performance of Lambda@Edge Function Monitor.

Attribute	Type	Description
display_name	string	Mandatory Name for the Lambda@Edge Function.
type	string	Mandatory LAMBDA-EDGE.
resource_name	string	Mandatory Lambda@Edge Function Identifier.
region	string	Mandatory System discovered region of the Lambda@Edge Function.
aws_account_id	string	Mandatory AWS Monitor ID.
aws_child_type	string	Mandatory 69 AWS child type for the Lambda@Edge Function.
aws_arn	string	Mandatory Amazon Resource Name for the Lambda@Edge Function.
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, if on_call_schedule_id is not choosen User group to be notified on down. Create new user group or find your preferred user group’s ID.
on_call_schedule_id	string	Mandatory, if user_group_ids is not choosen On-Call Schedule of your choice. Create new On-Call Schedule or find your preferred On-Call Schedule 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.
tag_ids	array	Tag IDs used to associate with a monitor. Create a new tag or find your preferred tag’s ID.

Inspector Monitor - POST not allowed

Monitor the usage and performance of Inspector Monitor.

Attribute	Type	Description
display_name	string	Mandatory Name of the Inspector.
type	string	Mandatory INSPECTOR
resource_name	string	Mandatory Name of the Inspector Finding Rules Package.
aws_child_type	string	Mandatory 70 AWS child type for the Inspector.
region	string	Mandatory System discovered region of the Inspector.
aws_account_id	string	Mandatory AWS Monitor id You can find monitor id using the monitor list api.
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.
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, if on_call_schedule_id is not choosen User group to be notified on down. Create new user group or find your preferred user group’s ID.
on_call_schedule_id	string	Mandatory, if user_group_ids is not choosen On-Call Schedule of your choice. Create new On-Call Schedule or find your preferred On-Call Schedule 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.
tag_ids	array	Tag IDs to associate monitor. Create new tag or find your preferred tag’s ID.

SFTP Monitor - POST not allowed

Monitor the usage and performance of SFTP monitor.

Attribute	Type	Description
display_name	string	Mandatory Name of the SFTP monitor.
type	string	Mandatory SFTP
resource_name	string	Mandatory Name of the SFTP monitor.
aws_child_type	string	Mandatory 70 AWS child type for the SFTP monitor.
region	string	Mandatory System discovered region of the SFTP monitor.
aws_account_id	string	Mandatory AWS Monitor id You can find monitor ID using the monitor list API..
monitor_groups	array	Group IDs to associate monitor with. Create a monitor groupa new monitor group or find the ID of the monitor group of your preference ..
dependency_resource_id	string	Suppress alert when dependent monitor monitor is down.
notification_profile_id	string	Mandatory Notification profile to be associated with the monitor. Create a new notification profile or find the ID of your preferred notification profile..
threshold_profile_id	string	Mandatory Threshold profile to be associated with the monitor. Create a new threshold profile find the ID of your preferred threshold profile..
user_group_ids	array	Mandatory, if on_call_schedule_id is not choosen User group to be notified when the monitor is Down . Create a new user groupor find the ID of your preferred user group..
on_call_schedule_id	string	Mandatory, if user_group_ids is not choosen On-Call Schedule of your choice. Create new On-Call Schedule or find your preferred On-Call Schedule ID.
action_ids	JSON array	Action to be performed during monitor status change . JSON Format {action_id: “$action_id”, alert_type: $action_rule_constants}. Create new action or find the ID of your preferred action..
tag_ids	array	Tag IDs to associate monitor with. Create new tag or find the ID of your preferred tags,.

EC2_CWAGENT Monitor - POST not allowed

Monitor the usage and performance of EC2 Cloudwatch Agent Monitor.

Attribute	Type	Description
display_name	string	Mandatory Name of the EC2 Cloudwatch Agent Monitor.
type	string	Mandatory EC2_CWAGENT
resource_name	string	Mandatory Name of the EC2 Cloudwatch Agent Monitor.
aws_child_type	string	Mandatory 70 AWS child type for the EC2 Cloudwatch Agent Monitor.
region	string	Mandatory System discovered region of the EC2 Cloudwatch Agent Monitor.
aws_account_id	string	Mandatory AWS Monitor id You can find monitor ID using the monitor list API..
monitor_groups	array	Group IDs to associate monitor with. Create a monitor groupa new monitor group or find the ID of the monitor group of your preference ..
dependency_resource_id	string	Suppress alert when dependent monitor monitor is down.
notification_profile_id	string	Mandatory Notification profile to be associated with the monitor. Create a new notification profile or find the ID of your preferred notification profile..
threshold_profile_id	string	Mandatory Threshold profile to be associated with the monitor. Create a new threshold profile find the ID of your preferred threshold profile..
user_group_ids	array	Mandatory, if on_call_schedule_id is not choosen User group to be notified when the monitor is Down . Create a new user groupor find the ID of your preferred user group..
on_call_schedule_id	string	Mandatory, if user_group_ids is not choosen On-Call Schedule of your choice. Create new On-Call Schedule or find your preferred On-Call Schedule ID.
action_ids	JSON array	Action to be performed during monitor status change . JSON Format {action_id: “$action_id”, alert_type: $action_rule_constants}. Create new action or find the ID of your preferred action..
tag_ids	array	Tag IDs to associate monitor with. Create new tag or find the ID of your preferred tags.

APPSTREAM 2.0 Monitor - POST not allowed

Monitor the usage and performance of Amazon AppStream 2.0

Attribute	Type	Description
display_name	string	Mandatory The AppStream monitor name.
resource_name	string	Mandatory The AppStream monitor name.
aws_child_type	string	Mandatory AWS child type for the AppStream monitor.
region	string	Mandatory The system discovered region of the AppStream monitor.
aws_arn	string	Mandatory The Amazon resource name for the AppStream Monitor.
aws_account_id	string	Mandatory The AWS monitor ID.
enable_uptime_monitoring	boolean	Monitor the AppStream availability status.
threshold_profile_id	string	Mandatory The 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, if on_call_schedule_id is not choosen User group to be notified on down. Create new user group or find your preferred user group’s ID.
on_call_schedule_id	string	Mandatory, if user_group_ids is not choosen On-Call Schedule of your choice. Create new On-Call Schedule or find your preferred On-Call Schedule ID.
monitor_groups	array	The group ID associated with the 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	The third party services that need to be notified.
tag_ids	array	Tag IDs used to associate with a monitor. Create a new tag or find your preferred tag’s ID.

Systems Manager Monitor - POST not allowed

Monitor the usage and performance of Amazon Systems Manager

Attribute	Type	Description
display_name	string	Mandatory The Systems Manager monitor name.
resource_name	string	Mandatory The Systems Manager identifier.
aws_child_type	string	Mandatory AWS child type for the Systems Manager monitor.
region	string	Mandatory The system discovered region of the Systems Manager monitor.
aws_arn	string	Mandatory The Amazon resource name for the Systems Manager monitor.
aws_account_id	string	Mandatory The AWS monitor ID.
enable_uptime_monitoring	boolean	Monitor the Systems Manager availability status.
threshold_profile_id	string	Mandatory The 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 The 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, if on_call_schedule_id is not choosen User group to be notified on down. Create new user group or find your preferred user group’s ID.
on_call_schedule_id	string	Mandatory, if user_group_ids is not choosen On-Call Schedule of your choice. Create new On-Call Schedule or find your preferred On-Call Schedule ID.
monitor_groups	array	The group ID associated with the 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	The third party services that need to be notified.
tag_ids	array	Tag IDs used to associate with a monitor. Create a new tag or find your preferred tag’s ID.

AWS Health Monitor - POST not allowed

Monitor the usage and performance of AWS Health

Attribute	Type	Description
display_name	string	Mandatory The AWS Health category name.
resource_name	string	Mandatory The Amazon resource name for the AWS Health monitor.
aws_child_type	string	Mandatory AWS child type for the AWS Health monitor.
region	string	Mandatory The system discovered region of the AWS Health monitor.
aws_arn	string	Mandatory The Amazon resource name for the AWS Health Monitor.
aws_account_id	string	Mandatory The AWS monitor ID.
threshold_profile_id	string	Mandatory The 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, if on_call_schedule_id is not choosen User group to be notified on down. Create new user group or find your preferred user group’s ID.
on_call_schedule_id	string	Mandatory, if user_group_ids is not choosen On-Call Schedule of your choice. Create new On-Call Schedule or find your preferred On-Call Schedule ID.
monitor_groups	array	The group ID associated with the 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	The third party services that need to be notified.
tag_ids	array	Tag IDs used to associate with a monitor. Create a new tag or find your preferred tag’s ID.

AWS AppSync Monitor - POST not allowed

Monitor the usage and performance of Amazon AppSync Attribute|Type|Description ———|———-|——– display_name|string| Mandatory
The AppSync monitor name. api_id|string| Mandatory
The AppSync API ID. aws_child_type|string| Mandatory
AWS child type for the AWS AppSync monitor. region|string| Mandatory
The system discovered region of the AppSync monitor. aws_arn|string| Mandatory
The Amazon resource name for the AWS AppSync monitor. aws_account_id|string| Mandatory
The AWS monitor ID. threshold_profile_id|string| Mandatory
The 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, if on_call_schedule_id is not choosen
The user group to be notified when the monitor is down.
Create new user group or find your preferred user group’s ID. on_call_schedule_id|string| Mandatory, if user_group_ids is not choosen
On-Call Schedule of your choice.
Create new On-Call Schedule or find your preferred On-Call Schedule ID. monitor_groups|array|The group ID associated with the 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| The third party services that need to be notified. tag_ids|array|Tag IDs used to associate with a monitor.
Create a new tag or find your preferred tag’s ID.

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, if on_call_schedule_id is not choosen User group to be notified on down. Create new user group or find your preferred user group’s ID.
on_call_schedule_id	string	Mandatory, if user_group_ids is not choosen On-Call Schedule of your choice. Create new On-Call Schedule or find your preferred On-Call Schedule ID.
monitor_groups	array	Group IDs to associate monitor. Create new monitor group or find your preferred monitor group’s ID.
dependency_resource_ids	array	Suppress alert when dependent monitor(s) 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.
tag_ids	array	Tag IDs to associate monitor. Create new tag or find your preferred tag’s ID.

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	string	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, if on_call_schedule_id is not choosen User group to be notified on down. Create new user group or find your preferred user group’s ID.
on_call_schedule_id	string	Mandatory, if user_group_ids is not choosen On-Call Schedule of your choice. Create new On-Call Schedule or find your preferred On-Call Schedule 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
response_headers_check	json	Check whether the HTTP response headers are present or verify header and corresponding values against predefined header and values. Trigger down or trouble alerts during failure. JSON Format: {value: [{name: “$header_name”, value: “$header_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”}
monitor_groups	array	Group IDs to associate monitor. Create new monitor group or find your preferred monitor group’s ID.
dependency_resource_ids	array	Suppress alert when dependent monitor(s) 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.
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.
tag_ids	array	Tag IDs to associate monitor. Create new tag or find your preferred tag’s ID.
ssl_protocol	string	Specify the version of the SSL protocol. If you are not sure about the version, use Auto. Default value is Auto
http_protocol	string	Specify the version of the HTTP protocol.
use_alpn	boolean	Enable ALPN to send supported protocols as part of the TLS handshake.

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, if on_call_schedule_id is not choosen User group to be notified on down. Create new user group or find your preferred user group’s ID.
on_call_schedule_id	string	Mandatory, if user_group_ids is not choosen On-Call Schedule of your choice. Create new On-Call Schedule or find your preferred On-Call Schedule ID.
monitor_groups	array	Group IDs to associate monitor. Create new monitor group or find your preferred monitor group’s ID.
dependency_resource_ids	array	Suppress alert when dependent monitor(s) 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.
tag_ids	array	Tag IDs to associate monitor. Create new tag or find your preferred tag’s ID.

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, if on_call_schedule_id is not choosen User group to be notified on down. Create new user group or find your preferred user group’s ID.
on_call_schedule_id	string	Mandatory, if user_group_ids is not choosen On-Call Schedule of your choice. Create new On-Call Schedule or find your preferred On-Call Schedule ID.
monitor_groups	array	Group IDs to associate monitor. Create new monitor group or find your preferred monitor group’s ID.
dependency_resource_ids	array	Suppress alert when dependent monitor(s) 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.
tag_ids	array	Tag IDs to associate monitor. Create new tag or find your preferred tag’s ID.

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, if on_call_schedule_id is not choosen User group to be notified on down. Create new user group or find your preferred user group’s ID.
on_call_schedule_id	string	Mandatory, if user_group_ids is not choosen On-Call Schedule of your choice. Create new On-Call Schedule or find your preferred On-Call Schedule ID.
monitor_groups	array	Group IDs to associate monitor. Create new monitor group or find your preferred monitor group’s ID.
dependency_resource_ids	array	Suppress alert when dependent monitor(s) 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.
tag_ids	array	Tag IDs to associate monitor. Create new tag or find your preferred tag’s ID.

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, if on_call_schedule_id is not choosen User group to be notified on down. Create new user group or find your preferred user group’s ID.
on_call_schedule_id	string	Mandatory, if user_group_ids is not choosen On-Call Schedule of your choice. Create new On-Call Schedule or find your preferred On-Call Schedule ID.
monitor_groups	array	Group IDs to associate monitor. Create new monitor group or find your preferred monitor group’s ID.
dependency_resource_ids	array	Suppress alert when dependent monitor(s) 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.
tag_ids	array	Tag IDs to associate monitor. Create new tag or find your preferred tag’s ID.

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	string	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, if on_call_schedule_id is not choosen User group to be notified on down. Create new user group or find your preferred user group’s ID.
on_call_schedule_id	string	Mandatory, if user_group_ids is not choosen On-Call Schedule of your choice. Create new On-Call Schedule or find your preferred On-Call Schedule 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.
defacement_types	array	Defacement types to be monitored.
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.
tag_ids	array	Tag IDs to associate monitor. Create new tag or find your preferred tag’s ID.

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.

NTP Server

Continuously check the availability of primary NTP server and time synchronization between primary NTP server and secondary NTP servers.

Attribute	Type	Description
display_name	string	Mandatory Name of the monitor.
type	string	Mandatory NTP
primaryntpserver	string	Mandatory Domain name or IP address of primary NTP server.
check_frequency	string	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, if on_call_schedule_id is not choosen User group to be notified on down. Create new user group or find your preferred user group’s ID.
on_call_schedule_id	string	Mandatory, if user_group_ids is not choosen On-Call Schedule of your choice. Create new On-Call Schedule or find your preferred On-Call Schedule ID.
synchronization	boolean	Enable this to perform time synchronization.
secondaryserver_1	string	Domain name or IP address of secondary NTP server.
secondaryserver_2	string	Domain name or IP address of secondary NTP server.
secondaryserver_3	string	Domain name or IP address of secondary NTP server.
drift	json	Time difference allowed between primary NTP server and each secondary NTP servers. JSON Format:{value: ”$value”, severity: “$alert_type_constant”}
use_ipv6	boolean	Select IPv6 for monitoring the ntp servers 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.
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.
tag_ids	array	Tag IDs to associate monitor. Create new tag or find your preferred tag’s ID.

Real-time Blacklist Check

Regularly check and confirm if your Domain or IP Addresses are blacklisted against popular DNS-based blacklists.

Attribute	Type	Description
display_name	string	Mandatory Name of the monitor.
type	string	Mandatory RBL (Real-time Blacklist Check)
rbl_ips	JSON array	Mandatory Array of IP addresses/Hostnames to be monitored. JSON Format: { ip_address: “$ip_address”,domain: “$domain”}
ip_refresh	boolean	If ip_refresh is yes, IP addresses will be refreshed and updated during every poll.
blacklist_providers	array	IDs of DNS based blacklists to check whether your domains or ip addresses are listed in any of the domain based blacklists or ip based blacklists.
user_group_ids	array	Mandatory, if on_call_schedule_id is not choosen User group to be notified on down. Create new user group or find your preferred user group’s ID.
on_call_schedule_id	string	Mandatory, if user_group_ids is not choosen On-Call Schedule of your choice. Create new On-Call Schedule or find your preferred On-Call Schedule 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	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.
tag_ids	array	Tag IDs to associate monitor. Create new tag or find your preferred tag’s ID.

Brand Reputation

Brand Reputation Monitor makes use of Google’s Safe Browsing index to securely validate and alert about customer URLs containing malware, phishing attempts, and hosting untrusted software.

Attribute	Type	Description
display_name	string	Mandatory Name of the monitor.
type	string	Mandatory BRANDREPUTATION
webpage_list_reputation	JSON array	Mandatory list of web pages to be checked. JSON Format: { page_name: “$page_name”, page_url: “$page_url”}
user_group_ids	array	Mandatory, if on_call_schedule_id is not choosen User group to be notified on down. Create new user group or find your preferred user group’s ID.
on_call_schedule_id	string	Mandatory, if user_group_ids is not choosen On-Call Schedule of your choice. Create new On-Call Schedule or find your preferred On-Call Schedule 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	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.
tag_ids	array	Tag IDs to associate monitor. Create new tag or find your preferred tag’s ID.

SMART Disk - POST not allowed

Monitor the availability and performance of your server’s SMART Disk.

Attribute	Type	Description
display_name	string	Mandatory Name for the monitor.
type	string	Mandatory SMARTDISK
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, if on_call_schedule_id is not choosen User group to be notified on down. Create new user group or find your preferred user group’s ID.
on_call_schedule_id	string	Mandatory, if user_group_ids is not choosen On-Call Schedule of your choice. Create new On-Call Schedule or find your preferred On-Call Schedule ID.
third_party_services	array	Third party services to be notified.

Heartbeat

Monitor to know if your scripts, agents, workers, daemons are continuously running as expected

Attribute	Type	Description
display_name	string	Mandatory Name of the monitor.
unique_name	string	Mandatory Unique name to be used in the ping URL.
type	string	Mandatory HEARTBEAT
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, if on_call_schedule_id is not choosen User group to be notified on down. Create new user group or find your preferred user group’s ID.
on_call_schedule_id	string	Mandatory, if user_group_ids is not choosen On-Call Schedule of your choice. Create new On-Call Schedule or find your preferred On-Call Schedule ID.
monitor_groups	array	Group IDs to associate monitor. Create new monitor group or find your preferred monitor group’s ID
third_party_services	array	Third party services to be notified.
tag_ids	array	Tag IDs to associate monitor. Create new tag or find your preferred tag’s ID.

Cron

Start tracking your jobs, workers, services, or anything that can send a HTTP request.

Attribute	Type	Description
display_name	string	Mandatory Unique name to be used in the ping URL.
cron_expression	string	Mandatory Cron expression to denote the job schedule.
cron_tz	string	Mandatory Timezone of the server where job runs.
wait_time	string	Mandatory Provide an extended period of time (seconds) to define when your alerts should be triggered. This is basically to avoid false alerts.
type	string	Mandatory CRON
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, if on_call_schedule_id is not choosen User group to be notified on down. Create new user group or find your preferred user group’s ID.
on_call_schedule_id	string	Mandatory, if user_group_ids is not choosen On-Call Schedule of your choice. Create new On-Call Schedule or find your preferred On-Call Schedule ID.
monitor_groups	array	Group IDs to associate monitor. Create new monitor group or find your preferred monitor group’s ID
third_party_services	array	Third party services to be notified.
tag_ids	array	Tag IDs to associate monitor. Create new tag or find your preferred tag’s ID.

Real User Monitor

Monitor the customer interactions with your web applications in real-time. Track and resolve Java Script errors.

Attribute	Type	Description
display_name	string	Mandatory Name for the monitor.
website	string	Mandatory Website address to monitor.
apdex_threshold	int	Apdex score. For details visit Apdex.
beacon_type	int	Beacon type corresponding to the type of application to be monitored. 0 for Traditional and 1 for SPA.
ajax_enabled	boolean	Track ajax calls or not.
cx_ajax_enabled	boolean	Track cross domain ajax calls or not.
excluded_domains	array	Domains to exclude from collecting data.
excluded_useragents	array	User agents to exclude from collecting data.
exclude_bots	boolean	Exclude bots from performance computation.
track_resources	boolean	Track resource metrics or not.
resources_config	array	Manually configure resources as first,third or cdn resources.
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, if on_call_schedule_id is not choosen User group to be notified on down. Create new user group or find your preferred user group’s ID.
on_call_schedule_id	string	Mandatory, if user_group_ids is not choosen On-Call Schedule of your choice. Create new On-Call Schedule or find your preferred On-Call Schedule ID.
tag_ids	array	Tag IDs to associate monitor. Create new tag or find your preferred tag’s ID.

Monitors

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

Create Monitor

POST /monitors

Create a new monitor.

Note : API Version has to be passed as “2.1” in the Accept header for the Create Monitor API.

e.g., Accept: application/json; version=2.1

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.1" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \
    -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"
          ],
          "on_call_schedule_id": "123412341234123446",
          "use_ipv6": true,
          "request_content_type": "F",
          "request_param": "param=value",
          "credential_profile_id":"123412341234123415",
          "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_ids": [
            "123412341234123419",
            "123412341234123420"
          ],
          "third_party_services":[
            "123412341234123423",
            "123412341234123433"
          ],
          "tag_ids":[
            "123456987654321012",
            "123456987654321013"
          ]
    }'

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"
    ],
    "on_call_schedule_id": "123412341234123446",
    "location_profile_id": "123412341234123412",
    "user_agent": "Mozilla Firefox",
    "request_content_type": "F",
    "timeout": 30,
    "match_regex": {
      "severity": "0",
      "value": "^reg*"
    },
    "monitor_groups": [
      "123412341234123416",
      "123412341234123417"
    ],
    "credential_profile_id":"123412341234123415",
    "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_ids": [
        "123412341234123419",
        "123412341234123420"
    ],
    "check_frequency": "1440",
    "display_name": "Display name for the monitor",
    "use_name_server": true,
    "tag_ids":[
        "123456987654321012",
        "123456987654321013"
    ]
  }
}

oauthscope : Site24x7.Admin.Create

Website
WebSocket
Web Page Speed (Browser)
REST API
SSL/TLS Certificate
Ping
Port (Custom Protocol)
DNS Server
UDP
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
NTP Server
Domain Expiry
REST API Transaction
Realtime Blacklist Check
Brand Reputation
Heartbeat
Cron
Real User Monitor

Retrieve Monitor

GET /monitors/{monitor_id}

Retrieve details of an existing monitor.

Note : API Version has to be passed as “2.1” in the Accept header for the Retrieve Monitor API.

e.g., Accept: application/json; version=2.1

Request Example

$ curl https://www.site24x7.com/api/monitors/123412341234123411 \
    -H "Accept: application/json; version=2.1" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

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"
        ],
      "on_call_schedule_id": "123412341234123446",
        "location_profile_id": "123412341234123412",
        "domain_name": "site24x7.com",
        "lookup_type": 2,
        "check_frequency": "5",
        "timeout": 15
    }
}

oauthscope : Site24x7.Admin.Read

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
WebSocket
Web Page Speed (Browser)
Web Transaction
REST API Transaction
Web Transaction (Browser)
REST API
SSL/TLS Certificate
Ping
Port (Custom Protocol)
DNS Server
UDP
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
Network Load Balancer
Gateway Load Balancer
Lambda Function Monitor
EC Memcached Cluster
EC Memcached Node
EC Redis Node
S3 Bucket Monitor
S3 Object Monitor
S3 Folder Monitor
SQS Queue Monitor
CloudFront Distribution Monitor
Kinesis Data Stream Monitor
Kinesis Firehose Delivery Stream Monitor
Kinesis Analytics Application Monitor
Kinesis Video Stream Monitor
Elastic Beanstalk environment Monitor
Direct Connect Monitor
VPC - Virtual Private Network Monitor
API Gateway Stage Monitor
API Gateway Resource Monitor
API Gateway Route Monitor
ECS Cluster Monitor
ECS Cluster Service Monitor
Redshift Cluster Monitor
Redshift Node Monitor
Elastic File System Monitor
Simple Email Service Monitor
Step Function State Machine Monitor
Web Application Firewall Monitor
CloudSearch Domain Monitor
Key Management Service Monitor
Route 53 Health Check Monitor
Route 53 Resolver Monitor
Route 53 Hosted Zone Monitor
Route 53 Hosted Zone Record Set Monitor
Elasticsearch Monitor
NAT Gateway Monitor
Elastic MapReduce Monitor
WorkSpace Monitor
EC2 Auto Scaling Group Monitor
Neptune Cluster Monitor
Neptune Instance Monitor
Certificate Manager Monitor
Lightsail Instance Monitor
EKS Cluster Monitor
EKS Namespace Monitor
EKS Node Monitor
Amazon MQ Broker Monitor
Amazon MQ Topic Monitor
Amazon MQ Queue Monitor
Amazon MQ Network Connector Monitor
Lightsail Database Monitor
Lightsail Load Balancer Monitor
Storage Gateway Monitor
Storage Gateway File Share Monitor
Storage Gateway Volume Monitor
Transit Gateway Monitor
Direct Connect Virtual Interface Monitor
DMS Replication Task Monitor
DMS Replication Instance Monitor
Amazon FSx Monitor
Lambda@Edge Function Monitor
Inspector Monitor
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
NTP Server
Realtime Blacklist Check
Brand Reputation
SMART Disk
SFTP monitor
EC2 Cloudwatch Agent Monitor
AppStream 2.0 Monitor
Systems Manager Monitor
AWS Health Monitor
AWS AppSync Monitor

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.

Note : API Version has to be passed as “2.1” in the Accept header for the Retrieve Monitor By Name API.

e.g., Accept: application/json; version=2.1

Request Example

$ curl https://www.site24x7.com/api/monitors/name/site24x7Monitor \
    -H "Accept: application/json; version=2.1" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

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"
        ],
      "on_call_schedule_id": "123412341234123446",
        "location_profile_id": "123412341234123412",
        "domain_name": "site24x7.com",
        "lookup_type": 2,
        "check_frequency": "5",
        "timeout": 15
    }
}

oauthscope : Site24x7.Admin.Read

Path Parameters

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

Response Attributes

Response attributes by monitor type.

Website
WebSocket
Web Page Speed (Browser)
Web Transaction
REST API Transaction
Web Transaction (Browser)
REST API
SSL/TLS Certificate
Ping
Port (Custom Protocol)
DNS Server
UDP
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
Network Load Balancer
Gateway Load Balancer
Lambda Function Monitor
EC Memcached Cluster
EC Memcached Node
EC Redis Node
S3 Bucket Monitor
S3 Object Monitor
S3 Folder Monitor
SQS Queue Monitor
CloudFront Distribution Monitor
Kinesis Data Stream Monitor
Kinesis Firehose Delivery Stream Monitor
Kinesis Analytics Application Monitor
Kinesis Video Stream Monitor
Elastic Beanstalk environment Monitor
Direct Connect Monitor
VPC - Virtual Private Network Monitor
API Gateway Stage Monitor
API Gateway Resource Monitor
API Gateway Route Monitor
ECS Cluster Monitor
ECS Cluster Service Monitor
Redshift Cluster Monitor
Redshift Node Monitor
Elastic File System Monitor
Simple Email Service Monitor
Step Function State Machine Monitor
Web Application Firewall Monitor
CloudSearch Domain Monitor
Key Management Service Monitor
Route 53 Health Check Monitor
Route 53 Resolver Monitor
Route 53 Hosted Zone Monitor
Route 53 Hosted Zone Record Set Monitor
Elasticsearch Monitor
NAT Gateway Monitor
Elastic MapReduce Monitor
WorkSpace Monitor
EC2 Auto Scaling Group Monitor
Neptune Cluster Monitor
Neptune Instance Monitor
Certificate Manager Monitor
Lightsail Instance Monitor
EKS Cluster Monitor
EKS Namespace Monitor
EKS Node Monitor
Amazon MQ Broker Monitor
Amazon MQ Topic Monitor
Amazon MQ Queue Monitor
Amazon MQ Network Connector Monitor
Lightsail Database Monitor
Lightsail Load Balancer Monitor
Storage Gateway Monitor
Storage Gateway File Share Monitor
Storage Gateway Volume Monitor
Transit Gateway Monitor
Direct Connect Virtual Interface Monitor
DMS Replication Task Monitor
DMS Replication Instance Monitor
Amazon FSx Monitor
Lambda@Edge Function Monitor
Inspector Monitor
VCenter Monitor
VMWare ESX/ESXi Server Monitor
VMWare VM Monitor
Network Device Monitor
SOAP Web Service
Domain Expiry
BizTalk Server Monitor
Office 365
SMART Disk
SFTP monitor
EC2 Cloudwatch Agent Monitor
AppStream 2.0 Monitor
Systems Manager Monitor
AWS Health Monitor
AWS AppSync Monitor

Update Monitor

PUT /monitors/{monitor_id}

Update an existing monitor

Note : API Version has to be passed as “2.1” in the Accept header for the Update Monitor API.

e.g., Accept: application/json; version=2.1

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.1" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \
    -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"],
        "on_call_schedule_id": "123412341234123446",
        "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_ids":[
            "123412341234123419",
            "123412341234123420"
        ],
        "third_party_services":[
            "123412341234123423",
            "123412341234123433"
          ],
        "tag_ids":[
            "123456789054321012",
            "123456789054321013"
          ]
    }'

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"
    ],
    "on_call_schedule_id": "123412341234123446",
    "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_ids":[
        "123412341234123419",
        "123412341234123420"
    ],
    "check_frequency": "1440",
    "display_name": "Display name for the monitor",
    "use_name_server": true,
    "tag_ids":[
        "123456987654321012",
        "123456987654321013"
    ]
  }
}

oauthscope : Site24x7.Admin.Update

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
WebSocket
Web Page Speed (Browser)
Web Transaction
REST API Transaction
Web Transaction (Browser)
REST API
SSL/TLS Certificate
Ping
Port (Custom Protocol)
DNS Server
UDP
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
Network Load Balancer
Gateway Load Balancer
Lambda Function Monitor
EC Memcached Cluster
EC Memcached Node
EC Redis Node
S3 Bucket Monitor
S3 Object Monitor
S3 Folder Monitor
SQS Queue Monitor
CloudFront Distribution Monitor
Kinesis Data Stream Monitor
Kinesis Firehose Delivery Stream Monitor
Kinesis Analytics Application Monitor
Kinesis Video Stream Monitor
Elastic Beanstalk environment Monitor
Direct Connect Monitor
VPC - Virtual Private Network Monitor
API Gateway Stage Monitor
API Gateway Resource Monitor
API Gateway Route Monitor
ECS Cluster Monitor
ECS Cluster Service Monitor
Redshift Cluster Monitor
Redshift Node Monitor
Elastic File System Monitor
Simple Email Service Monitor
Step Function State Machine Monitor
Web Application Firewall Monitor
CloudSearch Domain Monitor
Key Management Service Monitor
Route 53 Health Check Monitor
Route 53 Resolver Monitor
Route 53 Hosted Zone Monitor
Route 53 Hosted Zone Record Set Monitor
Elasticsearch Monitor
NAT Gateway Monitor
Elastic MapReduce Monitor
WorkSpace Monitor
EC2 Auto Scaling Group Monitor
Neptune Cluster Monitor
Neptune Instance Monitor
Certificate Manager Monitor
Lightsail Instance Monitor
EKS Cluster Monitor
EKS Namespace Monitor
EKS Node Monitor
Amazon MQ Broker Monitor
Amazon MQ Topic Monitor
Amazon MQ Queue Monitor
Amazon MQ Network Connector Monitor
Lightsail Database Monitor
Lightsail Load Balancer Monitor
Storage Gateway Monitor
Storage Gateway File Share Monitor
Storage Gateway Volume Monitor
Transit Gateway Monitor
Direct Connect Virtual Interface Monitor
DMS Replication Task Monitor
DMS Replication Instance Monitor
Amazon FSx Monitor
Lambda@Edge Function Monitor
Inspector Monitor
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
NTP Server
Realtime Blacklist Check
Brand Reputation
SMART Disk
SFTP monitor
EC2 Cloudwatch Agent Monitor
AppStream 2.0 Monitor
Systems Manager Monitor
AWS Health Monitor
AWS AppSync Monitor

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-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

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"
  }
}

oauthscope : Site24x7.Admin.Delete

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-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

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

oauthscope : Site24x7.Admin.Delete

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-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

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

oauthscope : Site24x7.Admin.Delete

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-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

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"
      ],
      "on_call_schedule_id": "726000000002048",
      "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"
      ],
      "on_call_schedule_id": "726000000002048",
      "location_profile_id": "726000000002033",
      "check_frequency": "5",
      "timeout": 10
    }
  ]
}

oauthscope : Site24x7.Admin.Read

Website
WebSocket
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
UDP
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
Network Load Balancer
Gateway Load Balancer
Lambda Function Monitor
EC Memcached Cluster
EC Memcached Node
EC Redis Node
S3 Bucket Monitor
S3 Object Monitor
S3 Folder Monitor
SQS Queue Monitor
CloudFront Distribution Monitor
Kinesis Data Stream Monitor
Kinesis Firehose Delivery Stream Monitor
Kinesis Analytics Application Monitor
Kinesis Video Stream Monitor
Elastic Beanstalk environment Monitor
Direct Connect Monitor
VPC - Virtual Private Network Monitor
API Gateway Stage Monitor
API Gateway Resource Monitor
API Gateway Route Monitor
ECS Cluster Monitor
ECS Cluster Service Monitor
Redshift Cluster Monitor
Redshift Node Monitor
Elastic File System Monitor
Simple Email Service Monitor
Step Function State Machine Monitor
Web Application Firewall Monitor
CloudSearch Domain Monitor
Key Management Service Monitor
Route 53 Health Check Monitor
Route 53 Resolver Monitor
Route 53 Hosted Zone Monitor
Route 53 Hosted Zone Record Set Monitor
Elasticsearch Monitor
NAT Gateway Monitor
Elastic MapReduce Monitor
WorkSpace Monitor
EC2 Auto Scaling Group Monitor
Neptune Cluster Monitor
Neptune Instance Monitor
Certificate Manager Monitor
Lightsail Instance Monitor
EKS Cluster Monitor
EKS Namespace Monitor
EKS Node Monitor
Amazon MQ Broker Monitor
Amazon MQ Topic Monitor
Amazon MQ Queue Monitor
Amazon MQ Network Connector Monitor
Lightsail Database Monitor
Lightsail Load Balancer Monitor
Storage Gateway Monitor
Storage Gateway File Share Monitor
Storage Gateway Volume Monitor
Transit Gateway Monitor
Direct Connect Virtual Interface Monitor
DMS Replication Task Monitor
DMS Replication Instance Monitor
Amazon FSx Monitor
Lambda@Edge Function Monitor
Inspector Monitor
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
NTP Server
Realtime Blacklist Check
Brand Reputation
SMART Disk
SFTP monitor
EC2 Cloudwatch Agent Monitor
AppStream 2.0 Monitor
Systems Manager Monitor
AWS Health Monitor
AWS AppSync Monitor

For information on licensing , see monitor type categorization.

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-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \
    -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",
}

oauthscope : Site24x7.Admin.Update

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-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" 

Response Example

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

oauthscope : Site24x7.Admin.Delete

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-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

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

oauthscope : Site24x7.Operations.Update

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-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

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

oauthscope : Site24x7.Operations.Update

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-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

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.

oauthscope : Site24x7.Admin.Read

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-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

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

oauthscope : Site24x7.Admin.Read

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.

Enable Uptime Steroid

PUT /monitors/uptime_check/enable/{monitor_id}

Enable a disabled uptime steroid

Request Example

$ curl https://www.site24x7.com/api/monitors/uptime_check/enable/72000078998922 \
    -X PUT \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

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

oauthscope : Site24x7.Operations.Update

Path Parameters

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

Disable Uptime Steroid

PUT /monitors/uptime_check/disable/{monitor_id}

Disable uptime steroid

Request Example

$ curl https://www.site24x7.com/api/monitors/uptime_check/disable/72000078998922 \
    -X PUT \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

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

oauthscope : Site24x7.Operations.Update

Path Parameters

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

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-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

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

oauthscope : Site24x7.Admin.Read

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-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

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."
        }
}

oauthscope : Site24x7.Operations.Read

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-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \
    -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",
           "notify" : "true"
        }'

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."
         }
}

oauthscope : Site24x7.Operations.Update

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.
notify	boolean	Notify the Super admin and admin users via email about alarms muting. Pass ‘true’ if you want to notify.

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.

oauthscope : Site24x7.Operations.Delete

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-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

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-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \

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",
    "resource_state": "pending",
    "display_name": "ec2"
  }
}

oauthscope : Site24x7.Operations.Update

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.
resource_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-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \

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",
    "resource_state": "pending",
    "display_name": "ec2"
  }
}

oauthscope : Site24x7.Operations.Update

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.
resource_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-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \

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",
    "resource_state": "rebooting",
    "display_name": "rds"
  }
}

oauthscope : Site24x7.Operations.Update

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.
resource_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-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \

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",
    "resource_state": "Rebooting",
    "display_name": "rds"
  }
}

oauthscope : Site24x7.Operations.Update

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.
resource_state	string	Current state of the instance.
display_name	string	Name of the monitor.

KINESIS ANALYTICS APPLICATION

AWS management action to Start and Stop Amazon Kinesis Analytics Application.

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

Request Example

$ curl https://www.site24x7.com/api/aws/management_actions/analytics/165519000002945001?action=2\
    -X PUT\
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "success",
    "data": {
        "application_name": "Analytics",
        "monitor_id": "165519000002945001",
        "resource_state": "STOPPING",
        "display_name": "KinesisAnalytics"
    }
}

oauthscope : Site24x7.Operations.Update

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
application_name	string	System generated Name of the Kinesis Analytics Application.
monitor_id	string	Unique ID of the monitor. Use retrieve monitor API to get the details of this monitor.
resource_state	string	Current state of the application.
display_name	string	Name of the monitor.

LIGHTSAIL INSTANCE

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

Actions With Monitor ID

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

Invokes AWS management action using monitor ID.

Request Example

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

Response Example

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

oauthscope : Site24x7.Operations.Update

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
monitor_id	string	Unique ID of the monitor. Use retrieve monitor API to get the details of this monitor.
resource_state	string	Current state of the instance.
display_name	string	Name of the monitor.

LIGHTSAIL DATABASE

AWS management actions to start, stop and reboot Amazon Lightsail Database.

Actions With Monitor ID

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

Invokes AWS management action using monitor ID.

Request Example

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

Response Example

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

oauthscope : Site24x7.Operations.Update

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
monitor_id	string	Unique ID of the monitor. Use retrieve monitor API to get the details of this monitor.
resource_state	string	Current state of the database.
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&group_required=false&locations_required=false&suspended_required=false" \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{
  "code": 0,
  "message": "success",
  "data": {
    "monitors": [
      {
        "name": "Zylker Server",
        "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": "-",
        "tags": [
            "down_tag"
        ],  
        "monitor_id": "355000001863001"
      },
      {
        "name": "ZylkerWeb",
        "attribute_key": "response_time",
        "status": 1,
        "last_polled_time": "2015-07-21T11:37:51+0530",
        "attributeName": "RESPONSETIME",
        "monitor_type": "URL",
        "attribute_label": "Response Time",
        "attribute_value": 856,
        "unit": "ms",
        "monitor_id": "355000001863102"
      },
      {
        "name": "ZylkerSite",
        "attribute_key": "response_time",
        "status": 2,
        "last_polled_time": "2015-07-21T15:30:35+0530",
        "attributeName": "RESPONSETIME",
        "monitor_type": "URL",
        "attribute_label": "Response Time",
        "attribute_value": 308,
        "unit": "ms",
        "outage_id": "1526624941082",
        "downtime_millis": "12885615",
        "down_reason": "Response time from California - IN exceeded 2000 ms.",
        "duration": "3 Hrs 35 Mins ",
        "monitor_id": "355000001863103"
      }
    ],
    "monitors_count": {
        "maintenance": 0,
        "up": 1,
        "down": 1,
        "critical": 0,
        "trouble": 1,
        "discovery": 0,
        "suspended": 0,
        "configuration_error": 0,
        "total": 3
    }
  }
}

Retrieve the current status of all your configured monitors and identify their operational parameters such as, status (UP/Down/Critical/Trouble), performance, poll duration, poll frequency and more.

oauthscope : Site24x7.Reports.Read

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
locations_required	boolean	Provides location based-report of individual monitor along with the current status of monitor.	true
status_required	string	Provides the list of monitors based on the specified monitor status in this parameter. Status can be passed as comma-separated values. Eg: status_required=0,1,2	Monitors with all status will be returned.

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 attribute displayed in the report.
attributeName	string	Performance metric tracked in the report.
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/critical/trouble.
duration	string	Duration for which the monitor is down/critical/trouble.
server_type	string	Applicable for server monitor where it tells the type of server monitor (Windows or Linux).
tags	JSON array	List of all tags associated with the monitors.

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-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{
    "code": 0,
    "message": "success",
    "data": {
        "isUpTimeCheckEnabled":false
        "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",
        "attributeName": "RESPONSETIME",
        "tags": [
            "zylker_tag",
            "web_tag"
        ],  
        "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.

oauthscope : Site24x7.Reports.Read

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
isUpTimeCheckEnabled	boolean	Status of uptime check task of the monitor
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 attribute displayed in the report.
attributeName	string	Performance metric tracked in the report.
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/critical/trouble.
duration	string	Duration for which the monitor is down/critical/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”}
tags	JSON array	List of all tags associated with the monitors.

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-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

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.

oauthscope : Site24x7.Reports.Read

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 attribute displayed in the report.
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/critical/trouble.
duration	string	Duration for which the monitor is down/critical/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-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

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",
        "tags": [
            "up_tag"
        ],  
        "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",
        "tags": [
            "up_tag"
        ],
        "monitor_id": "113770000010290043"
      }
    ]
  }
}

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

oauthscope : Site24x7.Reports.Read

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/critical/trouble.
duration	string	Duration for which the monitor is down/critical/trouble.
server_type	string	Applicable for server monitor where it tells the type of server monitor (Windows or Linux).
tags	JSON array	List of all tags associated with the monitors.
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-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{
    "code": 0,
    "message": "success",
    "data": {
        "down": {
            "count": 4,
            "status_name": "Down",
            "status": 0
        },
        "up": {
            "count": 10,
            "status_name": "Up",
            "status": 1
        },
        "critical": {
            "count": 0,
            "status_name": "Critical",
            "status": 3
        },
        "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.

oauthscope : Site24x7.Reports.Read

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”}
critical	json	Details about Critical 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-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

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
        },
        "critical": {
            "count": 0,
            "status_name": "Critical",
            "status": 3
        },
        "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.

oauthscope : Site24x7.Reports.Read

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”}
critical	json	Details about Critical 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-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

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
      },
      "critical": {
        "count": 0,
        "status_name": "Critical",
        "status": 3
      },
      "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
      },
      "critical": {
        "count": 0,
        "status_name": "Critical",
        "status": 3
      },
      "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.

oauthscope : Site24x7.Reports.Read

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”}
critical	json	Details about Critical 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.

Basic Availability

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

Basic Availability by monitor

GET /api/availability/monitor/{monitor_id}?period={report_period_constants}

Request Example

$ curl "https://www.site24x7.com/api/availability/monitor/113770000025720011?period=13" \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{
    "code": 0,
    "message": "success",
    "data": {
        "summary_details": {
            "down_count": 1,
            "downtime_duration": "3 days 0 Hrs 0 Mins ",
            "availability_percentage": 0,
            "mtbf": "0 Mins 0 Secs",
            "unmanaged_duration": "0 Mins 0 Secs",
            "mttr": "3 days 0 Hrs 0 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": "Monitor",
            "end_time": "2019-02-04T00:00:00+0530",
            "resource_type_name": "Monitor",
            "period_name": "This Month",
            "formatted_start_time": "February 1, 2019 12:00 AM IST",
            "formatted_end_time": "February 4, 2019 12:00 AM IST",
            "generated_time": "2019-02-04T14:30:46+0530",
            "start_time": "2019-02-01T00:00:00+0530",
            "resource_type": 2,
            "period": 13,
            "formatted_generated_time": "February 4, 2019 2:30 PM IST",
            "resource_id": "113770000025720011",
            "monitor_type": "URL",
            "monitor_count": 1
        }
    }
}

Get the basic availability details of a particular monitor over the specified period of time.

oauthscope : Site24x7.Reports.Read

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
maintenance_required	boolean	In reports, treat monitors as up during maintenance period

Response Attributes

Attribute	Type	Description
summary_details	json	The availability summary details of the monitor for the specified period.
down_count	int	Number of downtimes
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

Basic Availability by monitor group

GET /api/availability/group/{group_id}?period={report_period_constants}

Request Example

$ curl "https://www.site24x7.com/api/availability/group/113770000025830011?period=13" \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{
    "code": 0,
    "message": "success",
    "data": {
        "summary_details": {
            "down_count": 8,
            "downtime_duration": "15 days 10 Hrs 55 Mins ",
            "availability_percentage": 53.17,
            "mtbf": "2 days 4 Hrs 38 Mins ",
            "unmanaged_duration": "0 Mins 0 Secs",
            "mttr": "1 days 22 Hrs 22 Mins ",
            "maintenance_percentage": 0,
            "maintenance_duration": "0 Mins 0 Secs",
            "availability_duration": "17 days 13 Hrs 5 Mins ",
            "unmanaged_percentage": 0,
            "downtime_percentage": 46.83
        },
        "info": {
            "resource_name": "Monitor_Group",
            "end_time": "2019-02-04T00:00:00+0530",
            "resource_type_name": "Group",
            "period_name": "This Month",
            "formatted_start_time": "February 1, 2019 12:00 AM IST",
            "generated_time": "2019-02-04T14:31:04+0530",
            "formatted_end_time": "February 4, 2019 12:00 AM IST",
            "start_time": "2019-02-01T00:00:00+0530",
            "resource_type": 1,
            "period": 13,
            "formatted_generated_time": "February 4, 2019 2:31 PM IST",
            "resource_id": "113770000025830011",
            "monitor_count": 100
        }
    }
}

Get the basic availability details of a particular monitor group for a specified period of time.

oauthscope : Site24x7.Reports.Read

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
maintenance_required	boolean	In reports, treat monitors as up during maintenance period
subgroup_monitors	boolean	Enable this option to include subgroups of the selected Monitor Group. Otherwise, only the selected Group will be considered. Default value is true

Response Attributes

Attribute	Type	Description
summary_details	json	The availability summary details of the monitor for the specified period.
down_count	int	Number of downtimes
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

Basic Availability by monitor type

GET /api/availability/monitor_type/{monitor_type}?period={report_period_constants}

Request Example

$ curl "https://www.site24x7.com/api/availability/monitor_type/URL?period=13" \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{
    "code": 0,
    "message": "success",
    "data": {
        "summary_details": {
            "down_count": 47,
            "downtime_duration": "40 days 12 Hrs 14 Mins ",
            "availability_percentage": 81.75,
            "mtbf": "3 days 20 Hrs 41 Mins ",
            "unmanaged_duration": "18 days 0 Hrs 0 Mins ",
            "mttr": "20 Hrs 41 Mins ",
            "maintenance_percentage": 0,
            "maintenance_duration": "0 Mins 0 Secs",
            "availability_duration": "181 days 11 Hrs 46 Mins ",
            "unmanaged_percentage": 8.11,
            "downtime_percentage": 18.25
        },
        "info": {
            "resource_name": "Website",
            "end_time": "2019-02-04T00:00:00+0530",
            "resource_type_name": "Monitor Type",
            "period_name": "This Month",
            "formatted_start_time": "February 1, 2019 12:00 AM IST",
            "generated_time": "2019-02-04T14:31:08+0530",
            "formatted_end_time": "February 4, 2019 12:00 AM IST",
            "start_time": "2019-02-01T00:00:00+0530",
            "resource_type": 4,
            "period": 13,
            "formatted_generated_time": "February 4, 2019 2:31 PM IST",
            "monitor_type": "URL",
            "monitor_count": 50
        }
    }
}

Get the basic availability details of a particular monitor type over the specified period of time.

oauthscope : Site24x7.Reports.Read

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.
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
maintenance_required	boolean	In reports, treat monitors as up during maintenance period

Response Attributes

Attribute	Type	Description
summary_details	json	The availability summary details of the monitor for the specified period.
down_count	int	Number of downtimes
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

Basic Availability by tag and monitor type

GET /api/availability/tag/{tag_id}/monitor_type/{monitor_type}?period={report_period_constants}

Request Example

$ curl "https://www.site24x7.com/api/availability/tag/113770000025720021/monitor_type/URL?period=13" \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{
    "code": 0,
    "message": "success",
    "data": {
        "summary_details": {
            "down_count": 0,
            "downtime_duration": "0 Mins 0 Secs",
            "availability_percentage": 100,
            "mtbf": "3 days 0 Hrs 0 Mins ",
            "unmanaged_duration": "0 Mins 0 Secs",
            "mttr": "0 Mins 0 Secs",
            "maintenance_percentage": 0,
            "maintenance_duration": "0 Mins 0 Secs",
            "availability_duration": "3 days 0 Hrs 0 Mins ",
            "unmanaged_percentage": 0,
            "downtime_percentage": 0
        },
        "info": {
            "resource_name": "Tag_Name",
            "end_time": "2019-02-04T00:00:00+0530",
            "resource_type_name": "Tag",
            "period_name": "This Month",
            "formatted_start_time": "February 1, 2019 12:00 AM IST",
            "formatted_end_time": "February 4, 2019 12:00 AM IST",
            "generated_time": "2019-02-04T14:31:11+0530",
            "start_time": "2019-02-01T00:00:00+0530",
            "resource_type": 3,
            "period": 13,
            "formatted_generated_time": "February 4, 2019 2:31 PM IST",
            "resource_id": "113770000025720021",
            "monitor_type": "URL",
            "monitor_count": 20
        }
    }
}

Get the basic availability details of a particular tag and monitor type over the specified period of time.

oauthscope : Site24x7.Reports.Read

Path Parameters

Param	Type	Description
tag_id	string	Mandatory Unique ID of the tag. You can find tag_ud using the tag list api.
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.
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
maintenance_required	boolean	In reports, treat monitors as up during maintenance period

Response Attributes

Attribute	Type	Description
summary_details	json	The availability summary details of the monitor for the specified period.
down_count	int	Number of downtimes
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

Basic Availability for all monitors

GET /api/availability?period={report_period_constants}

Request Example

$ curl "https://www.site24x7.com/api/availability?period=13" \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{
    "code": 0,
    "message": "success",
    "data": {
        "summary_details": {
            "down_count": 192,
            "downtime_duration": "137 days 15 Hrs 4 Mins ",
            "availability_percentage": 77.94,
            "mtbf": "2 days 12 Hrs 47 Mins ",
            "unmanaged_duration": "0 Mins 0 Secs",
            "mttr": "17 Hrs 12 Mins ",
            "maintenance_percentage": 0.01,
            "maintenance_duration": "1 Hrs 7 Mins ",
            "availability_duration": "486 days 7 Hrs 49 Mins ",
            "unmanaged_percentage": 0,
            "downtime_percentage": 22.06
        },
        "info": {
            "end_time": "2019-02-04T00:00:00+0530",
            "resource_type_name": "All Monitors",
            "period_name": "This Month",
            "formatted_start_time": "February 1, 2019 12:00 AM IST",
            "generated_time": "2019-02-04T14:35:21+0530",
            "formatted_end_time": "February 4, 2019 12:00 AM IST",
            "start_time": "2019-02-01T00:00:00+0530",
            "resource_type": 0,
            "period": 13,
            "formatted_generated_time": "February 4, 2019 2:35 PM IST",
            "monitor_count": 250
        }
    }
}

Get the basic availability details of all the monitors of a particular type for the specified period of time.

oauthscope : Site24x7.Reports.Read

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
maintenance_required	boolean	In reports, treat monitors as up during maintenance period

Response Attributes

Attribute	Type	Description
summary_details	json	The availability summary details of the monitor for the specified period.
down_count	int	Number of downtimes
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

MSP

Retrieve MSP account data across all Customer Accounts using MSP APIs.

Global Monitor Status

GET /msp/monitors/status

Request Example

$ curl "https://www.site24x7.com/api/msp/monitors/status" \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{
  "code": 0,
  "message": "success",
  "data": [
        {
           "user_id": "5850000000004001",
           "customer_name": "Zylker",
           "monitor_id": "5850000000007010",
           "monitor_name": "Website-zylker.com",
           "monitor_type": "URL",
           "status": 0,
           "status_name": "Down",
           "last_polled_time": "2017-10-20T11:14:00+0530",
           "reason": "The String \"random\" is not present in the response"
        }
   ]
}

Retrieve an overall status based-report of all the configured monitors across all your Customer Accounts.

oauthscope : Site24x7.Msp.Read

Response Attributes

Attribute	Type	Description
user_id	string	Unique ID of the Customer.
customer_name	string	Name of the Customer.
monitor_id	string	Unique ID of the monitor. Use retrieve monitor API to fetch the details of the monitor.
monitor_name	string	Name of the monitor.
monitor_type	string	Type of the monitor.
status	int	Status of the monitor.
status_name	string	Name given to the monitor’s status.
last_polled_time	string	Last polled time for the monitor in ISO format.
reason	string	Reason for the monitor’s outage (down or trouble).

Customer Wise Monitor Status

GET /msp/customers/monitors/status

Request Example

$ curl https://www.site24x7.com/api/msp/customers/monitors/status \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{
    "code": 0,
    "message": "success",
    "data": [
        {
            "user_id": "5850000000004001",
            "zaaid": "54289191",
            "customer_name": "Zylker",
            "monitors": [
                {
                    "monitor_id": "5850000000007010",
                    "monitor_name": "Website-zylker.com",
                    "monitor_type": "URL",
                    "status": 0,
                    "status_name": "Down",
                    "last_polled_time": "2017-10-20T11:14:00+0530",
                    "reason": "The String \"random\" is not present in the response"
                }
            ]
        }
    ]
}

Retrieve status based-report of all the configured monitors filtered by Customers.

oauthscope : Site24x7.Msp.Read

Response Attributes

Attribute	Type	Description
user_id	string	Unique ID of the Customer.
zaaid	string	Account ID of the Customer.
customer_name	string	Name of the Customer.
monitor_id	string	Unique ID of the monitor. Use retrieve monitor API to fetch the details of the monitor.
monitor_name	string	Name of the monitor.
monitor_type	string	Type of the monitor.
status	int	Status of the monitor.
status_name	string	Name given to the monitor’s status.
last_polled_time	string	Last polled time for the monitor in ISO format.
reason	string	Reason for the monitor’s outage (down or trouble).

Customer Wise Monitor Count Based on Status

GET msp/customers/monitors/status/count?from={from}&limit={limit}

Request Example

$ curl https://www.site24x7.com/api/msp/customers/monitors/status/count?from=0&limit=50 \
    -X GET \
    -H "Accept: application/json; version=2.1" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{
    "code": 0,
    "message": "success",
    "data": {
        "customers": [
            {
                "configuration_error": {
                    "count": 0,
                    "status_name": "Configuration Error",
                    "status": 10
                },
                "trouble": {
                    "count": 0,
                    "status_name": "Trouble",
                    "status": 2
                },
                "customer_name": "Zylker",
                "maintenance": {
                    "count": 0,
                    "status_name": "Maintenance",
                    "status": 7
                },
                "zaaid": "54289191",
                "suspended": {
                    "count": 0,
                    "status_name": "Suspended",
                    "status": 5
                },
                "up": {
                    "count": 4,
                    "status_name": "Up",
                    "status": 1
                },
                "discovery": {
                    "count": 0,
                    "status_name": "Discovery",
                    "status": 9
                },
                "total": {
                    "count": 4,
                    "status_name": "Total"
                },
                "critical": {
                    "count": 0,
                    "status_name": "Critical",
                    "status": 3
                },
                "down": {
                    "count": 0,
                    "status_name": "Down",
                    "status": 0
                },
                "user_id": "5850000000004001",
            }
        ],
        "info": {
            "limit": 50,
            "search": "Zylker",
            "total": 1,
            "from": 0
        }
    }
}

Retrieve status based count of all the configured monitors filtered by Customers.

oauthscope : Site24x7.Msp.Read

Query Parameters

Param	Type	Description
from	int	Mandatory Retrieve customer information from customer accounts by setting a ‘from’ threshold.
limit	int	Mandatory Retrieve customer information from customer accounts by setting a ‘limit’ threshold.
search	string	Retrieve customer information starting with the ‘search’ value.
group_id	long	Unique ID for the Customer Groups.

Response Attributes

Attribute	Type	Description
customers	json	Details about Customers and Monitor Status. JSON Format: {user_id:$user_id, zaaid:$zaaid, customer_name:$customer_name, down:$down, up:$up, trouble:$trouble, suspended:$suspended, maintenance:$maintenance, discovery:$discovery, configuration_error:$configuration_error, total:$total}
info	json	Information of Customers fetched. JSON Format: {from:$from, limit:$limit, search:$search, total:$total}
user_id	string	Unique ID of the Customer.
zaaid	string	Account ID of the Customer.
customer_name	string	Name of the Customer.
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 given to the monitor’s status.
count	int	Number of monitors grouped under a status.
from	int	Fetch Customers from the given ‘from’ value.
limit	int	Total number of Customers need to fetch.
total	int	Total count of Customers.
search	string	Fetch the Customer Name starting with ‘search’ value.

Subscriptions across Customer Accounts

GET /msp/customers/subscriptions

Request Example

$ curl https://www.site24x7.com/api/msp/customers/subscriptions \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{
    "code": 0,
    "message": "success",
    "data": [
        {
            "user_id": "5850000000004001",
            "name": "Zylker",
            "zaaid": "54289191",
            "subscriptions": {
                "pack_details": {
                    "package_name": "MSP Customer Plan",
                    "package_id": 402,
                    "default": {
                        "all_monitor_count": 0,
                        "advanced_monitor_count": 0,
                        "rum_page_views": "0",
                        "network_interfaces": 0
                        "app_log_size": 209715200,
                        "free_alert_credits": 0
                    }
                },
                "usage_details": {
                    "total_monitors": {
                        "used": 90,
                        "allowed": 0
                    },
                    "basic_monitors": {
                        "used_internet_services": 8,
                        "used_server": 10,
                        "used": 18,
                        "allowed": 0
                    },
                    "advanced_monitors": {
                        "used_mobileapm": 0,
                        "used_internet_services": 20,
                        "used_apm": 30,
                        "used_server": 22,
                        "used": 72,
                        "allowed": 0
                    },
                    "rum_details": {
                        "page_views_used": "0",
                        "page_views_limit": "0"
                    },
                    "interfaces_details": {
                        "interfaces_limit": 0,
                        "interfaces_used": 225
                    },
                     "mobileapm_details": {
                        "used": 0,
                        "allowed": 0
                    },
                    "applog_details": {
                        "app_logs_used": "0",
                        "app_logs_left": "0",
                        "app_logs_used_per_month_in_bytes": "0",
                        "app_logs_limit": "0",
                        "app_logs_used_per_month_in_gb": "0"
                    },
                    "alert_credits": {
                        "remaining_alert_credits": 10
                    },
                    "basic_additional_checks": 250000,
                    "basic_additional_checks_used": 21693,
                    "advanced_additional_checks": 10000,
                    "advanced_additional_checks_used": 0
                },
                "enabled_products":{
                    "apm": false, 
                    "website": true, 
                    "network": false, 
                    "server": false, 
                    "aws": false
                },
                "billing_details":{
                    "hourly_pricing": {
                        "is_enabled": false
                    },
                    "billing_contacts": [
                        {
                            "email_id": "kavitha.sr+01msp@zohotest.com", 
                            "display_name": "kavitha.sr+01msp"

                        }
                    ]
                }
            }
        }
    ]
}

Retrieve subscription information across all your Customer Accounts. To learn more about what resources fall under basic and advanced monitors, see monitor type categorization.

oauthscope : Site24x7.Msp.Read

Response Attributes

Attribute	Type	Description
user_id	string	Unique ID of the Customer Account.
name	string	Name of the Customer Account.
zaaid	string	Unique Account ID of the Customer Account.
package_name	string	Current subscription plan name.
package_id	int	Current subscription plan ID.
all_monitor_count	int	Total number of basic and advanced monitors that a Customer Account is entitled to use.
advanced_monitor_count	int	Total number of advanced monitors that a Customer Account is entitled to use.
rum_page_views	string	Total available RUM page views.
network_interfaces	int	Total available Network interfaces.
app_log_size	int	Total amount of storage space that a Customer Account is entitled to use.
free_alert_credits	int	Total available Voice/SMS alert credits.
total_monitors	json	Total number of monitors that has been used by a Customer Account.
basic_monitors	json	Contains the total number of basic Web & Internet Service monitors, basic Server monitors and Apps used and allowed.
advanced_monitors	json	Contains the total number of advanced Web & Internet Service monitors, APM and advanced Server monitors used and allowed.
rum_details	json	Contains the number of RUM page views used and allowed.
interfaces_details	json	Contains the number of network interfaces used and allowed.
mobileapm_details	json	Contains the number of network interfaces used and allowed.
applog_details	json	Contains the amount of data space used/available for Applogs.
alert_credits	json	Consolidated number of alert credits remaining in the account.
enabled_products	json	Type of monitos present in the account.
billing_details	json	Contains the hourly_pricing and billing contacts.
hourly_pricing	boolean	True, if hourly pricing is enabled for the account
billing_contacts	JSON Array	Billing contacts for the Customer.
basic_additional_checks	int	Total number of basic additional checks that you are entitled to use under the subscription plan.
basic_additional_checks_used	int	Total number of basic additional checks you’ve used in your current subscription plan.
advanced_additional_checks	int	Total number of advanced additional checks that you are entitled to use under the subscription plan.
advanced_additional_checks_used	int	Total number of advanced additional checks you’ve used in your current subscription plan.

MSP Location Profiles

Location Profiles make it convenient to set monitoring locations consistently across many websites or monitors.The profile settings will be applied across all customer accounts.

Create MSP Location Profile

POST /msp/location_profiles

Create a new MSP Location Profile.

oauthscope : Site24x7.Msp.Create

PARAMETERS

Retrieve MSP Location Profile

GET /msp/location_profiles/{profile_id}

Retrieve configuration of a MSP Location Profile.

oauthscope : Site24x7.Msp.Read

PARAMETERS

Update a MSP Location Profile

PUT /msp/location_profiles/{profile_id}

Update an existing MSP Location Profile.

oauthscope : Site24x7.Msp.Update

PARAMETERS

Delete an existing MSP location profile.

DELETE /msp/location_profiles/{profile_id}

Delete an existing MSP Location Profile.

oauthscope : Site24x7.Msp.Delete

PARAMETERS

List of all MSP Location Profiles

GET /msp/location_profiles

List of all MSP Location Profiles.

oauthscope : Site24x7.Msp.Read

PARAMETERS

MSP Threshold Profiles

Threshold and Availability Profiles help the alarms engine to decide if a specific resource has to be declared critical or down. Configure Downtime Rules to reduce false alerts. The profile settings will be applied across all customer accounts.

Note : API Version has to be passed as “2.1” in the Accept header for the Threshold APIs.

e.g., Accept: application/json; version=2.1

Create MSP Threshold Profile

POST /msp/threshold_profiles

Create a new MSP Threshold and Availability profile.

oauthscope : Site24x7.Msp.Create

PARAMETERS

Retrieve MSP Threshold Profile

GET /msp/threshold_profiles/{profile_id}

Retrieve the configuration of a MSP Threshold and Availability Profile.

oauthscope : Site24x7.Msp.Read

PATH PARAMETERS

Update MSP Threshold Profile

PUT /msp/threshold_profiles/{profile_id}

Update an existing MSP Threshold Profile.

oauthscope : Site24x7.Msp.Update

PARAMETERS

Delete a MSP Threshold Profile

DELETE /msp/threshold_profiles/{profile_id}

Delete an existing MSP Threshold and Availability Profile.

oauthscope : Site24x7.Msp.Delete

PARAMETERS

List MSP Threshold Profiles

GET /msp/threshold_profiles

List of all MSP Threshold and Availability Profiles.

oauthscope : Site24x7.Msp.Read

PARAMETERS

MSP Notification Profiles

Notification Profiles help you tweak when alerts have to be sent out.The profile settings will be applied across all customer accounts.

Create MSP Notification Profile

POST /msp/notification_profiles

Create a new MSP Notification Profile.

oauthscope : Site24x7.Msp.Create

PARAMETERS

Retrieve MSP Notification Profile

GET /msp/notification_profiles/{profile_id}

Retrieve configuration of a MSP notification profile.

oauthscope : Site24x7.Msp.Read

PARAMETERS

Update MSP Notification Profile

PUT /msp/notification_profiles/{profile_id}

Update configuration of a MSP notification profile.

oauthscope : Site24x7.Msp.Update

PARAMETERS

Delete MSP Notification Profile

DELETE /msp/notification_profiles/{profile_id}

Delete an existing MSP Notification Profile.

oauthscope : Site24x7.Msp.Delete

PARAMETERS

List MSP Notification Profiles

GET /msp/notification_profiles

List of all MSP Notification Profiles.

oauthscope : Site24x7.msp.Read

PARAMETERS

MSP Email Templates

Email Templates help you customize the content of alert email sent. The profile settings will be applied across all customer accounts.

Create MSP Email Template

POST /msp/email_templates

Create a new MSP Email Template.

oauthscope : Site24x7.Msp.Create

PARAMETERS

Retrieve MSP Email Template

GET /msp/email_templates/{template_id}

Retrieve configuration of a MSP Email Template.

oauthscope : Site24x7.Msp.Read

PARAMETERS

Update MSP Email Template

PUT /msp/email_templates/{template_id}

Update an existing MSP Email Template.

oauthscope : Site24x7.Msp.Update

PARAMETERS

Delete MSP Email Template

DELETE /msp/email_templates/{template_id}

Delete an existing MSP Email Template.

oauthscope : Site24x7.Msp.Delete

PARAMETERS

List Email Templates

GET /msp/email_templates

List of all MSP Email Templates.

oauthscope : Site24x7.Msp.Read

PARAMETERS

MSP ThirdParty Integrations

ThirdParty Integrations help you post the site24x7 alerts as alarms or incidents or messages based on the type of integration to notify the customer about the failure immediately. ThirdParty settings will be applied across all customer accounts.

Create MSP WebHook

POST /msp/integration/webhooks

Create a new MSP WebHook.

oauthscope : Site24x7.Msp.Create

PARAMETERS

Retrieve MSP Webhook

GET /msp/integration/webhooks/{service_id}

Retrieve configuration of a MSP WebHook.

oauthscope : Site24x7.Msp.Read

PARAMETERS

Update MSP WebHook

PUT /msp/integration/webhooks/{service_id}

Update an existing MSP WebHook.

oauthscope : Site24x7.Msp.Update

PARAMETERS

Create MSP PagerDuty

POST /msp/integration/pager_duty

Create a new PagerDuty MSP integration.

oauthscope : Site24x7.Msp.Create

PARAMETERS

Retrieve MSP PagerDuty

GET /msp/integration/pager_duty/{service_id}

Retrieve configuration of a MSP PagerDuty.

oauthscope : Site24x7.Msp.Read

PARAMETERS

Update MSP PagerDuty

PUT /msp/integration/pager_duty/{service_id}

Update an existing MSP PagerDuty.

oauthscope : Site24x7.Msp.Update

PARAMETERS

Create MSP Slack

POST /msp/integration/slack

Create a new MSP Slack integration.

oauthscope : Site24x7.Msp.Create

PARAMETERS

Retrieve MSP slack

GET /msp/integration/slack/{service_id}

Retrieve configuration of a MSP slack.

oauthscope : Site24x7.Msp.Read

PARAMETERS

Update MSP Slack

PUT /msp/integration/slack/{service_id}

Update an existing MSP Slack.

oauthscope : Site24x7.Msp.Update

PARAMETERS

Create MSP OpsGenie

POST /msp/integration/opsgenie

Create a new MSP OpsGenie.

oauthscope : Site24x7.Msp.Create

PARAMETERS

Retrieve MSP OpsGenie

GET /msp/integration/opsgenie/{service_id}

Retrieve configuration of a MSP OpsGenie.

oauthscope : Site24x7.Msp.Read

PARAMETERS

Update MSP OpsGenie

PUT /msp/integration/opsgenie/{service_id}

Update an existing MSP OpsGenie.

oauthscope : Site24x7.Msp.Update

PARAMETERS

Create MSP ServiceNow

POST /msp/integration/service_now

Create a new MSP ServiceNow Integration.

oauthscope : Site24x7.Msp.Create

PARAMETERS

Retrieve MSP ServiceNow Integration.

GET /msp/integration/service_now/{service_id}

Retrieve configuration of a MSP ServiceNow Integration.

oauthscope : Site24x7.Msp.Read

PARAMETERS

Update MSP ServiceNow

PUT /msp/integration/service_now/{service_id}

Update an existing MSP ServiceNow Integration.

oauthscope : Site24x7.Msp.Update

PARAMETERS

Create MSP ConnectWise

POST /msp/integration/connectwise

Create a new MSP ConnectWise Integration.

oauthscope : Site24x7.Msp.Create

PARAMETERS

Retrieve MSP ConnectWise Integration.

GET /msp/integration/connectwise/{service_id}

Retrieve configuration of a MSP ConnectWise Integration.

oauthscope : Site24x7.Msp.Read

PARAMETERS

Update MSP ConnectWise

PUT /msp/integration/connectwise/{service_id}

Update an existing MSP ConnectWise Integration.

oauthscope : Site24x7.Msp.Update

PARAMETERS

Create MSP Telegram

POST /msp/integration/telegram

Create a new MSP Telegram integration.

oauthscope : Site24x7.Msp.Create

PARAMETERS

Retrieve MSP Telegram

GET /msp/integration/telegram/{service_id}

Retrieve configuration of a MSP Telegram.

oauthscope : Site24x7.Msp.Read

PARAMETERS

Update MSP Telegram

PUT /msp/integration/telegram/{service_id}

Update an existing MSP Telegram.

oauthscope : Site24x7.Msp.Update

PARAMETERS

Create MSP Freshservice

POST /msp/integration/fresh_service

Create a new MSP Freshservice integration.

oauthscope : Site24x7.Msp.Create

PARAMETERS

Retrieve MSP Freshservice

GET /msp/integration/fresh_service/{service_id}

Retrieve configuration of a MSP Freshservice.

oauthscope : Site24x7.Msp.Read

PARAMETERS

Update MSP Freshservice

PUT /msp/integration/fresh_service/{service_id}

Update an existing MSP Freshservice.

oauthscope : Site24x7.Msp.Update

PARAMETERS

List MSP Integrations

GET /msp/third_party_services

List of all MSP Integrations.

oauthscope : Site24x7.Msp.Read

PARAMETERS

Delete MSP Integration

DELETE /msp/integration/thirdparty_service/{service_id}

Delete an existing MSP integration.

oauthscope : Site24x7.Msp.Delete

PARAMETERS

MSP Audit Logs

Retrieve a detailed record of all the events and user operations in your Site24x7 MSP account.

Retrieve MSP Action

GET msp/audit_logs

Retrieve MSP Audit Logs.

oauthscope : Site24x7.Operations.Read

PARAMETERS

Assign Technician

Assign Technician for an outage.

PUT /msp/alarms/technician?id={{user_id}}

Request Example

$ curl https://www.site24x7.com/api/msp/alarms/technician?id=18616000000006001 \
    -X PUT \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \
    -d '{
          "monitor_id": "1000000123001",
          "technician_zuid": "65478659"
        }'

Response Example

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

oauthscope : Site24x7.Msp.Update

Path Parameters

Param	Type	Description
user_id	string	Mandatory Unique ID of the Customer.

Request Parameters

Param	Type	Description
monitor_id	string	Mandatory Unique ID of the monitor for which the technician should be assigned.
technician_zuid	string	Unique ID of the user.

Response Attributes

Attribute	Type	Description
monitor_id	string	Unique ID of the monitor for which the technician has been assigned.
technician_zuid	string	Unique ID of the user.

Business Units

Retrieve data across various Business Units using APIs

Subscription

GET /bu/business_units/subscriptions

Request Example

$ curl "https://www.site24x7.com/api/bu/business_units/subscriptions" \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{
    "code": 0,
    "message": "success",
    "data": [
        {
            "user_id": "5850000000004001",
            "name": "Zylker",
            "zaaid": "54289191",
            "subscriptions": {
                "pack_details": {
                    "package_name": "Business Units Plan",
                    "default": {
                        "free_alert_credits": 0,
                        "advanced_monitor_count": 0,
                        "app_log_size": "0",
                        "all_monitor_count": 0,
                        "rum_page_views": "0",
                        "network_interfaces": 0
                    },
                    "addons": [
                        {
                            "addon_count": 500,
                            "addon_label": "Additional 10 Basic Monitors Add-on"
                        },
                        {
                            "addon_count": 10,
                            "addon_label": "Additional 5 Advanced Monitors Add-on"
                        },
                        {
                            "addon_count": 1,
                            "addon_label": "500K RUM Pageviews Add-on"
                        }
                    ]
                },
                "usage_details": {
                    "total_monitors": {
                        "used": 13,
                        "allowed": 5050
                    },
                    "basic_monitors": {
                        "used_internet_services": 13,
                        "used_server": 0,
                        "used": 13,
                        "allowed": 5000
                    },
                    "advanced_monitors": {
                        "used_mobileapm": 0,
                        "used_internet_services": 0,
                        "used_apm": 0,
                        "used_server": 0,
                        "used": 0,
                        "allowed": 50
                    },
                    "rum_details": {
                        "page_views_used": "0",
                        "page_views_limit": "500000"
                    },
                    "interfaces_details": {
                        "interfaces_limit": 0,
                        "interfaces_used": 0
                    },
                    "alert_credits": {
                        "remaining_alert_credits": 10
                    },
                     "mobileapm_details": {
                        "used": 0,
                        "allowed": 1
                    },
                    "applog_details": {
                        "app_logs_used": "0",
                        "app_logs_left": "0",
                        "app_logs_used_per_month_in_bytes": "0",
                        "app_logs_limit": "0",
                        "app_logs_used_per_month_in_gb": "0"
                    },
                    "basic_additional_checks": 250000,
                    "basic_additional_checks_used": 21693,
                    "advanced_additional_checks": 10000,
                    "advanced_additional_checks_used": 0
                },
                "enabled_products":{
                    "apm": false, 
                    "website": true, 
                    "network": false, 
                    "server": false, 
                    "aws": false
                },
                "billing_details": {
                    "billing_contacts": [
                        {
                            "email_id": "mark@zylker.com",
                            "display_name": "Mark"
                        }
                    ]
                }
            }
        }
    ]
}

Retrieves subscription information across various Business Units.

oauthscope : Site24x7.Bu.Read

Response Attributes

Attribute	Type	Description
user_id	string	Unique ID of the Business Unit.
name	string	Name of the Business Unit.
zaaid	string	Unique Account ID of the Business Unit.
package_name	string	Current subscription plan name.
free_alert_credits	int	Total Voice/SMS alert credits available in the current subscription plan.
advanced_monitor_count	int	Total number of advanced monitors that the Business Unit is entitled to use under the current subscription plan.
app_log_size	int	Total amount of storage space that the Business Unit is entitled to use under the current subscription plan.
all_monitor_count	int	Total number of basic and advanced monitors that the Business Unit is entitled to use under the current subscription plan.
rum_page_views	string	Total RUM page views available in the current subscription plan.
network_interfaces	int	Total amount of Network interfaces available in the current subscription plan.
addons	JSON array	Additional units of basic monitors, advanced monitors, RUM page views, and Mobile APMs purchased.
total_monitors	json	Total number of monitors and purchased add-ons that you’ve exhausted from your available monitor count.
basic_monitors	json	Contains the total number of basic Web & Internet Service monitors, basic Server monitors and Apps used and allowed.
advanced_monitors	json	Contains the total number of advanced Web & Internet Service monitors, APM and advanced Server monitors used and allowed.
rum_details	json	Contains the number of RUM page views used and allowed.
interfaces_details	json	Contains the number of network interfaces used and allowed.
mobileapm_details	json	Contains the number of Mobile APM used and allowed.
applog_details	json	Contains the amount of data space used/available for Applogs.
alert_credits	json	Consolidated number of free and purchased alert credits remaining in the account.
enabled_products	json	Types of monitos present in the account.
billing_contacts	JSON array	Billing contacts for the Business Unit.
basic_additional_checks	int	Total number of basic additional checks that you are entitled to use under the subscription plan.
basic_additional_checks_used	int	Total number of basic additional checks you’ve used in your current subscription plan.
advanced_additional_checks	int	Total number of advanced additional checks that you are entitled to use under the subscription plan.
advanced_additional_checks_used	int	Total number of advanced additional checks you’ve used in your current subscription plan.

Update Licence

PUT /bu/business_units/license/{user_id}

Apply license to Business units

Request example for updating a license.

$ curl https://www.site24x7.com/api/bu/business_units/license/106173000007272003 \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \
    -d '{
          "advanced_monitors_multiple": 1,
          "alert_credits":10
          "app_logs_multiple": 2,
          "basic_monitors_multiple": 2,
          "network_interfaces_multiple": 4,
          "rum_page_views_multiple": 5,
          "mobileapm_multiple": 1
        }'

Response Example

{
  "code": 0,
  "message": "success",
  "data": {
          "advanced_monitors_multiple": 1,
          "alert_credits":10
          "app_logs_multiple": 2,
          "basic_monitors_multiple": 2,
          "network_interfaces_multiple": 4,
          "rum_page_views_multiple": 5,
          "mobileapm_multiple": 1     
  }
}

oauthscope : Site24x7.Bu.Update

Path Parameters

Param	Type	Description
user_id	long	Mandatory Unique ID generated by the server. This can be used as an identifier.

Request Parameters

Param	Type	Description
advanced_monitors_multiple	long	The number of Advanced monitors to be allowed (in units of 5).
alert_credits	long	The number of Alert Credits to be allowed.
app_logs_multiple	long	The size of AppLogs to be allowed (in units of 10 GB).
basic_monitors_multiple	long	The number of Basic monitors to be allowed (in units of 10).
network_interfaces_multiple	long	The number of Network Interfaces to be allowed (in units of 50).
rum_page_views_multiple	long	The number of RUM Page Views to be allowed (in units of 500 K).
mobileapm_multiple	long	The number of Mobile APM to be allowed.

Response Parameters

Param	Type	Description
advanced_monitors_multiple	int	The number of Advanced monitors allowed (in units of 5).
alert_credits	int	The number of Alert Credits allowed.
app_logs_multiple	int	The size of AppLogs allowed (in units of 10 GB).
basic_monitors_multiple	int	The number of Basic monitors allowed (in units of 10).
network_interfaces_multiple	int	The number of Network Interfaces allowed (in units of 50).
rum_page_views_multiple	int	The number of RUM Page Views allowed (in units of 500 K).
mobileapm_multiple	int	The number of Mobile APM to be allowed.

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-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

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,
       "resource_tags": [
            "rum:rum app",
            "app:redis",
            "app:nginx"
        ],
      "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.

oauthscope : Site24x7.Reports.Read

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. Find the granularities supported for each period here.
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-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{
  "code": 0,
  "message": "success",
  "data": {
    "performance_details": {
      "REALBROWSER": {
        "name": [
          "RBM_TD3"
        ],
        "tags": [
           ["tag:val","account_site24x7:Prod Account","app:nginx","app:redis"]
          ],
        "attribute_data": [
          {
            "0": {
              "RESPONSETIME": 4210
            }
          }
        ],
        "availability": [
          "100.0"
        ]
      },
      "RDSINSTANCE": {
        "name": [
          "yyyyyy"
        ],
        "tags": [
            ["tag:val","account_site24x7:Prod Account","app:nginx","resource:RDS"]
          ],
        "attribute_data": [
          {
            "0": {
              "CPUUTILIZATION": "-"
            }
          }
        ],
        "availability": [
          "0.0"
        ]
      },
      "EC2INSTANCE": {
        "name": [
          "i-01f6bfa2",
          "i-1e9ed6bd",
          "i-2f0a438c",
          "i-4dbf04ee",
          "i-bf642f1c",
          "i-ca0eb43d"
        ],
        "tags": [
            [
               "aws:ec2:fleet-id:fleet-98f445dd-015f-8751-8490-0ba048041287","aws:ec2launchtemplate:id:lt-08e15c654806727d5","aws:ec2launchtemplate:version:1"
            ],
            [
              "rum:rum app","aws:ec2:fleet-id:fleet-98f445dd-015f-8751-8490-0ba048041287","aws:ec2launchtemplate:id:lt-08e15c654806727d5","aws:ec2launchtemplate:version:1"
            ],
            [
              "tag:val"
            ],
            [
                "-"
            ],
            [
              "rum:rum app"
            ],
            [
               "tag:val","aws:ec2:fleet-id:fleet-98f445dd-015f-8751-8490-0ba048041287","aws:ec2launchtemplate:id:lt-08e15c654806727d5"
            ]
        ],
        "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"
        ],
        "tags": [
            ["-"]
        ],
        "attribute_data": [
          {
            "0": {
              "RESPONSETIME": 40
            }
          }
        ],
        "availability": [
          "99.32"
        ]
      },
      "VMWAREVM": {
        "name": [
          "New Virtual Machine"
        ],
        "tags": [
            ["creationSource:aks-aks-nodepool1-30475163-vmss","Database:mysql","creationSource:aks-aksanod"]
        ],
        "attribute_data": [
          {
            "0": {
              "AVGCPUUTIL": "-"
            }
          }
        ],
        "availability": [
          "0.0"
        ]
      },
      "SERVER": {
        "name": [
          "localhost",
          "site24x7-win2012.site24x7.com"
        ],
        "tags": [
            ["component:appserver","check:untag"],
            ["-"]
        ],
        "attribute_data": [
          {
            "0": {
              "CPUUSEDPERCENT": "-"
            }
          },
          {
            "0": {
              "CPUUSEDPERCENT": "-"
            }
          }
        ],
        "availability": [
          "1.14",
          "1.14"
        ]
      },
      "IISSERVER": {
        "name": [
          "site24x7-win7-IIS- Don't delete"
        ],
        "tags": [
            ["account_site24x7:Prod Account"]
        ],
        "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_tags": [
            "rum:rum app",
            "app:redis",
            "app:nginx"
        ],
      "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.

oauthscope : Site24x7.Reports.Read

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. Find the granularities supported for each period here.
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.
subgroup_monitors	boolean	Enable this option to include subgroups of the selected Monitor Group. Otherwise, only the selected Group will be considered. Default value is true

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-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{
  "code": 0,
  "message": "success",
  "data": {
    "performance_details": {
      "PING": {
        "name": [
          "Ping 1",
          "Ping Single location",
          "PING_PROBEprobe10aprpre"
        ],
        "tags": [
            [
              "rum:rum app"
            ],
            [
            "tag:val","account_site24x7:Prod Account","app:nginx","resource:RDS"
            ],
            [
                "-"
            ]
        ],
        "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": "Monitor Type",
      "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": 4,
      "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.

oauthscope : Site24x7.Reports.Read

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. Find the granularities supported for each period here.
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-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{
  "code": 0,
  "message": "success",
  "data": {
    "performance_details": {
      "EC2INSTANCE": {
        "name": [
          "i-01f6bfa2",
          "i-1e9ed6bd",
          "i-2f0a438c",
          "i-4dbf04ee",
          "i-bf642f1c",
          "i-ca0eb43d"
        ],
        "tags": [
            [
               "aws:ec2:fleet-id:fleet-98f445dd-015f-8751-8490-0ba048041287","aws:ec2launchtemplate:id:lt-08e15c654806727d5","aws:ec2launchtemplate:version:1"
            ],
            [
              "rum:rum app","aws:ec2:fleet-id:fleet-98f445dd-015f-8751-8490-0ba048041287","aws:ec2launchtemplate:id:lt-08e15c654806727d5","aws:ec2launchtemplate:version:1"
            ],
            [
              "tag:val"
            ],
            [
                "-"
            ],
            [
              "rum:rum app"
            ],
            [
               "tag:val","aws:ec2:fleet-id:fleet-98f445dd-015f-8751-8490-0ba048041287","aws:ec2launchtemplate:id:lt-08e15c654806727d5"
            ]
        ],
        "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"
        ],
         "tags": [
            [
              "-"
            ],
            [
              "rum:rum app","account_site24x7:Prod Account"
            ],
            [
              "tag:val"
            ]
        ],
        "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"
        ],
        "tags": [
                [
                  "-"
                ],
                [
                  "rum:rum app","agentpool:agentpool","agentpool:nodepool1"
                ],
                [
                  "tag:val","agentpool:agentpool","agentpool:nodepool1"
                ],
                [
                  "-"
                ],
                [
                  "rum:rum app"
                ],
                [
                "tag:val"
                ],
                [
                  "agentpool:agentpool","agentpool:nodepool1"
                ],
                [
                  "rum:rum app","agentpool:agentpool","agentpool:nodepool1","component:appserver"
                ],
                [
                  "tag:val"
                ],
                [
                   "-"
                ],
                [
                  "rum:rum app"
                ]
            ],
        "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"
        ],
        "tags": [
            [
              "account_site24x7:Prod Account"
            ],
            [
              "rum:rum app","component:apiserver"
            ],
            [
              "tag:val"
            ],
            [
              "-"
            ]
        ],
        "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"
        ],
        "tags": [
            [
              "apmgroup:java","apm:redis"
            ]
        ],
        "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"
        ],
        "tags": [
            [
              "-"
            ],
            [
              "rum:rum app","creationSource:aks-aks-nodepool1-30475163-vmss","Database:mysql","creationSource:aks-aksanod"
            ],
            [
              "tag:val"
            ],
            [
             "creationSource:aks-aks-nodepool1-30475163-vmss","Database:mysql","creationSource:aks-aksanod"
            ],
            [
              "rum:rum app"
            ],
            [
              "tag:val","creationSource:aks-aksanod"
            ],
            [
              "-"
            ],
            [
              "rum:rum app","creationSource:aks-aks-agentpool-39797627-vmss"
            ],
            [
              "tag:val"
            ],
            [
              "-"
            ],
            [
              "rum:rum app"
            ],
            [
              "creationSource:aks-aksanod","Database:mysql"
            ],
            [
              "rum:rum app"
            ],
            [
              "tag:val","creationSource:aks-aksanod","Database:mysql"
            ],
            [
              "rum:rum app","creationSource:aks-aks-nodepool1-30475163-vmss","Database:mysql","creationSource:aks-aksanod"
            ],
            [
              "rum:rum app"
            ],
            [
                "tag:val"
            ],
            [
                "rum:rum app","creationSource:aks-aks-nodepool1-30475163-vmss","Database:mysql","creationSource:aks-aksanod"
            ],
            [
              "rum:rum app"
            ],
            [
              "tag:val"
            ],
            [
            "-"
            ],
            [
              "rum:rum app"
            ],
            [
              "-"
            ],
            [
              "rum:rum app"
            ],
            [
              "tag:val"
            ],
            [
            "-"
            ],
            [
              "rum:rum app"
            ],
            [
            "   tag:val"
            ],
            [
              "-"
            ],
            [
              "rum:rum app"
            ],
            [
              "tag:val"
            ],
            [
            "-"
            ]
        ],
        "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"
        ],
        "tags": [
            [
              "app;redis","config:error"
            ]
        ],
        "attribute_data": [
          {
            "0": {
              "RESPONSETIME": 109
            }
          }
        ],
        "availability": [
          "100.0"
        ]
      },
      "RDSINSTANCE": {
        "name": [
          "rds-test-1",
          "rdssss",
          "test-rds",
          "test-sep-rds",
          "testing",
          "testyesu",
          "ttttttt",
          "yyyyyy"
        ],
        "tags": [
            [
              "-"
            ],
            [
              "rum:rum app","AWS:RdsInstance"
            ],
            [
              "tag:val","AWS:RdsInstance"
            ],
            [
             "AWS:RdsInstance"
            ],
            [
              "rum:rum app"
            ],
            [
               "tag:val"
            ],
            [
              "rum:rum app"
            ],
            [
             "tag:val"
            ]
        ],
        "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"
        ],
        "tags": [
            [
              "-"
            ],
            [
              "rum:rum app"
            ]
        ],
        "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"
        ],
        "tags": [
            [
              "-"
            ],
            [
              "rum:rum app","agentpool:agentpool","agentpool:nodepool1"
            ],
            [
              "tag:val"
            ],
            [
              "agentpool:agentpool","agentpool:nodepool1"
            ],
            [
              "rum:rum app"
            ],
            [
             "tag:val"
            ],
            [
              "rum:rum app","agentpool:agentpool","agentpool:nodepool1"
            ],
            [
            "tag:val"
            ],
            [
            "tag:val"
            ]
        ],
        "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"
        ],
        "tags": [
            [
            "-"
            ],
            [
              "rum:rum app","Environment:testing","Exclude:yes"
            ],
            [
            "tag:val","Environment:testing","Exclude:yes"
            ],
            [
              "-"
            ],
            [
              "rum:rum app"
            ],
            [
              "tag:val"
            ],
            [
            "-"
            ],
            [
              "rum:rum app","Environment:testing","Exclude:yes"
            ],
            [
              "-"
            ],
            [
              "rum:rum app"
            ],
            [
              "tag:val"
            ],
            [
            "-"
            ],
            [
              "rum:rum app"
            ],
            [
            "tag:val","Environment:testing","Exclude:yes"
            ],
            [
              "-"
            ],
            [
              "rum:rum app"
            ],
            [
              "tag:val"
            ],
            [
            "-"
            ],
            [
              "rum:rum app"
            ],
            [
              "-"
            ],
            [
              "rum:rum app","Environment:testing","Exclude:yes"
            ],
            [
              "tag:val"
            ],
            [
            "-"
            ],
            [
              "rum:rum app"
            ],
            [
            "tag:val"
            ],
            [
              "-"
            ],
            [
              "rum:rum app","Environment:testing","Exclude:yes"
            ],
            [
              "tag:val","Environment:testing","Exclude:yes"
            ],
            [
            "-"
            ],
            [
              "rum:rum app"
            ],
            [
              "-"
            ],
            [
              "rum:rum app"
            ],
            [
              "tag:val"
            ],
            [
            "-"
            ],
            [
              "rum:rum app"
            ],
            [
            "tag:val"
            ],
            [
              "-"
            ],
            [
              "rum:rum app"
            ],
            [
              "tag:val"
            ],
            [
            "-"
            ],
            [
              "rum:rum app"
            ],
            [
              "-"
            ],
            [
              "rum:rum app","Environment:testing","Exclude:yes","account_site24x7:ProdAccount"
            ],
            [
              "tag:val"
            ],
            [
             "-"
            ],
            [
              "rum:rum app"
            ],
            [
             "tag:val"
            ],
            [
              "-"
            ],
            [
              "rum:rum app","account_site24x7:ProdAccount"
            ],
            [
              "tag:val"
            ],
            [
            "-"
            ]
        ],
        "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"
        ],
        "tags": [
            [
              "-"
            ],
            [
              "rum:rum app","account_site24x7:ProdAccount"
            ],
            [
              "tag:val","account_site24x7:ProdAccount"
            ]
        ],
        "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"
        ],
       "tags": [
            [
              "-"
            ],
            [
              "rum:rum app"
            ],
            [
              "tag:val","account_site24x7:ProdAccount"
            ],
            [
            "-"
            ]
        ],
        "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"
        ],
        "tags": [
            [
              "-"
            ],
            [
              "rum:rum app","account_site24x7:ProdAccount"
            ],
            [
              "tag:val","account_site24x7:ProdAccount"
            ],
            [
            "-"
            ],
            [
              "rum:rum app","account_site24x7:ProdAccount"
            ],
            [
            "tag:val","account_site24x7:ProdAccount"
            ],
            [
              "-"
            ],
            [
              "rum:rum app"
            ],
            [
              "tag:val"
            ],
            [
            "-"
            ],
            [
              "rum:rum app"
            ],
            [
            "tag:val"
            ],
            [
              "-"
            ],
            [
              "rum:rum app","account_site24x7:ProdAccount"
            ],
            [
              "tag:val","app:dnsmonitor"
            ],
            [
            "-"
            ],
            [
              "rum:rum app"
            ],
            [
            "  tag:val","app:dnsmonitor"
            ],
            [
              "-"
            ],
            [
              "rum:rum app"
            ],
            [
              "tag:val"
            ],
            [
            "-"
            ],
            [
              "rum:rum app","app:dnsmonitor"
            ],
            [
            "tag:val","app:dnsmonitor"
            ],
            [
              "-"
            ],
            [
              "rum:rum app","app:dnsmonitor"
            ]
        ],
        "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"
        ],
        "tags": [
            [
              "-"
            ],
            [
              "rum:rum app","account_site24x7:ProdAccount"
            ]
        ],
        "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"
        ],
        "tags": [
            [
              "account_site24x7:ProdAccount"
            ],
            [
              "rum:rum app","account_site24x7:ProdAccount"
            ],
            [
              "-"
            ],
            [
              "rum:rum app"
            ]
        ],
        "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"
        ],
        "tags": [
            [
              "-"
            ],
            [
              "rum:rum app","account_site24x7:ProdAccount"
            ],
            [
              "-"
            ]
        ],
        "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"
        ],
        "tags": [
            [
              "-"
            ],
            [
              "rum:rum app","account_site24x7:ProdAccount"
            ],
            [
              "account_site24x7:ProdAccount"
            ],
            [
              "rum:rum app"
            ]
        ],
        "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"
        ],
        "tags": [
            [
              "-"
            ]
        ],
        "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"
        ],
        "tags": [
            [
              "-"
            ],
            [
              "rum:rum app","account_site24x7:ProdAccount","cluster-level:true","clusterName:plusfabric"
            ],
            [
              "-"
            ],
            [
              "rum:rum app"
            ],
            [
              "-"
            ],
            [
              "account_site24x7:ProdAccount","cluster-level:true","clusterName:plusfabric"
            ],
            [
              "-"
            ],
            [
              "account_site24x7:ProdAccount","cluster-level:true","clusterName:plusfabric"
            ],
            [
              "-"
            ],
            [
              "rum:rum app","account_site24x7:ProdAccount","cluster-level:true","clusterName:plusfabric"
            ],
            [
              "-"
            ],
            [
              "rum:rum app"
            ]
        ],
        "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"
        ],
        "tags": [
            [
              "account_site24x7:ProdAccount"
            ],
            [
              "rum:rum app"
            ]
        ],
        "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"
        ],
        "tags": [
            [
              "-"
            ],
            [
                "account_site24x7:ProdAccount","type:WPA"
            ],
            [
              "-"
            ],
            [
              "rum:rum app","account_site24x7:ProdAccount","type:WPA"
            ],
            [
              "-"
            ],
            [
              "rum:rum app","account_site24x7:ProdAccount","type:WPA"
            ],
            [
              "account_site24x7:ProdAccount","type:WPA"
            ],
            [
              "rum:rum app"
            ],
            [
              "-"
            ],
            [
              "rum:rum app"
            ],
            [
              "-"
            ],
            [
              "rum:rum app"
            ],
            [
              "account_site24x7:ProdAccount","type:WPA"
            ],
            [
              "rum:rum app"
            ],
            [
              "account_site24x7:ProdAccount","type:WPA","config:error"
            ],
            [
              "rum:rum app"
            ],
            [
              "-"
            ],
            [
              "rum:rum app"
            ]
        ],
        "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"
        ],
        "tags": [
            [
              "-"
            ],
            [
              "rum:rum app","type:SMTP","account_site24x7:ProdAccount"

            ],
            [
              "-"
            ],
            [
              "rum:rum app","type:SMTP"
            ],
            [
              "-"
            ],
            [
              "rum:rum app","type:SMTP"
            ],
            [
              "-"
            ]
        ],
        "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"
        ],
        "tags": [
            [
              "account_site24x7:Prod Account"
            ],
            [
              "rum:rum app"
            ]
        ],
        "attribute_data": [
          {
            "0": {
              "RESPONSETIME": 12556
            }
          },
          {
            "0": {
              "RESPONSETIME": 839
            }
          }
        ],
        "availability": [
          "80.23",
          "100.0"
        ]
      },
      "PORT_FTP": {
        "name": [
          "FEB20-ftp-server",
          "FTP_PROBEprobe10aprpre",
          "FTP_Service_TD1"
        ],
        "tags": [
            [
              "-"
            ],
            [
              "rum:rum app"
            ],
            [
              "account_site24x7:ProdAccount"
            ]
        ],
        "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"
        ],
        "tags": [
            [
              "-"
            ],
            [
              "rum:rum app","version:v0.3.6","version:v0.3.7","version:v0.3.8"
            ],
            [
              "-"
            ],
            [
              "rum:rum app"
            ],
            [
              "-"
            ],
            [
              "rum:rum app","version:v0.3.6","version:v0.3.7","version:v0.3.8"
            ],
            [
              "-"
            ],
            [
              "rum:rum app","version:v0.3.6","version:v0.3.7","version:v0.3.8"
            ],
            [
              "-"
            ],
            [
              "rum:rum app"
            ],
            [
              "-"
            ]
        ],
        "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"
        ],
        "tags": [
            [
              "-"
            ],
            [
             "version:v0.3.6","version:v0.3.7","version:v0.3.8"
            ],
            [
              "-"
            ],
            [
              "version:v0.3.6","version:v0.3.7","version:v0.3.8"
            ],
            [
              "-"
            ],
            [
              "rum:rum app","version:v0.3.6","version:v0.3.7","version:v0.3.8"
            ],
            [
              "-"
            ],
            [
              "rum:rum app"
            ],
            [
              "-"
            ],
            [
              "rum:rum app"
            ],
            [
              "-"
            ],
            [
              "rum:rum app"
            ],
            [
              "version:v0.3.6","version:v0.3.7","version:v0.3.8"
            ],
            [
              "rum:rum app","version:v0.3.6","version:v0.3.7","version:v0.3.8"
            ],
            [
              "-"
            ],
            [
              "rum:rum app"
            ],
            [
              "-"
            ],
            [
              "rum:rum app"
            ],
            [
              "-"
            ],
            [
              "rum:rum app"
            ],
            [
              "-"
            ],
            [
              "rum:rum app"
            ],
            [
              "version:v0.3.6","version:v0.3.7","version:v0.3.8"
            ],
            [
              "rum:rum app"
            ]
        ],
        "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.

oauthscope : Site24x7.Reports.Read

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" \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

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",
       "resource_tags": [
            "rum:rum app",
            "app:redis",
            "app:nginx"
        ],

      "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.

oauthscope : Site24x7.Reports.Read

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.
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, UDP, 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" \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

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,
        "tags": [
         "rum:rum app",
         "app:redis",
         "app:wordpress"
        ]
      },
      {
        "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,
        "tags": [
         "rum:rum app",
         "app:website",
         "app:redis",
         "account_site24x7:Prod Account"
        ]
      },
      ...
    ],
    "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",
      "resource_tags": [
            "rum:rum app",
            "app:redis",
            "app:nginx"
        ],
      "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.

oauthscope : Site24x7.Reports.Read

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.
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.
subgroup_monitors	boolean	Enable this option to include subgroups of the selected Monitor Group. Otherwise, only the selected Group will be considered. Default value is true

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.
tags	String Array	Tags associated with the 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" \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

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,
        "tags": [
          "APM:Java",
          "APM:Python"
        ]
      },
      {
        "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,
        "tags": [
          "tag:val",
          "account_site24x7:Prod Account"
        ]
      },
      ...
    ],
    "info": {
      "resource_name": "Website",
      "end_time": "2017-05-19T00:00:00+0530",
      "resource_type_name": "Monitor Type",
      "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": 4,
      "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.

oauthscope : Site24x7.Reports.Read

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.
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.
tags	String Array	Tags associated with the 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-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

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,
        "tags": [
            "rum:rum app",
            "app:redis",
            "app:nginx"
        ]
      },
      {
        "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,
        "tags": [
            "rum:rum app",
            "app:redis",
            "app:nginx"
      ]

      },
      ...
    ],
    "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.

oauthscope : Site24x7.Reports.Read

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.
tags	String Array	Tags associated with the monitor.

Availability Summary by monitor type and Tag

GET /reports/availability_summary/tag/{monitor_type}/{tag_id}?period={report_period_constants}

Request Example

$ curl "https://www.site24x7.com/api/reports/availability_summary/tag/URL/113770000144486023?period=8" \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

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": "113770000144486146",
            "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",
            "type": 0,
            "image_file": "https://www.site24x7.com/app/screenshot/hdhVYNCOxxGRnRL+2cB
                            9yBzEILa2bk4KO0iiYzDfYrsmqHxn+4zFwpWp4r7\nViNV13RuClfdDm"
          },
          {
            "outage_id": "113770000144486150",
            "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",
            "type": 0,
            "image_file": "https://www.site24x7.com/app/screenshot/3amY1yVU/xxGRnRL
                            +2cB9yBzEILa2bk4KO0iiVxTBeC3YZn/0vyS7lcH93v7\nViNV13RuClfdD"
          },
          ...
        ],
        "monitor_id": "113770000144486134"
      }
    ],
    "availability_details": [
      {
        "down_count": 26,
        "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 ",
        "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": "113770000144486134",
        "unmanaged_percentage": 66.73,
        "downtime_percentage": 5.57
      },
      {
        "down_count": 21,
        "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",
        "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": "113770000144486134",
        "unmanaged_percentage": 0,
        "downtime_percentage": 5.59
      }
    ],
    "info": {
      "resource_name": "Test Tag",
      "end_time": "2018-01-01T00:00:00+0530",
      "resource_type_name": "Tag",
      "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": "113770000144486134",
      "report_type": 11,
      "monitor_type": "URL"
    }
  }
}

Get the availability summary details for monitors of a particular type and associated with a specific tag for selected period of time.

oauthscope : Site24x7.Reports.Read

Path Parameters

Param	Type	Description
monitor_type	string	Mandatory Type of the monitor.
tag_id	string	Mandatory Unique ID of the tag. You can find tag_id using the tag 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

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
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.
monitor_type	string	Type of the monitor.

Step Summary Reports

Obtain the step-wise availability and performance data of the individual steps of your monitors for a given time period.

Step Summary by Monitor (Web Transaction Browser)(Overall Availability)

GET /reports/step_summary/{monitor_id}?location_id={location_id}&maintenance_required={true/false}&period={report_period_constants}&metrics=1

Request Example

$ curl "https://www.site24x7.com/api/reports/step_summary/167018000003836005?location_id=50&maintenance_required=true&period=2&metrics=1" \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{
  "code": 0,
  "message": "success",
  "data": {
    "report_details": [
      {
        "steps": [
          {
            "response_time": "10649",
            "name": "Step - 1 : Loading - https://www.vtitan.com/",
            "availability": 100
          },
          {
            "response_time": "26448",
            "name": "Step - 2 : Click Corporate",
            "availability": 100
          }
        ],
        "display_name": "vtitan",
        "monitor_id": "4567000000026211"
      }
    ],
    "info": {
     "info": {
      "resource_name": "vtitan",
      "metrics_name": "Overall",
      "end_time": "2019-09-22T00:00:00+0530",
      "resource_type_name": "Monitor",
      "report_name": "Step Summary Report",
      "period_name": "Last Week (sun - sat)",
      "formatted_start_time": "September 15, 2019 12:00 AM IST",
      "formatted_end_time": "September 22, 2019 12:00 AM IST",
      "generated_time": "2019-09-23T19:29:00+0530",
      "start_time": "2019-09-15T00:00:00+0530",
      "resource_type": 2,
      "metrics": 1,
      "period": 2,
      "formatted_generated_time": "September 23, 2019 7:29 PM IST",
      "resource_id": "4567000000026211",
      "monitor_type": "REALBROWSER",
      "report_type": 20


    }
  }
}

Get the step summary details of a particular Web Transaction (Browser) monitor over the specified period of time.

oauthscope : Site24x7.Reports.Read

Path Parameters

Param	Type	Description
monitor_id	string	Mandatory Unique ID of the monitor

Query Parameters

Param	Type	Description
location_id	int	Mandatory The location for which the step summary report is required.
maintainance_required	boolean	Mandatory True, to include maintenance time for uptime calculation. False, to exclude maintenance time for uptime calculation.
metrics	int	Mandatory 1 - Overall data (only one entry per step). This is applicable across all time periods.
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
report_details	JSON array	Contains details of each monitor.
steps	JSON array	Step-by-step details of the monitor with its performance data and availability in percentage.
display_name	string	Name of the monitor for which the report is generated.
monitor_id	string	Unique ID of the monitor. Use retrieve monitor API to get the details of this monitor.

Step Summary by Monitor (Web Transaction Browser)(Availability by day)

GET /reports/step_summary/{monitor_id}?location_id={location_id}&maintenance_required={true/false}&period={report_period_constants}&metrics=2

Request Example

$ curl "https://www.site24x7.com/api/reports/step_summary/167018000003836005?location_id=50&maintenance_required=false&period=2&metrics=2" \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{
  "code": 0,
  "message": "success",
  "data": {
    "report_details": [
      {
        "step_summary_details": [
          {
            "steps": [
              {
                "response_time": "10649",
                "name": "Step - 1 : Loading - http://vtitan.com/",
                "availability": 100
              },
              {
                "response_time": "10649",
                "name": "Step - 2 : Click CORPORATE",
                "availability": 100
              }
            ],
            "date": "2019-09-17T00:00:00+0530"
          },

          {
            "steps": [
              {
                "response_time": "10649",
                "name": "Step - 1 : Loading - http://vtitan.com/",
                "availability": 100
              },
              {
                "response_time": "10649",
                "name": "Step - 2 : Click CORPORATE",
                "availability": 100
              }
            ],
            "date": "2019-09-20T00:00:00+0530"
          },
          {
            "steps": [
              {
                "response_time": "10649",
                "name": "Step - 1 : Loading - http://vtitan.com/",
                "availability": 100
              },
              {
                "response_time": "10649",
                "name": "Step - 2 : Click CORPORATE",
                "availability": 100
              }
            ],
            "date": "2019-09-18T00:00:00+0530"
          }
        ],
        "display_name": "vt_RBM -primary",
        "monitor_id": "4567000000026115"
      }
    ],
    "info": {
      "resource_name": "vt_RBM -primary",
      "metrics_name": "By Day",
      "end_time": "2019-09-22T00:00:00+0530",
      "resource_type_name": "Group",
      "report_name": "Step Summary Report",
      "period_name": "Last Week (sun - sat)",
      "formatted_start_time": "September 15, 2019 12:00 AM IST",
      "generated_time": "2019-09-23T19:29:00+0530",
      "formatted_end_time": "September 22, 2019 12:00 AM IST",
      "start_time": "2019-09-15T00:00:00+0530",
      "monitor_type": "REALBROWSER",
      "resource_type": 2,
      "metrics": 2,
      "period": 2,
      "formatted_generated_time": "September 23, 2019 7:29 PM IST",
      "resource_id": "4567000000026115",
      "report_type": 20
    }
  }
}

Get the step summary details of a particular Web Transaction (Browser) monitor over the specified period of time.

oauthscope : Site24x7.Reports.Read

Path Parameters

Param	Type	Description
monitor_id	string	Mandatory Unique ID of the monitor

Query Parameters

Param	Type	Description
location_id	int	Mandatory The location for which the step summary report is required.
maintainance_required	boolean	Mandatory True, to include maintenance time for uptime calculation. False, to exclude maintenance time for uptime calculation.
metrics	int	Mandatory 2 - By day-data (only one entry per step every day for the selected time period). This will be applicable only to time periods whose date ranges between 1 to 30 i.e. except ‘This year’ and ‘custom period’ whose date ranges include less than two days and exceeds 30 days.
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
report_details	JSON array	Contains details of each monitor.
step_summary_details	JSON array	Contains the summary details of the monitor with its date.
steps	JSON array	Step-by-step details of the monitor with its performance data and availability in percentage.
date	string	The date of the step summary details in ISO format.
display_name	string	Name of the monitor for which the report is generated.
monitor_id	string	Unique ID of the monitor. Use retrieve monitor API to get the details of this monitor.

Step Summary by Monitor group (Web Transaction Browser)(Overall availability)

GET /reports/step_summary/group/{group_id}?&maintenance_required={true/false}&period={report_period_constants}&metrics=1

Request Example

$ curl "https://www.site24x7.com/api/reports/step_summary/group/15698000073749001?maintenance_required=false&period=2&metrics=1" \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{
  "code": 0,
  "message": "success",
  "data": {
    "report_details": [
      {
        "steps": [
          {
            "response_time": "10649",
            "name": "Step - 1 : Loading - http://vtitan.com/",
            "availability": 100
          },
          {
            "response_time": "10249",
            "name": "Step - 2 : Click CORPORATE",
            "availability": 100
          }
        ],
        "display_name": "vtitan",
        "monitor_id": "4567000000026115"
      }
    ],
    "info": {
      "resource_name": "vtitan",
      "metrics_name": "Overall",
      "end_time": "2019-09-22T00:00:00+0530",
      "resource_type_name": "Group",
      "report_name": "Step Summary Report",
      "period_name": "Last Week (sun - sat)",
      "formatted_start_time": "September 15, 2019 12:00 AM IST",
      "generated_time": "2019-09-23T19:28:46+0530",
      "formatted_end_time": "September 22, 2019 12:00 AM IST",
      "start_time": "2019-09-15T00:00:00+0530",
      "resource_type": 1,
      "metrics": 1,
      "period": 2,
      "formatted_generated_time": "September 23, 2019 7:28 PM IST",
      "resource_id": "4567000010137001",
      "report_type": 20
    }
  }
}

Get the step summary details of a particular monitor group for a specified period of time. This will provide data only for Web Transaction (Browser) monitor available in the monitor group.

oauthscope : Site24x7.Reports.Read

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
maintainance_required	boolean	Mandatory True, to include maintenance time for uptime calculation. False, to exclude maintenance time for uptime calculation.
metrics	int	Mandatory 1 - Overall data (only one entry per step). This is applicable across all time periods.
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
subgroup_monitors	boolean	Enable this option to include subgroups of the selected Monitor Group. Otherwise, only the selected Group will be considered.

Response Attributes

Attribute	Type	Description
report_details	JSON array	Contains details of each monitor.
steps	JSON array	Step-by-step details of the monitor with its performance data and availability in percentage.
display_name	string	Name of the monitor for which the report is generated.
monitor_id	string	Unique ID of the monitor. Use retrieve monitor API to get the details of this monitor.

Step Summary by Monitor group (Web Transaction Browser)(Availability by day)

GET /reports/step_summary/group/{group_id}?&maintenance_required={true/false}&period={report_period_constants}&metrics=2

Request Example

$ curl "https://www.site24x7.com/api/reports/step_summary/group/15698000073749001?maintenance_required=false&period=2&metrics=2" \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{
  "code": 0,
  "message": "success",
  "data": {
    "report_details": [
      {
        "step_summary_details": [
          {
            "steps": [
              {
                "response_time": "10569",
                "name": "Step - 1 : Loading - https://www.zoho.com/",
                "availability": 100
              },
              {
                "response_time": "10569",
                "name": "Step - 2 : Click About Zoho",
                "availability": 100
              }
            ],
            "date": "2019-09-17T00:00:00+0530"
          },
          {
            "steps": [
              {
                "response_time": "3224",
                "name": "Step - 1 : Loading - https://www.zoho.com/",
                "availability": 100
              },
              {
                "response_time": "3224",
                "name": "Step - 2 : Click About Zoho",
                "availability": 100
              }
            ],
            "date": "2019-09-18T00:00:00+0530"
          }
        ],
        "display_name": "RBM-Zoho",
        "monitor_id": "1454000003797094"
      },
      {
        "step_summary_details": [
          {
            "steps": [
              {
                "response_time": "3224",
                "name": "Step - 1 : Loading - http://vtitan.com/",
                "availability": 100
              },
              {
                "response_time": "3224",
                "name": "Step - 2 : Click CORPORATE",
                "availability": 100
              },
              {
                "response_time": "3224",
                "name": "Step - 3 : Click PRODUCTS",
                "availability": 100
              }
            ],
            "date": "2019-09-17T00:00:00+0530"
          },
          {
            "steps": [
              {
                "response_time": "10649",
                "name": "Step - 1 : Loading - http://vtitan.com/",
                "availability": 100
              },
              {
                "response_time": "10649",
                "name": "Step - 2 : Click CORPORATE",
                "availability": 100
              },
              {
                "response_time": "10649",
                "name": "Step - 3 : Click PRODUCTS",
                "availability": 100
              }
            ],
            "date": "2019-09-18T00:00:00+0530"
          }
        ],
        "display_name": "SDP_RBM-vtitan9",
        "monitor_id": "1454000003797074"
      }
    ],
    "info": {
      "resource_name": "vtitan",
      "metrics_name": "By Day",
      "end_time": "2019-09-22T00:00:00+0530",
      "resource_type_name": "Group",
      "report_name": "Step Summary Report",
      "period_name": "Last Week (sun - sat)",
      "formatted_start_time": "September 15, 2019 12:00 AM IST",
      "generated_time": "2019-09-24T14:57:19+0530",
      "formatted_end_time": "September 22, 2019 12:00 AM IST",
      "start_time": "2019-09-15T00:00:00+0530",
      "resource_type": 1,
      "metrics": 2,
      "period": 2,
      "formatted_generated_time": "September 24, 2019 2:57 PM IST",
      "resource_id": "1454000028559001",
      "report_type": 20
    }
  }
}

Get the step summary details of a particular monitor group for a specified period of time. This will provide data only for Web Transaction (Browser) monitor available in the monitor group.

oauthscope : Site24x7.Reports.Read

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
maintainance_required	boolean	Mandatory True, to include maintenance time for uptime calculation. False, to exclude maintenance time for uptime calculation.
metrics	int	Mandatory 2 - By day-data (only one entry per step every day for the selected time period). This will be applicable only to time periods whose date ranges between 1 to 30 i.e. except ‘This year’ and ‘custom period’ whose date ranges include less than two days and exceeds 30 days.
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
subgroup_monitors	boolean	Enable this option to include subgroups of the selected Monitor Group. Otherwise, only the selected Group will be considered. Default value is true

Response Attributes

Attribute	Type	Description
report_details	JSON array	Contains details of each monitor.
step_summary_details	JSON array	Contains the summary details of the monitor with its date.
steps	JSON array	Step-by-step details of the monitor with its performance data and availability in percentage.
date	string	The date of the step summary details in ISO format.
display_name	string	Name of the monitor for which the report is generated.
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-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

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",
       "resource_tags": [
            "rum:rum app",
            "app:redis",
            "app:nginx"
        ],
      "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.

oauthscope : Site24x7.Reports.Read

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
resource_tags	String Array	Tags associated with the monitor.

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-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

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.

oauthscope : Site24x7.Reports.Read

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-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

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.

oauthscope : Site24x7.Reports.Read

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.
subgroup_monitors	boolean	Enable this option to include subgroups of the selected Monitor Group. Otherwise, only the selected Group will be considered. Default value is true

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-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

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": "Monitor Type",
      "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": 4,
      "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.

oauthscope : Site24x7.Reports.Read

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-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

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.

oauthscope : Site24x7.Reports.Read

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-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{
  "code": 0,
  "message": "success",
  "data": {
    "report": [
        {
          "throughput": {
            "max": 64.53,
            "min": 0,
            "average": 26
          },
          "firstbyte_time": {
            "max": "743",
            "min": "35",
            "average": "161"
          },
          "tags": [
            "monitor_site24x7:false",
            "host:localhost"
          ],
          "monitor_name": "TestPerf2",
          "responsetime": {
            "max": "4728",
            "min": "320",
            "average": "1338"
          },
          "monitor_id": "1784000009260014"
        },
        {
          "throughput": {
            "max": 0.88,
            "min": 0.45,
            "average": 1
          },
          "firstbyte_time": {
            "max": "610",
            "min": "216",
            "average": "242"
          },
          "tags": [
            "tag:val",
            "monitor_site24x7:false",
            "host:localhost"
          ],
          "monitor_name": "Website-accounts.zoho.com",
          "responsetime": {
            "max": "2291",
            "min": "1167",
            "average": "1268"
          },
          "monitor_id": "1784000000202031"
        },
    ],
    "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.

oauthscope : Site24x7.Reports.Read

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.
tags	String Array	Tags associated with the 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-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{
  "code": 0,
  "message": "success",
  "data": {
    "report": [
      {
        "max": "10436",
        "min": "3272",
        "monitor_name": "PORT",
        "tags": [
            "tag:val",
            "account_site24x7:Prod Account",
            "app:nginx"
          ],
        "average": "3294",
        "monitor_id": "113770000000132190"
      },
      {
        "max": "421",
        "min": "208",
        "tags": [
            "tag:val",
            "host:localhost"
          ],
        "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.

oauthscope : Site24x7.Reports.Read

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.
tags	String Array	Tags associated with the 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-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

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"
        },
        "tags": [
            "tag:val",
            "account_site24x7:Prod Account",
            "app:nginx"
          ],
        "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"
        }
        "tags": [
            "tag:val",
            "account_site24x7:Prod Account",
            "app:nginx"
          ],
        "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.

oauthscope : Site24x7.Reports.Read

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.
tags	String Array	Tags associated with the 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-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{
  "code": 0,
  "message": "success",
  "data": {
    "report": [
      {
        "max": "9236",
        "min": "2816",
         "tags": [
            "tag:val",
            "app:redis",
            "app:Wordpress"
          ],
        "monitor_name": "Website",
        "average": "3151",
        "monitor_id": "113770000055242267"
      },
      {
        "max": "7470",
        "min": "2836",
        "tags": [
            "tag:val",
            "account_site24x7:Prod Account",
            "app:nginx"
          ],
        "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.

oauthscope : Site24x7.Reports.Read

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.

Top N Availability Reports

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

Top N Availability Report for all monitors

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

Request Example

$ curl "https://www.site24x7.com/api/reports/availability/top_n?limit=2&period=4" \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{
  "code": 0,
  "message": "success",
  "data": {
    "report": [
     {
        "monitor_name": "404",
        "availability": "0.0",
        "monitor_id": "177861000206003087"
     },
     {
        "monitor_name": "Configuration Error",
        "availability": "0.0",
        "monitor_id": "177861000189569007"
     }
    ],
    "info": {
       "end_time": "2019-10-15T00:00:00+0530",
        "resource_type_name": "All Monitors",
        "report_name": "Top N Reports",
        "period_name": "Yesterday",
        "formatted_start_time": "October 14, 2019 12:00 AM Asia/Calcutta",
        "limit": 2,
        "generated_time": "2019-10-15T11:14:10+0530",
        "formatted_end_time": "October 15, 2019 12:00 AM Asia/Calcutta",
        "start_time": "2019-10-14T00:00:00+0530",
        "resource_type": 0,
        "period": 4,
        "formatted_generated_time": "October 15, 2019 11:14 AM Asia/Calcutta",
        "report_type": 29
    }
  }
}

Get the top N downtime report for all monitors.

oauthscope : Site24x7.Reports.Read

Query Parameters

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

Response Attributes

Attribute	Type	Description
monitor_name	string	Name of the monitor.
availability	string	The availability percentage 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 Availability Report by Monitor Type

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

Request Example

$ curl "https://www.site24x7.com/api/reports/availability/top_n/type/URL?limit=3&period=4" \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{
  "code": 0,
  "message": "success",
  "data": {
    "report": [
      {
        "monitor_name": "404",
        "availability": "0.0",
        "monitor_id": "177861000206003092"
        },
     {
        "monitor_name": "Configuration Error",
        "availability": "0.0",
        "monitor_id": "177861000189569007"
      },
      {
        "monitor_name": "402",
        "availability": "0.0",
        "monitor_id": "177861000226272136"
     }
  ],
    "info": {
        "resource_name": "Website",
        "end_time": "2019-10-15T00:00:00+0530",
        "resource_type_name": "Monitor Type",
        "report_name": "Top N Reports",
        "period_name": "Yesterday",
        "formatted_start_time": "October 14, 2019 12:00 AM Asia/Calcutta",
        "limit": 3,
        "formatted_end_time": "October 15, 2019 12:00 AM Asia/Calcutta",
        "generated_time": "2019-10-15T11:20:56+0530",
        "start_time": "2019-10-14T00:00:00+0530",
        "resource_type": 4,
        "period": 4,
        "formatted_generated_time": "October 15, 2019 11:20 AM Asia/Calcutta",
        "monitor_type": "URL",
        "report_type": 29
    }
  }
}

Get the top N report for a particular monitor types.

oauthscope : Site24x7.Reports.Read

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	Optional Number of monitors to be retrieved. N = 10,25,50,100. Default limit is 100.

Response Attributes

Attribute	Type	Description
monitor_name	string	Name of the monitor.
availability	string	The availability percentage 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 Availability Report by Monitor Group

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

Request Example

$ curl "https://www.site24x7.com/api/reports/availability/top_n/group/174961000193758048?limit=1" \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{
  "code": 0,
  "message": "success",
  "data": {
    "report": [
      {
        "monitor_name": "Test-RBM",
        "availability": "0.0",
        "monitor_id": "174961000001990128"
      }
    ],
    "info": {
        "resource_name": "783",
        "end_time": "2019-10-15T00:00:00+0530",
        "resource_type_name": "Group",
        "report_name": "Top N Reports",
        "period_name": "Yesterday",
        "formatted_start_time": "October 14, 2019 12:00 AM Asia/Calcutta",
        "limit": 3,
        "formatted_end_time": "October 15, 2019 12:00 AM Asia/Calcutta",
        "generated_time": "2019-10-15T11:24:10+0530",
        "start_time": "2019-10-14T00:00:00+0530",
        "resource_type": 1,
        "period": 4,
        "formatted_generated_time": "October 15, 2019 11:24 AM Asia/Calcutta",
        "resource_id": "174961000193758048",
        "report_type": 29
    }
  }
}

Get the top N report in a specific Monitor group.

oauthscope : Site24x7.Reports.Read

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 Top N report is generated within this predefined interval.
limit	int	Optional Number of monitors to be retrieved. N = 10,25,50,100. Default limit is 100.

Response Attributes

Attribute	Type	Description
monitor_name	string	Name of the monitor.
availability	string	The availability percentage corresponding to the monitor.
monitor_id	string	Unique ID of the monitor. Use retrieve monitor API to get the details of this monitor.

Bottom N Reports

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

Bottom N Report by Monitor Type

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

Request Example

$ curl "https://www.site24x7.com/api/reports/bottom_n/PORT?limit=10&period=3" \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{
  "code": 0,
  "message": "success",
  "data": {
    "report": [
        {
          "throughput": {
            "max": 64.53,
            "min": 0,
            "average": 26
          },
          "firstbyte_time": {
            "max": "743",
            "min": "35",
            "average": "161"
          },
          "tags": [
            "monitor_site24x7:false",
            "host:localhost"
          ],
          "monitor_name": "TestPerf2",
          "responsetime": {
            "max": "4728",
            "min": "320",
            "average": "1338"
          },
          "monitor_id": "1784000009260014"
        },
        {
          "throughput": {
            "max": 0.88,
            "min": 0.45,
            "average": 1
          },
          "firstbyte_time": {
            "max": "610",
            "min": "216",
            "average": "242"
          },
          "tags": [
            "tag:val",
            "monitor_site24x7:false",
            "host:localhost"
          ],
          "monitor_name": "Website-accounts.zoho.com",
          "responsetime": {
            "max": "2291",
            "min": "1167",
            "average": "1268"
          },
          "monitor_id": "1784000000202031"
        },
    ],
    "info": {
      "end_time": "2016-04-26T11:54:23+0530",
      "report_name": "Bottom 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": 42
    }
  }
}

Get the bottom N report for a particular monitor types.

oauthscope : Site24x7.Reports.Read

Path Parameters

Param	Type	Description
monitor_type	string	Mandatory Type of the monitor.

Query Parameters

Param	Type	Description
period	int	Mandatory Bottom 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.
tags	String Array	Tags associated with the monitor.

Bottom N Report by Monitor Type and Attribute Type

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

Request Example

$ curl "https://www.site24x7.com/api/reports/bottom_n/PORT/response_time?limit=10&period=3" \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{
  "code": 0,
  "message": "success",
  "data": {
    "report": [
      {
        "max": "10436",
        "min": "3272",
        "monitor_name": "PORT",
        "tags": [
            "tag:val",
            "account_site24x7:Prod Account",
            "app:nginx"
          ],
        "average": "3294",
        "monitor_id": "113770000000132190"
      },
      {
        "max": "421",
        "min": "208",
        "tags": [
            "tag:val",
            "host:localhost"
          ],
        "monitor_name": "PORT_PROBEprobe10aprpre",
        "average": "271",
        "monitor_id": "113770000005174001"
      }
    ],
    "info": {
      "end_time": "2016-04-26T11:54:23+0530",
      "report_name": "Bottom 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": 42
    }
  }
}

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

oauthscope : Site24x7.Reports.Read

Path Parameters

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

Query Parameters

Param	Type	Description
period	int	Mandatory Bottom 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.
tags	String Array	Tags associated with the monitor.

Bottom N Report by Monitor Type in a particular Monitor Group

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

Request Example

$ curl "https://www.site24x7.com/api/reports/bottom_n/URL?limit=10&period=3&group_id=113770000005151225" \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

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"
        },
        "tags": [
            "tag:val",
            "account_site24x7:Prod Account",
            "app:nginx"
          ],
        "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"
        }
        "tags": [
            "tag:val",
            "account_site24x7:Prod Account",
            "app:nginx"
          ],
        "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": "Bottom 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": 42
    }
  }
}

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

oauthscope : Site24x7.Reports.Read

Path Parameters

Param	Type	Description
monitor_type	string	Mandatory Type of the monitor.

Query Parameters

Param	Type	Description
period	int	Mandatory Bottom 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.
tags	String Array	Tags associated with the monitor.

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

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

Request Example

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

Response Example

{
  "code": 0,
  "message": "success",
  "data": {
    "report": [
      {
        "max": "9236",
        "min": "2816",
         "tags": [
            "tag:val",
            "app:redis",
            "app:Wordpress"
          ],
        "monitor_name": "Website",
        "average": "3151",
        "monitor_id": "113770000055242267"
      },
      {
        "max": "7470",
        "min": "2836",
        "tags": [
            "tag:val",
            "account_site24x7:Prod Account",
            "app:nginx"
          ],
        "monitor_name": "Website_1",
        "average": "3096",
        "monitor_id": "113770000063069023"
      }
    ],
    "info": {
      "end_time": "2017-06-20T00:00:00+0530",
      "report_name": "Bottom 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": 42
    }
  }
}

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

oauthscope : Site24x7.Reports.Read

Path Parameters

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

Query Parameters

Param	Type	Description
period	int	Mandatory Bottom 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}?unit_of_time={unit_of_time}&locations={location_id}&period={report_period_constants}

Request Example

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

Response Example

{
  "code": 0,
  "message": "success",
  "data": {
    "table_data": {
      "113770000000073133": {
        "RESPONSETIME": {
          "max": 1895,
          "min": 1780,
          "average": 1868,
          "95_percentile":1895,
          "95_percentile_description":"95th Percentile Time",
          "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",
      "resource_tags": [
            "rum:rum app",
            "app:redis",
            "app:nginx"
        ],
      "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,
      "metric_aggregation_name":"Average",
      "metric_aggregation":0
    },
    "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.

oauthscope : Site24x7.Reports.Read

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.
unit_of_time	int	The interval in which the data points in the response have to be divided. Find the granularities supported for each period here.
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, UDP, 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=={report_period_constants}&metric_aggregation={metric_aggregation_constants}

Request Example

$ curl "https://www.site24x7.com/api/reports/performance/group/113770000005189687?period=3&metric_aggregation=0" \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{
  "code": 0,
  "message": "success",
  "data": {
    "group_data": {
      "FTP": {
        "name": [
          "FTPRTT_TD1",
          "FTPRTT_TD2",
          "FTPRTT_TD3"
        ],
          "tags": [ 
            [
                "tag:val","rum:rum app","app:redis","app:nginx"
            ],
            [
                "-"
            ],
            [
                "rum:rum app","config:error"
            ]
        ],
        "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",
       "resource_tags": [
            "monitorgroup:true", "app:url","app:website"
        ],
      "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,
      "metric_aggregation_name":"Average",
      "metric_aggregation":0
    }
  }
}

Get the overall performance reports of a particular monitor group.

oauthscope : Site24x7.Reports.Read

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.
metric_aggregation	int	Performance details report is generated with this aggregation.
subgroup_monitors	boolean	Enable this option to include subgroups of the selected Monitor Group. Otherwise, only the selected Group will be considered. Default value is true

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.
tags	String Array	Tags associated with the monitor.

Performance Report by Monitor type

GET /reports/performance/type/PORT?period={report_period_constants}&metric_aggregation={metric_aggregation_constants}

Request Example

$ curl "https://www.site24x7.com/api/reports/performance/type/PORT?period=3&metric_aggregation=0" \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{
  "code": 0,
  "message": "success",
  "data": {
    "group_data": {
      "PORT": {
        "name": [
          "PORT",
          "PORT_PROBEprobe10aprpre",
          "Hubnuhu"
        ],
        "tags": [
            [
              "rum:rum app","app:port","portmonitor:port"
            ],
            [
              "tag:val","portmonitor:port"
            ],
            [
              "portmonitor:port"
            ]
        ],

        "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": "Monitor Type",
      "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": 4,
      "period": 3,
      "formatted_generated_time": "April 27, 2016 11:10 AM IST",
      "report_type": 16,
      "metric_aggregation_name":"Average",
      "metric_aggregation":0
    }
  }
}

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

oauthscope : Site24x7.Reports.Read

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.
metric_aggregation	int	Performance details report is generated with this aggregation.

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.
tags	String Array	Tags associated with the monitor.

Performance Report of all monitors

GET /reports/performance?period={report_period_constants}&metric_aggregation={metric_aggregation_constants}

Request Example

$ curl "https://www.site24x7.com/api/reports/performance?period=3&metric_aggregation=0" \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{
  "code": 0,
  "message": "success",
  "data": {
    "group_data": {
      "URL": {
        "name": [
          "Sample",
          "Sawi",
          "Amazon",
          "Apple"
        ],
        "tags": [
            [
              "rum:rum app","account_site24x7:Prod Account","apm:group"
            ],
            [
              "tag:val"
            ],
            [
                "-"
            ],
            [
                "-"
            ]
        ],
        "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,
      "metric_aggregation_name":"Average",
      "metric_aggregation":0
    }
  }
}

Get overall performance reportS of all monitors in your account.

oauthscope : Site24x7.Reports.Read

Query Parameters

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

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.
tags	String Array	Tags associated with the monitor.

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-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

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"
    }
  }
}

oauthscope : Site24x7.Reports.Read

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-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \
    -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"
  }
}

oauthscope : Site24x7.Reports.Create

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-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \
    -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"
  }
}

oauthscope : Site24x7.Reports.Update

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 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-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

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
    }
  ]
}

oauthscope : Site24x7.Reports.Read

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-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

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
  }
}

oauthscope : Site24x7.Reports.Read

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-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

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

oauthscope : Site24x7.Reports.Delete

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-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

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_title": "Response Time Trend",
            "attribute_name": "Response Time",
            "type": 2,
            "generated_time": "2017-07-11T16:33:06+0530",
            "formatted_generated_time": "11 July, 2017 4:33 PM IST",
            "start_time": "2017-07-01T00:00:00+0530",
            "end_time": "2017-07-10T16:33:06+0530",
            "formatted_start_time": "1 July, 2017 12:00 AM IST",
            "formatted_end_time": "10 July, 2017 4:33 PM IST",
        }
    }
}

oauthscope : Site24x7.Reports.Read

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_title	string	The metric which is compared, returns ‘Response Time Trend’ for Response time comparison and returns ‘Availability Trend’ 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-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \
    -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]
            },
  }
}

oauthscope : Site24x7.Reports.Create

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-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \
    -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]
            },
    }
}

oauthscope : Site24x7.Reports.Update

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.

FQDN Report

Receive a list of all your monitors with details about the actual days to the domain and SSL certificate expiry.

SSL And Domain Expiry Report

oauthscope : Site24x7.Reports.Read

GET /reports/fqdn/ssl_domain_reports

Request Example

$ curl https://www.site24x7.com/api/reports/fqdn/ssl_domain_reports \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{
    "code": 0,
    "message": "success",
    "data": {
        "fqdn_details": [
            {
                "ssl_expiry_days": "-",
                "domain_expiry_days": "180",
                "name": "paytm - Domain Expiry",
                "monitor_type": "DOMAINEXPIRY"
            },
            {
                "ssl_expiry_days": 183,
                "domain_expiry_days": "-",
                "name": "zoho",
                "monitor_type": "SSL_CERT"
            },
            {
                "ssl_expiry_days": "-",
                "domain_expiry_days": "150",
                "name": "facebook",
                "monitor_type": "DOMAINEXPIRY"
            },
            {
                "ssl_expiry_days": 321,
                "domain_expiry_days": "-",
                "name": "w3schools",
                "monitor_type": "SSL_CERT"
            },
            {
                "ssl_expiry_days": 376,
                "domain_expiry_days": "-",
                "name": "s247-ssl",
                "monitor_type": "SSL_CERT"
            }
        ],
        "info": {
            "end_time": "2018-12-03T14:19:21+0530",
            "resource_type_name": "All Monitors",
            "report_name": "FQDN Report",
            "period_name": "Today",
            "formatted_start_time": "December 3, 2018 12:00 AM IST",
            "generated_time": "2018-12-03T14:19:21+0530",
            "formatted_end_time": "December 3, 2018 2:19 PM IST",
            "start_time": "2018-12-03T00:00:00+0530",
            "resource_type": 0,
            "period": 3,
            "formatted_generated_time": "December 3, 2018 2:19 PM IST",
            "report_type": 22
        }
    }
}

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-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

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"
    }
  }
}

oauthscope : Site24x7.Reports.Read

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-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

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
    }
  }
}

oauthscope : Site24x7.Reports.Read

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-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

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
    }
  }
}

oauthscope : Site24x7.Reports.Read

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.

Get Outage Details of AWS Monitors

Get Outage Details of AWS Monitors

Obtain the total downtime duration of all the child monitors in an AWS account for a selected period of time.

GET /reports/outage/cloud/{parent_id}?period={report_period_constants}

Request Example

$ curl "https://www.site24x7.com/api/reports/outage/cloud/113770000005151207?period=3" \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": {
    "outage_details": [
      {
        "display_name": "i-0c335285f3670b63c",
        "outages": [
          {
            "outage_id": "1563793285004",
            "end_time": "2019-07-24T11:15:57+0530",
            "type": 0,
            "start_time": "2019-07-24T00:00:00+0530",
            "duration": "11 Hrs 16 Mins "
          }
        ],
        "monitor_id": "208669000001930027"
      }
    ],
    "info": {
      "end_time": "2019-07-24T11:15:57+0530",
      "resource_type_name": "selected resources",
      "report_name": "Outage Report",
      "period_name": "Today",
      "formatted_start_time": "July 24, 2019 12:00 AM Asia/Calcutta",
      "generated_time": "2019-07-24T11:15:57+0530",
      "formatted_end_time": "July 24, 2019 11:15 AM Asia/Calcutta",
      "start_time": "2019-07-24T00:00:00+0530",
      "resource_type": 0,
      "period": 3,
      "formatted_generated_time": "July 24, 2019 11:15 AM Asia/Calcutta",
      "report_type": 12
    }
  }
}

oauthscope : Site24x7.Reports.Read

Path Parameters

Param	Type	Description
parent_id	string	Mandatory Amazon monitor ID.

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-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

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

oauthscope : Site24x7.Reports.Update

Path Parameters

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

Mark Maintenance as Outage

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

PUT /reports/mark_downtime/{monitor_id}/{outage_id}

Request Example

$ curl https://www.site24x7.com/api/reports/mark_downtime/113770000009636043/1436794673738 \
    -X PUT \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

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

oauthscope : Site24x7.Reports.Update

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-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \
    -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"
  }
}

oauthscope : Site24x7.Reports.Update

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 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-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \
    -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"
  }
}

oauthscope : Site24x7.Reports.Update

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 outage occured.
monitor_id	string	Unique ID of the monitor.
reason	string	Reason for the outage.

Delete Outage

Delete the faulty downtime alerts to reflect the actual available state of the monitor.

DELETE /reports/outage/{monitor_id}/{outage_id}

Request Example

$ curl https://www.site24x7.com/api/reports/outage/113770000009636043/72000078998922 \
    -X DELETE \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

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

oauthscope : Site24x7.Reports.Delete

Path Parameters

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

Get Alarms

Alarms API provides you with insights on your monitor’s down, trouble or maintenance status.

GET /reports/alarms

Request Example

$ curl "https://www.site24x7.com/api/reports/alarm?period=2&business_hours_id=113770000019678086" \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

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"
    }
  }
}

oauthscope : Site24x7.Reports.Read

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

Get Alarms of Monitor

Obtain the actual down, trouble and maintenance status of your configured monitors. Alert types

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

Request Example

$ curl "https://www.site24x7.com/api/reports/alarm/113770000021689043?period=1&business_hours_id=113770000019678086" \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

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-19T16:34:19+0530",
            "type": 0,
            "start_time": "2016-04-18T19:42:08+0530",
            "reason": "Unable to connect to http://myesuraj-0551:9090/manager/status.",
            "duration": "20 Hrs 52 Mins "
          },
          {
            "outage_id": "1460985122907",
            "end_time": "2016-04-18T19:42:04+0530",
            "type": 7,
            "start_time": "2016-04-18T18:42:02+0530",
            "reason": "Rtyhj",
            "duration": "1 Hrs 0 Mins "
          },
          {
            "outage_id": "1460902323412",
            "end_time": "2016-04-18T18:42:02+0530",
            "type": 0,
            "start_time": "2016-04-18T16:34:19+0530",
            "reason": "Unable to connect to http://myesuraj-0551:9090/manager/status.",
            "duration": "2 Hrs 8 Mins "
          }
        ],
        "monitor_id": "113770000021689043"
      }
    ],
    "summary_details": {
      "down_count": 2,
      "threshold_profile_details": [],
      "downtime_duration": "23 Hrs 0 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 2 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": 2,
      "mttr": "11 Hrs 30 Mins ",
      "maintenance_percentage": 4.17,
      "maintenance_duration": "1 Hrs 0 Mins ",
      "availability_duration": "0 Mins 4 Secs",
      "unmanaged_percentage": 0,
      "downtime_percentage": 95.83
    },
    "location_availability": [
      {
        "down_count": 2,
        "name": "Chennai - IN",
        "downtime_duration": "23 Hrs 0 Mins ",
        "availability_percentage": 0,
        "mtbf": "0 Mins 2 Secs",
        "unmanaged_duration": "0 Mins 0 Secs",
        "location_id": "15",
        "mttr": "11 Hrs 30 Mins ",
        "maintenance_percentage": 4.17,
        "last_down": "2016-04-18T19:42:08+0530",
        "maintenance_duration": "1 Hrs 0 Mins ",
        "availability_duration": "0 Mins 4 Secs",
        "monitor_id": "113770000021689043",
        "unmanaged_percentage": 0,
        "downtime_percentage": 95.83
      },
      {
        "down_count": 2,
        "name": "Dallas - US",
        "downtime_duration": "23 Hrs 0 Mins ",
        "availability_percentage": 0,
        "mtbf": "0 Mins 2 Secs",
        "unmanaged_duration": "0 Mins 0 Secs",
        "location_id": "7",
        "mttr": "11 Hrs 30 Mins ",
        "maintenance_percentage": 4.17,
        "last_down": "2016-04-18T19:42:08+0530",
        "maintenance_duration": "1 Hrs 0 Mins ",
        "availability_duration": "0 Mins 4 Secs",
        "monitor_id": "113770000021689043",
        "unmanaged_percentage": 0,
        "downtime_percentage": 95.83
      },
      {
        "down_count": 2,
        "name": "Chicago - US",
        "downtime_duration": "23 Hrs 0 Mins ",
        "availability_percentage": 0,
        "mtbf": "0 Mins 2 Secs",
        "unmanaged_duration": "0 Mins 0 Secs",
        "location_id": "9",
        "mttr": "11 Hrs 30 Mins ",
        "maintenance_percentage": 4.17,
        "last_down": "2016-04-18T19:42:08+0530",
        "maintenance_duration": "1 Hrs 0 Mins ",
        "availability_duration": "0 Mins 4 Secs",
        "monitor_id": "113770000021689043",
        "unmanaged_percentage": 0,
        "downtime_percentage": 95.83
      },
      {
        "down_count": 2,
        "name": "Los Angeles - US",
        "downtime_duration": "23 Hrs 0 Mins ",
        "availability_percentage": 0,
        "mtbf": "0 Mins 2 Secs",
        "unmanaged_duration": "0 Mins 0 Secs",
        "location_id": "26",
        "mttr": "11 Hrs 30 Mins ",
        "maintenance_percentage": 4.17,
        "last_down": "2016-04-18T19:42:08+0530",
        "maintenance_duration": "1 Hrs 0 Mins ",
        "availability_duration": "0 Mins 4 Secs",
        "monitor_id": "113770000021689043",
        "unmanaged_percentage": 0,
        "downtime_percentage": 95.83
      },
      {
        "down_count": 2,
        "name": "Denver - US",
        "downtime_duration": "23 Hrs 0 Mins ",
        "availability_percentage": 0,
        "mtbf": "0 Mins 2 Secs",
        "unmanaged_duration": "0 Mins 0 Secs",
        "location_id": "27",
        "mttr": "11 Hrs 30 Mins ",
        "maintenance_percentage": 4.17,
        "last_down": "2016-04-18T19:42:08+0530",
        "maintenance_duration": "1 Hrs 0 Mins ",
        "availability_duration": "0 Mins 4 Secs",
        "monitor_id": "113770000021689043",
        "unmanaged_percentage": 0,
        "downtime_percentage": 95.83
      },
      {
        "down_count": 2,
        "name": "Kansas - US",
        "downtime_duration": "23 Hrs 0 Mins ",
        "availability_percentage": 0,
        "mtbf": "0 Mins 2 Secs",
        "unmanaged_duration": "0 Mins 0 Secs",
        "location_id": "28",
        "mttr": "11 Hrs 30 Mins ",
        "maintenance_percentage": 4.17,
        "last_down": "2016-04-18T19:42:08+0530",
        "maintenance_duration": "1 Hrs 0 Mins ",
        "availability_duration": "0 Mins 4 Secs",
        "monitor_id": "113770000021689043",
        "unmanaged_percentage": 0,
        "downtime_percentage": 95.83
      }
    ],
    "info": {
      "resource_name": "FEB18-3",
      "end_time": "2016-04-19T16:34:19+0530",
      "resource_type_name": "Monitor",
      "report_name": "",
      "period_name": "Past 1 day",
      "formatted_start_time": "April 18, 2016 4:34 PM IST",
      "generated_time": "2016-04-19T16:34:19+0530",
      "formatted_end_time": "April 19, 2016 4:34 PM IST",
      "start_time": "2016-04-18T16:34:19+0530",
      "resource_type": 2,
      "period": 1,
      "formatted_generated_time": "April 19, 2016 4:34 PM IST",
      "resource_id": "113770000021689043",
      "report_type": 31
    }
  }
}

oauthscope : Site24x7.Reports.Read

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.
reason	string	Reason for the outage

Get Alarms of Monitor Groups

Obtain the actual down, trouble and maintenance status of your configured monitor groups. Alert types

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

Request Example

$ curl "https://www.site24x7.com/api/reports/alarm/group/113770000005151207?period=3&business_hours_id=113770000019678086" \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

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-19T16:44:03+0530",
            "type": 0,
            "start_time": "2016-04-19T00:00:00+0530",
            "duration": "16 Hrs 44 Mins "
          }
        ],
        "monitor_id": "113770000000198003"
      },
      {
        "display_name": "RBM_TD2",
        "outages": [
          {
            "outage_id": "1460810748281",
            "end_time": "2016-04-19T16:44:03+0530",
            "type": 2,
            "start_time": "2016-04-19T00:00:00+0530",
            "duration": "16 Hrs 44 Mins "
          }
        ],
        "monitor_id": "113770000003426037"
      }
    ],
    "summary_details": {
      "down_count": 1,
      "downtime_duration": "16 Hrs 44 Mins ",
      "availability_percentage": 66.67,
      "mtbf": "1 days 9 Hrs 28 Mins ",
      "unmanaged_duration": "0 Mins 0 Secs",
      "alarm_count": 2,
      "mttr": "16 Hrs 44 Mins ",
      "maintenance_percentage": 0,
      "maintenance_duration": "0 Mins 0 Secs",
      "availability_duration": "1 days 9 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": "",
      "period_name": "Today",
      "formatted_start_time": "April 19, 2016 12:00 AM IST",
      "generated_time": "2016-04-19T16:44:03+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 4:44 PM IST",
      "resource_id": "113770000005151207",
      "report_type": 31
    }
  }
}

oauthscope : Site24x7.Reports.Read

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.

Get comments for a monitor

Get all the comments for a monitor for the given duration.

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

Request Example

$ curl "https://www.site24x7.com/api/reports/comments/113770000021689013?period=5" \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "success",
    "data": {
        "comment_details": {
            "comments_array": [
                {
                    "comment_time": "2016-04-06T15:38:02+0530",
                    "comment_id": "1459937282078",
                    "reason": "Unable to connect to http://myesuraj-0551:9090/manager/status.",
                    "updated_by": "Site24x7 - Monitoring Service",
                    "updated_time": "2016-04-06T15:38:02+0530"
                },
                {
                    "comment_time": "2016-04-06T15:40:02+0530",
                    "comment_id": "1459937282098",
                    "reason": "Unable to connect to http://myesuraj-0551:9090/manager/status.",
                    "updated_by": "testaccount@site24x7.com",
                    "updated_time": "2016-04-06T15:50:02+0530",
                    "zuid":"683390"
                }
            ]
        }
    }
}

oauthscope : Site24x7.Reports.Read

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.

Response Attributes

Attribute	Type	Description
comment_time	string	Time at which the comment was added
comment_id	string	Unique ID of the comment
reason	string	Comment
updated_by	string	Who added the comment
updated_time	string	Comment updated time in ISO format.
zuid	string	Unique ID of the user.

Get outage comments.

Get all the comments for a particular outage of a monitor.

GET /reports/comments/{monitor_id}/{outage_id}

Request Example

$ curl https://www.site24x7.com/api/reports/comments/113770000000198003/1460363579476 \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "success",
    "data": {
        "comment_details": {
            "outage_id": "1460363579476",
            "comments_array": [
                {
                    "comment_time": "2016-04-11T14:02:59+0530",
                    "comment_id": "1460363579476",
                    "reason": "Unable to locate element \"linktext=WebNMS Framework\" in step \"Click WebNMS Framework\". RCA : URL mismatch. URL expected: \"http://www.webnms.com/webnms/index.html\"; URL loaded: \"http://www.webnms.com/\"",
                    "updated_time": "2016-04-06T15:38:02+0530",
                    "updated_by": "Site24x7 - Monitoring Service"
                },
                {
                    "comment_time": "2016-04-11T14:03:59+0530",
                    "comment_id": "1460363579976",
                    "reason": "Unable to locate element \"linktext=WebNMS Framework\" in step \"Click WebNMS Framework\". RCA : URL mismatch. URL expected: \"http://www.webnms.com/webnms/index.html\"; URL loaded: \"http://www.webnms.com/\"",
                    "updated_time": "2016-04-06T15:38:02+0530",
                    "updated_by": "testaccount@site24x7.com",
                    "zuid":"683390"
                }
            ]
        }
    }
}

oauthscope : Site24x7.Reports.Read

Path Parameters

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

Response Attributes

Attribute	Type	Description
comment_time	string	Time at which the comment was added
comment_id	string	Unique ID of the comment
reason	string	Comment
updated_by	string	Who added/updated the comment
updated_time	string	Comment updated time in ISO format.
zuid	string	Unique ID of the user.

Update outage comments.

Update the comment for a given monitor.

PUT /reports/comments/{monitor_id}/{outage_id}

Request Example

$ curl https://www.site24x7.com/api/reports/comments/113770000000198003/1460363579476 \
    -X PUT \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \
    -d '{
          "comment_id": "1475130662206",
          "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": {
    "comment_details": {
      "outage_id": "1461075125290",
      "comments_array": [
        {
          "comment_time": "2016-04-19T19:42:05+0530",
          "comment_id": "1475130662206",
          "reason": "Unable to connect to http://zylker-0551:9090/manager/status.",
          "updated_time": "2016-04-19T19:42:05+0530",
          "updated_by": "Site24x7 - Monitoring Service"
        },
        {
          "comment_time": "2016-04-19T19:42:06+0530",
          "comment_id": "1475130662299",
          "reason": "Unable to connect to http://zylker-0551:9090/manager/status.",
          "updated_time": "2016-04-06T15:58:02+0530",
          "updated_by": "testaccount@site24x7.com",
          "zuid":"683390"
        }
      ]
    }
  }
}

oauthscope : Site24x7.Reports.Update

Path Parameters

Param	Type	Description
monitor_id	string	Mandatory Unique ID of the monitor
outage_id	int	Mandatory Unique ID of the outage for which the comment should be updated

Request Parameters

Param	Type	Description
comment_id	string	Mandatory The unique ID of the comment to be updated.
reason	string	Comment

Response Attributes

Attribute	Type	Description
comment_time	string	Time at which the comment was added
comment_id	string	Unique ID of the comment
reason	string	Comment
updated_by	string	Who added the comment
updated_time	string	Comment updated time in ISO format.
zuid	string	Unique ID of the user.

Update outage comments by comment Id.

Update the comment for a given monitor by comment id.

PUT /reports/comments/{monitor_id}/{outage_id}/{comment_id}

Request Example

$ curl https://www.site24x7.com/api/reports/comments/287724000010313009/1638363150139/1638363150139 \
    -X PUT \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \
    -d '{
          "reason": "Unable to connect to vtitan.com"
        }'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "success",
    "data": {
        "comment_time": "2021-12-01T18:22:30+0530",
        "reason": "Unable to connect to vtitan.com",
        "updated_time": "2021-12-03T11:27:21+0530",
        "updated_by": "testaccount@site24x7.com",
        "comment_id": "1638363150139"
    }
}

oauthscope : Site24x7.Reports.Update

Path Parameters

Param	Type	Description
monitor_id	string	Mandatory Unique ID of the monitor
outage_id	int	Mandatory Unique ID of the outage for which the comment should be updated
comment_id	string	Mandatory The unique ID of the comment to be updated.

Request Parameters

Param	Type	Description
reason	string	Comment

Response Attributes

Attribute	Type	Description
comment_time	string	Time at which the comment was added
comment_id	string	Unique ID of the comment
reason	string	Comment
updated_by	string	Who added the comment
updated_time	string	Comment updated time in ISO format.

Add outage comments

Add new comment to any outage of a monitor.

POST /reports/comments/{monitor_id}/{outage_id}

Request Example

$ curl https://www.site24x7.com/api/reports/comments/113770000000198003/1460363579476 \
    -X POST \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \
    -d '{
          "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": {
    "comment_details": {
      "outage_id": "1461075125290",
      "comments_array": [
        {
          "comment_time": "2016-04-20T14:45:00+0530",
          "comment_id": "1461143700745",
          "reason": "Test",
          "updated_by": "test@zylker.com",
          "updated_time": "2016-04-20T14:45:00+0530",
          "zuid":"683390"
        }        
      ]
    }
  }
}

oauthscope : Site24x7.Reports.Create

Path Parameters

Param	Type	Description
monitor_id	string	Mandatory Unique ID of the monitor
outage_id	int	Mandatory Unique ID of the outage for which the comment should be updated

Request Parameters

Param	Type	Description
reason	string	Comment

Response Attributes

Attribute	Type	Description
comment_time	string	Time at which the comment was added
comment_id	string	Unique ID of the comment
reason	string	Comment
updated_by	string	Who added the comment
updated_time	string	Comment updated time in ISO format.
zuid	string	Unique ID of the user.

Delete comment

Delete an outage comment.

DELETE /reports/comments/{monitor_id}/{outage_id}?comment_id={comment_id}

Request Example

$ curl https://www.site24x7.com/api/reports/comments/113770000021689043/1461075125290?comment_id=1475140118419\
    -X DELETE \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

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

oauthscope : Site24x7.Reports.Delete

Path Parameters

Param	Type	Description
monitor_id	string	Mandatory Unique ID of the monitor
outage_id	int	Mandatory Unique ID of the outage for which the comment should be updated

Query Parameters

Param	Type	Description
comment_id	string	Mandatory The unique ID of the comment to be updated.

Assign Technician

Assign Technician for an outage.

PUT /alarms/technician

Request Example

$ curl https://www.site24x7.com/api/alarms/technician \
    -X PUT \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \
    -d '{
          "monitor_id": "1000000123001",
          "technician_zuid": "65478659"
        }'

Response Example

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

oauthscope : Site24x7.Operations.Update

Request Parameters

Param	Type	Description
monitor_id	string	Mandatory Unique ID of the monitor for which the technician should be assigned.
technician_zuid	string	Unique ID of the user.

Response Attributes

Attribute	Type	Description
monitor_id	string	Unique ID of the monitor for which the technician has been assigned.
technician_zuid	string	Unique ID of the user.

SLA Reports

Obtain SLA reports of your monitors over a specified period of time.

Availability SLA

GET /reports/sla_reports/availability?period={report_period_constants}

Request Example

$ curl "https://www.site24x7.com/api/reports/sla_reports/availability?period=3" \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{
  "code": 0,
  "message": "success",
  "data": {
    "availabilityslareport": [
      {
        "operatorKey": 0,
        "colour": "#9e3434",
        "targetname": "Success",
        "monitor_name": "HomePage-zohocorp.com",
        "businessid": "0",
        "totaldowntime": "0",
        "TotalDownTime": "0 Mins 0 Secs",
        "sla_id": "113770000005151296",
        "totalmaintenancetime": "0",
        "expected": 99,
        "sla_name": "availability_withouthr",
        "totaltime": "47059309",
        "monitor_type": "HOMEPAGE",
        "monitor_id": "113770000000027001",
        "achieved": 100
      },
      {
        "operatorKey": 0,
        "colour": "#33CC00",
        "targetname": "Success",
        "monitor_name": "HomePage-zohocorp.com",
        "businessid": "0",
        "totaldowntime": "0",
        "TotalDownTime": "0 Mins 0 Secs",
        "sla_id": "113770000005151302",
        "totalmaintenancetime": "0",
        "expected": 99,
        "sla_name": "avali_withhour",
        "monitor_groups": [
            {
                "group_id": "113770000008151302",
                "group_name": "zohocorp"
            },
            {
                "group_id": "113770000009151302",
                "group_name": "site24x7"
            }
        ],
        "totaltime": "47059315",
        "monitor_type": "HOMEPAGE",
        "monitor_id": "113770000000027001",
        "achieved": 100
      }
    ]
  }
}

Get all the configured availability SLA reports.

oauthscope : Site24x7.Reports.Read

Query Parameters

Param	Type	Description
period	int	Mandatory SLA 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
monitor_name	string	Name of the monitor for which the SLA is generated.
sla_name	string	Name of the SLA configured.
expected	int	Expected SLA to be achieved.
achieved	int	SLA achieved.
target	int	Target achieved or not.

Response SLA

GET /reports/sla_reports/response?period={report_period_constants}

Request Example

$ curl "https://www.site24x7.com/api/reports/sla_reports/response?period=3" \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{
  "code": 0,
  "message": "success",
  "data": {
    "responsetimeslareport": [
      {
        "businessid": "0",
        "sla_name": "response",
        "monitor_name": "HomePage-zohocorp.com",
        "overalltargets": [
          {
            "name": "Success",
            "t0": "Success",
            "colour": "#33CC00",
            "achieved": 22.22
          },
          {
            "name": "Failed",
            "t1": "Failed",
            "colour": "#FF0000",
            "achieved": 77.78
          }
        ],
        "sla_id": "113770000005151306",
        "monitor_type": "HOMEPAGE",
        "monitor_id": "113770000000027001"
      },
      {
        "businessid": "0",
        "sla_name": "response_withhour",
        "monitor_name": "HomePage-zohocorp.com",
        "overalltargets": [
          {
            "name": "Success",
            "t0": "Success",
            "colour": "#33CC00",
            "achieved": 22.22
          },
          {
            "name": "Failed",
            "t1": "Failed",
            "colour": "#FF0000",
            "achieved": 77.78
          }
        ],
        "sla_id": "113770000005151310",
        "monitor_groups": [
            {
                "group_id": "113770000008151302",
                "group_name": "zohocorp"
            },
            {
                "group_id": "113770000009151302",
                "group_name": "site24x7"
            }
        ],
        "monitor_type": "HOMEPAGE",
        "monitor_id": "113770000000027001"
      }
    ]
  }
}

Get all the configured response SLA reports.

oauthscope : Site24x7.Reports.Read

Query Parameters

Param	Type	Description
period	int	Mandatory SLA 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
monitor_name	string	Name of the monitor for which the SLA is generated.
sla_name	string	Name of the SLA configured.
achieved	int	SLA achieved.

Composite SLA

GET /reports/sla_reports/composite?period={report_period_constants}

Request Example

$ curl "https://www.site24x7.com/api/reports/sla_reports/composite?period=3" \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{
  "code": 0,
  "message": "success",
  "data": {
    "compositeslareport": [
      {
        "operatorKey": 3,
        "colour": "#1d00cc",
        "targetname": "Poor",
        "monitor_name": "HomePage-zohocorp.com",
        "businessid": "0",
        "totaldowntime": "0",
        "TotalDownTime": "0 Mins 0 Secs",
        "sla_id": "113770000005151314",
        "totalmaintenancetime": "0",
        "expected": 90,
        "sla_name": "composite",
        "totaltime": "47308532",
        "monitor_type": "HOMEPAGE",
        "monitor_id": "113770000000027001",
        "achieved": 50
      },
      {
        "operatorKey": 0,
        "colour": "#33CC00",
        "targetname": "Success",
        "monitor_name": "SMTP-MX",
        "businessid": "0",
        "totaldowntime": "0",
        "TotalDownTime": "0 Mins 0 Secs",
        "sla_id": "113770000005151314",
        "totalmaintenancetime": "0",
        "expected": 90,
        "sla_name": "composite",
        "monitor_groups": [
            {
                "group_id": "113770000008151302",
                "group_name": "zohocorp"
            },
            {
                "group_id": "113770000009151302",
                "group_name": "site24x7"
            }
        ],
        "totaltime": "47308538",
        "monitor_type": "PORT-SMTP",
        "monitor_id": "113770000000028001",
        "achieved": 99.35
      }
    ]
  }
}

Get all the configured composite SLA reports.

oauthscope : Site24x7.Reports.Read

Query Parameters

Param	Type	Description
period	int	Mandatory SLA 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
monitor_name	string	Name of the monitor for which the SLA is generated.
sla_name	string	Name of the SLA configured.
achieved	int	SLA achieved.
expected	int	Expected SLA to be achieved.

Executive Summary SLA

GET /reports/sla_reports/executive_summary/{group_id}?period={report_period_constants}

Request Example

$ curl "https://www.site24x7.com/api/reports/sla_reports/executive_summary/11377000017171713?period=3" \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{
    "code": 0,
    "message": "success",
    "data": {
        "summary": {
            "best_response_time": {
                    "colour": {
                      "failed": "#FF0000",
                      "met": "#21BC63",
                      "almost_met": "#f7C228",
                      "no_response": "#e1e1e1"
                    },
                    "time": 2000
                  },
            "sla_availability_percentage": 69.23,
            "sla_response_time_percentage": 97.27
        },
        "sla_details": [
            {
                "response_time": {
                    "sla_name": "Site24x7 Response Time SLA",
                    "response_time": 523,
                    "overalltargets": [
                        {
                            "operatorkey": 3,
                            "operator": "less than",
                            "name": "Success",
                            "t0": "Success",
                            "target": 1500,
                            "colour": "#33CC00",
                            "achieved": 98.2
                        },
                        {
                            "operatorkey": 2,
                            "operator": "greater than or equal to",
                            "name": "Trouble",
                            "t1": "Trouble",
                            "target": 1501,
                            "colour": "#dbd314",
                            "achieved": 1.8
                        },
                        {
                            "operatorkey": 2,
                            "operator": "greater than or equal to",
                            "name": "Failed",
                            "t2": "Failed",
                            "target": 2500,
                            "colour": "#fa0a18",
                            "achieved": 0
                        }
                    ],
                    "sla_id": "1454000025787005"
                },
                "name": "OldMonitor sequence",
                "availability": {
                    "sla_achieved": 100,
                    "availability": 100,
                    "sla_id": "1454000030190003",
                    "overalltargets": [
                        {
                            "operatorkey": 0,
                            "operator": "greater than",
                            "name": "Success",
                            "target": 99,
                            "colour": "#33CC00"
                        }
                    ],
                    "sla_name": "SLA Site24x7",
                    "sla_targetname": "Success",
                    "sla_expected": 99,
                    "sla_colour": "#33CC00"
                },
                "id": "1454000003797157"
            },
            {
                "response_time": {
                    "sla_name": "Site24x7 Response Time SLA",
                    "response_time": 526,
                    "overalltargets": [
                        {
                            "operatorkey": 3,
                            "operator": "less than",
                            "name": "Success",
                            "t0": "Success",
                            "target": 1500,
                            "colour": "#33CC00",
                            "achieved": 96.34
                        },
                        {
                            "operatorkey": 2,
                            "operator": "greater than or equal to",
                            "name": "Trouble",
                            "t1": "Trouble",
                            "target": 1501,
                            "colour": "#dbd314",
                            "achieved": 0
                        },
                        {
                            "operatorkey": 2,
                            "operator": "greater than or equal to",
                            "name": "Failed",
                            "t2": "Failed",
                            "target": 2500,
                            "colour": "#fa0a18",
                            "achieved": 0
                        },
                        {
                            "name": "Failed",
                            "t3": "Failed",
                            "colour": "#FF0000",
                            "achieved": 3.66
                        }
                    ],
                    "sla_id": "1454000025787005"
                },
                "name": "RBM Site24x7",
                "availability": {
                    "sla_achieved": 100,
                    "availability": 100,
                    "sla_id": "1454000030190003",
                    "overalltargets": [
                        {
                            "operatorkey": 0,
                            "operator": "greater than",
                            "name": "Success",
                            "target": 99,
                            "colour": "#33CC00"
                        }
                    ],
                    "sla_name": "SLA Site24x7",
                    "sla_targetname": "Success",
                    "sla_expected": 99,
                    "sla_colour": "#33CC00"
                },
                "id": "1454000003797094"
            }
        ],
        "info": {
            "resource_name": "Site24x7 Group",
            "end_time": "2018-09-19T12:01:16+0530",
            "resource_type_name": "Group",
            "report_name": "Executive Summary SLA",
            "period_name": "Today",
            "formatted_start_time": "September 19, 2018 12:00 AM IST",
            "status": "All",
            "generated_time": "2018-09-19T12:01:16+0530",
            "formatted_end_time": "September 19, 2018 12:01 PM IST",
            "start_time": "2018-09-19T00:00:00+0530",
            "resource_type": 1,
            "period": 3,
            "formatted_generated_time": "September 19, 2018 12:01 PM IST",
            "resource_id": "1454000002079003",
            "report_type": 19
        }
    }
}

Get executive summary SLA report by monitor group.

oauthscope : Site24x7.Reports.Read

Query Parameters

Param	Type	Description
period	int	Mandatory SLA report is generated within this predefined interval.
start_date	string	Mandatory, if period chosen is Custom.Start date for a custom period. Executive summary SLA 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. Executive summary SLA report is generated until this date. Format - yyyy-mm-dd

Response Attributes

Attribute	Type	Description
id	int	ID of the monitor for which the SLA is generated.
name	string	Name of the monitor for which the SLA is generated.
availability	json	Availability metrics JSON Format:{sla_id:$sla_id,sla_name:“$sla_name”,sla_achieved:$sla_achieved,sla_expected:$sla_expected,sla_targetname:“$sla_targetname”,sla_colour:“$sla_colour”,availability:$availability,overalltargets:[$overalltargets]}
response_time	json	Response Time metrics JSON Format:{sla_id:$sla_id,sla_name:“$sla_name”,response_time:$response_time,overalltargets:[$overalltargets]}
summary	json	Receive average availability, average response time and best response time values for monitors in the group. JSON Format:{sla_availability_percentage:$sla_availability_percentage, sla_response_time_percentage:$sla_response_time_percentage, best_response_time:$best_response_time}

JSON Format

Attribute	Type	Description
sla_id	long	ID of the SLA.
sla_name	string	Name of the SLA configured.
sla_achieved	float	SLA achieved.
sla_expected	float	Expected threshold value for the SLA.
sla_targetname	string	Target name of the achieved SLA.
sla_colour	string	Color code of the achieved SLA with respect to target name configured.
availability	float	Average actual availability of the monitor for the given time period.
response_time	float	Primary response time of the monitor.
overalltargets	JSON array	User configured SLA target metrics. JSON Array Format: [{name:$“name”, colour:$“colour”, target:$target, operator:$“operator”, operatorkey:$operatorkey}]
sla_response_time_percentage	float	Average response time SLA percentage value of your individual monitors in your monitor group.
sla_availability_percentage	float	Average availability SLA percentage value of your individual monitors in your monitor group.
best_response_time	json	Fetch the benchmarked response time data applied for baselining your monitor’s response time SLA values. JSON Format: {time:$time, colour:{$colour}}

Security Reports

Obtain the status availability of your security monitors at the current time.

Brand Reputation Report

GET /reports/brand_reputation/all

Request Example

$ curl "https://www.site24x7.com/api/reports/brand_reputation/all" \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{
    "code": 0,
    "message": "success",
    "data": {
        "report_details": {
            "unwanted_software_count": "0",
            "threat_type": "ALL",
            "phishing_count": "0",
            "malware_count": "1",
            "total_url": 9
        },
        "brand_reputation_report": [{
            "url": "http://malware.wicar.org",
            "malware_time": "1581068692890",
            "unwanted_software_time": "-",
            "status": false,
            "phishing_time": "-",
            "collection_time": "1598950526895",
            "is_unwanted_software": false,
            "gsb_threat_info": "{"MALWARE":"true"}",
            "no": 1,
            "is_phishing": false,
            "is_malware": true
        }, {
            "url": "https://vtitan.com",
            "malware_time": "-",
            "unwanted_software_time": "-",
            "status": true,
            "phishing_time": "-",
            "collection_time": "1606387323728",
            "is_unwanted_software": false,
            "gsb_threat_info": "",
            "no": 2,
            "is_phishing": false,
            "is_malware": false
        }, {
            "url": "https://vtitan.com/vtitan-and-covid19.html",
            "malware_time": "-",
            "unwanted_software_time": "-",
            "status": true,
            "phishing_time": "-",
            "collection_time": "1606387323728",
            "is_unwanted_software": false,
            "gsb_threat_info": "",
            "no": 4,
            "is_phishing": false,
            "is_malware": false
        }],
        "info": {
            "end_time": "2020-11-27T12:32:54+0530",
            "resource_type_name": "All Monitors",
            "report_name": "Brand Reputation Report",
            "period_name": "Today",
            "formatted_start_time": "November 27, 2020 12:00 AM IST",
            "generated_time": "2020-11-27T12:32:54+0530",
            "formatted_end_time": "November 27, 2020 12:32 PM IST",
            "start_time": "2020-11-27T00:00:00+0530",
            "resource_type": 0,
            "period": 3,
            "formatted_generated_time": "November 27, 2020 12:32 PM IST",
            "report_type": 24
        }
    }
}

Get the threat status of the all the URLs across the Brand Reputation monitors.

oauthscope : Site24x7.Reports.Read

Response Attributes

Attribute	Type	Description
report_details	json	Has the json data containing the count categorised by threat and total URL count respectively. JSON Format: { “unwanted_software_count”: “$unwanted_software_count”, “threat_type”: “$threat_type”, “phishing_count”: “$phishing_count”, “malware_count”: “$malware_count”, “total_url”: $total_url }
brand_reputation_report	JSON array	Has the data containing the details of the URL along with its threat information. JSON Format: { “url”: “$url”, “malware_time”: “$malware_time”, “unwanted_software_time”: “$unwanted_software_time”, “status”: $status, “phishing_time”: “$phishing_time”, “collection_time”: “$collection_time”, “is_unwanted_software”: $is_unwanted_software, “gsb_threat_info”: “$gsb_threat_info”, “no”: $no, “is_phishing”: $is_phishing, “is_malware”: $is_malware }

JSON Format

Attribute	Type	Description
url	string	Website address to monitor.
malware_time	string	The time from which the given URL contains malware.
unwanted_software_time	string	The time from which suspected URL has been containing malicious software.
status	boolean	Threat status
phishing_time	string	The time from which the suspected URL has been subject to Phishing/Social Engineering attacks.
collection_time	string	The time when the URL was checked last.
is_unwanted_software	boolean	True, if the suspected URL contains malicious software.
gsb_threat_info	string	The URL suspect to be threat under categories.
no	int	Index of URL
is_phishing	boolean	True, if the suspected URL has been subject to Phishing/Social Engineering attacks.
is_malware	boolean	True, if the suspected URL contains Malware.

SSL/TLS Grade Report

GET /reports/ssl_cert/all

Request Example

$ curl "https://www.site24x7.com/api/reports/ssl_cert/all" \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{
  "code": 0,
  "message": "success",
  "data": {
    "ssl_cert_report": [
      {
        "status": 0,
        "expire": "332",
        "grade": "B",
        "vuln": 1,
        "no": 1,
        "host_name": "example.com",
        "issued_date": "2020-03-18T22:47:27+0530",
        "expiry_date": "2022-03-28T23:17:27+0530"
      }
    ],
    "info": {
      "end_time": "2021-07-12T15:57:45+0530",
      "resource_type_name": "All Monitors",
      "report_name": "SSL/TLS Grade Report",
      "period_name": "Today",
      "formatted_start_time": "July 12, 2021 12:00 AM IST",
      "generated_time": "2021-07-12T15:57:45+0530",
      "formatted_end_time": "July 12, 2021 3:57 PM IST",
      "start_time": "2021-07-12T00:00:00+0530",
      "resource_type": 0,
      "period": 3,
      "formatted_generated_time": "July 12, 2021 3:57 PM IST",
      "report_type": 36
    }
  }
}

Obtain the certificate grade, the number of days left for expiry, expiry date, issued date and the number of vulnerabilities of your SSL Certificate monitors.

oauthscope : Site24x7.Reports.Read

Response Attributes

Attribute	Type	Description
ssl_cert_report	JSON array	It will have details of the certificate grade, the number of days left for expiry, expiry date, issued date and the number of vulnerabilities. JSON Format: { “status”:“$status”, “expire”:“$expire”, “grade”:“$grade”, “vuln”:“$vuln”, “no”:“$no”, “host_name”:“$host_name”, “expiry_date”:“$expiry_date”, “issued_date”:“$issued_date”}.

JSON Format

Attribute	Type	Description
status	int	Status of the monitor
expire	string	Days left for certificate expiry.
expiry_date	string	Certificate expiry date.
issued_date	string	Certificate issue date.
grade	string	Certificate Grade.
vuln	int	Number of vulnerabilities.
host_name	string	Domain provided for monitoring.
no	int	Index of domain.

RBL Report

GET /reports/rbl/all

Request Example

$ curl "https://www.site24x7.com/api/reports/rbl/all" \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{
  "code": 0,
  "message": "success",
  "data": {
    "rbl_ip_report": [
      {
        "status": true,
        "listed": "Not listed",
        "displayname": "RBL-1",
        "ip_address": "example.com",
        "domain": "example.com",
        "monitorid": "1000000188005"
      },
      {
        "status": false,
        "listed": "Blacklisted",
        "displayname": "RBL-1",
        "ip_address": "127.0.0.1",
        "domain": "",
        "monitorid": "1000000188005"
      }
    ],
    "report_details": {
      "blIpCount": "1",
      "totalDomains": "1",
      "totalIps": "1",
      "blDomainCount": "0"
    },
    "info": {
      "end_time": "2021-07-12T16:33:57+0530",
      "resource_type_name": "All Monitors",
      "report_name": "Real-time Blocklist Report",
      "period_name": "Today",
      "formatted_start_time": "July 12, 2021 12:00 AM IST",
      "generated_time": "2021-07-12T16:33:57+0530",
      "formatted_end_time": "July 12, 2021 4:33 PM IST",
      "start_time": "2021-07-12T00:00:00+0530",
      "resource_type": 0,
      "period": 3,
      "formatted_generated_time": "July 12, 2021 4:33 PM IST",
      "report_type": 26
    }
  }
}

Get the status of your RBL monitors.

oauthscope : Site24x7.Reports.Read

Response Attributes

Attribute	Type	Description
report_details	json	Includes the json data containing the count of total blacklisted domains/IPs and the total number of configured domains/IP addresses for all monitors. JSON Format: { “blIpCount”: “$blIpCount”, “totalDomains”: “$totalDomains”, “totalIps”: “$totalIps”, “blDomainCount”: “$blDomainCount” }
rbl_ip_report	JSON array	Contains the details of individual domain or IP address. JSON Format: { “status”: “$status”, “listed”: “$listed”, “displayname”: “$displayname”, “ip_address”: $ip_address, “domain”: “$domain”, “monitorid”: “$monitorid”}

JSON Format

Attribute	Type	Description
status	boolean	False, if the domain/IP is blacklisted
listed	string	Blacklisted, if the domain/IP is blacklisted. Not listed, if the domain/IP is not blacklisted.
displayname	string	Name of the monitor.
ip_address	string	Resolved IP of the monitored domain.
domain	string	Domain provided for monitoring.
monitorid	string	Unique ID of the monitor.

Website Defacement Report for all monitors

GET /reports/website_defacement/all

Request Example

$ curl "https://www.site24x7.com/api/reports/website_defacement/all" \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{
  "report_details": {
    "total_defaced_links_count": 1,
    "monitor_count": 1,
    "total_links_count": 2
  },
  "website_defacement_report": [
    {
      "monitorId": "1000000017001",
      "defaced_links_count": 1,
      "links_count": 2,
      "display_name": "Example",
      "url": "https://example.com",
      "status": 2,
      "links": [
        {
          "no": 1,
          "page_name": "/webinars",
          "url": "https://example.com/webinars",
          "page_size": 86,
          "last_modified_time": "1626410009608",
          "modified_elements_count": 4,
          "is_script_modified": "false",
          "script_modified_percentage": 1,
          "is_text_modified": "false",
          "text_modified_percentage": 0,
          "is_anchor_modified": "false",
          "anchor_modified_percentage": 0,
          "is_iframe_modified": "false",
          "iframe_modified_percentage": 0,
          "is_image_modified": "false",
          "image_modified_percentage": 3,
          "is_link_modified": "false",
          "link_modified_percentage": 5
        },
        {
          "no": 2,
          "page_name": "/blog",
          "url": "https://example.com/blog",
          "page_size": 41,
          "last_modified_time": "1626410009608",
          "modified_elements_count": 1,
          "is_script_modified": "true",
          "script_modified_percentage": 10,
          "is_text_modified": "false",
          "text_modified_percentage": 1,
          "is_anchor_modified": "false",
          "anchor_modified_percentage": 4,
          "is_iframe_modified": "false",
          "iframe_modified_percentage": 2,
          "is_image_modified": "false",
          "image_modified_percentage": 3,
          "is_link_modified": "false",
          "link_modified_percentage": 5

        }
      ]
    }
  ],
  "info": {
    "period": 3,
    "resource_type_name": "All Monitors",
    "resource_type": 0,
    "end_time": "2021-07-16T10:08:04+0530",
    "period_name": "Today",
    "formatted_start_time": "July 16, 2021, 12:00 AM IST",
    "report_type": 41,
    "formatted_generated_time": "July 16, 2021, 10:08 AM IST",
    "formatted_end_time": "July 16, 2021, 10:08 AM IST",
    "generated_time": "2021-07-16T10:08:04+0530",
    "start_time": "2021-07-16T00:00:00+0530",
    "report_name": "global.subtitle.website.defacement.report"
  }
}

Get the threat status for all URLs under website defacement monitoring.

oauthscope : Site24x7.Reports.Read

Response Attributes

Attribute	Type	Description
report_details	json	Contains the json data including the count of defaced links, monitors, and the total number of links. JSON Format: { “total_defaced_links_count”: “$total_defaced_links_count”, “monitor_count”: “$monitor_count”, “total_links_count”: “$total_links_count” }
website_defacement_report	JSON array	Has the monitor specific details. JSON Format: { “monitorId”: “$monitorId”, “links_count”: “$links_count”, “defaced_links_count”: “$defaced_links_count”, “display_name”: “$display_name”,“url”: $url, “status”:“$status”, “links”: “ [ {"no”:“$no”, “page_name”:“$page_name”, “url”:“$url”, “page_size”:“$page_size”, “last_modified_time”:“$last_modified_time”, “modified_elements_count”:“$modified_elements_count”, “is_script_modified”:“$is_script_modified”, “script_modified_percentage”:“$script_modified_percentage”, “is_text_modified”:“$is_text_modified”, “text_modified_percentage”:“$text_modified_percentage”, “is_anchor_modified”:“$is_anchor_modified”, “anchor_modified_percentage”:“$anchor_modified_percentage”, “is_iframe_modified”:“$is_iframe_modified”, “iframe_modified_percentage”:“$iframe_modified_percentage”, “is_image_modified”:“$is_image_modified”, “image_modified_percentage”:“$image_modified_percentage”, “is_link_modified”:“$is_link_modified”, “link_modified_percentage”:“$link_modified_percentage”} ] “ }

JSON Format

Attribute	Type	Description
monitorId	string	Unique ID of the monitor.
defaced_links_count	int	The number of defaced links in the current monitor.
links_count	int	The number of links in the current monitor.
display_name	string	Name of the monitor.
url	string	URL provided for the monitoring.
status	int	Status of the monitor
links	JSON array	It contains the time at which the links in the monitor were modified and the percentage of modification.

Website Defacement Report by Monitor ID

GET /reports/website_defacement/{monitor_id}

$ curl "https://www.site24x7.com/api/reports/website_defacement/1000000017001" \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{
  "report_details": {
    "total_defaced_links_count": 1,
    "monitor_count": 1,
    "total_links_count": 2
  },
  "website_defacement_report": [
    {
      "monitorId": "1000000017001",
      "defaced_links_count": 1,
      "links_count": 2,
      "display_name": "Example",
      "url": "https://example.com",
      "status": 2,
      "links": [
        {
          "no": 1,
          "page_name": "/webinars",
          "url": "https://example.com/webinars",
          "page_size": 86,
          "last_modified_time": "1626410009608",
          "modified_elements_count": 4,
          "is_script_modified": "false",
          "script_modified_percentage": 1,
          "is_text_modified": "false",
          "text_modified_percentage": 0,
          "is_anchor_modified": "false",
          "anchor_modified_percentage": 0,
          "is_iframe_modified": "false",
          "iframe_modified_percentage": 0,
          "is_image_modified": "false",
          "image_modified_percentage": 3,
          "is_link_modified": "false",
          "link_modified_percentage": 5
        },
        {
          "no": 2,
          "page_name": "/blog",
          "url": "https://example.com/blog",
          "page_size": 41,
          "last_modified_time": "1626410009608",
          "modified_elements_count": 1,
          "is_script_modified": "true",
          "script_modified_percentage": 10,
          "is_text_modified": "false",
          "text_modified_percentage": 1,
          "is_anchor_modified": "false",
          "anchor_modified_percentage": 4,
          "is_iframe_modified": "false",
          "iframe_modified_percentage": 2,
          "is_image_modified": "false",
          "image_modified_percentage": 3,
          "is_link_modified": "false",
          "link_modified_percentage": 5

        }
      ]
    }
  ],
  "info": {
    "period": 3,
    "resource_type_name": "All Monitors",
    "resource_type": 0,
    "end_time": "2021-07-16T10:08:04+0530",
    "period_name": "Today",
    "formatted_start_time": "July 16, 2021, 12:00 AM IST",
    "report_type": 41,
    "formatted_generated_time": "July 16, 2021, 10:08 AM IST",
    "formatted_end_time": "July 16, 2021, 10:08 AM IST",
    "generated_time": "2021-07-16T10:08:04+0530",
    "start_time": "2021-07-16T00:00:00+0530",
    "report_name": "global.subtitle.website.defacement.report"
  }
}

Get the threat status for all URLs under website defacement monitoring.

oauthscope : Site24x7.Reports.Read

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
report_details	json	Contains the json data including the count of defaced links, monitors, and the total number of links. JSON Format: { "total_defaced_links_count”: “$total_defaced_links_count”, “monitor_count”: “$monitor_count”, “total_links_count”: “$total_links_count” }
website_defacement_report	JSON array	Has the monitor specific details. JSON Format: { “monitorId”: “$monitorId”, “links_count”: “$links_count”, “defaced_links_count”: “$defaced_links_count”, “display_name”: “$display_name”,“url”: $url, “status”:“$status”, “links”: “ [ {"no”:“$no”, “page_name”:“$page_name”, “url”:“$url”, “page_size”:“$page_size”, “last_modified_time”:“$last_modified_time”, “modified_elements_count”:“$modified_elements_count”, “is_script_modified”:“$is_script_modified”, “script_modified_percentage”:“$script_modified_percentage”, “is_text_modified”:“$is_text_modified”, “text_modified_percentage”:“$text_modified_percentage”, “is_anchor_modified”:“$is_anchor_modified”, “anchor_modified_percentage”:“$anchor_modified_percentage”, “is_iframe_modified”:“$is_iframe_modified”, “iframe_modified_percentage”:“$iframe_modified_percentage”, “is_image_modified”:“$is_image_modified”, “image_modified_percentage”:“$image_modified_percentage”, “is_link_modified”:“$is_link_modified”, “link_modified_percentage”:“$link_modified_percentage”} ] “ }

JSON Format

Attribute	Type	Description
monitorId	string	Unique ID of the monitor.
defaced_links_count	int	The number of defaced links in the current monitor.
links_count	int	The number of links in the current monitor.
display_name	string	Name of the monitor.
url	string	URL provided for the monitoring.
status	int	Status of the monitor
links	JSON array	It contains the time at which the links in the monitor were modified and the percentage of modification.

Log Report

Retrieve the log report for the monitor by a single day or over a period.

Log Report By Date

Retrieve log details of the monitor for the given date.
Log reports for the past 30 days alone can be accessed.

GET /reports/log_reports/{monitor_id}?date={yyyy-mm-dd}

Request Example

$ curl "https://www.site24x7.com/api/reports/log_reports/726000000002465?date=2015-02-08" \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": {
    "monitor_id": "726000000002465",
    "report": {
      "availability": "1",
      "collectiontime": "2015-01-11T12:00:00-0700",
      "connection_time": "268",
      "dns_time": "10",
      "ssl_time": "350"
      "response_time": "951",
      "response_code": "200",
      "content_length": "12900",
      "location_id": "1",
      "nameserver":"156.154.67.90",
      "resolved_ip":"127.0.0.1",
      "reason": "The String \"My Bills\" is not available in response."
    }
  }
}

oauthscope : Site24x7.Reports.Read

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
date	string	Mandatory Format - yyyy-mm-dd Choose the date for which you want to generate the log report.

Response Attributes

Attribute	Type	Description
connection_time	string	The time taken for a TCP connection to be established with the server.
dns_time	string	The time taken to resolve the given domain name.
ssl_time	string	The time taken for an SSL handshake with the server.
response_code	string	HTTP status code received from the server in response to the client’s request.
collection_time	string	Time stamp at which the resource was collected for monitoring.
availability	string	The availability status of the monitor.
response_time	string	The total time taken by a web server to send the first response to the browser. It is the sum of TCP connection time, DNS time and SSL handshake time.
location_id	string	The global location from which monitoring is done.
nameserver	string	The authoritative name server IP used for monitoring.
resolved_ip	string	The resolved IP which is used for monitoring.
reason	string	The reason for the Down or Trouble status of the monitor.
content_length	string	The length of the content obtained from the server’s response.

Log Report By Period

Retrieve log details of the monitor for a range of dates.
Log reports for the past 30 days alone can be accessed.

GET /reports/log_reports/{monitor_id}?start_date={yyyy-mm-dd}&end_date={yyyy-mm-dd}

Request Example

$ curl "https://www.site24x7.com/api/reports/log_reports/726000000002465?start_date=2015-02-08&end_date=2015-02-20" \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": {
    "monitor_id": "726000000002465",
    "report": [{
      "availability": "1",
      "collectiontime": "2015-01-11T12:00:00-0700",
      "connection_time": "268",
      "dns_time": "10",
      "ssl_time": "300"
      "response_time": "951",
      "response_code": "200",
      "content_length": "12900",
      "location_id": "1",
      "nameserver":"156.154.67.90",
      "resolved_ip":"127.0.0.1",
      "reason": "The String \"My Bills\" is not available in response."
    },
    {
      "availability": "1",
      "collectiontime": "2015-01-11T12:05:00-0700",
      "connection_time": "250",
      "dns_time": "11",
      "ssl_time": "250"
      "response_time": "900",
      "response_code": "200",
      "content_length": "12900",
      "location_id": "1",
      "nameserver":"156.154.67.90",
      "resolved_ip":"127.0.0.1",
      "reason": "The String \"My Bills\" is not available in response."
    }]
  }
}

oauthscope : Site24x7.Reports.Read

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
start_date	string	Mandatory Format - yyyy-mm-dd Choose the date from which you want to generate the log report.
end_date	string	Mandatory Format - yyyy-mm-dd Choose the date up to which you want to generate the log report.

Response Attributes

Attribute	Type	Description
connection_time	string	The time taken for a TCP connection to be established with the server.
dns_time	string	The time taken to resolve the given domain name.
ssl_time	string	The time taken for an SSL handshake with the server.
response_code	string	HTTP status code received from the server in response to the client’s request.
collection_time	string	Time stamp at which the resource was collected for monitoring.
availability	string	The availability status of the monitor.
response_time	string	The total time taken by a web server to send the first response to the browser. It is the sum of TCP connection time, DNS time and SSL handshake time.
location_id	string	The global location from which monitoring is done.
nameserver	string	The authoritative name server IP used for monitoring.
resolved_ip	string	The resolved IP which is used for monitoring.
reason	string	The reason for the Down or Trouble status of the monitor.
content_length	string	The length of the content obtained from the server’s response.

RCA Report

GET /monitors/rca/{monitor_id}?downtime={down_time}&is_raw_data={true or false}

Request Example

$ curl "https://www.site24x7.com/api/monitors/rca/5000000002008?downtime=1446619608001&is_raw_data=true" \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": {
    "website": "http://zohocorp.com",
    "outage_id": "1446619608001",
    "location_name": "Chennai",
    "downtime_start": "2015-11-03T22:46:48-0800",
    "downtime_end": "2015-11-04T01:05:32-0800",
    "location_id": "15",
    "status": 2,
    "mtr_net_path": {
      "nodes": [
            {
              "nodeName": "Chennai",
              "response": true,
              "nodeIp": "121.244.91.46",
              "metrics": {
                "Chennai": {
                  "worstRtt": "0",
                  "hopCount": "0",
                  "lossPercentage": "0.0%",
                  "bestRtt": "0",
                  "packetsSent": "0",
                  "averageRtt": "0",
                  "lastRtt": "0",
                  "standardDeviation": "0"
                }
              },
              "source": true,
              "nodeASN": "4755",
              "nodeId": "1",
              "group": "Chennai"
            },
            {
              "nodeName": "Internal",
              "response": true,
              "nodeIp": "Internal",
              "metrics": {
                "Chennai": {
                  "worstRtt": "16.7",
                  "hopCount": "  1",
                  "lossPercentage": "0.0%",
                  "bestRtt": "0.9",
                  "packetsSent": "10",
                  "averageRtt": "5.5",
                  "lastRtt": "0.9",
                  "standardDeviation": "5.2"
                }
              },
              "nodeId": "2",
              "group": "Chennai"
            }
        ],
        "links": [
            {
              "targetName": "Internal",
              "linkId": 1,
              "linkDelay": {
                "Chennai": "2.75"
              },
              "source": "1",
              "sourceName": "Chennai",
              "group": "Chennai",
              "target": "2"
            }
        ]
    },
    "ideal_mtr_net_path": {
      "nodes": [
            {
              "nodeName": "Chennai",
              "response": true,
              "nodeIp": "121.244.91.46",
              "metrics": {
                "Chennai": {
                  "worstRtt": "0",
                  "hopCount": "0",
                  "lossPercentage": "0.0%",
                  "bestRtt": "0",
                  "packetsSent": "0",
                  "averageRtt": "0",
                  "lastRtt": "0",
                  "standardDeviation": "0"
                }
              },
              "source": true,
              "nodeASN": "4755",
              "nodeId": "1",
              "group": "Chennai"
            },
            {
              "nodeName": "Internal",
              "response": true,
              "nodeIp": "Internal",
              "metrics": {
                "Chennai": {
                  "worstRtt": "16.7",
                  "hopCount": "  1",
                  "lossPercentage": "0.0%",
                  "bestRtt": "0.9",
                  "packetsSent": "10",
                  "averageRtt": "5.5",
                  "lastRtt": "0.9",
                  "standardDeviation": "5.2"
                }
              },
              "nodeId": "2",
              "group": "Chennai"
            }
        ],
        "links": [
            {
              "targetName": "Internal",
              "linkId": 1,
              "linkDelay": {
                "Chennai": "2.75"
              },
              "source": "1",
              "sourceName": "Chennai",
              "group": "Chennai",
              "target": "2"
            }
        ]
    },
    "location_status": [
      {
        "urlDetails": [
            {
                "response_header": "<br/>HTTP/1.1 200 OK<br/>Date : Thu, 02 Sep 2021 07:48:58 GMT<br/>Server : Apache<br/>Last-Modified : Tue, 10 Aug 2021 11:22:09 GMT<br/>Accept-Ranges : bytes<br/>Content-Length : 29802<br/>Connection : close<br/>Content-Type : text/html; charset=UTF-8<br/>",
                "resolved_ip": "192.168.100.100",
                "request_header": "<br/>GET / HTTP/1.1<br/>User-Agent : Site24x7<br/>Cache-Control : no-cache<br/>Accept : */*<br/>Connection : Keep-Alive<br/>Accept-Encoding : gzip<br/>Host : ***<br/>",
                "is_pre_rca": false,
                "index": 0,
                "response_time": 54,
                "urlid": "1000000054001",
                "display_name": "Step - 1",
                "is_html_rca": false,
                "status": 1
            },
            {
                "response_header": "",
                "resolved_ip": "192.168.100.100",
                "request_header": "",
                "is_pre_rca": false,
                "index": 1,
                "response_time": "-",
                "urlid": "1000000054005",
                "display_name": "Step - 2",
                "is_html_rca": false,
                "status": 0
            }
        ],
        "status": 1,
        "downtime": "1446619608001",
        "resolved_ip": "192.168.100.100",
        "reason": "The String \"exception\" is not present in the response\nThe String \"zoho\" is present in the response",
        "location_name": "California",
        "location_id": "1",
        "response_code": 200
      },
      {
        "status": 1,
        "downtime": "1446619608001",
        "resolved_ip": "74.201.113.154",
        "reason": "The String \"exception\" is not present in the response\nThe String \"zoho\" is present in the response",
        "location_name": "Chennai",
        "location_id": "15",
        "response_code": 200
      },
      {
        "status": 1,
        "downtime": "1446619608001",
        "resolved_ip": "74.201.113.154",
        "reason": "The String \"exception\" is not present in the response\nThe String \"zoho\" is present in the response",
        "location_name": "Virginia",
        "location_id": "19",
        "response_code": 200
      }
    ],
    "previous_polls": {
     "report":[
           {
                "availability": "1",
                "collection_time": "2015-01-11T12:00:00-0700",
                "connection_time": "245",
                "content_length": "60686",
                "dns_time": "1",
                "location_id": "1",
                "location_name": "San Francisco - US",
                "reason": "-",
                "nameserver":"156.154.67.90",
                "resolved_ip": "127.0.0.1",
                "response_code": "200",
                "response_time": "1756"
          }
        ]
     },
    "reason": "The String \"exception\" is not present in the response\nThe String \"zoho\" is present in the response",
    "html_file": "https://manivarman-0566.csez.zohocorpin.com:8443/app/responsecontent/neICjrQtNhKxSNSBdyQfGjsMai+8FUnYd+Bg4Ih44qhGZzHUY7ZhUyBGdlurlGzDl1T8p0Jb4FK1\nQB/s3ENWHzPp15MhORdS4lspI5t4p8squbA5IgQyFmNzDd44gb7Mp5yWjg0UOBe+lnKHH8cMbjHR\nvoXxvdHJ5nfq61Tu4YQ=",
    "type": "URL",
    "display_name": "Website-zohocorp.com",
    "monitor_id": "5000000002008",
    "down_duration": "2 Hrs 19 Mins "
  }
}

Retrieve Root Cause Analysis report of your configured monitor.

oauthscope : Site24x7.Admin.Read

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
downtime	string	Outage ID
is_raw_data	boolean	This is set as true by default

Response Parameters

Attribute	Type	Description
website	string	URL for which the RCA is generated.
outage_id	long	The time at which the RCA was generated.
location_name	string	Location at which the outage occured.
downtime_start	string	Human readable down start time.
downtime_end	string	Human readable down end time.
location_id	string	Location ID at which the outage occured.
status	int	Status of the Monitor
location_status	JSON array	Status of each of the configured locations. JSON Format: {“status”:Status of the monitor from a particular location,“ downtime”:“$downtime in milliseconds”, “resolved_ip”:“$resolved_ip”, “reason”:“$reason”, “location_name”:“$location_name”, “location_id”:“$location_id”, “response_code”:“$response_code”, “urlDetails” : $urlDetails$urlDetails}
previous_polls	JSON	Previous poll reports from each of the configured locations.
reason	string	Cause of the outage.
type	string	Type of the monitor.
display_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.
down_duration	string	Duration for which the monitor was down.
image_file	string	Link to view the screenshot
location_rca_details	JSON array	Contains rca for each location. JSON Format: {“locationName”:“$location_name”, “raw_dns”:{“isDNSFileExists”:true/false}, “conclusion”:“$conclusion”}
mtr_net_path	json	Contains nodes, links, latency, and other metric details on the current network route. JSON Format: {“nodes”:“$nodes”, “links”:“$links”}
ideal_mtr_net_path	json	Contains nodes, links, latency, and other metric details on the last successful network route. JSON Format: {“nodes”:“$nodes”, “links”:“$links”}
domain_name	string	Name of the domain
isRawData	boolean	True if is_raw_data is set as true

JSON Format

Attribute	Type	Description
nodes	JSON Array	List of nodes for constructing the network route.
links	JSON Array	List of sources and targets for linking the nodes in the network route.
urlDetails	JSON Array	Step information. JSON Format: {“response_header”: “”, “resolved_ip”: “$resolved_ip”, “request_header”: “$request_header”, “is_pre_rca”: $is_pre_rca, “index”: $index, “response_time”: “$response_time”, “urlid”: “$urlid”, “display_name”: “$display_name”, “is_html_rca”: $is_html_rca, “status”: $status, “html_file”, “$html_file”}

Monitor Groups

Monitor Groups help you organize resources (Monitors) by business application, geography, type or resource ownership. Its a handy concept for easy administration.

Note : API Version has to be passed as “2.1” in the Accept header for the Monitor Group’s APIs.

e.g., Accept: application/json; version=2.1

Create Monitor Group

POST /monitor_groups

Request Example

$ curl https://www.site24x7.com/api/monitor_groups \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Accept: application/json; version=2.1" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \
    -d '{
    "display_name": "Group1",
    "description": "Group all IDC monitors.",
    "monitors": [
        "726000000002460",
        "726000000002464"
    ],
    "dependency_resource_ids":[
        "726000000002468",
        "726000000002472"
    ]
}'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": {
    "group_id": "113770000041271035",
    "display_name": "Group1",
    "description": "Group all IDC monitors.",
    "monitors": [
      "726000000002460",
      "726000000002464"
    ],
    "selection_type": "",
    "dependency_resource_ids":[
        "726000000002468",
        "726000000002472"
    ],
    "suppress_alert": "",
    "health_threshold_count": 1
  }
}

Create a new Monitor Group.

oauthscope : Site24x7.Admin.Create

Request Parameters

Param	Type	Description
display_name	string	Mandatory Display Name for the Monitor Group.
description	string	Description for the Monitor Group.
monitors	array	Monitors to be associated to the group.
health_threshold_count	int	Number of monitors' health that decide the group status. ‘0’ implies that all the monitors are considered for determining the group status. Default value is 1
dependency_resource_ids	array	Suppress alert when dependent monitor(s) is down
suppress_alert	boolean	Suppress alert when dependent monitor is down

Response Attributes

Attribute	Type	Description
group_id	string	Unique ID generated by the server. This can be used as an identifier.
display_name	string	Display Name for the Monitor Group.
description	string	Description for the Monitor Group.
monitors	array	Monitors to be associated to the group.
health_threshold_count	int	Number of monitors' health that decide the group status. ‘0’ implies that all the monitors are considered for determining the group status. Default value is 1
dependency_resource_ids	array	Suppress alert when dependent monitor(s) is down
suppress_alert	boolean	Suppress alert when dependent monitor is down

Retrieve Monitor Group

GET /monitor_groups/{group_id}

Request Example

$ curl https://www.site24x7.com/api/monitor_groups/113770000041271035 \
    -H "Accept: application/json; version=2.1" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": {
    "group_id": "113770000041271035",
    "display_name": "Group1",
    "description": "Group all IDC monitors.",
    "monitors": [
      "726000000002460",
      "726000000002464"
    ],
    "selection_type": "",
    "dependency_resource_ids":[
        "726000000002468",
        "726000000002472"
    ],
    "suppress_alert": "",
    "health_threshold_count": 1
  }
}

Retrieve details for an existing monitor group.

oauthscope : Site24x7.Admin.Read

Path Parameters

Param	Type	Description
group_id	string	Mandatory Unique ID generated by the server. This can be used as an identifier.

Response Attributes

Attribute	Type	Description
group_id	string	Unique ID generated by the server. This can be used as an identifier.
display_name	string	Display Name for the Monitor Group.
description	string	Description for the Monitor Group.
monitors	array	Monitors to be associated to the group.
health_threshold_count	int	Number of monitors' health that decide the group status. ‘0’ implies that all the monitors are considered for determining the group status. Default value is 1
dependency_resource_ids	array	Suppress alert when dependent monitor(s) is down
suppress_alert	boolean	Suppress alert when dependent monitor is down

Update Monitor Group

PUT /monitor_groups/{group_id}

Request Example

$ curl https://www.site24x7.com/api/monitor_groups/113770000041271035 \
    -X PUT \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Accept: application/json; version=2.1" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \
    -d '{
        "display_name": "Group1",
        "description": "Group all IDC monitors.",
        "monitors": [
          "726000000002464",
          "726000000002464",
          "726000000002466"
        ],
        "selection_type": 2,
        "dependency_resource_ids":[
        "726000000002468",
        "726000000002472"
        ],
        "suppress_alert": true,
        "health_threshold_count": 2
      }'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": {
    "group_id": "113770000041271035",
    "display_name": "Group1",
    "description": "Group all IDC monitors.",
    "monitors": [
      "726000000002464",
      "726000000002464",
      "726000000002466"
    ],
    "selection_type": 2,
    "dependency_resource_ids":[
        "726000000002468",
        "726000000002472"
    ],
    "suppress_alert": true,
    "health_threshold_count": 2
  }
}

Update an existing Monitor Group.

oauthscope : Site24x7.Admin.Update

Path Parameters

Param	Type	Description
group_id	string	Mandatory Unique ID generated by the server. This can be used as an identifier.

Request Parameters

Param	Type	Description
display_name	string	Mandatory Display Name for the Monitor Group.
description	string	Description for the Monitor Group.
monitors	array	Monitors to be associated to the group.
health_threshold_count	int	Number of monitors' health that decide the group status. ‘0’ implies that all the monitors are considered for determining the group status. Default value is 1
dependency_resource_ids	array	Suppress alert when dependent monitor(s) is down
suppress_alert	boolean	Suppress alert when dependent monitor is down

Response Attributes

Attribute	Type	Description
group_id	string	Unique ID generated by the server. This can be used as an identifier.
display_name	string	Display Name for the Monitor Group.
description	string	Description for the Monitor Group.
monitors	array	Monitors to be associated to the group.
health_threshold_count	int	Number of monitors' health that decide the group status. ‘0’ implies that all the monitors are considered for determining the group status. Default value is 1
dependency_resource_ids	array	Suppress alert when dependent monitor(s) is down
suppress_alert	boolean	Suppress alert when dependent monitor is down

Delete Monitor Group

DELETE /monitor_groups/{group_id}

Request Example

$ curl https://www.site24x7.com/api/monitor_groups/113770000041271035 \
    -X DELETE \
    -H "Accept: application/json; version=2.1" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

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

Delete an existing Monitor Group.

oauthscope : Site24x7.Admin.Delete

Path Parameters

Param	Type	Description
group_id	string	Mandatory Unique ID generated by the server. This can be used as an identifier.

List of all Monitor Groups

GET /monitor_groups

Request Example

$ curl https://www.site24x7.com/api/monitor_groups \
    -H "Accept: application/json; version=2.1" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": [{
    "group_id": "113770000041271035",
    "display_name": "Group1",
    "description": "Group all IDC monitors.",
    "group_type": 1
    "monitors": [
      "726000000002464",
      "726000000002464",
      "726000000002466"
    ],
    "selection_type": 2,
    "dependency_resource_ids":[
        "726000000002468",
        "726000000002472"
    ],
    "suppress_alert": true,
    "health_threshold_count": 2,
    "tags": [
      "726000000003674"
    ]
  }]
}

List of all Monitor Groups.

oauthscope : Site24x7.Admin.Read

Query Parameters

Attribute	Type	Description
subgroup_required	boolean	Fetches the subgroups associated with the corresponding monitor group, when set as true. Default value is false.

Response Attributes

Attribute	Type	Description
group_id	string	Unique ID generated by the server. This can be used as an identifier.
display_name	string	Display Name for the Monitor Group.
description	string	Description for the Monitor Group.
monitors	array	Monitors to be associated to the group.
health_threshold_count	int	The health of the number of monitors that decide the group status. ‘0’ implies that all the monitors are considered for determining the group status. Default value is 1
dependency_resource_ids	array	Suppress alert when dependent monitor(s) is down
suppress_alert	boolean	Suppress alert when dependent monitor is down
group_type	int	Specifies the Monitor Type associated with the group. This parameter will not be present when subgroups are fetched.
type	int	Resource Type of the group. This parameter will be present when subgroups are fetched.
tags	array	Array containg the list of associated tags.
subgroups	JSON Array	Array containing subgroup objects. JSON Format:{group_id:“$group_id”, health_threshold_count:“$health_threshold_count”, display_name:“$display_name”, description:“$description”, type:“$type”, monitors:“$monitors”}

JSON Format

Attribute	Type	Description
group_id	string	Unique ID generated by the server. This can be used as an identifier for the Subgroup.
display_name	string	Display Name for the Subgroup.
description	string	Description for the Subgroup.
monitors	array	Monitors associated with the Subgroup.
health_threshold_count	int	Number of monitors' health that decide the group status. ‘0’ implies that all the monitors are considered for determining the group status. Default value is 1
type	int	Resource Type of the group.

Update Monitor Group using monitor IDs

PUT /monitor_groups/add_monitors

Request Example

$ curl https://www.site24x7.com/api/monitor_groups/add_monitors \
    -X PUT \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \
    -d '{
        "group_id":1000000380011,
        "monitor_ids": [
          "1000000255542"
        ]
    }'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": {
    "group_id": "1000000452001",
    "monitor_ids": [
       "1000000123001"
    ]
  }
}

Update an existing Monitor Group without sending the complete list of the monitor IDs.

oauthscope : Site24x7.Admin.Update

Request Parameters

Param	Type	Description
group_id	string	Unique ID generated by the server. This can be used as an identifier.
monitor_ids	array	Monitors to be associated with the group.

Response Attributes

Attribute	Type	Description
group_id	string	Unique ID generated by the server. This can be used as an identifier.
monitor_ids	array	Monitors that are associated with a group.

Update Monitor Group using monitor Names

PUT /monitor_groups/add_monitors/name

Request Example

$ curl https://www.site24x7.com/api/monitor_groups/add_monitors/name \
    -X PUT \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \
    -d '{
        "group_name":"API - Group 1",
        "monitor_names": [
          "AlfaRomeo"
        ]
    }'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": {
    "group_name":"API - Group 1",
    "monitor_names": [
       "AlfaRomeo"
    ]
  }
}

Update an existing Monitor Group without sending the complete list of monitor names.

oauthscope : Site24x7.Admin.Update

Request Parameters

Param	Type	Description
group_name	string	Name of monitor group.
monitor_names	array	Monitors to be associated with the group.

Response Attributes

Attribute	Type	Description
group_name	string	Name of monitor group.
monitor_names	array	Monitors that are associated with a group.

Subgroups

Subgroups help you revisualize the high level architecture of your monitor group in a business view inside the web client. Create nested subgroups under your monitor group. Its a handy concept for easy administration. Know more.

Create Subgroup

POST /subgroups

Request Example

$ curl https://www.site24x7.com/api/subgroups \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \
    -d '{
    "display_name": "Subgroup1",
    "description": "Group all IDC monitors.",
    "monitors": [
        "726000000002460",
        "726000000002464"
    ],
    "top_group_id":"113770000041212365",
    "parent_group_id":"11377000004143454"
}'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": {
    "group_id": "113770000041271035",
    "display_name": "Subgroup1",
    "description": "Group all IDC monitors.",
    "monitors": [
      "726000000002460",
      "726000000002464"
    ],
    "health_threshold_count": 1,
    "top_group_id":"113770000041212365",
    "parent_group_id":"11377000004143454"
  }
}

Create a new Subgroup.

oauthscope : Site24x7.Admin.Create

Request Parameters

Param	Type	Description
display_name	string	Mandatory Display Name for the Subgroup.
description	string	Description for the Subgroup.
monitors	array	Monitors to be associated to the group.
health_threshold_count	int	Number of monitors health that decide the group status. ‘0’ implies that all the monitors are considered for determining the group status. Default value is 1.
top_group_id	string	Unique ID of the top monitor group for which business view has been configured.
parent_group_id	string	Unique ID of the parent group under which subgroup has to be configured. It can be a subgroup or Monitor group. (In case of level 1 subgroup, top_group_id is monitor group id. In other cases it will be subgroup id. You can get the subgroup Ids configured for top_group_id by using business view API).

Response Attributes

Attribute	Type	Description
group_id	string	Unique ID generated by the server. This can be used as an identifier.
display_name	string	Display Name for the Subgroup.
description	string	Description for the Subgroup.
monitors	array	Monitors to be associated to the group.
health_threshold_count	int	Number of monitors' health that decide the group status. ‘0’ implies that all the monitors are considered for determining the group status. Default value is 1.
top_group_id	string	Unique ID of the top monitor group for which business view has been configured.
parent_group_id	string	Unique ID of the parent group under which subgroup is configured. It can be a subgroup or Monitor group. (In case of level 1 subgroup, top_group_id is monitor group id. In other cases it will be subgroup id)

Retrieve Subgroup

GET /subgroups/{group_id}

Request Example

$ curl https://www.site24x7.com/api/subgroups/113770000041271035 \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": {
    "group_id": "113770000041271035",
    "display_name": "Subgroup1",
    "description": "Group all IDC monitors.",
    "monitors": [
      "726000000002460",
      "726000000002464"
    ],
    "health_threshold_count": 1,
    "top_group_id":"113770000041212365",
    "parent_group_id":"11377000004143454"
  }
}

Retrieve details for an existing subgroup.

oauthscope : Site24x7.Admin.Read

Path Parameters

Param	Type	Description
group_id	string	Mandatory Unique ID generated by the server. This can be used as an identifier. This id can be found in business view API under subgroups attribute.

Response Attributes

Attribute	Type	Description
group_id	string	Unique ID generated by the server. This can be used as an identifier.
display_name	string	Display Name for the Subgroup.
description	string	Description for the Subgroup.
monitors	array	Monitors to be associated to the group.
health_threshold_count	int	Number of monitors' health that decide the group status. ‘0’ implies that all the monitors are considered for determining the group status. Default value is 1.
top_group_id	string	Unique ID of the top monitor group for which business view has been configured.
parent_group_id	string	Unique ID of the parent group under which subgroup is configured. It can be a subgroup or Monitor group. (In case of level 1 subgroup, top_group_id is monitor group id. In other cases it will be subgroup id)

Update Subgroup

PUT /subgroups/{group_id}

Request Example

$ curl https://www.site24x7.com/api/subgroups/113770000041271035 \
    -X PUT \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \
    -d '{
        "display_name": "Subgroup1",
        "description": "Group all IDC monitors.",
        "monitors": [
          "726000000002464",
          "726000000002464",
          "726000000002466"
        ],
        "health_threshold_count": 2,
        "top_group_id":"113770000041212365",
        "parent_group_id":"11377000004143454"
      }'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": {
    "group_id": "113770000041271035",
    "display_name": "Subgroup1",
    "description": "Group all IDC monitors.",
    "monitors": [
      "726000000002464",
      "726000000002464",
      "726000000002466"
    ],
    "health_threshold_count": 2,
    "top_group_id":"113770000041212365",
    "parent_group_id":"11377000004143454"
  }
}

Update an existing Subgroup.

oauthscope : Site24x7.Admin.Update

Path Parameters

Param	Type	Description
group_id	string	Mandatory Unique ID generated by the server. This can be used as an identifier. This can be used as an identifier. This id can be found in business view API under subgroups attribute

Request Parameters

Param	Type	Description
display_name	string	Mandatory Display Name for the Subgroup.
description	string	Description for the Subgroup.
monitors	array	Monitors to be associated to the group.
health_threshold_count	int	Number of monitors' health that decide the group status. ‘0’ implies that all the monitors are considered for determining the group status. Default value is 1.
top_group_id	string	Unique ID of the top monitor group for which business view has been configured.
parent_group_id	string	Unique ID of the parent group under which subgroup has to be configured. It can be a subgroup or Monitor group. (In case of level 1 subgroup, top_group_id is monitor group id. In other cases it will be subgroup id. You can get the subgroup Ids configured for top_group_id by using business view API).

Response Attributes

Attribute	Type	Description
group_id	string	Unique ID generated by the server. This can be used as an identifier.
display_name	string	Display Name for the Subgroup.
description	string	Description for the Subgroup.
monitors	array	Monitors to be associated to the group.
health_threshold_count	int	Number of monitors' health that decide the group status. ‘0’ implies that all the monitors are considered for determining the group status. Default value is 1.
top_group_id	string	Unique ID of the top monitor group for which business view has been configured.
parent_group_id	string	Unique ID of the parent group under which subgroup is configured. It can be a subgroup or Monitor group. (In case of level 1 subgroup, top_group_id is monitor group id. In other cases it will be subgroup id)

Delete Subgroup

DELETE /subgroups/{group_id}

Request Example

$ curl https://www.site24x7.com/api/subgroups/113770000041271035 \
    -X DELETE \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

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

Delete an existing subgroup.

oauthscope : Site24x7.Admin.Delete

Path Parameters

Param	Type	Description
group_id	string	Mandatory Unique ID generated by the server. This can be used as an identifier. This can be used as an identifier. This id can be found in business view API under subgroups attribute

Business View

Access Business View as part of the Monitor Group Details page. With business view, quickly gain attention about any unusual patterns in your Monitor Group and its associated subgroups with a bird’s-eye view of your infrastructure. Tell me more about business view.

Retrieve Business View

GET /monitor_group_view/{group_id}

Request Example

$ curl https://www.site24x7.com/api/monitor_group_view/113770000041271035 \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": {
    "group_id": "165519000011756001",
    "group_name": "Group 1",
    "description": "Monitor Group",
    "group_status": 0,
    "type": 0,
    "monitors": [
      {
        "monitor_id": "1655190000001285",
        "monitor_type": "SOAP",
        "monitor_name": "soap",
        "status": 1
      },
      {
        "monitor_id": "165519000002035011",
        "monitor_type": "URL",
        "monitor_name": "Website-site24x7.com",
        "status": 1
      },
      {
        "monitor_id": "165519000012095079",
        "monitor_type": "SOAP",
        "monitor_name": "soap",
        "status": 1
      }
    ],
    "subgroups": [
      {
        "group_id": "165519000034507008",
        "group_name": "subgroup 1",
        "description": "Level 1",
        "group_status": 1,
        "type": 1,
        "monitors": [
          {
            "monitor_id": "165519000004424013",
            "monitor_type": "HOMEPAGE",
            "monitor_name": "Homepage-site24x7.com",
            "status": 1
          },
          {
            "monitor_id": "165519000005210003",
            "monitor_type": "HOMEPAGE",
            "monitor_name": "Homepage-site24x7.com",
            "status": 1
          }
        ],
        "subgroups": [
          {
            "group_id": "165519000034507010",
            "group_name": "subgroup 2",
            "description": "Level 2",
            "group_status": 2,
            "type": 1,
            "monitors": [
              {
                "monitor_id": "165519000003077003",
                "monitor_type": "HOMEPAGE",
                "monitor_name": "Homepage-site24x7.com",
                "status": 2
              },
              {
                "monitor_id": "165519000009173077",
                "monitor_type": "HOMEPAGE",
                "monitor_name": "Homepage-site24x7.com",
                "status": 1
              }
            ],
            "subgroups": [
              {
                "group_id": "165519000034507012",
                "group_name": "subgroup 3",
                "description": "Level 3",
                "group_status": 1,
                "type": 1,
                "monitors": [
                  {
                    "monitor_id": "165519000004424013",
                    "monitor_type": "HOMEPAGE",
                    "monitor_name": "Homepage-site24x7.com",
                    "status": 1
                  },
                  {
                    "monitor_id": "165519000005210003",
                    "monitor_type": "HOMEPAGE",
                    "monitor_name": "Homepage-site24x7.com",
                    "status": 1
                  }
                ]
              }
            ]
          }
        ]
      },
      {
        "group_id": "165519000034507014",
        "group_name": "subgroup 11",
        "description": "Level 1",
        "group_status": 1,
        "type": 1,
        "monitors": [
          {
            "monitor_id": "165519000000737078",
            "monitor_type": "PORT-POP",
            "monitor_name": "POP monitoring",
            "status": 1
          },
          {
            "monitor_id": "165519000000737131",
            "monitor_type": "PING",
            "monitor_name": "ping monitoring()",
            "status": 1
          }
        ],
        "subgroups": [
          {
            "group_id": "165519000034507016",
            "group_name": "subgroup 22",
            "description": "Level 2",
            "group_status": 2,
            "type": 1,
            "monitors": [
              {
                "monitor_id": "165519000004045296",
                "monitor_type": "URL",
                "monitor_name": "Website-site24x7.com",
                "status": 2
              },
              {
                "monitor_id": "165519000004384001",
                "monitor_type": "URL",
                "monitor_name": "Website-site24x7.com",
                "status": 1
              }
            ]
          },
          {
            "group_id": "165519000034507018",
            "group_name": "subgroup 33",
            "description": "Level 2",
            "group_status": 1,
            "type": 1,
            "monitors": [
              {
                "monitor_id": "165519000004384001",
                "monitor_type": "URL",
                "monitor_name": "Website-site24x7.com",
                "status": 1
              },
              {
                "monitor_id": "165519000005210029",
                "monitor_type": "URL",
                "monitor_name": "Website-site24x7.com",
                "status": 1
              },
              {
                "monitor_id": "165519000013799049",
                "monitor_type": "URL",
                "monitor_name": "Website-site24x7.com",
                "status": 1
              }
            ]
          }
        ]
      }
    ]
  }
}

Retrieve details of existing monitor group along with subgroups that are configured to it.

oauthscope : Site24x7.Admin.Read

Path Parameters

Param	Type	Description
group_id	string	Mandatory Unique ID generated by the server. This can be used as an identifier.

Response Attributes

Attribute	Type	Description
group_id	string	Unique ID generated by the server. This can be used as an identifier.
group_name	string	Display Name of the group.
description	string	Description for the group.
group_status	int	Status of a group.
type	int	Type of the group.
monitors	array	Monitors associated to the group.
monitor_name	string	Name of the monitor.
monitor_id	string	Unique ID used to identify the monitor. Use the list monitor API to obtain your monitor’s unique monitor ID.
monitor_type	string	Type of the monitor.
status	int	Identify the operational status of the monitor.
subgroups	JSON array	Details of subgroups associated to the group. Group may be a monitor group or subgroup.

Users

Setup other users who can login to Site24x7 and receive instant notifications about outages.

Create new user

POST /users

Request Example

$ curl https://www.site24x7.com/api/users \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \
    -d '{
            "user_role":1,
            "statusiq_role":21,
            "cloudspend_role":11,
            "job_title": 3,
            "mobile_settings":{
                "country_code":1,
                "mobile_number":3547658910
            },
            "user_groups":["152798000075327023"],
            "alert_settings":{
                "email_format":0,
                "dont_alert_on_days":[1],
                "alerting_period":{
                    "start_time":"4:30",
                    "end_time":"20:15"
                },
                "down":[1,2,3],
                "trouble":[1,2,3],
                "up":[1,2,3],
                "applogs":[1,2,3],
                "anomaly":[1]
            },
            "display_name":"user name",
            "email_address":"example@abc.com",
            "notify_medium":[1,2,3]
      }'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": {
    "image_present": false,
    "twitter_settings": {},
    "selection_type": 0,
    "email_address": "example@abc.com",
    "is_account_contact": false,
    "is_contact": false,
    "alert_settings": {
      "trouble": [
        1,
        2,
        3
      ],
      "up": [
        1,
        2,
        3
      ],
      "dont_alert_on_days": [
        1
      ],
      "email_format": 0,
      "alerting_period": {
        "end_time": "20:15",
        "start_time": "04:30"
      },
      "down": [
        1,
        2,
        3
      ],
      "applogs":[
        1,
        2,
        3
      ],
      "anomaly": [
        1
      ]      
    },
    "user_groups": [
      "113770000014101149"
    ],
    "is_invited": false,
    "notify_medium": [
      1,
      2,
      3
    ],
    "is_edit_allowed": true,
    "display_name": "user name",
    "user_id": "113770000041267039",
    "mobile_settings": {
      "country_code": "1",
      "sms_provider_id": 1,
      "mobile_number": "3547658910",
      "call_provider_id": 0
    },
    "user_role": 1,
    "statusiq_role": 21,
    "cloudspend_role": 11,
    "job_title": 3,
    "zuid" : "65478659"
  }
}

Create a new user.

oauthscope : Site24x7.Account.Create

Request Parameters

Param	Type	Description
display_name	string	Mandatory Name of the User.
email_address	string	Mandatory Email address of the user.
user_role	int	Mandatory, if user is not present in ORG. Role assigned to the user for accessing Site24x7. Role will be updated only after the user accepts the invitation
statusiq_role	int	Role assigned to the user for accessing StatusIQ. Role will be updated only after the user accepts the invitation
cloudspend_role	int	Role assigned to the user for accessing CloudSpend. Role will be updated only after the user accepts the invitation
notify_medium	array	Mandatory Notify medium to receive alerts.
alert_settings	json	Mandatory Settings for receiving. JSON Format: {email_format:$email_format, dont_alert_on_days:[$day_constants], alerting_period: { start_time : “$hh:mm”, end_time: “$hh:mm”}, down:[ $alerting_mode_constants ], trouble:[ $alerting_mode_constants ], up: [ $alerting_mode_constants ], applogs: [ $alerting_mode_constants ], anomaly: [1]} Only Email alerting is supported for Anomaly IM alerting is not supported for Applogs
job_title	int	Provide your job title to be added in Site24x7.
mobile_settings	json	Phone number configurations to receive alerts. JSON Format: {country_code: $country_code, mobile_number: $mobile_number, sms_provider_id: $sms_providers, call_provider_id: $voice_call_provider}
user_groups	array	Group to be associated for the user for receiving alerts.
selection_type	int	Default value is 0. Resource type associated to this user. Monitors not supported.
consent_for_non_eu_alerts	boolean	Mandatory for EU DC The third-party providers we use to send SMS and voice alerts will process the data outside the EU region. By passing true, you will be confirming your consent to transfer alert-related data.

Response Attributes

Attribute	Type	Description
display_name	string	Name of the User.
email_address	string	Email address of the user.
user_role	int	Role assigned to the user for accessing Site24x7. Role will be updated only after the user accepts the invitation
statusiq_role	int	Role assigned to the user for accessing StatusIQ. Role will be updated only after the user accepts the invitation
cloudspend_role	int	Role assigned to the user for accessing CloudSpend. Role will be updated only after the user accepts the invitation
notify_medium	array	Notify medium to receive alerts.
alert_settings	json	Settings for receiving. JSON Format: {email_format:$email_format, dont_alert_on_days:[$day_constants], alerting_period: { start_time : “$hh:mm”, end_time: “$hh:mm”}, down:[ $alerting_mode_constants ], trouble:[ $alerting_mode_constants ], up: [ $alerting_mode_constants ], applogs: [ $alerting_mode_constants ], anomaly: [1]} Only Email alerting is supported for Anomaly IM alerting is not supported for Applogs
job_title	int	Job title of the user.
mobile_settings	json	Phone number configurations to receive alerts. JSON Format: {country_code: $country_code, mobile_number: $mobile_number, sms_provider_id: $sms_providers, call_provider_id: $voice_call_provider}
user_groups	array	Group to be associated for the user for receiving alerts.
selection_type	int	Default value is 0. Resource type associated to this user. Monitors not supported.
twitter_settings	json	Setting to receive alerts via Twitter.
zuid	String	Unique ID of the user.

Retrieve User

GET /users/{user_id}

Request Example

$ curl https://www.site24x7.com/api/users/152798000075330005 \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": {
    "image_present": false,
    "twitter_settings": {},
    "selection_type": 0,
    "email_address": "example@abc.com",
    "is_account_contact": false,
    "is_contact": false,
    "alert_settings": {
      "trouble": [
        1,
        2,
        3
      ],
      "up": [
        1,
        2,
        3
      ],
      "dont_alert_on_days": [
        1
      ],
      "email_format": 0,
      "alerting_period": {
        "end_time": "20:15",
        "start_time": "04:30"
      },
      "down": [
        1,
        2,
        3
      ],
      "applogs":[
        1,
        2,
        3
      ],
      "anomaly": [
        1
      ]
    },
    "user_groups": [
      "113770000014101149"
    ],
    "is_invited": false,
    "notify_medium": [
      1,
      2,
      3
    ],
    "is_edit_allowed": true,
    "display_name": "user name",
    "user_id": "113770000041267039",
    "mobile_settings": {
      "country_code": "1",
      "sms_provider_id": 1,
      "mobile_number": "3547658910",
      "call_provider_id": 0
    },
    "user_role": 1,
    "statusiq_role": 21,
    "cloudspend_role": 11,
    "job_title": 3,
    "zuid" : "65478659"
  }
}

Retrieve information for an existing user.

oauthscope : Site24x7.Account.Read

Path Parameters

Param	Type	Description
user_id	string	Mandatory Unique ID generated by the server. This can be used as an identifier.

Response Attributes

Attribute	Type	Description
display_name	string	Name of the User.
email_address	string	Email address of the user.
user_role	int	Role assigned to the user for accessing Site24x7. Role will be updated only after the user accepts the invitation
statusiq_role	int	Role assigned to the user for accessing StatusIQ. Role will be updated only after the user accepts the invitation
cloudspend_role	int	Role assigned to the user for accessing CloudSpend. Role will be updated only after the user accepts the invitation
notify_medium	array	Notify medium to receive alerts.
job_title	int	Job title of the user.
alert_settings	json	Settings for receiving. JSON Format: {email_format:$email_format, dont_alert_on_days:[$day_constants], alerting_period: { start_time : “$hh:mm”, end_time: “$hh:mm”}, down:[ $alerting_mode_constants ], trouble:[ $alerting_mode_constants ], up: [ $alerting_mode_constants ], applogs: [ $alerting_mode_constants ], anomaly: [1]} Only Email alerting is supported for Anomaly IM alerting is not supported for Applogs
mobile_settings	json	Phone number configurations to receive alerts. JSON Format: {country_code: $country_code, mobile_number: $mobile_number, sms_provider_id: $sms_providers, call_provider_id: $voice_call_provider}
user_groups	array	Group to be associated for the user for receiving alerts.
selection_type	int	Default value is 0. Resource type associated to this user. Monitors not supported.
twitter_settings	json	Setting to receive alerts via Twitter.
zuid	String	Unique ID of the user.

Update User

PUT /users/{user_id}

Request Example

$ curl https://www.site24x7.com/api/users/113770000041267039 \
    -X PUT \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \
    -d '{
            "user_role":1,
            "statusiq_role": 21,
            "cloudspend_role": 11,
            "job_title": 3,
            "mobile_settings":{
                "country_code":1,
                "mobile_number":3547658910
            },
            "user_groups":["152798000075327023"],
            "alert_settings":{
                "email_format":0,
                "dont_alert_on_days":[1],
                "alerting_period":{
                    "start_time":"4:30",
                    "end_time":"20:15"
                },
                "down":[1,2,3],
                "trouble":[1,2,3],
                "up":[1,2,3],
                "applogs":[1,2,3],
                "anomaly":[1]
            },
            "display_name":"user name",
            "email_address":"example@abc.com",
            "notify_medium":[1,2,3]
      }'

Response Example

HTTP/1.1 200 OK
{
  "code": 0,
  "message": "success",
  "data": {
    "image_present": false,
    "twitter_settings": {},
    "selection_type": 0,
    "email_address": "example@abc.com",
    "is_account_contact": false,
    "is_contact": false,
    "alert_settings": {
      "trouble": [
        1,
        2,
        3
      ],
      "up": [
        1,
        2,
        3
      ],
      "dont_alert_on_days": [
        1
      ],
      "email_format": 0,
      "alerting_period": {
        "end_time": "20:15",
        "start_time": "04:30"
      },
      "down": [
        1,
        2,
        3
      ],
      "applogs":[
        1,
        2,
        3
      ],
      "anomaly": [
        1
      ]
    },
    "user_groups": [
      "113770000014101149"
    ],
    "is_invited": false,
    "notify_medium": [
      1,
      2,
      3
    ],
    "is_edit_allowed": true,
    "display_name": "user name",
    "user_id": "113770000041267039",
    "mobile_settings": {
      "country_code": "1",
      "sms_provider_id": 1,
      "mobile_number": "3547658910",
      "call_provider_id": 0
    },
    "user_role": 1,
    "statusiq_role": 21,
    "cloudspend_role": 11,
    "job_title": 3,
    "zuid" : "65478659"
  }
}

Update an existing User.

oauthscope : Site24x7.Account.Update

Path Parameters

Param	Type	Description
user_id	string	Mandatory Unique ID generated by the server. This can be used as an identifier.

Request Parameters

Param	Type	Description
display_name	string	Mandatory Name of the User.
email_address	string	Mandatory Email address of the user.
user_role	int	Mandatory, if user is not present in ORG. Role assigned to the user for accessing Site24x7. Role will be updated only after the user accepts the invitation
statusiq_role	int	Role assigned to the user for accessing StatusIQ. Role will be updated only after the user accepts the invitation
cloudspend_role	int	Role assigned to the user for accessing CloudSpend. Role will be updated only after the user accepts the invitation
notify_medium	array	Mandatory Notify medium to receive alerts.
alert_settings	json	Mandatory Settings for receiving. JSON Format: {email_format:$email_format, dont_alert_on_days:[$day_constants], alerting_period: { start_time : “$hh:mm”, end_time: “$hh:mm”}, down:[ $alerting_mode_constants ], trouble:[ $alerting_mode_constants ], up: [ $alerting_mode_constants ], applogs: [ $alerting_mode_constants ], anomaly: [1]} Only Email alerting is supported for Anomaly IM alerting is not supported for Applogs
job_title	int	Provide your job title to be added in Site24x7.
mobile_settings	json	Phone number configurations to receive alerts. JSON Format: {country_code: $country_code, mobile_number: $mobile_number, sms_provider_id: $sms_providers, call_provider_id: $voice_call_provider}
user_groups	array	Group to be associated for the user for receiving alerts.
selection_type	int	Default value is 0. Resource type associated to this user. Monitors not supported.
twitter_settings	json	Setting to receive alerts via Twitter.
consent_for_non_eu_alerts	boolean	Mandatory for EU DC, if the mobile number has been updated The third-party providers we use to send SMS and voice alerts will process the data outside the EU region. By passing true, you will be confirming your consent to transfer alert-related data.

Response Attributes

Attribute	Type	Description
user_id	string	Unique ID generated by the server. This can be used as an identifier.
display_name	string	Name of the User.
email_address	string	Email address of the user.
user_role	int	Role assigned to the user for accessing Site24x7. Role will be updated only after the user accepts the invitation
statusiq_role	int	Role assigned to the user for accessing StatusIQ. Role will be updated only after the user accepts the invitation
cloudspend_role	int	Role assigned to the user for accessing CloudSpend. Role will be updated only after the user accepts the invitation
notify_medium	array	Notify medium to receive alerts.
job_title	int	Job title of the user.
alert_settings	json	Settings for receiving. JSON Format: {email_format:$email_format, dont_alert_on_days:[$day_constants], alerting_period: { start_time : “$hh:mm”, end_time: “$hh:mm”}, down:[ $alerting_mode_constants ], trouble:[ $alerting_mode_constants ], up: [ $alerting_mode_constants ], applogs: [ $alerting_mode_constants ], anomaly: [1]} Only Email alerting is supported for Anomaly IM alerting is not supported for Applogs
mobile_settings	json	Phone number configurations to receive alerts. JSON Format: {country_code: $country_code, mobile_number: $mobile_number, sms_provider_id: $sms_providers, call_provider_id: $voice_call_provider}
user_groups	array	Group to be associated for the user for receiving alerts.
selection_type	int	Default value is 0. Resource type associated to this user. Monitors not supported.
twitter_settings	json	Setting to receive alerts via Twitter.
zuid	String	Unique ID of the user.

Delete User

DELETE /users/{user_id}

Request Example

$ curl https://www.site24x7.com/api/users/113770000041267039 \
    -X DELETE \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

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

Delete an existing User.

oauthscope : Site24x7.Account.Delete

Path Parameters

Param	Type	Description
user_id	string	Mandatory Unique ID generated by the server. This can be used as an identifier.

List of all Users

GET /users

Request Example

$ curl https://www.site24x7.com/api/users \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": [{
    "image_present": false,
    "twitter_settings": {},
    "selection_type": 0,
    "email_address": "example@abc.com",
    "is_account_contact": false,
    "is_contact": false,
    "alert_settings": {
      "trouble": [
        1,
        2,
        3
      ],
      "up": [
        1,
        2,
        3
      ],
      "dont_alert_on_days": [
        1
      ],
      "email_format": 0,
      "alerting_period": {
        "end_time": "20:15",
        "start_time": "04:30"
      },
      "down": [
        1,
        2,
        3
      ],
      "applogs":[
        1,
        2,
        3
      ],
      "anomaly": [
        1
      ]
    },
    "user_groups": [
      "113770000014101149"
    ],
    "is_invited": false,
    "notify_medium": [
      1,
      2,
      3
    ],
    "is_edit_allowed": true,
    "display_name": "user name",
    "user_id": "113770000041267039",
    "mobile_settings": {
      "country_code": "1",
      "sms_provider_id": 1,
      "mobile_number": "3547658910",
      "call_provider_id": 0
    },
    "user_role": 1,
    "statusiq_role": 21,
    "cloudspend_role": 11,
    "job_title": 3,
    "zuid" : "65478659"
  }]
}

List of all Users.

oauthscope : Site24x7.Account.Read

Response Attributes

Attribute	Type	Description
user_id	string	Unique ID generated by the server. This can be used as an identifier.
display_name	string	Name of the User.
email_address	string	Email address of the user.
user_role	int	Role assigned to the user for accessing Site24x7. Role will be updated only after the user accepts the invitation
statusiq_role	int	Role assigned to the user for accessing StatusIQ. Role will be updated only after the user accepts the invitation
cloudspend_role	int	Role assigned to the user for accessing CloudSpend. Role will be updated only after the user accepts the invitation
notify_medium	array	Notify medium to receive alerts.
alert_settings	json	Settings for receiving. JSON Format: {email_format:$email_format, dont_alert_on_days:[$day_constants], alerting_period: { start_time : “$hh:mm”, end_time: “$hh:mm”}, down:[ $alerting_mode_constants ], trouble:[ $alerting_mode_constants ], up: [ $alerting_mode_constants ], applogs: [ $alerting_mode_constants ], anomaly: [1]} Only Email alerting is supported for Anomaly IM alerting is not supported for Applogs
job_title	int	Job title of the user.
mobile_settings	json	Phone number configurations to receive alerts. JSON Format: {country_code: $country_code, mobile_number: $mobile_number, sms_provider_id: $sms_providers, call_provider_id: $voice_call_provider}
user_groups	array	Group to be associated for the user for receiving alerts.
selection_type	int	Default value is 0. Resource type associated to this user. Monitors not supported.
twitter_settings	json	Setting to receive alerts via Twitter.
zuid	String	Unique ID of the user.

User Groups

User Groups help you to organize individuals so that they receive alerts and reports based on their responsibility.

Create User Group

POST /user_groups

Request Example

$ curl https://www.site24x7.com/api/user_groups \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \
    -d '{
      "display_name": "Manager",
      "product_id" : 0,
      "attribute_group_id" :"113770000041197709",
      "users": [
          "726000000002007",
          "726000000002015"
      ]
    }'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": {
    "user_group_id": "113770000041195204",
    "display_name": "Manager",
    "product_id": 0,
    "attribute_group_id" :"113770000041197709",
    "is_master_group": false,
    "users": [
      "726000000002007",
      "726000000002015"
    ]
  }
}

Create a new User Group.

oauthscope : Site24x7.Admin.Create

Request Parameters

Param	Type	Description
display_name	string	Mandatory Display name for the user group.
product_id	int	Product for which the user group is being created. Default value is 0.
users	array	Mandatory User IDs of the users to be associated to the group.
attribute_group_id	string	Attribute Alert Group to be associated with the User Alert group. Create new Attribute Alert Group or find your preferred attribute alert group ID.

Response Attributes

Attribute	Type	Description
user_group_id	string	Unique ID generated by the server. This can be used as an identifier.
display_name	string	Display name for the user group.
product_id	int	Product for which the user group is being created.
users	array	User IDs of the users associated with the group.
attribute_group_id	string	Attribute Alert Group to be associated with the User Alert group. List of Attribute Alert Groups.

Retrieve User Group

GET /user_groups/{user_group_id}

Request Example

$ curl https://www.site24x7.com/api/user_groups/113770000041195204 \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": {
    "user_group_id": "113770000041195204",
    "display_name": "Manager",
    "product_id": 0,
    "attribute_group_id" :"113770000041197709",
    "is_master_group": false,
    "users": [
      "726000000002007",
      "726000000002015"
    ]
  }
}

Retrieve information for an existing user group.

oauthscope : Site24x7.Admin.Read

Path Parameters

Param	Type	Description
user_group_id	string	Mandatory Unique ID generated by the server. This can be used as an identifier.

Response Attributes

Attribute	Type	Description
user_group_id	string	Unique ID generated by the server. This can be used as an identifier.
display_name	string	Display name for the user group.
product_id	int	Product to which the user group belongs to.
users	array	User IDs of the users associated with the group.
attribute_group_id	string	Attribute Alert Group to be associated with the User Alert group. List of Attribute Alert Groups.

Update User Group

PUT /user_groups/{user_group_id}

Request Example

$ curl https://www.site24x7.com/api/user_groups/113770000041195204 \
    -X PUT \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \
    -d '{
      "display_name": "Manager",
      "product_id": 0,
      "attribute_group_id" :"113770000041197709",
      "users": [
          "726000000002007",
          "726000000002015"
      ]
    }'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": {
    "user_group_id": "113770000041195204",
    "display_name": "Manager",
    "product_id": 0,
    "attribute_group_id" :"113770000041197709",
    "is_master_group": false,
    "users": [
      "726000000002007",
      "726000000002015"
    ]
  }
}

Update an existing User Group.

oauthscope : Site24x7.Admin.Update

Path Parameters

Param	Type	Description
user_group_id	string	Mandatory Unique ID generated by the server. This can be used as an identifier.

Request Attributes

Attribute	Type	Description
display_name	string	Mandatory Display name for the user group.
product_id	int	Product to which the user group belongs to.
users	array	Mandatory User IDs of the users associated with the group.
attribute_group_id	string	Attribute Alert Group to be associated with the User Alert group. Create new Attribute Alert Group or find your preferred attribute alert group ID.

Response Attributes

Attribute	Type	Description
user_group_id	string	Unique ID generated by the server. This can be used as an identifier.
display_name	string	Display name for the user group.
product_id	int	Product to which the user group belongs to.
users	array	User IDs of the users associated with the group.
attribute_group_id	string	Attribute Alert Group to be associated with the User Alert group. List of Attribute Alert Groups.

Delete User Group

DELETE /user_groups/{user_group_id}

Request Example

$ curl https://www.site24x7.com/api/user_groups/113770000041195204 \
    -X DELETE \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \

Response Example

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

Delete an existing User Group.

oauthscope : Site24x7.Admin.Delete

Path Parameters

Param	Type	Description
user_group_id	string	Mandatory Unique ID generated by the server. This can be used as an identifier.

List of all User Groups

GET /user_groups

Request Example

$ curl https://www.site24x7.com/api/user_groups \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "success",
    "data":
    [
      {
      "user_group_id": "726000000002465",
      "display_name": "Manager",
      "product_id": 0,
      "attribute_group_id" :"113770000041197709",
      "users": [
          "726000000002007",
          "726000000002015"
        ]
      }
      {..},
      {..}
    ]
}

List of all User Groups.

oauthscope : Site24x7.Admin.Read

Response Attributes

Attribute	Type	Description
user_group_id	string	Unique ID generated by the server. This can be used as an identifier.
display_name	string	Display name for the user group.
product_id	int	Product to which the user group belongs to.
users	array	User IDs of the users associated with the group.
attribute_group_id	string	Attribute Alert Group to be associated with the User Alert group. List of Attribute Alert Groups.

Attribute Alert Groups

Attribute Alert group help you to get alerts for a specific set of attributes of a monitor. You can group attributes from different monitor types and associate it to an Alert Group. This will help Teams segregate so that we can send alerts to those who really matter.

Create Attribute Alert Group

POST /attribute_groups

Request Example

$ curl https://www.site24x7.com/api/attribute_groups \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \
    -d '{
      "display_name": "devOps Alert Attributes",
      "attribute_list": [1,3]
  }'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "success",
    "data":    {
      "group_id":"6000000027001",
      "display_name": "devOps Alert Attributes",
      "attribute_list": [1,3]
}

Create a new Attribute Alert Group.

oauthscope : Site24x7.Admin.Create

Request Parameters

Param	Type	Description
display_name	string	Mandatory Display name for the attribute alert group.
attribute_list	array	Mandatory List of attributes to be associated to the group. For info on attributes, refer attribute details.

Response Attributes

Attribute	Type	Description
group_id	string	Unique ID generated by the server. This can be used as an identifier.
display_name	string	Display name for the attribute alert group.
attribute_list	array	List of attributes to be associated to the group. For info on attributes, refer attribute details.

Update Attribute Alert Group

PUT /attribute_groups/{group_id}

Request Example

$ curl https://www.site24x7.com/api/attribute_groups/726000000002465 \
    -X PUT \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \
    -d '{
      "display_name": "devOps Alert Attributes",
      "attribute_list": [1,3]
    }'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "success",
    "data": {
      "group_id":"6000000027001",
      "display_name": "devOps Alert Attributes",
      "attribute_list": [1,3]
    }
}

Update an existing Attribute Alert Group.

oauthscope : Site24x7.Admin.Update

Path Parameters

Param	Type	Description
group_id	string	Mandatory Unique ID generated by the server. This can be used as an identifier.

Request Parameters

Param	Type	Description
display_name	string	Mandatory Display name for the attribute alert group.
attribute_list	array	MandatoryList of attributes to be associated to the group. For info on attributes, refer attribute details.

Response Attributes

Attribute	Type	Description
group_id	string	Unique ID generated by the server. This can be used as an identifier.
display_name	string	Display name for the attribute alert group.
attribute_list	array	List of attributes to be associated to the group. For info on attributes, refer attribute details.

Delete Attribute Alert Group

DELETE /attribute_groups/{group_id}

oauthscope : Site24x7.Admin.Delete

Request Example

$ curl https://www.site24x7.com/api/attribute_groups/726000000002465 \
    -X DELETE \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

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

Delete an existing Attribute Alert Group.

Path Parameters

Param	Type	Description
group_id	string	Mandatory Unique ID generated by the server. This can be used as an identifier.

List Attribute Alert Group

GET /attribute_groups

oauthscope : Site24x7.Admin.Read

Request Example

$ curl https://www.site24x7.com/api/attribute_groups \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": [
    {
      "group_id": "726000000002465",
      "display _name": "test name",
      "attribute_list": [1,3]
    },
    {
      "group_id": "726000000002465",
      "display _name": "test name",
      "attribute_list": [1,3]
    }
  ]
}

List of all Global Parameters.

Response Attributes

Attribute	Type	Description
group_id	string	Unique ID generated by the server. This can be used as an identifier.
display_name	string	Display name for the attribute alert group.
attribute_list	array	List of attributes to be associated to the group. For info on attributes, refer attribute details.

Attribute Details

GET /attribute_details

oauthscope : Site24x7.Admin.Read

Request Example

$ curl https://www.site24x7.com/api/attribute_details \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": [
        {
            "type":"URL",
            "attributes":[
                {"id":1,"name":"Avilability"},
                {"id":2,"name":"Notify when website content changes by percentage"}
            ]
        },
        {
            "type":"SERVER",
            "attributes":[
                {"id":26,"name":"CPU Utilization threshold"},
                {"id":27,"name":"Memory Utilization threshold"}
            ]
        }
  }
}

Details of all attributes and the monitor type that it is grouped to.

Response Attributes

Attribute	Type	Description
type	string	Type of monitor.
id	string	Id of the attribute.
name	string	Name of attribute.

On-Call Schedules

Use the On-Call Schedule option to ensure that the assigned individual can quickly respond to incidents and outages round-the-clock.
Note :- On-Call Schedule feature is available only for users who sign up after April 6, 2022.This feature is in the beta stage. Contact Support(support@site24x7.com) if you wish to enable this feature for your account.

Create On-Call Schedule

POST /on_call_schedules

Request Example

$ curl https://www.site24x7.com/api/on_call_schedules \
    -X POST \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \
    -d '{
    "schedule_name": "On Call DevOps",
    "timezone": "Asia/Calcutta",
    "shifts": [
        {
            "shift_name": "General Shift",
            "user_group_ids": [
            "113770000041195212",
            "113770000041195222"
            ],
            "start_time": "09:00",
            "duration": 9
        },
        {
            "shift_name": "Night shift",
            "user_group_ids": [
            "113770000041195212"
            ],
            "start_time": "20:00",
            "duration": 9
        }
    ],
    "rotation": {
        "rotate": 2,
        "on": 6,
        "time": "10:00",
        "week_count": 1
    },
    "excluded_days": {
        "frequency": 1,
        "days_of_the_week": [0,3]
    }
  }
}'

Response Example

HTTP/1.1 201 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": {
    "on_call_schedule_id": "113770000041197744"
    "schedule_name": "On Call DevOps",
    "timezone": "Asia/Calcutta",
    "shifts": [
        {
            "shift_name": "General Shift",
            "user_group_ids": [
            "113770000041195212",
            "113770000041195222"
            ],
            "start_time": "09:00",
            "duration": 9
        },
        {
            "shift_name": "Night shift",
            "user_group_ids": [
            "113770000041195212"
            ],
            "start_time": "20:00",
            "duration": 9
        }
    ],
    "rotation": {
        "rotate": 2,
        "on": 6,
        "time": "10:00",
        "week_count": 1
    },
    "excluded_days": {
        "frequency": 1,
        "days_of_the_week": [0,3]
    }
  }
}

Create a new On-Call Schedule.

oauthscope : Site24x7.Admin.Create

Request Parameters

Param	Type	Description
schedule_name	string	Mandatory Display name for the On-Call Schedule.
timezone	string	Mandatory Time zone for your On-Call Schedule.
shifts	JSON array	Mandatory Configure shifts for your On-Call Schedule. JSON array Format: [{ shift_name: $shift_name, user_group_ids: $user_groups, start_time: “$hh:mm”, duration: 1 - 24 }]
rotation	json	Provide the period of rotation for the user groups associated with the shift. JSON Format: {rotate: $rotation, on: $rotate on ,start_time: “$hh:mm”, week_count: 1-51} Default value is {rotate : 0}.
excluded_days	json	Configure the days for which you’d like to exclude alerts. JSON Format: {frequency: $frequency, days_of_the_week: $days_of_the_week } Default value is {frequency : -2}.

Response Attributes

Attribute	Type	Description
on_call_schedule_id	string	Unique ID generated by the server. This can be used as an identifier.
schedule_name	string	Display name for the On-Call Schedule.
timezone	string	Time zone for your On-Call Schedule.
shifts	JSON array	Configure shifts for your On-Call Schedule. JSON array Format: [{ shift_name: $shift_name, user_group_ids: $user_groups, start_time: “$hh:mm”, duration: 1 - 24 }]
rotation	json	Provide the period of rotation for the user groups associated with the shift. JSON Format: {rotate: $rotation, on: $rotate on ,start_time: “$hh:mm”, week_count: 1-51} Default value is {rotate : 0}.
excluded_days	json	Configure the days for which you’d like to exclude alerts. JSON Format: {frequency: $frequency, days_of_the_week: $days_of_the_week } Default value is {frequency : -2}.

Retrieve On-Call Schedule

GET /on_call_schedules/{on_call_schedule_id}

Request Example

$ curl https://www.site24x7.com/api/on_call_schedules/113770000041197744 \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": {
    "on_call_schedule_id": "113770000041197744"
    "schedule_name": "On Call DevOps",
    "timezone": "Asia/Calcutta",
    "shifts": [
        {
            "shift_name": "General Shift",
            "user_group_ids": [
            "113770000041195212",
            "113770000041195222"
            ],
            "start_time": "09:00",
            "duration": 9
        },
        {
            "shift_name": "Night shift",
            "user_group_ids": [
            "113770000041195212"
            ],
            "start_time": "20:00",
            "duration": 9
        }
    ],
    "rotation": {
        "rotate": 2,
        "on": 6,
        "time": "10:00",
        "week_count": 1
    },
    "excluded_days": {
        "frequency": 1,
        "days_of_the_week": [0,3]
    }
  }
}

Retrieve information for an existing on-call schedule.

oauthscope : Site24x7.Admin.Read

Path Parameters

Param	Type	Description
on_call_schedule_id	string	Mandatory Unique ID generated by the server. This can be used as an identifier.

Response Attributes

Attribute	Type	Description
on_call_schedule_id	string	Unique ID generated by the server. This can be used as an identifier.
schedule_name	string	Display name for the On-Call Schedule.
timezone	string	Time zone for your On-Call Schedule.
shifts	JSON array	Configure shifts for your On-Call Schedule. JSON array Format: [{ shift_name: $shift_name, user_group_ids: $user_groups, start_time: “$hh:mm”, duration: 1 - 24 }]
rotation	json	Provide the period of rotation for the user groups associated with the shift. JSON Format: {rotate: $rotation, on: $rotate on ,start_time: “$hh:mm”, week_count: 1-51} Default value is {rotate : 0}.
excluded_days	json	Configure the days for which you’d like to exclude alerts. JSON Format: {frequency: $frequency, days_of_the_week: $days_of_the_week } Default value is {frequency : -2}.

Update On-Call Schedule

PUT /on_call_schedules/{on_call_schedule_id}

Request Example

$ curl https://www.site24x7.com/api/on_call_schedules/113770000041197744 \
    -X PUT \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \
    -d '{
    "schedule_name": "On Call DevOps",
    "timezone": "Asia/Calcutta",
    "shifts": [
        {
            "shift_name": "General Shift",
            "user_group_ids": [
            "113770000041195212",
            "113770000041195222"
            ],
            "start_time": "09:00",
            "duration": 9
        },
        {
            "shift_name": "Night shift",
            "user_group_ids": [
            "113770000041195212"
            ],
            "start_time": "20:00",
            "duration": 9
        }
    ],
    "rotation": {
        "rotate": 5,
        "on": 6,
        "time": "10:00"
    },
    "excluded_days": {
        "frequency": 1,
        "days_of_the_week": [0,3]
    }
  }
}'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": {
    "on_call_schedule_id": "113770000041197744", 
    "schedule_name": "On Call DevOps",
    "timezone": "Asia/Calcutta",
    "shifts": [
        {
            "shift_name": "General Shift",
            "user_group_ids": [
            "113770000041195212",
            "113770000041195222"
            ],
            "start_time": "09:00",
            "duration": 9
        },
        {
            "shift_name": "Night shift",
            "user_group_ids": [
            "113770000041195212"
            ],
            "start_time": "20:00",
            "duration": 9
        }
    ],
    "rotation": {
        "rotate": 5,
        "on": 6,
        "time": "10:00"
    },
    "excluded_days": {
        "frequency": 1,
        "days_of_the_week": [0,3]
    }
  }
}

Update an existing On_Call Schedule.

oauthscope : Site24x7.Admin.Update

Path Parameters

Param	Type	Description
on_call_schedule_id	string	Mandatory Unique ID generated by the server. This can be used as an identifier.

Request Attributes

Attribute	Type	Description
schedule_name	string	Mandatory Display name for the On-Call Schedule.
timezone	string	Mandatory Time zone for your On-Call Schedule.
shifts	JSON array	Mandatory Configure shifts for your On-Call Schedule. JSON array Format: [{ shift_name: $shift_name, user_group_ids: $user_groups, start_time: “$hh:mm”, duration: 1 - 24 }]
rotation	json	Provide the period of rotation for the user groups associated with the shift. JSON Format: {rotate: $rotation, on: $rotate on ,start_time: “$hh:mm”, week_count: 1-51} Default value is {rotate : 0}.
excluded_days	json	Configure the days for which you’d like to exclude alerts. JSON Format: {frequency: $frequency, days_of_the_week: $days_of_the_week } Default value is {frequency : -2}.

Response Attributes

Attribute	Type	Description
on_call_schedule_id	string	Unique ID generated by the server. This can be used as an identifier.
schedule_name	string	Display name for the On-Call Schedule.
timezone	string	Time zone for your On-Call Schedule.
shifts	JSON array	Configure shifts for your On-Call Schedule. JSON array Format: [{ shift_name: $shift_name, user_group_ids: $user_groups, start_time: “$hh:mm”, duration: 1 - 24 }]
rotation	json	Provide the period of rotation for the user groups associated with the shift. JSON Format: {rotate: $rotation, on: $rotate on ,start_time: “$hh:mm”, week_count: 1-51} Default value is {rotate : 0}.
excluded_days	json	Configure the days for which you’d like to exclude alerts. JSON Format: {frequency: $frequency, days_of_the_week: $days_of_the_week } Default value is {frequency : -2}.

Delete On-Call Schedule

DELETE /on_call_schedules/{on_call_schedule_id}

Request Example

$ curl https://www.site24x7.com/api/on_call_schedules/113770000041197744 \
    -X DELETE \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \

Response Example

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

Delete an existing On-Call Schedule.

oauthscope : Site24x7.Admin.Delete

Path Parameters

Param	Type	Description
on_call_schedule_id	string	Mandatory Unique ID generated by the server. This can be used as an identifier.

List of all On-Call Schedules

GET /on_call_schedules

Request Example

$ curl https://www.site24x7.com/api/on_call_schedules \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "success",
    "data":
    [
        {
        "on_call_schedule_id" : "113770000041197744",
        "schedule_name": "On Call DevOps",
        "timezone": "Asia/Calcutta",
        "shifts": [
            {
                "shift_name": "General Shift",
                "user_group_ids": [
                "113770000041195212",
                "113770000041195222"
                ],
                "start_time": "09:00",
                "duration": 9
            },
            {
                "shift_name": "Night shift",
                "user_group_ids": [
                "113770000041195212"
                ],
                "start_time": "20:00",
                "duration": 9
            }
        ],
        "rotation": {
            "rotate": 5,
            "on": 6,
            "time": "10:00"
        },
        "excluded_days": {
            "frequency": 1,
            "days_of_the_week": [0,3]
        }
    },
    {..},
    {..}
  ]
}

List of all On-Call Schedules.

oauthscope : Site24x7.Admin.Read

Response Attributes

Attribute	Type	Description
on_call_schedule_id	string	Unique ID generated by the server. This can be used as an identifier.
schedule_name	string	Display name for the On-Call Schedule.
timezone	string	Time zone for your On-Call Schedule.
shifts	JSON array	Configure shifts for your On-Call Schedule. JSON array Format: [{ shift_name: $shift_name, user_group_ids: $user_groups, start_time: “$hh:mm”, duration: 1 - 24 }]
rotation	json	Provide the period of rotation for the user groups associated with the shift. JSON Format: {rotate: $rotation, on: $rotate on ,start_time: “$hh:mm”, week_count: 1-51} Default value is {rotate : 0}.
excluded_days	json	Configure the days for which you’d like to exclude alerts. JSON Format: {frequency: $frequency, days_of_the_week: $days_of_the_week } Default value is {frequency : -2}.

Location Profiles

Location Profiles make it convenient to set monitoring locations consistently across many websites or monitors

Create Location Profile

POST /location_profiles

Request Example

$ curl https://www.site24x7.com/api/location_profiles \
    -X POST \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \
    -d '{
    "profile_name": "Europe_Profile",
    "primary_location": "15",
    "restrict_alt_loc":false,
    "secondary_check_frequency":"1800000",
    "secondary_locations": [
        "3",
        "21",
        "8",
        "10",
        "33",
        "726000000005633"
    ]
}'

Response Example

HTTP/1.1 201 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "success",
    "data":    {
    "profile_id": "726000000002465",
    "profile_name": "Europe_Profile",
    "primary_location": "15",
    "restrict_alt_loc":false,
    "secondary_check_frequency":"1800000",
    "secondary_locations": [
        "3",
        "21",
        "8",
        "10",
        "33",
        "726000000005633"
    ]
  }
}

Create a new Location Profile.

oauthscope : Site24x7.Admin.Create

Request Parameters

Param	Type	Description
profile_name	string	Mandatory Display name for the location profile.
primary_location	string	Mandatory Primary location for monitoring.
secondary_check_frequency	string	Secondary location monitoring frequency.
secondary_locations	array	Secondary location for monitoring
restrict_alt_loc	boolean	Restricts polling of the resource from the selected locations alone in the Location Profile, overrides the alternate location poll logic.
outer_regions_location_consent	boolean	true, if you are in the European Economic Area (EEA) or in the Adequate countries in EU data center and want to create a location profile from countries outside that region.

Response Attributes

Attribute	Type	Description
profile_id	string	Unique ID generated by the server. This can be used as an identifier.
profile_name	string	Display name for the location profile.
primary_location	string	Primary location for monitoring.
secondary_check_frequency	string	Secondary location monitoring frequency.
secondary_locations	array	Secondary location for monitoring
restrict_alt_loc	boolean	Restricts polling of the resource from the selected locations alone in the Location Profile, overrides the alternate location poll logic.
outer_regions_location_consent	boolean	true, if you are in the European Economic Area (EEA) or in the Adequate countries in EU data center and want to create a location profile from countries outside that region.

Retrieve Location Profile

/location_profiles/{profile_id}

Request Example

$ curl https://www.site24x7.com/api/location_profiles/113770000041271049 \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "success",
    "data":    {
    "profile_id": "726000000002465",
    "profile_name": "Europe_Profile",
    "restrict_alt_loc":false,
    "primary_location": "15",
    "secondary_check_frequency":"1800000",
    "secondary_locations": [
        "3",
        "21",
        "8",
        "10",
        "33",
        "726000000005633"
    ]
  }
}

Retrieve configuration of a Location Profile.

oauthscope : Site24x7.Admin.Read

Path Parameters

Param	Type	Description
profile_id	string	Mandatory Unique ID generated by the server for the location profile.

Response Attributes

Attribute	Type	Description
profile_id	string	Mandatory Unique ID generated by the server for the location profile.
profile_name	string	Display name for the location profile.
primary_location	string	Primary location for monitoring.
secondary_check_frequency	string	Secondary location monitoring frequency.
secondary_locations	array	Secondary location for monitoring
restrict_alt_loc	boolean	Restricts polling of the resource from the selected locations alone in the Location Profile, overrides the alternate location poll logic.

Update a Location Profile

PUT /location_profiles/{profile_id}

Request Example

$ curl https://www.site24x7.com/api/location_profiles\726000000002465 \
    -X PUT \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \
    -d '{
    "profile_name": "Europe_Profile",
    "primary_location": "15",
    "restrict_alt_loc":false,
    "secondary_check_frequency":"1800000",
    "secondary_locations": [
        "3",
        "21",
        "8",
        "10",
        "33",
        "726000000005633"
    ]
}'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "success",
    "data":    {
    "profile_id": "726000000002465",
    "profile_name": "Europe_Profile",
    "primary_location": "15",
    "restrict_alt_loc":false,
    "secondary_check_frequency":"1800000",
    "secondary_locations": [
        "3",
        "21",
        "8",
        "10",
        "33",
        "726000000005633"
    ]
  }
}

Update an existing Location Profile.

oauthscope : Site24x7.Admin.Update

Path Parameters

Param	Type	Description
profile_id	string	Mandatory Unique ID generated by the server for the location profile.

Request Attributes

Attribute	Type	Description
profile_name	string	Display name for the location profile.
primary_location	string	Primary location for monitoring.
secondary_check_frequency	string	Secondary location monitoring frequency.
secondary_locations	array	Secondary location for monitoring
restrict_alt_loc	boolean	Restricts polling of the resource from the selected locations alone in the Location Profile, overrides the alternate location poll logic.
outer_regions_location_consent	boolean	true, if you are in the European Economic Area (EEA) or in the Adequate countries in EU data center and want to create a location profile from countries outside that region.

Response Attributes

Attribute	Type	Description
profile_id	string	Unique ID generated by the server for the location profile.
profile_name	string	Display name for the location profile.
primary_location	string	Primary location for monitoring.
secondary_check_frequency	string	Secondary location monitoring frequency.
secondary_locations	array	Secondary location for monitoring
restrict_alt_loc	boolean	Restricts polling of the resource from the selected locations alone in the Location Profile, overrides the alternate location poll logic.
outer_regions_location_consent	boolean	true, if you are in the European Economic Area (EEA) or in the Adequate countries in EU data center and want to create a location profile from countries outside that region.

Delete an existing location profile.

DELETE /location_profiles/{profile_id}

Request Example

$ curl https://www.site24x7.com/api/location_profiles/726000000002465 \
    -X DELETE \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

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

Delete an existing Location Profile.

oauthscope : Site24x7.Admin.Delete

Path Parameters

Param	Type	Description
profile_id	string	Mandatory Unique ID generated by the server for the location profile.

List of all Location Profiles

GET /location_profiles

Request Example

$ curl https://www.site24x7.com/api/location_profiles \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data":
  [
    {
      "profile_id": "726000000002465",
      "profile_name": "Europe_Profile",
      "primary_location": "15",
      "restrict_alt_loc":false,
      "secondary_check_frequency":"1800000",
      "secondary_locations": [
        "3",
        "21",
        "8",
        "10",
        "33",
        "726000000005633"
      ]
    }
    {..},
    {..}
  ]
}

List of all Location Profiles.

oauthscope : Site24x7.Admin.Read

Response Attributes

Attribute	Type	Description
profile_id	string	Unique ID generated by the server for the location profile.
profile_name	string	Display name for the location profile.
primary_location	string	Primary location for monitoring.
secondary_check_frequency	string	Secondary location monitoring frequency.
secondary_locations	array	Secondary location for monitoring
restrict_alt_loc	boolean	Restricts polling of the resource from the selected locations alone in the Location Profile, overrides the alternate location poll logic.

Get Location Template

GET /location_template

Request Example

$ curl https://www.site24x7.com/api/location_template \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

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

                  "locations": [
                    {
                      "location_id": "1",
                      "display_name": "Fremont-CA - US",
                      "city_name": "Fremont-CA",
                      "city_short": "FMT",
                      "country_name": "United States",
                      "continent": "North America",
                      "use_ipv6": true
                    },
                    {
                      "location_id": "14",
                      "display_name": "Shanghai - CHN",
                      "city_name": "Shanghai",
                      "city_short": "SHA",
                      "country_name": "China",
                      "continent": "Asia",
                      "use_ipv6": false
                    }

                  ],
                  "onpremise_pollers": [
                    {
                      "probe_info": "OS Details : Microsoft Windows 8.1 Pro 6.3.9600 <br>No of Processors : 4 <br>Processor Details : Intel64 Family 6 Model 60 Stepping 3, GenuineIntel, AMD64, System Type : 64-bit OS",
                      "display_name": "ONPREMISE_POLLER",
                      "location_id": "170000000000000003"
                    }
                  ],
                  "mobile_pollers": [
                    {
                      "probe_info": "-",
                      "display_name": "MobilePoller",
                      "location_id": "170000000000000003"
                    }
                  ]
                }
}

Retrieve details of available locations for polling along with the On-Premise pollers and Mobile Pollers associated with the account.

oauthscope : Site24x7.Admin.Read

Response Attributes

Attribute	Type	Description
locations	JSONArray	Global monitoring locations available for polling. JSON Format[{country_name:“$country_name”,display_name:“$display_name”,use_ipv6:“$use_ipv6”,city_name:“$city_name”,city_short:“$city_short”,continent:“$continent”,location_id:“$location_id”}]
onpremise_pollers	JSONArray	List of On-Premise pollers configured in the account. JSON Format[{probe_info:“$probe_info”,display_name:“$display_name”,location_id:“$location_id”}]
mobile_pollers	JSONArray	List of mobile pollers configured in the account. JSON Format[{probe_info:“$probe_info”,display_name:“$display_name”,location_id:“$location_id”}]

JSON Format

Attribute	Type	Description
location_id	string	Unique ID generated by the server, which can be used as an identifier.
display_name	string	Name of the monitor.
city_name	string	The name of the city.
city_short	string	The representation of the city in short form.
country_name	string	The name of the country where the corresponding city is located.
continent	string	The continent where the city is located.
use_ipv6	boolean	Denotes whether the location supports monitoring of websites hosted with IPv6 addresses.
probe_info	string	Contains Guest OS configuration, if available, on which the probe is installed.

Threshold Parameters

This section list all monitor specific thresholds supported.

Website

Attribute	Type	Description
type	string	Mandatory URL
profile_name	string	Mandatory Name of the profile
profile_type	int	$threshold_profile_types
down_location_threshold	int	Mandatory Triggers alert when the monitor is down from configured number of locations. Downtime Rules Constants
website_content_modified	boolean	Triggers alert when Website content is modified.
website_content_changes	json	Triggers alert when Website content changes by configured percentage. JSON Format: $threshold_attribute_format
response_time_threshold	json	Response time threshold for primary and secondary monitoring location. Anomaly Enabled Attribute JSON Format: {“primary”: {$threshold_attribute_format} “secondary”: {$threshold_attribute_format}}

Web Page Speed Browser

Attribute	Type	Description
type	string	Mandatory HOMEPAGE
profile_name	string	Mandatory Name of the profile
down_location_threshold	int	Mandatory Triggers alert when the monitor is down from configured number of locations. Downtime Rules Constants Only 3 locations supported
objects_alert_broken	boolean	Triggers alert when any resource in the page fails to load.
website_content_changes	json	Triggers alert when Website content changes by configured percentage. JSON Format: $threshold_attribute_format
images_threshold	json	Triggers alert when the total image size changes, when the number and size of all the images on a page exceeds, and when the size of individual image exceeds the configured value. JSON Format: {count: {$threshold_attribute_format}, size: {$threshold_attribute_format}, size_change: {$threshold_attribute_format}, per_size_change: {$threshold_attribute_format}}
scripts_threshold	json	Triggers alert when the total script size changes, when the number and size of all the scripts on a page exceeds, and when the size of individual script exceeds the configured value. JSON Format: {count: {$threshold_attribute_format}, size: {$threshold_attribute_format}, size_change: {$threshold_attribute_format}, per_size_change: {$threshold_attribute_format}}
css_threshold	json	Triggers alert when the total CSS size changes, when the number and size of all the CSS on a page exceeds, and when the size of individual CSS exceeds the configured value. JSON Format: {count: {$threshold_attribute_format}, size: {$threshold_attribute_format}, size_change: {$threshold_attribute_format}, per_size_change: {$threshold_attribute_format}}
response_time_threshold	json	Response time threshold for primary and secondary monitoring location. Anomaly Enabled Attribute JSON Format: {“primary”: {$threshold_attribute_format} “secondary”: {$threshold_attribute_format}}

REST API

Attribute	Type	Description
type	string	Mandatory RESTAPI
profile_name	string	Mandatory Name of the profile
down_location_threshold	int	Mandatory Triggers alert when the monitor is down from configured number of locations. Downtime Rules Constants
response_time_threshold	json	Response time threshold for primary and secondary monitoring location. Anomaly Enabled Attribute. JSON Format: {“primary”: {$threshold_attribute_format} “secondary”: {$threshold_attribute_format}}

DNS Server

Attribute	Type	Description
type	string	Mandatory DNS
profile_name	string	Mandatory Name of the profile
down_location_threshold	int	Mandatory Triggers alert when the monitor is down from configured number of locations. Downtime Rules Constants
response_time_threshold	json	Response time threshold for primary and secondary monitoring location. Anomaly Enabled Attribute. JSON Format: {“primary”: {$threshold_attribute_format} “secondary”: {$threshold_attribute_format}}

UDP

Attribute	Type	Description
type	string	Mandatory UDP
profile_name	string	Mandatory Name of the profile
down_location_threshold	int	Mandatory Triggers alert when the monitor is down from configured number of locations. Downtime Rules Constants
response_time_threshold	json	Response time threshold for primary and secondary monitoring locations. Anomaly Enabled Attribute. JSON Format: {“primary”: {$threshold_attribute_format} “secondary”: {$threshold_attribute_format}}

Port (Custom Protocol) - Threshold Parameter

Attribute	Type	Description
type	string	Mandatory PORT
profile_name	string	Mandatory Name of the profile
down_location_threshold	int	Mandatory Triggers alert when the monitor is down from configured number of locations. Downtime Rules Constants
response_time_threshold	json	Response time threshold for primary and secondary monitoring location. Anomaly Enabled Attribute. JSON Format: {“primary”: {$threshold_attribute_format} “secondary”: {$threshold_attribute_format}}

POP Server - Threshold Parameter

Attribute	Type	Description
type	string	Mandatory PORT-POP
profile_name	string	Mandatory Name of the profile
down_location_threshold	int	Mandatory Triggers alert when the monitor is down from configured number of locations. Downtime Rules Constants
response_time_threshold	json	Response time threshold for primary and secondary monitoring location. Anomaly Enabled Attribute. JSON Format: {“primary”: {$threshold_attribute_format} “secondary”: {$threshold_attribute_format}}

SMTP Server

Attribute	Type	Description
type	string	Mandatory PORT-SMTP
profile_name	string	Mandatory Name of the profile
down_location_threshold	int	Mandatory Triggers alert when the monitor is down from configured number of locations. Downtime Rules Constants
response_time_threshold	json	Response time threshold for primary and secondary monitoring location. JSON Format: {“primary”: {$threshold_attribute_format} “secondary”: {$threshold_attribute_format}}

PING

Attribute	Type	Description
type	string	Mandatory PING
profile_name	string	Mandatory Name of the profile
down_location_threshold	int	Mandatory Triggers alert when the monitor is down from configured number of locations. Downtime Rules Constants
packet_loss_threshold	json	Triggers alert when the packet loss exceeds configured threshold. Anomaly Enabled Attribute. JSON Format: {“primary”: {$threshold_attribute_format} “secondary”: {$threshold_attribute_format}}

FTP Server

Attribute	Type	Description
type	string	Mandatory PORT-FTP
profile_name	string	Mandatory Name of the profile
down_location_threshold	int	Mandatory Triggers alert when the monitor is down from configured number of locations. Downtime Rules Constants
response_time_threshold	json	Response time threshold for primary and secondary monitoring location. Anomaly Enabled Attribute. JSON Format: {“primary”: {$threshold_attribute_format} “secondary”: {$threshold_attribute_format}}

SSL Certificate

Attribute	Type	Description
type	string	Mandatory SSL_CERT
profile_name	string	Mandatory Name of the profile
ssl_fingerprint_modified	json	Mandatory Triggers alert when the ssl certificate is modified JSON Format: {“value”:true}
days_until_expiry	json	Optional Triggers alert before the SSL certificate expires within the configured number of days. JSON Format: [{“severity”: Severity, “comparison_operator”: Comparison Operator, “value”: 30}, {“severity”: Severity, “comparison_operator”: Comparison Operator, “value”: 60}]

Mail Delivery

Attribute	Type	Description
type	string	Mandatory SMTP
profile_name	string	Mandatory Name of the profile
down_location_threshold	int	Mandatory Triggers alert when the monitor is down from configured number of locations. Downtime Rules Constants Only 3 locations supported
response_time_threshold	json	Response time threshold for primary and secondary monitoring location. JSON Format: {“primary”: $response_time_for_primary_location, “secondary”: $response_time_for_secondary_locations}
notify_connection_errors	boolean	Triggers alert when the mail server is experiencing Connection error in any of the IP.

FTP Transfer

Attribute	Type	Description
type	string	Mandatory FTP
profile_name	string	Mandatory Name of the profile
down_location_threshold	int	Mandatory Triggers alert when the monitor is down from configured number of locations. Downtime Rules Constants Only 3 locations supported
upload_time_threshold	json	Triggers alert when the ftp upload time exceeds threshold. JSON Format:$threshold_attribute_format
download_time_threshold	json	Triggers alert when the ftp download time exceeds threshold. JSON Format:$threshold_attribute_format
response_time_threshold	json	Response time threshold for primary and secondary monitoring location. Anomaly Enabled Attribute. JSON Format: {“primary”: {$threshold_attribute_format} “secondary”: {$threshold_attribute_format}}

Web Transaction

Attribute	Type	Description
type	string	Mandatory URL-SEQ
profile_name	string	Mandatory Name of the profile
down_location_threshold	int	Mandatory Triggers alert when the monitor is down from configured number of locations. Downtime Rules Constants
response_time_threshold	json	Response time threshold for primary and secondary monitoring location. Anomaly Enabled Attribute. JSON Format: {“primary”: {$threshold_attribute_format} “secondary”: {$threshold_attribute_format}}

REST API Transaction

Attribute	Type	Description
type	string	Mandatory RESTAPISEQ
profile_name	string	Mandatory Name of the profile
down_location_threshold	int	Mandatory Triggers alert when the monitor is down from configured number of locations. Downtime Rules Constants
response_time_threshold	json	Response time threshold for primary and secondary monitoring location. Anomaly Enabled Attribute. JSON Format: {“primary”: {$threshold_attribute_format} “secondary”: {$threshold_attribute_format}}

Web Transaction (Browser)

Attribute	Type	Description
type	string	Mandatory REALBROWSER
profile_name	string	Mandatory Name of the profile
down_location_threshold	int	Mandatory Triggers alert when the monitor is down from configured number of locations. Downtime Rules Constants
response_time_threshold	json	Response time threshold for primary and secondary monitoring location. Anomaly Enabled Attribute. JSON Format: {“primary”: {$threshold_attribute_format} “secondary”: {$threshold_attribute_format}}

Server Monitor

Attribute	Type	Description
type	string	Mandatory SERVER
profile_name	string	Mandatory Name of the profile
cpu_threshold	json	Triggers alert if Server CPU Usage exceeds configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
memory_threshold	json	Triggers alert if Server Memory Usage exceeds configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
disk_usage_threshold	json	Triggers alert if Server Disk utilization exceeds configured threshold. JSON Format: $threshold_attribute_format
process_down_alert	json	Triggers alert if process is down. JSON Format:{“value”:true/false,“severity”: “$STATUS”}
server_resource_down_alert	boolean	Notifiy if a resource check fails.
disk_partition_threshold	json	Triggers alert if disk partition threshold exceeds configured threshold. JSON Format: $threshold_attribute_format
process_cpu_threshold	json	Triggers alert if any process CPU usage exceeds configured threshold. JSON Format: $threshold_attribute_format
process_memory_threshold	json	Triggers alert if any process memory usage exceeds configured threshold. JSON Format: $threshold_attribute_format
process_disk_usage_threshold	json	Triggers alert if any process disk utilization exceeds configured threshold. JSON Format: $threshold_attribute_format
process_handle_count_threshold	int	Triggers alert if any process handle count exceeds configured threshold. JSON Format: $threshold_attribute_format
network_error_packet_threshold	json	Triggers alert if network error packet exceeds configured threshold. JSON Format: $threshold_attribute_format
ip_address_change	json	Triggers alert if IP address validation fails. JSON Format:$threshold_attribute_format
running_process	json	Windows Specific Triggers alert if running proccess count exceeds configured threshold. JSON Format: $threshold_attribute_format
total_service	json	Windows Specific Triggers alert if total service count exceeds configured threshold. JSON Format: $threshold_attribute_format
process_queue_length	json	Windows Specific Triggers alert if processor queue length exceeds configured threshold. JSON Format: $threshold_attribute_format
system_load_1min	json	Linux Specific Triggers alert if system load(1 min avg) exceeds configured threshold. JSON Format: $threshold_attribute_format
system_load_5min	json	Linux Specific Triggers alert if system load(5 min avg) exceeds configured threshold. JSON Format: $threshold_attribute_format
system_load_15min	json	Linux Specific Triggers alert if system load(15 min avg) exceeds configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
process_running	json	Linux Specific Triggers alert if running process count exceeds configured threshold. JSON Format: $threshold_attribute_format
total_process	json	Linux Specific Triggers alert if total process count exceeds configured threshold. JSON Format: $threshold_attribute_format
blocked_process	json	Linux Specific Triggers alert if blocked process count exceeds configured threshold. JSON Format: $threshold_attribute_format
disk_used_size	json	Triggers alert if disk partition usage threshold exceeds configured threshold. JSON Format: {“trouble”: $disk_used_size, “comparison_operator”:$comparison_operator, “polls_check”:$poll_check_value, “strategy”: $strategy,“unit_id”:$unit_id}
disk_free_size	json	Triggers alert if disk partition free space exceeds configured threshold. JSON Format: {“trouble”: $disk_used_size, “comparison_operator”:$comparison_operator, “polls_check”:$poll_check_value, “strategy”: $strategy,“unit_id”:$unit_id}
process_instance_count_threshold	int	Triggers alert if any process instance count exceeds configured threshold. JSON Format: $threshold_attribute_format
server_uptime	json	Triggers alert if uptime of the server exceeds configured threshold. JSON Format: {“trouble”: $process_instance_count_threshold, “comparison_operator”:$comparison_operator, “polls_check”:$poll_check_value, “strategy”: $strategy,“unit_id”:$unit_id}

Microsoft Exchange Server

Attribute	Type	Description
type	string	Mandatory MSEXCHANGE
profile_name	string	Mandatory Name of the profile
io_db_write_threshold	json	Triggers alert when configured threshold is exceeded. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
io_db_read_threshold	json	Triggers alert when configured threshold is exceeded. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
rpc_responsetime_to_unifiedmessaging_threshold	json	Triggers alert when configured threshold is exceeded. JSON Format: $threshold_attribute_format
rpc_responsetime_to_hub_threshold	json	Triggers alert when configured threshold is exceeded. JSON Format: $threshold_attribute_format
info_store_rpc_responsetime_threshold	json	Triggers alert when configured threshold is exceeded. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
info_store_rpc_request_threshold	json	Triggers alert when configured threshold is exceeded. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
info_store_mailbox_avg_deliverytime_threshold	json	Triggers alert when configured threshold is exceeded. JSON Format: $threshold_attribute_format
hub_smtp_inbound_threshold	json	Triggers alert when configured threshold is exceeded. JSON Format: $threshold_attribute_format
hub_smtp_outbound_threshold	json	Triggers alert when configured threshold is exceeded. JSON Format: $threshold_attribute_format
hub_messages_sent_threshold	json	Triggers alert when configured threshold is exceeded. JSON Format: $threshold_attribute_format
hub_messages_received_threshold	json	Triggers alert when configured threshold is exceeded. JSON Format: $threshold_attribute_format
edge_smtp_inbound_threshold	json	Triggers alert when configured threshold is exceeded. JSON Format: $threshold_attribute_format
edge_smtp_outbound_threshold	json	Triggers alert when configured threshold is exceeded. JSON Format: $threshold_attribute_format
edge_messages_sent_threshold	json	Triggers alert when configured threshold is exceeded. JSON Format: $threshold_attribute_format
edge_messages_received_threshold	json	Triggers alert when configured threshold is exceeded. JSON Format: $threshold_attribute_format
edge_messages_route_failed_threshold	json	Triggers alert when configured threshold is exceeded. JSON Format: $threshold_attribute_format
edge_messages_route_success_threshold	json	Triggers alert when configured threshold is exceeded. JSON Format: $threshold_attribute_format
owa_responsetime_threshold	json	Triggers alert when configured threshold is exceeded. JSON Format: $threshold_attribute_format
active_sync_responsetime_threshold	json	Triggers alert when configured threshold is exceeded. JSON Format: $threshold_attribute_format
owa_request_threshold	json	Triggers alert when configured threshold is exceeded. JSON Format: $threshold_attribute_format
active_sync_request_threshold	json	Triggers alert when configured threshold is exceeded. JSON Format: $threshold_attribute_format
owa_sent_messages_threshold	json	Triggers alert when configured threshold is exceeded. JSON Format: $threshold_attribute_format
active_sync_threads_threshold	json	Triggers alert when configured threshold is exceeded. JSON Format: $threshold_attribute_format
current_calls_threshold	json	Triggers alert when configured threshold is exceeded. JSON Format: $threshold_attribute_format
mailbox_access_failure_threshold	json	Triggers alert when configured threshold is exceeded. JSON Format: $threshold_attribute_format
hub_transport_access_failure_threshold	json	Triggers alert when configured threshold is exceeded. JSON Format: $threshold_attribute_format
direct_access_failure_threshold	json	Triggers alert when configured threshold is exceeded. JSON Format: $threshold_attribute_format
user_response_latency_threshold	json	Triggers alert when configured threshold is exceeded. JSON Format: $threshold_attribute_format
call_duration_threshold	json	Triggers alert when configured threshold is exceeded. JSON Format: $threshold_attribute_format
subscriber_authentication_failure_threshold	json	Triggers alert when configured threshold is exceeded. JSON Format: $threshold_attribute_format

Microsoft IIS Server

Attribute	Type	Description
type	string	Mandatory IISSERVER
profile_name	string	Mandatory Name of the profile
iis_site_down_threshold	json	Notify when Site is down. JSON Format: {value:true/false, serverity:“$status”}
iis_apppool_down_threshold	json	Notify when Application Pool is down. JSON Format: {value:true/false, severity:“$status”}
network_traffic_threshold	json	Network Traffic Exceeds. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
current_request_threshold	json	Triggers alert when current requests exceed the configured threshold. JSON Format: $threshold_attribute_format

VMWare ESX/ESXi Server Monitor

Attribute	Type	Description
type	string	Mandatory VMWAREESX
profile_name	string	Mandatory Name of the profile
cpu_threshold	json	Triggers alert when configured threshold is exceeded. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
memory_threshold	json	Triggers alert when configured threshold is exceeded. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
disk_io_threshold	json	Triggers alert when configured threshold is exceeded. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
network_usage_threshold	json	Triggers alert when configured threshold is exceeded. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format

VMWare VM Monitor

Attribute	Type	Description
type	string	Mandatory VMWAREVM
profile_name	string	Mandatory Name of the profile
cpu_threshold	json	Triggers alert when configured threshold is exceeded. JSON Format: $threshold_attribute_format
memory_threshold	json	Triggers alert when configured threshold is exceeded. JSON Format: $threshold_attribute_format
disk_io_threshold	json	Triggers alert when configured threshold is exceeded. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
network_usage_threshold	json	Triggers alert when configured threshold is exceeded. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format

EC2 Instance Monitor

Attribute	Type	Description
type	string	Mandatory EC2INSTANCE
profile_name	string	Mandatory Name of the profile
agent_alert	json	Notify for Agent Failure. JSON Format: {value:true/false, severity:“$status”}
status_checks	json	Notify for Status Check Failure. JSON Format: {value:true/false, severity:“$status”}
mute_cpu_alert	json	Mute Alert for CPU Credit Balance in Unlimited Mode. JSON Format: {value:true/false, severity:“$status”}
spot_alert	json	Notify for Spot Instance Termination. JSON Format: {value:true/false, severity:“$status”}
scheduled_alert	json	Notify for Scheduled Instance Termination. JSON Format: {value:true/false, severity:“$status”}
gpu_connectivitycheck	json	Notify for GPU Connectivity Check Failure. JSON Format: {value:true/false, severity:“$status”}
gpu_healthcheck	json	Notify for GPU Health Check Failure JSON Format. : {value:true/false, severity:“$status”}
connectivity_check	json	Notify for Accelerator Connectivity Check Failure. JSON Format: {value:true/false, severity:“$status”}
accelerator_health_check	json	Notify for Accelerator Health Check Failure. JSON Format: {value:true/false, severity:“$status”}
cpu_threshold	json	Triggers alert if the CPU utilization exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
network_in_threshold	json	Triggers alert if the number of bytes received exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
network_out_threshold	json	Triggers alert if the number of bytes sent out exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
packets_in_threshold	json	Triggers alert if the number of packets received exceeds the configured threshold. JSON Format: $threshold_attribute_format
packets_out_threshold	json	Triggers alert if the number of packets sent out exceeds the configured threshold. JSON Format: $threshold_attribute_format
disk_read_ops_threshold	json	Triggers alert if the disk read operations exceeds the configured threshold. JSON Format: $threshold_attribute_format
disk_write_ops_threshold	json	Triggers alert if the disk write operations exceeds the configured threshold. JSON Format: $threshold_attribute_format
disk_read_bytes_threshold	json	Triggers alert if the bytes read exceeds the configured threshold. JSON Format: $threshold_attribute_format
disk_write_bytes_threshold	json	Triggers alert if the bytes written exceeds the configured threshold. JSON Format: $threshold_attribute_format
cpu_credit_usage_threshold	json	Triggers alert if the number of CPU credit spent exceeds the configured threshold. Only valid for T2 instances JSON Format: $threshold_attribute_format
cpu_credit_balance_threshold	json	Triggers alert if the number of earned CPU credits exceeds the configured threshold. Only valid for T2 instances JSON Format: $threshold_attribute_format
cpu_surplus_balance_threshold	json	Triggers alert if the number of surplus credits exceeds the configured threshold. Only valid for T2 instances JSON Format: $threshold_attribute_format
cpu_surplus_charged_threshold	json	Triggers alert if the number of spent surplus credits exceeds the configured threshold. Only valid for T2 instances JSON Format: $threshold_attribute_format
idletime_threshold	json	Triggers alert if the volume idle time exceeds the configured threshold. JSON Format: $threshold_attribute_format
queuelength_threshold	json	Triggers alert if the volume queue length exceeds the configured threshold. JSON Format: $threshold_attribute_format
burst_balance_threshold	json	Triggers alert if the volume burst balance exceeds the configured threshold. JSON Format: $threshold_attribute_format
iops_usage	json	Triggers alert if the utilization of I/O operations per second by volume exceeds the configured threshold. JSON Format: $threshold_attribute_format
read_latency_threshold	json	Triggers alert if the volume read latency exceeds the configured threshold. JSON Format: $threshold_attribute_format
write_latency_threshold	json	Triggers alert if the volume write latency exceeds the configured threshold. JSON Format: $threshold_attribute_format
read_bandwidth_threshold	json	Triggers alert if the volume read bandwidth exceeds the configured threshold. JSON Format: $threshold_attribute_format
write_bandwidth_threshold	json	Triggers alert if the volume write bandwidth exceeds the configured threshold. JSON Format: $threshold_attribute_format
read_throughput_threshold	json	Triggers alert if the volume read throughput exceeds the configured threshold. JSON Format: $threshold_attribute_format
write_throughput_threshold	json	Triggers alert if the volume write throughput exceeds the configured threshold. JSON Format: $threshold_attribute_format
gpu_memoryutilization	json	Triggers alert if the GPU memory utilization exceeds the configured threshold. JSON Format: $threshold_attribute_format
accelerator_memory_usage	json	Triggers alert if the accelerator memory usage exceeds the configured threshold. JSON Format: $threshold_attribute_format
accelerator_utilization	json	Triggers alert if the accelerator utilization exceeds the configured threshold. JSON Format: $threshold_attribute_format

RDS Instance Monitor

Attribute	Type	Description
type	string	Mandatory RDSINSTANCE
profile_name	string	Mandatory Name of the profile
mute_aurora_reader	json	Mute alerts for Aurora reader instance. JSON Format: {value:true/false, severity:“$status”}
cpu_threshold	json	Triggers alert if the CPU utilization exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
db_connection_sum	json	Triggers alert if the sum of database connections exceeds the configured threshold. JSON Format: $threshold_attribute_format
db_connection_avg	json	Triggers alert if the average of database connections exceeds the configured threshold. JSON Format: $threshold_attribute_format
db_connection_max	json	Triggers alert if the maximum number of database connections exceeds the configured threshold. JSON Format: $threshold_attribute_format
db_connection_realcount	json	Triggers alert if the count of the current active/open connections exceeds the configured threshold. JSON Format: $threshold_attribute_format
read_ops_threshold	json	Triggers alert if the number of disk read operations exceeds the configured threshold. JSON Format: $threshold_attribute_format
write_ops_threshold	json	Triggers alert if the number of disk write operations exceeds the configured threshold. JSON Format: $threshold_attribute_format
read_latency_threshold	json	Triggers alert if the time taken per disk read operation exceeds the configured threshold. JSON Format: $threshold_attribute_format
write_latency_threshold	json	Triggers alert if the time taken per disk write operation exceeds the configured threshold. JSON Format: $threshold_attribute_format
read_throughput_threshold	json	Triggers alert if the number of bytes read from disk per second exceeds the configured threshold. JSON Format: $threshold_attribute_format
write_throughput_threshold	json	Triggers alert if the number of bytes written to disk per second exceeds the configured threshold. JSON Format: $threshold_attribute_format
cpu_credit_usage_threshold	json	Triggers alert if the number of CPU credit spent exceeds the configured threshold. Only valid for T2 instances JSON Format: $threshold_attribute_format
cpu_credit_balance_threshold	json	Triggers alert if the number of earned CPU credits exceeds the configured threshold. Only valid for T2 instances JSON Format: $threshold_attribute_format
cpu_surplus_balance_threshold	json	Triggers alert if the number of surplus credits exceeds the configured threshold. Only valid for T2 instances JSON Format: $threshold_attribute_format
cpu_surplus_charged_threshold	json	Triggers alert if the number of spent surplus credits exceeds the configured threshold. Only valid for T2 instances JSON Format: $threshold_attribute_format
failed_sqlserver_agent_jobs	json	Triggers alert if the number of failed sql server agent jobs exceeds the configured threshold. JSON Format: $threshold_attribute_format
bin_log_usage	json	Triggers alert if the disk space occupied by binary logs exceeds the configured threshold. JSON Format: $threshold_attribute_format
buffer_cache_hit_threshold	json	Triggers alert if the percentage of requests that are served by buffer cache exceeds the configured threshold. JSON Format: $threshold_attribute_format
disk_queue_depth	json	Triggers alert if the number of requests waiting to access the disk exceeds the configured threshold. JSON Format: $threshold_attribute_format
freeable_memory	json	Triggers alert if the available random access memory exceeds the configured threshold. JSON Format: $threshold_attribute_format
freeable_memory_percentage	json	Triggers alert if the freeable memory percentage exceeds the configured threshold. JSON Format: $threshold_attribute_format
max_transaction_id	json	Triggers alert if the maximum number of transaction IDs used exceeds the configured threshold. JSON Format: $threshold_attribute_format
receive_throughput	json	Triggers alert if the incoming network traffic exceeds the configured threshold. JSON Format: $threshold_attribute_format
transmit_throughput	json	Triggers alert if the outgoing network traffic exceeds the configured threshold. JSON Format: $threshold_attribute_format
logs_disk_usage	json	Triggers alert if the disk space used by transaction logs exceeds the configured threshold. JSON Format: $threshold_attribute_format
swap_usage	json	Triggers alert if the amount of swap space used exceeds the configured threshold. JSON Format:$threshold_attribute_format
active_transactions	json	Triggers alert if the number of current transactions exceeds the configured threshold. JSON Format: $threshold_attribute_format
aurora_bin_log	json	Triggers alert if the amount of time a replica cluster lags behind source cluster exceeds the configured threshold. JSON Format: $threshold_attribute_format
aurora_replica_lag	json	Triggers alert if the time taken for replicating updates exceeds the configured threshold. JSON Format: $threshold_attribute_format
aurora_lag_max	json	Triggers alert if the maximum amount of lag between the primary instance and Aurora DB instance exceeds the configured threshold. JSON Format: $threshold_attribute_format
aurora_lag_min	json	Triggers alert if the minimum amount of lag between the primary instance and Aurora DB instance exceeds the configured threshold. JSON Format: $threshold_attribute_format
blocked_transactions	json	Triggers alert if the number of blocked transactions exceeds the configured threshold. JSON Format: $threshold_attribute_format
commit_latency	json	Triggers alert if the amount of latency for commit operations exceeds the configured threshold. JSON Format: $threshold_attribute_format
commit_throughput	json	Triggers alert if the number of commit operations per second exceeds the configured threshold. JSON Format: $threshold_attribute_format
ddl_latency	json	Triggers alert if the amount of latency for DDL requests exceeds the configured threshold. JSON Format: $threshold_attribute_format
ddl_throughput	json	Triggers alert if the number of DDL requests per second exceeds the configured threshold. JSON Format: $threshold_attribute_format
dead_locks	json	Triggers alert if the number of deadlocks exceeds the configured threshold. JSON Format: $threshold_attribute_format
delete_latency	json	Triggers alert if the amount of latency for delete queries exceeds the configured threshold. JSON Format: $threshold_attribute_format
delete_throughput	json	Triggers alert if the number of delete queries per second exceeds the configured threshold. JSON Format: $threshold_attribute_format
dml_latency	json	Triggers alert if the amount of latency for DML operations exceeds the configured threshold. JSON Format: $threshold_attribute_format
dml_throughput	json	Triggers alert if the number of DML operations per second exceeds the configured threshold. JSON Format: $threshold_attribute_format
engine_up_time	json	Triggers alert if the instance run time exceeds the configured threshold. JSON Format: $threshold_attribute_format
free_local_storage	json	Triggers alert if the amount of storage available for temporary tables, logs exceeds the configured threshold. JSON Format: $threshold_attribute_format
insert_latency	json	Triggers alert if the amount of latency for insert queries exceeds the configured threshold. JSON Format: $threshold_attribute_format
insert_throughput	json	Triggers alert if the number of insert queries per second exceeds the configured threshold. JSON Format: $threshold_attribute_format
login_failures	json	Triggers alert if the number of failed login attempts exceeds the configured threshold. JSON Format: $threshold_attribute_format
network_throughput	json	Triggers alert if the amount of network throughput both received and transmitted exceeds the configured threshold. JSON Format: $threshold_attribute_format
queries	json	Triggers alert if the number of queries executed exceeds the configured threshold. JSON Format: $threshold_attribute_format
result_cache_ratio	json	Triggers alert if the percentage of requests that are served by the result set cache exceeds the configured threshold. JSON Format: $threshold_attribute_format
select_latency	json	Triggers alert if the amount of latency for select queries exceeds the configured threshold. JSON Format: $threshold_attribute_format
select_throughput	json	Triggers alert if the number of select queries per second exceeds the configured threshold. JSON Format: $threshold_attribute_format
update_latency	json	Triggers alert if the amount of latency for update queries exceeds the configured threshold. JSON Format: $threshold_attribute_format
update_throughput	json	Triggers alert if the number of update queries per second exceeds the configured threshold. JSON Format: $threshold_attribute_format
vol_bytes_used	json	Triggers alert if the amount of storage used by the instance exceeds the configured threshold. JSON Format:$threshold_attribute_format
vol_read_iops	json	Triggers alert if the number of disk read operations from a cluster volume exceeds the configured threshold. JSON Format: $threshold_attribute_format
vol_write_iops	json	Triggers alert if the number of disk write operations to the cluster volume exceeds the configured threshold. JSON Format: $threshold_attribute_format
free_storage_threshold	json	Triggers alert if the amount of available storage space exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
replica_lag	json	Triggers alert if the amount of time a replica instance lags behind the source instance exceeds the configured threshold. JSON Format: $threshold_attribute_format
burst_balance_threshold	json	Triggers alert if the percent of available burst-bucket credits exceeds the configured threshold. JSON Format: $threshold_attribute_format
replication_slot_lag	json	Triggers alert if the lagging size of replication slot exceeds the configured threshold. JSON Format: $threshold_attribute_format
replication_slot_disk	json	Triggers alert if the amount of space used by replication slot files exceeds the configured threshold. JSON Format: $threshold_attribute_format
logs_generation	json	Triggers alert if the size of transaction logs generated per second exceeds the configured threshold. JSON Format: $threshold_attribute_format
serverless_db_capacity	json	Triggers an alert if the serverless aurora database instance capacity exceeds the configured threshold. JSON Format: $threshold_attribute_format
total_backup_storage	json	Triggers an alert if the total amount of backup storage billed exceeds the configured threshold. JSON Format: $threshold_attribute_format
snapshot_storage	json	Triggers an alert if the total amount of backup storage consumed by snapshots exceeds the configured threshold. JSON Format: $threshold_attribute_format
backup_retention_storage	json	Triggers an alert if the total amount of backup storage used to support restore feature exceeds the configured threshold. JSON Format: $threshold_attribute_format
backtrack_records_rate	json	Triggers an alert if the number of backtrack change records created exceeds the configured threshold. JSON Format: $threshold_attribute_format
backtrack_records_storage	json	Triggers an alert if the actual number of backtrack change records used exceeds the configured threshold. JSON Format: $threshold_attribute_format
backtrack_window_actual	json	Triggers an alert if the difference between the target backtrack window and the actual backtrack window exceeds the configured threshold. JSON Format: $threshold_attribute_format
backtrack_window_alert	json	Triggers an alert if the configured threshold exceeds the number of times the actual backtrack window is smaller than the target backtrack window. JSON Format: $threshold_attribute_format
max_storage_percentage	json	Triggers an alert if the maximum used storage percentage exceeds the configured threshold. JSON Format: $threshold_attribute_format

SNS Topic Monitor

Attribute	Type	Description
type	string	Mandatory SNSTOPIC
profile_name	string	Mandatory Name of the profile
number_of_messages_published	json	Triggers alert if the number of messages published exceeds the configured threshold. JSON Format: $threshold_attribute_format
pubic_size	json	Triggers alert if the publish size exceeds the configured threshold. JSON Format: $threshold_attribute_format
number_of_notifications_delivered	json	Triggers alert if the number of notifications delivered exceeds the configured threshold. JSON Format: $threshold_attribute_format
number_of_notifications_failed	json	Triggers alert if the number of notifications failed exceeds the configured threshold. JSON Format: $threshold_attribute_format
sms_success_rate	json	Triggers alert if the SMS success rate exceeds the configured threshold. JSON Format: $threshold_attribute_format

DynamoDB Table Monitor

Attribute	Type	Description
type	string	Mandatory DYNAMODBTABLE
profile_name	string	Mandatory Name of the profile
conditional_check_failed_requests	json	Triggers alert if the number of failed conditional writes exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
consumed_read_capacity_units	json	Triggers alert if the number of consumed read capacity units exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
consumed_write_capacity_units	json	Triggers alert if the number of consumed write capacity units exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
provisioned_read_capacity_units	json	Triggers alert if the number of provisioned read capacity units exceeds the configured threshold Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
provisioned_write_capacity_units	json	Triggers alert if the number of provisioned write capacity units exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
get_latency	json	Triggers alert if the successful request latency for GetItem operation exceeds the configured threshold. JSON Format: $threshold_attribute_format
put_latency	json	Triggers alert if the successful request latency for PutItem operation exceeds the configured threshold. JSON Format: $threshold_attribute_format
query_latency	json	Triggers alert if the successful request latency for Query operation exceeds the configured threshold. JSON Format:$threshold_attribute_format
query_returned_item_count	json	Triggers alert if the number of items returned by the Query operation exceeds the configured threshold. JSON Format: $threshold_attribute_format
read_throttle_events	json	Triggers alert if the number of throttled read requests exceeds the configured threshold. JSON Format: $threshold_attribute_format
scan_returned_item_count	json	Triggers alert if the number of items returned by scan operation exceeds the configured threshold. JSON Format: $threshold_attribute_format
throttled_batch_get_item_requests	json	Triggers alert if the number of requests throttled for BatchGetItem operation exceeds the configured threshold. JSON Format: $threshold_attribute_format
throttled_batch_write_item_requests	json	Triggers alert if the number of requests throttled for BatchWriteItem operation exceeds the configured threshold. JSON Format: $threshold_attribute_format
throttled_delete_item_requests	json	Triggers alert if the number of requests throttled for DeleteItem operation exceeds the configured threshold. JSON Format: $threshold_attribute_format
throttled_get_item_requests	json	Triggers alert if the number of requests throttled for GetItem operation exceeds the configured threshold. JSON Format: $threshold_attribute_format
throttled_put_item_requests	json	Triggers alert if the number of requests throttled for PutItem operation exceeds the configured threshold.  JSON Format: $threshold_attribute_format
throttled_query_requests	json	Triggers alert if the number of requests throttled for Query operation exceeds the configured threshold. JSON Format: $threshold_attribute_format
throttled_scan_requests	json	Triggers alert if the number of requests throttled for Scan operation exceeds the configured threshold. JSON Format: $threshold_attribute_format
throttled_update_item_requests	json	Triggers alert if the number of requests throttled for UpdateItem operation exceeds the configured threshold. JSON Format: $threshold_attribute_format
user_errors	json	Triggers alert if the number of requests that generated a HTTP 400 status code exceeds the configured threshold. JSON Format: $threshold_attribute_format
write_throttle_events	json	Triggers alert if the number of throttled write requests exceeds the configured threshold. JSON Format: $threshold_attribute_format
online_consumed_write	json	Triggers alert if the number of write capacity units consumed when adding a new global secondary index exceeds the configured threshold. JSON Format: $threshold_attribute_format
online_percentage_progress	json	Triggers alert if the percentage progress of global secondary index completion exceeds the configured threshold. JSON Format: $threshold_attribute_format
online_throttle_events	json	Triggers alert if the number of write throttle events during new global secondary index addition exceeds the configured threshold. JSON Format: $threshold_attribute_format
replication_count	json	Triggers alert if the pending replication count exceeds the configured threshold. JSON Format: $threshold_attribute_format
replication_latency	json	Triggers alert if the replication latency exceeds the configured threshold. JSON Format: $threshold_attribute_format
returned_bytes	json	Triggers alert if the number of bytes returned by GetRecords operation exceeds the configured threshold. JSON Format: $threshold_attribute_format
deleted_item_count	json	Triggers alert if the number of items deleted by Time To Live (TTL) exceeds the configured threshold. JSON Format: $threshold_attribute_format
total_item_count	json	Triggers alert if the total number of items exceeds the configured threshold. JSON Format: $threshold_attribute_format
returned_records	json	Triggers alert if the number of returned records exceeds the configured threshold. JSON Format: $threshold_attribute_format
delete_latency	json	Triggers alert if the successful request latency for delete item operation exceeds the configured threshold. JSON Format: $threshold_attribute_format
update_latency	json	Triggers alert if the successful request latency for update item operation exceeds the configured threshold. JSON Format: $threshold_attribute_format
batch_get_latency	json	Triggers alert if the successful batch request latency for get item operation exceeds the configured threshold. JSON Format: $threshold_attribute_format
batch_write_latency	json	Triggers alert if the successful batch request latency for write item operation exceeds the configured threshold. JSON Format: $threshold_attribute_format
system_error_get	json	Triggers alert if the number of requests that generated a HTTP 500 status code for GetItem operation exceeds the configured threshold. JSON Format: $threshold_attribute_format
system_error_put	json	Triggers alert if the number of requests that generated a HTTP 500 status code for PutItem operation exceeds the configured threshold. JSON Format: $threshold_attribute_format
system_error_query	json	Triggers alert if the number of requests that generated a HTTP 500 status code for Query operation exceeds the configured threshold JSON Format: $threshold_attribute_format
system_error_scan	json	Triggers alert if the number of requests that generated a HTTP 500 status code for Scan operation exceeds the configured threshold. JSON Format: $threshold_attribute_format
system_error_delete	json	Triggers alert if the number of requests that generated a HTTP 500 status code for Delete operation exceeds the configured threshold. JSON Format: $threshold_attribute_format
system_error_update	json	Triggers alert if the number of requests that generated a HTTP 500 status code for UpdateItem operation exceeds the configured threshold. JSON Format: $threshold_attribute_format
system_error_batch_get	json	Triggers alert if the number of requests that generated a HTTP 500 status code for BatchGetItem operation exceeds the configured threshold.  JSON Format: $threshold_attribute_format
system_error_batch_write	json	Triggers alert if the number of requests that generated a HTTP 500 status code for BatchWriteItem operation exceeds the configured threshold. JSON Format: $threshold_attribute_format

Classic Load Balancer

Attribute	Type	Description
type	string	Mandatory LOADBALANCER
profile_name	string	Mandatory Name of the profile
ELB_4XX	json	Triggers alert when configured threshold is exceeded. JSON Format: $threshold_attribute_format
ELB_5XX	json	Triggers alert when configured threshold is exceeded. JSON Format: $threshold_attribute_format
backend_connection_errors	json	Triggers alert when configured threshold is exceeded. JSON Format: $threshold_attribute_format
latency	json	Triggers alert when configured threshold is exceeded. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
spill_over_count	json	Triggers alert when configured threshold is exceeded. JSON Format: $threshold_attribute_format
request_count_sum	json	Triggers alert when configured threshold is exceeded. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
request_count_avg	json	Triggers alert when configured threshold is exceeded. JSON Format: $threshold_attribute_format
surge_queue_length	json	Triggers alert when configured threshold is exceeded. JSON Format: $threshold_attribute_format
healthy_host_count	json	Triggers alert when configured threshold is exceeded. JSON Format: $threshold_attribute_format
unhealthy_host_count	json	Triggers alert when configured threshold is exceeded. JSON Format: $threshold_attribute_format
beanstalk_resource_alert	json	Notify for monitored resource status change. JSON Format: {value:true/false, severity:“$status”}

Application Load Balancer

Attribute	Type	Description
type	string	Mandatory APPLN-LOADBALANCER
profile_name	string	Mandatory Name of the profile
ELB_4XX	json	Triggers alert if the HTTP 4xx error exceeds the configured threshold. JSON Format: $threshold_attribute_format
ELB_5XX	json	Triggers alert if the HTTP 5xx error exceeds the configured threshold. JSON Format: $threshold_attribute_format
client_tls_errors	json	Triggers alert if the client TLS error exceeds the configured threshold. JSON Format: $threshold_attribute_format
consumed_lcus_sum	json	Triggers alert if the consumed LCU sum exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
consumed_lcus_average	json	Triggers alert if the consumed LCU average exceeds the configured threshold. JSON Format: $threshold_attribute_format
latency	json	Triggers alert if the average latency exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
active_connections	json	Triggers alert if the active connections exceeds the configured threshold. JSON Format: $threshold_attribute_format
new_connections	json	Triggers alert if the new connection exceeds the configured threshold. JSON Format: $threshold_attribute_format
rejected_connections	json	Triggers alert if the rejected connection exceeds the configured threshold. JSON Format: $threshold_attribute_format
request_count_sum	json	Triggers alert if the request count sum exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
request_count_avg	json	Triggers alert if the request count average exceeds the configured threshold. JSON Format: $threshold_attribute_format
healthy_host_count	json	Triggers alert if the healthy host exceeds the configured threshold. JSON Format: $threshold_attribute_format
unhealthy_host_count	json	Triggers alert if the unhealthy host exceeds the configured threshold. JSON Format: $threshold_attribute_format
ipv6_bytes	json	Triggers alert if the IPV6 processed bytes exceeds the configured threshold. JSON Format: $threshold_attribute_format
ipv6_count	json	Triggers alert if the IPV6 request count exceeds the configured threshold. JSON Format: $threshold_attribute_format
processed_bytes	json	Triggers alert if the processed bytes exceeds the configured threshold. JSON Format: $threshold_attribute_format
rule_evaluation	json	Triggers alert if the rule evaluation exceeds the configured threshold. JSON Format: $threshold_attribute_format
target_connection_errors	json	Triggers alert if the target connection error exceeds the configured threshold. JSON Format: $threshold_attribute_format
healthy_host_target	json	Triggers alert if the healthy host per target exceeds the configured threshold. JSON Format: $threshold_attribute_format
unhealthy_host_target	json	Triggers alert if the unhealthy host per target exceeds the configured threshold. JSON Format: $threshold_attribute_format
target_request_count	json	Triggers alert if the request count per target exceeds the configured threshold. JSON Format: $threshold_attribute_format
TARGET_2XX	json	Triggers alert if the target HTTP 2xx count exceeds the configured threshold. JSON Format:$threshold_attribute_format
TARGET_3XX	json	Triggers alert if the target HTTP 3xx count exceeds the configured threshold. JSON Format: $threshold_attribute_format
TARGET_4XX	json	Triggers alert if the target HTTP 4xx count exceeds the configured threshold. JSON Format: $threshold_attribute_format
TARGET_5XX	json	Triggers alert if the target HTTP 5xx count exceeds the configured threshold. JSON Format: $threshold_attribute_format
beanstalk_resource_alert	json	Notify for monitored resource status change. JSON Format: {value:true/false, severity:“$status”}

Network Load Balancer

Attribute	Type	Description
type	string	Mandatory NETWORK-LOADBALANCER
profile_name	string	Mandatory Name of the profile
active_flow_count	json	Triggers alert if the active flow count exceeds the configured threshold. JSON Format: $threshold_attribute_format
new_flow_count	json	Triggers alert if the new flow count exceeds the configured threshold. JSON Format:$threshold_attribute_format
consumed_lcus_sum	json	Triggers alert if the consumed LCU sum exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format:$threshold_attribute_format
consumed_lcus_average	json	Triggers alert if the consumed LCU average exceeds the configured threshold. JSON Format: $threshold_attribute_format
healthy_host_count	json	Triggers alert if the healthy host exceeds the configured threshold. JSON Format: $threshold_attribute_format
unhealthy_host_count	json	Triggers alert if the unhealthy host exceeds the configured threshold. JSON Format: $threshold_attribute_format
healthy_host_target	json	Triggers alert if the healthy host per target exceeds the configured threshold. JSON Format: $threshold_attribute_format
unhealthy_host_target	json	Triggers alert if the unhealthy host per target exceeds the configured threshold. JSON Format: $threshold_attribute_format
processed_bytes	json	Triggers alert if the processed bytes exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
client_reset	json	Triggers alert if the TCP client reset count exceeds the configured threshold. JSON Format:$threshold_attribute_format
elb_reset	json	Triggers alert if the TCP ELB reset count exceeds the configured threshold. JSON Format: $threshold_attribute_format
target_reset	json	Triggers alert if the TCP target reset count exceeds the configured threshold. JSON Format: $threshold_attribute_format
beanstalk_resource_alert	json	Notify for monitored resource status change. JSON Format: {value:true/false, severity:“$status”}

Gateway Load Balancer

Attribute	Type	Description
type	string	Mandatory GATEWAY-LOADBALANCER

profile_name|string| Mandatory
Name of the profile active_flow_count|json|Triggers alerts if the active flow count exceeds the configured threshold.
Anomaly Enabled Attribute.
JSON Format: $threshold_attribute_format new_flow_count|json|Triggers alerts if the new flow count exceeds the configured threshold.
Anomaly Enabled Attribute.
JSON Format:$threshold_attribute_format consumed_lcus_sum|json|Triggers alerts if the consumed LCU sum exceeds the configured threshold.
Anomaly Enabled Attribute.
JSON Format:$threshold_attribute_format consumed_lcus_avg|json|Triggers alerts if the consumed LCU average exceeds the configured threshold.
JSON Format: $threshold_attribute_format processed_bytes|json|Triggers alerts if the processed bytes exceeds the configured threshold.
Anomaly Enabled Attribute.
JSON Format: $threshold_attribute_format total_healthy_host_target|json|Triggers alerts if the total healthy host target exceeds the configured threshold.
JSON Format: $threshold_attribute_format total_unhealthy_host_target|json|Triggers alerts if the total unhealthy host target exceeds the configured threshold.
JSON Format: $threshold_attribute_format az_active_flow_count|json|Triggers alerts if the active flow count exceeds the configured threshold (Per Availability Zone).
JSON Format:$threshold_attribute_format az_new_flow_count|json|Triggers alerts if the new flow count exceeds the configured threshold (Per Availability Zone).
JSON Format: $threshold_attribute_format az_processed_bytes|json|Triggers alerts if the processed bytes exceeds the configured threshold (Per Availability Zone).
JSON Format: $threshold_attribute_format service_endpoint_connected|json|Triggers an alert when the stack is disassociated from the fleet.
JSON Format:$threshold_attribute_format total_count_of_connected_endpoints|json|Triggers alerts if total End Point connected to service exceeds the configured threshold.
JSON Format: $threshold_attribute_format notify_for_deleted|json|Triggers alerts if endpoint gets deleted.
JSON Format: $threshold_attribute_format notify_for_failed|json|Triggers alerts if endpoint gets fails.
JSON Format: $threshold_attribute_format notify_for_rejected|json|Triggers alerts if endpoint gets rejected.
JSON Format: $threshold_attribute_format healthy_host_target|json|Triggers alerts if the healthy host per target exceeds the configured threshold.
JSON Format: $threshold_attribute_format unhealthy_host_target|json|Triggers alerts if the unhealthy host per target exceeds the configured threshold.
JSON Format: $threshold_attribute_format beanstalk_resource_alert|json|Notify for monitored resource status change.
JSON Format: {value:true/false, severity:“$status”}

Lambda Function Monitor

Attribute	Type	Description
type	string	Mandatory LAMBDAFUNCTION
profile_name	string	Mandatory Name of the profile
invocations_sum	json	Triggers alert if the number of times a function is invoked exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
invocations_average	json	Triggers alert if the average number of times a function is invoked exceeds the configured threshold. JSON Format: $threshold_attribute_format
errors_sum	json	Triggers alert if the number of invocations that failed due to errors exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
errors_average	json	Triggers alert if the average number of invocations that failed due to errors exceeds the configured threshold. JSON Format: $threshold_attribute_format
duration_sum	json	Triggers alert if the amount of time taken by the function to complete execution exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
duration_average	json	Triggers alert if the average amount of time taken by the function to complete execution exceeds the configured threshold. JSON Format: $threshold_attribute_format
throttles_sum	json	Triggers alert if the number of throttled function invocation attempts exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
throttles_average	json	Triggers alert if the average number of throttled function invocation attempts exceeds the configured threshold. JSON Format: $threshold_attribute_format
iterator_age_sum	json	Triggers alert if the sum of the age of last record for each batch exceeds the configured threshold. JSON Format: $threshold_attribute_format
iterator_age_average	json	Triggers alert if the average of the age of last record for each batch exceeds the configured threshold. JSON Format: $threshold_attribute_format
iterator_age_maximum	json	Triggers alert if the maximum value of the age of last record for each batch exceeds the configured threshold. JSON Format: $threshold_attribute_format
iterator_age_minimum	json	Triggers alert if the minimum value of the age of last record for each batch exceeds the configured threshold. JSON Format: $threshold_attribute_format
dead_letter_error	json	Triggers alert if the number of attempts failed to write payload event in dead letter queues exceeds the configured threshold. JSON Format: $threshold_attribute_format
successful_percentage	json	Triggers alert if the percentage of successful execution exceeds the configured threshold. JSON Format: $threshold_attribute_format

EC Memcached Cluster Monitor

Attribute	Type	Description
type	string	Mandatory EC-MEMCACHED
profile_name	string	Mandatory Name of the profile
cpu_threshold	json	Triggers alert if the CPU usage exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
ec_memcached_bytes_used_for_cache	json	Triggers alert if the bytes used by the cache exceeds the configured threshold. JSON Format: $threshold_attribute_format
ec_memcached_cache_evictions	json	Triggers alert if the number of evictions exceeds the configured threshold. JSON Format: $threshold_attribute_format
ec_memcached_cache_reclaimed	json	Triggers alert if the number of reclaims exceeds the configured threshold. JSON Format: $threshold_attribute_format
ec_memcached_cache_connections	json	Triggers alert if the average number of connections exceeds the configured threshold. JSON Format: $threshold_attribute_format
ec_memcached_cache_currentitems	json	Triggers alert if the average number of current items exceeds the configured threshold. JSON Format: $threshold_attribute_format
ec_memcached_cache_swapusage	json	Triggers alert if the swap usage exceeds the configured threshold. JSON Format: $threshold_attribute_format
ec_memcached_cache_hits	json	Triggers alert if the number of hits exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
ec_memcached_cache_misses	json	Triggers alert if the number of misses exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
ec_memcached_cmdflush	json	Triggers alert if the number of Flush commands received by cache exceeds the configured threshold. JSON Format: $threshold_attribute_format
ec_memcached_cmdget	json	Triggers alert if the number of Get commands received by cache exceeds the configured threshold. JSON Format: $threshold_attribute_format
ec_memcached_cmdset	json	Triggers alert if the number of Set commands received by cache exceeds the configured threshold. JSON Format: $threshold_attribute_format

EC Memcached Node Monitor

Attribute	Type	Description
type	string	Mandatory EC-MEM-NODE
profile_name	string	Mandatory Name of the profile
cpu_threshold	json	Triggers alert if the CPU usage exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
ec_memcached_bytes_used_for_cache	json	Triggers alert if the bytes used by the cache exceeds the configured threshold. JSON Format: $threshold_attribute_format
ec_memcached_cache_evictions	json	Triggers alert if the number of evictions exceeds the configured threshold. JSON Format: $threshold_attribute_format
ec_memcached_cache_reclaimed	json	Triggers alert if the number of reclaims exceeds the configured threshold. JSON Format: $threshold_attribute_format
ec_memcached_cache_connections	json	Triggers alert if the average number of connections exceeds the configured threshold. JSON Format: $threshold_attribute_format
ec_memcached_cache_currentitems	json	Triggers alert if the average number of current items exceeds the configured threshold. JSON Format:$threshold_attribute_format
ec_memcached_cache_swapusage	json	Triggers alert if the swap usage exceeds the configured threshold. JSON Format: $threshold_attribute_format
ec_memcached_cache_hits	json	Triggers alert if the number of hits exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
ec_memcached_cache_misses	json	Triggers alert if the number of misses exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
ec_memcached_cmdflush	json	Triggers alert if the number of Flush commands received by cache exceeds the configured threshold. JSON Format:$threshold_attribute_format
ec_memcached_cmdget	json	Triggers alert if the number of Get commands received by cache exceeds the configured threshold. JSON Format: $threshold_attribute_format
ec_memcached_cmdset	json	Triggers alert if the number of Set commands received by cache exceeds the configured threshold. JSON Format: $threshold_attribute_format

EC Redis Node Monitor

Attribute	Type	Description
type	string	Mandatory EC-REDIS
profile_name	string	Mandatory Name of the profile
cpu_threshold	json	Triggers alert if the CPU usage exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
ec_redis_bytes_used_for_cache	json	Triggers alert if the bytes used by the cache exceeds the configured threshold. JSON Format: $threshold_attribute_format
ec_redis_cache_evictions	json	Triggers alert if the number of evictions exceeds the configured threshold. JSON Format: $threshold_attribute_format
ec_redis_cache_reclaimed	json	Triggers alert if the number of reclaims exceeds the configured threshold. JSON Format: $threshold_attribute_format
ec_redis_cache_connections	json	Triggers alert if the average number of connections exceeds the configured threshold. JSON Format: $threshold_attribute_format
ec_redis_cache_currentitems	json	Triggers alert if the average number of current items exceeds the configured threshold. JSON Format: $threshold_attribute_format
ec_redis_cache_swapusage	json	Triggers alert if the swap usage exceeds the configured threshold. JSON Format: $threshold_attribute_format
ec_redis_cache_hits	json	Triggers alert if the number of hits exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format:$threshold_attribute_format
ec_redis_cache_misses	json	Triggers alert if the number of misses exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
ec_redis_new_connections	json	Triggers alert if the number of new connections exceeds the configured threshold. JSON Format: $threshold_attribute_format

S3 Bucket Monitor

Attribute	Type	Description
type	string	Mandatory S3BUCKET
profile_name	string	Mandatory Name of the profile
bucket_size_threshold	json	Triggers alert if Bucket Size exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
object_count_threshold	json	Triggers alert if Object Count exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
all_request_threshold	json	Triggers alert if All Requests exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
get_request_threshold	json	Triggers alert if Get Requests exceeds the configured threshold. JSON Format: $threshold_attribute_format
put_request_threshold	json	Triggers alert if Put Requests exceeds the configured threshold. JSON Format: $threshold_attribute_format
delete_request_threshold	json	Triggers alert if Delete Requests exceeds the configured threshold. JSON Format: $threshold_attribute_format
head_request_threshold	json	Triggers alert if Head Requests exceeds the configured threshold. JSON Format: $threshold_attribute_format
post_request_threshold	json	Triggers alert if Post Requests exceeds the configured threshold. JSON Format: $threshold_attribute_format
list_request_threshold	json	Triggers alert if List Requests exceeds the configured threshold. JSON Format: $threshold_attribute_format
bytes_downloaded_threshold	json	Triggers alert if Bytes Downloaded exceeds the configured threshold. JSON Format: $threshold_attribute_format
bytes_uploaded_threshold	json	Triggers alert if Bytes Uploaded exceeds the configured threshold. JSON Format: $threshold_attribute_format
s3_4xx_errors_threshold	json	Triggers alert if HTTP 4XX Errors exceeds the configured threshold. JSON Format: $threshold_attribute_format
s3_5xx_errors_threshold	json	Triggers alert if HTTP 5XX Errors exceeds the configured threshold. JSON Format: $threshold_attribute_format
first_byte_latency_threshold	json	Triggers alert if First Byte Latency exceeds the configured threshold. JSON Format: $threshold_attribute_format
total_latency_threshold	json	Triggers alert if Total Request Latency exceeds the configured threshold. JSON Format: $threshold_attribute_format
replication_latency	json	Triggers alert if the number of seconds by which the replication destination region is behind the source region for a given replication rule exceeds the configured threshold. JSON Format: $threshold_attribute_format
pending_bytes	json	Triggers alert if the total number of bytes of objects pending replication for a given replication rule exceeds the configured threshold. JSON Format: $threshold_attribute_format
pending_operations	json	Triggers alert if the number of operations pending replication for a given replication rule exceeds the configured threshold. JSON Format: $threshold_attribute_format

S3 Object Monitor

Attribute	Type	Description
type	string	Mandatory S3ENDPOINT
profile_name	string	Mandatory Name of the profile
down_location_threshold	int	Mandatory Triggers alert when the monitor is down from configured number of locations. Downtime Rules Constants
response_time_threshold	json	Response time threshold for primary and secondary monitoring location. JSON Format: {“primary”: {$threshold_attribute_format}, “secondary”: {$threshold_attribute_format}}

S3 Folder Monitor

Attribute	Type	Description
type	string	Mandatory S3FOLDER
profile_name	string	Mandatory The profile name.
object_count_threshold	json	Triggers alert if the object count exceeds the configured threshold. JSON Format: $threshold_attribute_format
total_object_count_threshold	json	Triggers alert if the total object count exceeds the configured threshold. JSON Format: $threshold_attribute_format
modified_object_count_threshold	json	Triggers alert if the modified object count exceeds the configured threshold. JSON Format: $threshold_attribute_format
folder_count_threshold	json	Triggers alert if the folder count exceeds the configured threshold. JSON Format: $threshold_attribute_format
total_folder_count_threshold	json	Triggers alert if the total folder count exceeds the configured threshold. JSON Format: $threshold_attribute_format
max_object_size_threshold	json	Triggers alert if the maximum object size exceeds the configured threshold. JSON Format: $threshold_attribute_format
min_object_size_threshold	json	Triggers alert if the minimum object size exceeds the configured threshold. JSON Format: $threshold_attribute_format

SQS Queue Monitor

Attribute	Type	Description
type	string	Mandatory SQS
profile_name	string	Mandatory Name of the profile
sqs_approx_age_of_oldest_messages	json	Triggers alert if the average approximate age of the oldest non-deleted message in the queue exceeds the configured threshold. JSON Format: $threshold_attribute_format
sqs_approx_num_of_msgs_delayed	json	Triggers alert if the average number of messages in the queue that are delayed exceeds the configured threshold. JSON Format: $threshold_attribute_format
sqs_approx_num_of_msgs_not_visible	json	Triggers alert if the average number of messages that are in flight exceeds the configured threshold. JSON Format: $threshold_attribute_format
sqs_approx_num_of_msgs_visible	json	Triggers alert if the average number of messages available for retrieval from the queue exceeds the configured threshold. JSON Format: $threshold_attribute_format
sqs_num_of_empty_msgs	json	Triggers alert if the total number of ReceiveMessage API calls that did not return a message exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
sqs_num_of_msgs_deleted	json	Triggers alert if the total number of messages deleted from the queue exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
sqs_num_of_msgs_received	json	Triggers alert if the total number of messages returned by calls to the ReceiveMessage API action exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
sqs_num_of_msgs_sent	json	Triggers alert if the total number of messages added to a queue exceeds the configured threshold. JSON Format: $threshold_attribute_format
sqs_sent_msg_size	json	Triggers alert if the average size of messages added to a queue exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format

CloudFront Distribution Monitor

Attribute	Type	Description
type	string	Mandatory CLOUDFRONT
profile_name	string	Mandatory Name of the profile
requests_threshold	json	Triggers alert if the number of requests for all HTTP methods exceeds the configured threshold. JSON Format: $threshold_attribute_format
bytes_downloaded_threshold	json	Triggers alert if the number of bytes downloaded by viewers exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
bytes_uploaded_threshold	json	Triggers alert if the number of bytes uploaded to origin exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
total_error_rate	json	Triggers alert if the percentage of all HTTP 4xx and HTTP 5xx error requests exceeds the configured threshold. JSON Format: $threshold_attribute_format
http_4xx	json	Triggers alert if the percentage of all HTTP 4xx error requests exceeds the configured threshold. JSON Format: $threshold_attribute_format
http_5xx	json	Triggers alert if the percentage of all HTTP 5xx error requests exceeds the configured threshold. JSON Format:$threshold_attribute_format
lambda_execution_error	json	Triggers alert when the Execution Errors violates the configured the configured threshold. JSON Format: $threshold_attribute_format
lambda_validation_error	json	Triggers alert when the Invalid Function Responses violates the configured threshold. JSON Format: $threshold_attribute_format
throttles	json	Triggers alert when the Throttles violates the configured threshold. JSON Format:$threshold_attribute_format

Kinesis Data Stream Monitor

Attribute	Type	Description
type	string	Mandatory KINESIS-DATA
profile_name	string	Mandatory Name of the profile
getrecords_bytes	json	Triggers alert if the number of bytes retrieved from the Kinesis stream exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
getrecords_iteratorage	json	Triggers alert if the age of the last record in GetRecord calls exceeds the configured threshold. JSON Format: $threshold_attribute_format
get_latency	json	Triggers alert if the time taken per GetRecord operation exceeds the configured threshold. JSON Format: $threshold_attribute_format
getrecords_records	json	Triggers alert if the number of records retrieved from the shard exceeds the configured threshold. JSON Format: $threshold_attribute_format
getrecords_success	json	Triggers alert if the number of successful GetRecord operations exceeds the configured threshold. JSON Format: $threshold_attribute_format
incoming_bytes	json	Triggers alert if the number of bytes successfully put to the Kinesis stream exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format:$threshold_attribute_format
incoming_records	json	Triggers alert if the number of records successfully put to the Kinesis stream exceeds the configured threshold. JSON Format: $threshold_attribute_format
putrecord_bytes	json	Triggers alert if the number of bytes put to the Kinesis stream using PutRecord operation exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
put_latency	json	Triggers alert if the time taken per PutRecord operation exceeds the configured threshold. JSON Format: $threshold_attribute_format
putrecord_success	json	Triggers alert if the number of successful PutRecord operations exceeds the configured threshold. JSON Format: $threshold_attribute_format
putrecords_bytes	json	Triggers alert if the number of bytes put to the Kinesis stream using PutRecords operation exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
putrecords_latency	json	Triggers alert if the time taken per PutRecords operation exceeds the configured threshold. JSON Format: $threshold_attribute_format
putrecords_records	json	Triggers alert if the number of successful records in a PutRecords operation exceeds the configured threshold. JSON Format: $threshold_attribute_format
putrecords_success	json	Triggers alert if the number of successful PutRecords operations exceeds the configured threshold. JSON Format: $threshold_attribute_format
read_throughput	json	Triggers alert if the number of GetRecord calls rejected due to throttled for the stream exceeds the configured threshold. JSON Format: $threshold_attribute_format
write_throughput	json	Triggers alert if the number of PutRecord calls rejected due to throttling for the stream exceeds the configured threshold. JSON Format: $threshold_attribute_format

Kinesis Firehose Delivery Stream Monitor

Attribute	Type	Description
type	string	Mandatory KINESIS-FIREHOSE
profile_name	string	Mandatory Name of the profile
delivery_stream_latency	json	Triggers alert if the time taken per DescribeDeliveryStream operation exceeds the configured threshold. JSON Format: $threshold_attribute_format
delivery_stream_requests	json	Triggers alert if the total number of DescribeDeliveryStream requests exceeds the configured threshold. JSON Format: $threshold_attribute_format
put_record_bytes	json	Triggers alert if the number of bytes put to the Kinesis Data Firehose delivery stream using PutRecord exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
put_record_latency	json	Triggers alert if the time taken per PutRecord operation exceeds the configured threshold. JSON Format: $threshold_attribute_format
put_record_requests	json	Triggers alert if the total number of PutRecord requests exceeds the configured threshold. JSON Format:$threshold_attribute_format
put_batch_bytes	json	Triggers alert if the number of bytes put to the Kinesis Data Firehose delivery stream using PutRecordBatch exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
put_batch_latency	json	Triggers alert if the time taken per PutRecordBatch operation exceeds the configured threshold. JSON Format:$threshold_attribute_format
put_batch_records	json	Triggers alert if the total number of records from PutRecordBatch operations exceeds the configured threshold. JSON Format: $threshold_attribute_format
put_batch_requests	json	Triggers alert if the total number of PutRecordBatch requests exceeds the configured threshold. JSON Format: $threshold_attribute_format
update_stream_latency	json	Triggers alert if the time taken per UpdateDeliveryStream operation exceeds the configured threshold. JSON Format: $threshold_attribute_format
update_stream_requests	json	Triggers alert if the total number of UpdateDeliveryStream requests exceeds the configured threshold. JSON Format: $threshold_attribute_format
incoming_bytes	json	Triggers alert if the number of bytes ingested into the Kinesis Data Firehose stream exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
incoming_records	json	Triggers alert if the number of records ingested into the Kinesis Data Firehose stream exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
ec_bytes	json	Triggers alert if the number of bytes indexed to Amazon ES exceeds the configured threshold. JSON Format: $threshold_attribute_format
ec_records	json	Triggers alert if the number of records indexed to Amazon ES exceeds the configured threshold. JSON Format: $threshold_attribute_format
ec_success	json	Triggers alert if the number of successfully indexed records exceeds the configured threshold. JSON Format:$threshold_attribute_format
s3_bytes	json	Triggers alert if the number of bytes delivered to Amazon S3 exceeds the configured threshold. JSON Format: $threshold_attribute_format
s3_data	json	Triggers alert if the age of the oldest record exceeds the configured threshold. JSON Format: $threshold_attribute_format
s3_data_max	json	Triggers an alert if the maximum age of the oldest record in S3 exceeds the configured threshold. JSON Format: $threshold_attribute_format
s3_records	json	Triggers alert if the number of records delivered to Amazon S3 exceeds the configured threshold. JSON Format: $threshold_attribute_format
s3_success	json	Triggers alert if the number of successfully delivered records exceeds the configured threshold. JSON Format: $threshold_attribute_format
rs_bytes	json	Triggers alert if the number of bytes copied to Amazon Redshift exceeds the configured threshold. JSON Format: $threshold_attribute_format
rs_records	json	Triggers alert if the number of records copied to Amazon Redshift exceeds the configured threshold. JSON Format: $threshold_attribute_format
rs_success	json	Triggers alert if the number of successfully copied records exceeds the configured threshold. JSON Format: $threshold_attribute_format
splunk_bytes	json	Triggers alert if the number of bytes delivered to Splunk exceeds the configured threshold. JSON Format: $threshold_attribute_format
splunk_data	json	Triggers alert if the age of the oldest record exceeds the configured threshold. JSON Format: $threshold_attribute_format
splunk_data_max	json	Triggers an alert if the maximum age of the oldest record exceeds the configured threshold. JSON Format: $threshold_attribute_format
splunk_records	json	Triggers alert if the number of records delivered to Splunk exceeds the configured threshold. JSON Format: $threshold_attribute_format
splunk_success	json	Triggers alert if the number of successfully delivered records exceeds the configured threshold. JSON Format: $threshold_attribute_format
lambda_duration	json	Triggers alert if the time taken for each Lambda function invocation exceeds the configured threshold. JSON Format: $threshold_attribute_format
lambda_success	json	Triggers alert if the number of successful invocations exceeds the configured threshold. JSON Format: $threshold_attribute_format
lambda_records	json	Triggers alert if the number of successfully processed records exceeds the configured threshold. JSON Format: $threshold_attribute_format
lambda_bytes	json	Triggers alert if the number of successfully processed bytes exceeds the configured threshold. JSON Format: $threshold_attribute_format
backup_bytes	json	Triggers alert if the number of bytes delivered to Amazon S3 for backup exceeds the configured threshold. JSON Format: $threshold_attribute_format
backup_data	json	Triggers alert if the age of the oldest record for backup exceeds the configured threshold. JSON Format: $threshold_attribute_format
backup_data_max	json	Triggers an alert if the maximum age of the oldest record for backup exceeds the configured threshold. JSON Format: $threshold_attribute_format
backup_records	json	Triggers alert if the number of records delivered to Amazon S3 for backup exceeds the configured threshold. JSON Format: $threshold_attribute_format
backup_success	json	Triggers alert if the number of successfully delivered records for backup exceeds the configured threshold. JSON Format: $threshold_attribute_format

Kinesis Analytics Application Monitor

Attribute	Type	Description
type	string	Mandatory KINESIS-ANALYTICS
profile_name	string	Mandatory Name of the profile
processing_units	json	Triggers alert if the number of kinesis processing units exceeds the configured threshold. JSON Format: $threshold_attribute_format
incoming_bytes	json	Triggers alert if the number of bytes read per input stream exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
outgoing_bytes	json	Triggers alert if the number of bytes written per output stream exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
millis_behind_latest	json	Triggers alert if the application read lag exceeds the configured threshold. JSON Format: $threshold_attribute_format
incoming_records	json	Triggers alert if the number of records read per input stream exceeds the configured threshold. JSON Format: $threshold_attribute_format
outgoing_records	json	Triggers alert if the number of records written per outgoing stream exceeds the configured threshold. JSON Format: $threshold_attribute_format
input_duration	json	Triggers alert if the time taken for each Lambda function invocation exceeds the configured threshold. JSON Format: $threshold_attribute_format
input_okrecords	json	Triggers alert if the number of records returned by a Lambda function that were marked with Ok status exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
input_okbytes	json	Triggers alert if the sum of bytes of the records returned by a Lambda function that were marked with Ok status exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
input_dropped	json	Triggers alert if the number of records returned by a Lambda function that were marked with Dropped status exceeds the configured threshold. JSON Format: $threshold_attribute_format
input_failedrecords	json	Triggers alert if the number of records returned by a Lambda function that were marked with ProcessingFailed status exceeds the configured threshold. JSON Format: $threshold_attribute_format
input_success	json	Triggers alert if the number of successful Lambda invocations exceeds the configured threshold. JSON Format: $threshold_attribute_format
outgoing_bytes_data	json	Triggers alert if the number of bytes written to Kinesis Data Stream exceeds the configured threshold. JSON Format: $threshold_attribute_format
outgoing_records_data	json	Triggers alert if the number of records written to Kinesis Data stream exceeds the configured threshold. JSON Format: $threshold_attribute_format
success_data	json	Triggers alert if the number of successful delivery to Kinesis Data stream exceeds the configured threshold. JSON Format: $threshold_attribute_format
outgoing_bytes_firehose	json	Triggers alert if the number of bytes written to Kinesis Firehose exceeds the configured threshold. JSON Format: $threshold_attribute_format
outgoing_records_firehose	json	Triggers alert if the number of records written to Kinesis Firehose exceeds the configured threshold. JSON Format: $threshold_attribute_format
success_firehose	json	Triggers alert if the number of successful delivery to Kinesis Firehose exceeds the configured threshold. JSON Format: $threshold_attribute_format
outgoing_bytes_lambda	json	Triggers alert if the number of bytes written to Lambda function exceeds the configured threshold. JSON Format: $threshold_attribute_format
outgoing_records_lambda	json	Triggers alert if the number of records written to Lambda function exceeds the configured threshold. JSON Format: $threshold_attribute_format
success_lambda	json	Triggers alert if the number of successful delivery to Lambda function exceeds the configured threshold. JSON Format: $threshold_attribute_format
lambda_ok	json	Triggers alert if the number of records returned by a Lambda function that were marked with Ok status exceeds the configured threshold. JSON Format: $threshold_attribute_format
lambda_failed	json	Triggers alert if the number of records returned by a Lambda function that were marked with DeliveryFailed status exceeds the configured threshold. JSON Format: $threshold_attribute_format
lambda_duration	json	Triggers alert if the time taken for Lambda function invocation exceeds the configured threshold. JSON Format: $threshold_attribute_format

Kinesis Video Stream Monitor

Attribute	Type	Description
type	string	Mandatory KINESIS-VIDEO
profile_name	string	Mandatory Name of the profile
put_requests	json	Triggers alert if the number of PutMedia API requests exceeds the configured threshold. JSON Format: $threshold_attribute_format
put_bytes	json	Triggers alert if the number of bytes received as part of PutMedia exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
put_fragments	json	Triggers alert if the number of complete fragments received as part of PutMedia exceeds the configured threshold. JSON Format: $threshold_attribute_format
put_frames	json	Triggers alert if the number of complete frames received as part of PutMedia exceeds the configured threshold. JSON Format: $threshold_attribute_format
put_activeconnections	json	Triggers alert if the total number of connections to the service host exceeds the configured threshold. JSON Format: $threshold_attribute_format
put_connection_errors	json	Triggers alert if the number of errors while establishing PutMedia connection exceeds the configured threshold. JSON Format: $threshold_attribute_format
put_ingestion_latency	json	Triggers alert if the time difference between the first and last bytes of a fragment exceeds the configured threshold. JSON Format: $threshold_attribute_format
put_persist_latency	json	Triggers alert if the time taken from when the complete fragment data is received and archived exceeds the configured threshold. JSON Format: $threshold_attribute_format
put_latency	json	Triggers alert if the time difference between the request and the HTTP response from InletService exceeds the configured threshold. JSON Format: $threshold_attribute_format
put_buffering_latency	json	Triggers alert if the time difference between first byte of new fragment and buffering Ack received for fragment exceeds the configured threshold. JSON Format: $threshold_attribute_format
put_received_latency	json	Triggers alert if the time difference between last byte of new fragment and received Ack sent for fragment exceeds the configured threshold. JSON Format: $threshold_attribute_format
put_persisted_latency	json	Triggers alert if the time difference between last byte of fragment and persisted Ack sent for fragment exceeds the configured threshold. JSON Format: $threshold_attribute_format
put_error_count	json	Triggers alert if the number of Error Acks sent while doing PutMedia for the stream exceeds the configured threshold. JSON Format: $threshold_attribute_format
put_success	json	Triggers alert if the number failed fragments exceeds the configured value. JSON Format: $threshold_attribute_format
get_requests	json	Triggers alert if the number of GetMedia API requests exceeds the configured threshold. JSON Format: $threshold_attribute_format
get_bytes	json	Triggers alert if the number of bytes sent as part of GetMedia exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
get_fragments	json	Triggers alert if the number of complete fragments sent as part of GetMedia exceeds the configured threshold. JSON Format: $threshold_attribute_format
get_frames	json	Triggers alert if the number of complete frames sent as part of GetMedia exceeds the configured threshold. JSON Format: $threshold_attribute_format
get_millisbehindnow	json	Triggers alert if the time difference between the current server time stamp and the server time stamp of the last fragment sent exceeds the configured threshold. JSON Format: $threshold_attribute_format
get_connectionerrors	json	Triggers alert if the number of failed connections established exceeds the configured threshold. JSON Format: $threshold_attribute_format
get_success	json	Triggers alert if the number of failed sent fragments exceeds the configured threshold. JSON Format: $threshold_attribute_format
fragmentlist_bytes	json	Triggers alert if the total number of bytes sent out from the service as part of the GetMediaForFragmentList API exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
fragmentlist_fragments	json	Triggers alert if the total number of fragments sent out from the service as part of the GetMediaForFragmentList API exceeds the configured threshold. JSON Format: $threshold_attribute_format
fragmentlist_frames	json	Triggers alert if the total number of frames sent out from the service as part of the GetMediaForFragmentList API exceeds the configured threshold. JSON Format: $threshold_attribute_format
fragmentlist_requests	json	Triggers alert if the number of GetMediaForFragmentList API requests exceeds the configured threshold. JSON Format: $threshold_attribute_format
fragmentlist_success	json	Triggers alert if the number of successfully written media with GetMediaForFragmentList API exceeds the configured threshold. JSON Format: $threshold_attribute_format
listfragments_latency	json	Triggers alert if the latency of the ListFragments API calls exceeds the configured threshold. JSON Format: $threshold_attribute_format

Elastic Beanstalk Environment Monitor

Attribute	Type	Description
type	string	Mandatory EBSENVIRONMENT
profile_name	string	Mandatory Name of the profile
beanstalk_resource_alert	json	Notify for monitored resource status change. JSON Format: {value:true/false, severity:“$status”}
beanstalk_health_status	json	Notify for environment health failure. JSON Format: {value:true/false, severity:“$status”}
beanstalk_health_status_warning	json	Notify for environment health status warning. JSON Format: {value:true/false, severity:“$status”}
beanstalk_platform_deprecated	json	Notify when platform branch status is in deprecated state. JSON Format: {value:true/false, severity:“$status”}
beanstalk_platform_retired	json	Notify when platform branch status is in retired state. JSON Format: {value:true/false, severity:“$status”}
debug_count	json	Triggers alert if the number of events with DEBUG severity state exceeds the configured threshold. JSON Format: $threshold_attribute_format
error_count	json	Triggers alert if the number of events with ERROR severity state exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
fatal_count	json	Triggers alert if the number of events with FATAL severity state exceeds the configured threshold. JSON Format:$threshold_attribute_format
info_count	json	Triggers alert if the number of events with INFO severity state exceeds the configured threshold. JSON Format:$threshold_attribute_format
trace_count	json	Triggers alert if the number of events with TRACE severity state exceeds the configured threshold. JSON Format: $threshold_attribute_format
warn_count	json	Triggers alert if the number of events with WARN severity state exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
ok	json	Triggers alert if the number of instances with Ok health status goes below the configured threshold. JSON Format:$threshold_attribute_format
warning	json	Triggers alert if the number of instances with Warning health status goes below the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
info	json	Triggers alert if the number of instances with Info health status goes below the configured threshold. JSON Format: $threshold_attribute_format
severe	json	Triggers alert if the number of instances with Severe health status goes below the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
degraded	json	Triggers alert if the number of instances with Degraded health status goes below the configured threshold. Anomaly Enabled Attribute. JSON Format:$threshold_attribute_format
no_data	json	Triggers alert if the number of instances with NoData health status goes below the configured threshold. JSON Format: $threshold_attribute_format
pending	json	Triggers alert if the number of instances with Pending health status goes below the configured threshold. JSON Format: $threshold_attribute_format
unknown	json	Triggers alert if the number of instances with Unknown health status goes below the configured threshold. JSON Format: $threshold_attribute_format
instances_ok	json	Triggers alert if the number of instances with Ok health status (cloudwatch) goes below the configured threshold. JSON Format: $threshold_attribute_format
instances_pending	json	Triggers alert if the number of instances with Pending health status (cloudwatch) exceeds the configured threshold. JSON Format: $threshold_attribute_format
instances_info	json	Triggers alert if the number of instances with Info health status (cloudwatch) goes below the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
instances_unknown	json	Triggers alert if the number of instances with Unknown health (cloudwatch) status exceeds the configured threshold. JSON Format: $threshold_attribute_format
instances_no_data	json	Triggers alert if the number of instances with NoData health status (cloudwatch) goes below the configured threshold. JSON Format: $threshold_attribute_format
instances_warning	json	Triggers alert if the number of instances with Warning health status (cloudwatch) exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
instances_degraded	json	Triggers alert if the number of instances with Degraded health status (cloudwatch) exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
instances_severe	json	Triggers alert if the number of instances with Severe health status (cloudwatch) exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
application_requests_total	json	Triggers alert if the number of requests completed by the environment exceeds the configured threshold. JSON Format: $threshold_attribute_format
application_requests_2xx	json	Triggers alert if the number of requests that completed with a 2XX status code by the environment exceeds the configured threshold. JSON Format: $threshold_attribute_format
application_requests_3xx	json	Triggers alert if the number of requests that completed with a 3XX status code by the environment exceeds the configured threshold. JSON Format: $threshold_attribute_format
application_requests_4xx	json	Triggers alert if the number of requests that completed with a 4XX status code by the environment exceeds the configured threshold. JSON Format: $threshold_attribute_format
application_requests_5xx	json	Triggers alert if the number of requests that completed with a 5XX status code by the environment exceeds the configured threshold. JSON Format: $threshold_attribute_format
application_latency_p10	json	Triggers alert if the average time to complete the fastest 10 percent of requests by environment exceeds the configured threshold. JSON Format: $threshold_attribute_format
application_latency_p50	json	Triggers alert if the average time to complete the fastest 50 percent of requests by environment exceeds the configured threshold. JSON Format: $threshold_attribute_format
application_latency_p75	json	Triggers alert if the average time to complete the fastest 75 percent of requests by environment exceeds the configured threshold. JSON Format: $threshold_attribute_format
application_latency_p85	json	Triggers alert if the average time to complete the fastest 85 percent of requests by environment exceeds the configured threshold. JSON Format: $threshold_attribute_format
application_latency_p90	json	Triggers alert if the average time to complete the fastest 90 percent of requests by environment exceeds the configured threshold. JSON Format:$threshold_attribute_format
application_latency_p95	json	Triggers alert if the average time to complete the fastest 95 percent of requests by environment exceeds the configured threshold. JSON Format: $threshold_attribute_format
application_latency_p99	json	Triggers alert if the average time to complete the fastest 99 percent of requests by environment exceeds the configured threshold. JSON Format: $threshold_attribute_format
application_latency_p99_9	json	Triggers alert if the average time to complete the fastest X percent of requests by environment exceeds the configured threshold. JSON Format: $threshold_attribute_format
load_average_1_min	json	Triggers alert if the average CPU load exceeds the configured threshold. JSON Format: $threshold_attribute_format
instance_health	json	Triggers alert if the health status of the instance exceeds the configured threshold. JSON Format: $threshold_attribute_format
root_file_system_util	json	Triggers alert if the percentage of disk space in use exceeds the configured threshold. JSON Format: $threshold_attribute_format
cpu_irq	json	Triggers alert if the percentage of time the CPU was in IRQ state exceeds the configured threshold. JSON Format: $threshold_attribute_format
cpu_user	json	Triggers alert if the percentage of time the CPU was in USER state exceeds the configured threshold. JSON Format:$threshold_attribute_format
cpu_idle	json	Triggers alert if the percentage of time the CPU was in IDLE state exceeds the configured threshold. JSON Format: $threshold_attribute_format
cpu_system	json	Triggers alert if the percentage of time the CPU was in SYSTEM state exceeds the configured threshold. JSON Format: $threshold_attribute_format
cpu_soft_irq	json	Triggers alert if the percentage of time the CPU was in SOFT IRQ state exceeds the configured threshold. JSON Format: $threshold_attribute_format
cpu_io_wait	json	Triggers alert if the percentage of time the CPU was in IO WAIT state exceeds the configured threshold. JSON Format: $threshold_attribute_format
cpu_nice	json	Triggers alert if the percentage of time the CPU was in NICE state exceeds the configured threshold. JSON Format: $threshold_attribute_format
application_requests_total_inst	json	Triggers alert if the number of requests completed by the instance exceeds the configured threshold. JSON Format: $threshold_attribute_format
application_requests_2xx_inst	json	Triggers alert if the number of requests that completed with a 2XX status code by the instance exceeds the configured threshold. JSON Format: $threshold_attribute_format
application_requests_3xx_inst	json	Triggers alert if the number of requests that completed with a 3XX status code by the instance exceeds the configured threshold. JSON Format: $threshold_attribute_format
application_requests_4xx_inst	json	Triggers alert if the number of requests that completed with a 4XX status code by the instance exceeds the configured threshold. JSON Format: $threshold_attribute_format
application_requests_5xx_inst	json	Triggers alert if the number of requests that completed with a 5XX status code by the instance exceeds the configured threshold. JSON Format: $threshold_attribute_format
application_latency_p10_inst	json	Triggers alert if the average time to complete the fastest 10 percent of requests by instance exceeds the configured threshold. JSON Format: $threshold_attribute_format
application_latency_p50_inst	json	Triggers alert if the average time to complete the fastest 50 percent of requests by instance exceeds the configured threshold. JSON Format: $threshold_attribute_format
application_latency_p75_inst	json	Triggers alert if the average time to complete the fastest 75 percent of requests by instance exceeds the configured threshold. JSON Format: $threshold_attribute_format
application_latency_p85_inst	json	Triggers alert if the average time to complete the fastest 85 percent of requests by instance exceeds the configured threshold. JSON Format: $threshold_attribute_format
application_latency_p90_inst	json	Triggers alert if the average time to complete the fastest 90 percent of requests by instance exceeds the configured threshold. JSON Format: $threshold_attribute_format
application_latency_p95_inst	json	Triggers alert if the average time to complete the fastest 95 percent of requests by instance exceeds the configured threshold. JSON Format: $threshold_attribute_format
application_latency_p99_inst	json	Triggers alert if the average time to complete the fastest 99 percent of requests by instance exceeds the configured threshold. JSON Format:$threshold_attribute_format
application_latency_p99_9_inst	json	Triggers alert if the average time to complete the fastest X percent of requests by instance exceeds the configured threshold. JSON Format: $threshold_attribute_format

Direct Connect Monitor

Attribute	Type	Description
type	string	Mandatory DIRECTCONNECT
profile_name	string	Mandatory Name of the profile
connection_state	json	Notify for connection state failure. JSON Format: {value:true/false, severity:“$status”}
bps_egress	json	Triggers alert if the bit rate for outbound data from the AWS side of connection exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
bps_ingress	json	Triggers alert if the bit rate for inbound data to the AWS side of connection exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
pps_egress	json	Triggers alert if the packet rate for outbound data from the AWS side of connection exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
pps_ingress	json	Triggers alert if the packets rate for inbound data to the AWS side of connection exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
crc_error_count	json	Triggers alert if the number of cyclic redundancy check errors exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
light_level_tx	json	Triggers alert if the fiber connection health for outbound traffic exceeds the configured threshold. JSON Format: $threshold_attribute_format
light_level_rx	json	Triggers alert if the fiber connection health for inbound traffic exceeds the configured threshold. JSON Format: $threshold_attribute_format

VPC - Virtual Private Network Monitor

Attribute	Type	Description
type	string	Mandatory VPC-VPN
profile_name	string	Mandatory Name of the profile
tunnel_count	json	Triggers alert if the number of down tunnels exceeds or equals the configured threshold. JSON Format: $threshold_attribute_format
total_data_in	json	Triggers alert if the total bytes received through the connection exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
total_data_out	json	Triggers alert if the total bytes sent through the connection exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
tunnel_data_in	json	Triggers alert if the bytes received through each tunnel exceeds the configured threshold. JSON Format: $threshold_attribute_format
tunnel_data_out	json	Triggers alert if the bytes sent through each tunnel exceeds the configured threshold. JSON Format: $threshold_attribute_format
accepted_route	json	Triggers alert if the accepted routes through each tunnel exceeds the configured threshold. JSON Format: $threshold_attribute_format

API Gateway Stage Monitor

Attribute	Type	Description
type	string	Mandatory APIGATEWAY-STAGE
profile_name	string	Mandatory Name of the profile
latency	json	Triggers alert if the time between the receipt of a request and returned response at a stage-level exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
integration_latency	json	Triggers alert if the time between the relay of a request to backend and returned response at a stage-level exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
count	json	Triggers alert if the number of API requests on a stage level exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
miss_count	json	Triggers alert if the number of requests served from back end at a stage-level exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
hit_count	json	Triggers alert if the number of requests served from API cache at a stage-level exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
error_5xx	json	Triggers alert if the number of server-side errors at a stage-level exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
error_4xx	json	Triggers alert if the number of client-side errors at a stage-level exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
data_processed	json	Triggers alert if the data processed by API Gateway at a stage-level exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
connect_count	json	Triggers alert if number of messages sent to the $connect route integration at a stage-level exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
message_count	json	Triggers alert if number of messages sent to the WebSocket API at a stage-level exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
integration_error_count	json	Triggers alert if number of requests that return a 4XX/5XX response from the integration at a stage-level exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
client_error	json	Triggers alert if number of requests that have a 4XX response returned by API Gateway before the integration is invoked at a stage-level exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
execution_error	json	Triggers alert if the number of errors that occurred when calling the integration at a stage-level exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format

API Gateway Route Monitor

Attribute	Type	Description
type	string	Mandatory APIGATEWAY-ROUTE
profile_name	string	Mandatory Name of the profile
http_latency	json	Triggers alert if the time between the receipt of a request and returned response at a route-level exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
http_integration_latency	json	Triggers alert if the time between the relay of a request to backend and returned response at a route-level exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
http_count	json	Triggers alert if the number of API requests at a route-level exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
http_error_5xx	json	Triggers alert if the number of server-side errors at a route-level exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
http_error_4xx	json	Triggers alert if the number of client-side errors at a route-level exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
data_processed	json	Triggers alert if the data processed by API Gateway at a route-level exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
connect_count	json	Triggers alert if number of messages sent to the $connect route integration at a route-level exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
message_count	json	Triggers alert if number of messages sent to the WebSocket API at a route-level exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
integration_error_count	json	Triggers alert if number of requests that return a 4XX/5XX response from the integration at a route-level exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
client_error	json	Triggers alert if number of requests that have a 4XX response returned by API Gateway before the integration is invoked at a route-level exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
execution_error	json	Triggers alert if the number of errors that occurred when calling the integration at a route-level exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format

API Gateway Resource Monitor

Attribute	Type	Description
type	string	Mandatory APIGATEWAY-RESOURCE
profile_name	string	Mandatory Name of the profile
latency	json	Triggers alert if the time between the receipt of a request and returned response on a method-level exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
integration_latency	json	Triggers alert if the time between the relay of a request to backend and returned response on a method-level exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
count	json	Triggers alert if the number of API requests on a method-level exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
miss_count	json	Triggers alert if the number of requests served from the backend on a method-level exceeds the configured value. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
hit_count	json	Triggers alert if the number of requests served from the API cache on a method-level exceeds the configured value. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
error_5xx	json	Triggers alert if the number of server-side errors on a method-level exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
error_4xx	json	Triggers alert if the number of client-side errors on a method-level exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format

ECS Cluster Monitor

Attribute	Type	Description
type	string	Mandatory ECSCLUSTER
profile_name	string	Mandatory Name of the profile
tasks_failure	json	Notify for ECS task failures in Cluster. JSON Format: {value:true/false, severity:“$status”}
cpu_reservation	json	Triggers alert if the percentage of CPU units that are reserved by running tasks in the cluster exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
cpu_utilization	json	Triggers alert if the percentage of average CPU units consumed in the cluster exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
cpu_utilization_max	json	Triggers alert if the percentage of maximum CPU units consumed in the cluster exceeds the configured threshold. JSON Format: $threshold_attribute_format
memory_reservation	json	Triggers alert if the percentage of memory that is reserved by running tasks in the cluster exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
memory_utilization	json	Triggers alert if the percentage of memory used in the cluster exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
active_services	json	Triggers alert if the number of active services exceeds the configured threshold. JSON Format: $threshold_attribute_format
pending_tasks	json	Triggers alert if the number of tasks in pending state across the cluster exceeds the configured threshold. JSON Format: $threshold_attribute_format
running_tasks	json	Triggers alert if the number of tasks in running state across the cluster exceeds the configured threshold. JSON Format: $threshold_attribute_format
container_instance	json	Triggers alert if the number of container instances registered to the cluster exceeds the configured threshold. JSON Format: $threshold_attribute_format
container_instance_count	json	Triggers alert if the number of EC2 instances registered with a cluster exceeds the configured threshold. JSON Format: $threshold_attribute_format
cpu_utilized	json	Triggers alert if the total CPU units used by tasks in the cluster exceeds the configured threshold. JSON Format: $threshold_attribute_format
cpu_reserved	json	Triggers alert if the total CPU units reserved by tasks in the cluster exceeds the configured threshold. JSON Format: $threshold_attribute_format
memory_utilized	json	Triggers alert if the memory being used by tasks in the cluster exceeds the configured threshold. JSON Format: $threshold_attribute_format
memory_reserved	json	Triggers alert if the memory reserved by tasks in the cluster exceeds the configured threshold. JSON Format: $threshold_attribute_format
network_rx	json	Triggers alert if the number of bytes received by the cluster exceeds the configured threshold. JSON Format: $threshold_attribute_format
network_tx	json	Triggers alert if the number of bytes sent by the cluster exceeds the configured threshold. JSON Format: $threshold_attribute_format
storage_readbytes	json	Triggers alert if the number of bytes read from storage exceeds the configured threshold. JSON Format: $threshold_attribute_format
storage_writebytes	json	Triggers alert if the number of bytes written to storage exceeds the configured threshold. JSON Format: $threshold_attribute_format
ec2_pending_tasks	json	Triggers alert if the number of tasks in pending state per container exceeds the configured threshold. JSON Format: $threshold_attribute_format
ec2_running_tasks	json	Triggers alert if the number of tasks in running state per container instance exceeds the configured threshold. JSON Format: $threshold_attribute_format
memory_available	json	Triggers alert if the available memory per container instance exceeds the configured threshold. JSON Format: $threshold_attribute_format
cpu_available	json	Triggers alert if the available CPU units per container instance exceeds the configured threshold. JSON Format: $threshold_attribute_format
service_cpu_utilization	json	Triggers alert if the percentage of CPU units used in the service exceeds the configured threshold. JSON Format: $threshold_attribute_format
service_memory_utilization	json	Triggers alert if the percentage of memory used in the service exceeds the configured threshold.  JSON Format: $threshold_attribute_format
service_pending_tasks	json	Triggers alert if the number of tasks in pending state per service exceeds the configured threshold. JSON Format: $threshold_attribute_format
service_running_tasks	json	Triggers alert if the number of tasks in running state per service exceeds the configured threshold. JSON Format: $threshold_attribute_format

ECS Cluster Service Monitor

Attribute	Type	Description
type	string	Mandatory ECSCLUSTERSERVICE
profile_name	string	Mandatory Name of the profile
tasks_failure	json	Notify for ECS task failures in Cluster Service. JSON Format: {value:true/false, severity:“$status”}
cpu_utilization	json	Triggers alert if the percentage of CPU units used in the service exceeds the configured threshold.  JSON Format: $threshold_attribute_format
memory_utilization	json	Triggers alert if the percentage of memory used in the service exceeds the configured threshold.  JSON Format: $threshold_attribute_format
pending_tasks	json	Triggers alert if the number of tasks in pending state per service exceeds the configured threshold. JSON Format: $threshold_attribute_format
running_tasks	json	Triggers alert if the number of tasks in running state per service exceeds the configured threshold. JSON Format: $threshold_attribute_format
cpu_utilized	json	Triggers alert if the total CPU units used by tasks in the service exceeds the configured threshold. JSON Format: $threshold_attribute_format
cpu_reserved	json	Triggers alert if the total CPU units reserved by tasks in the service exceeds the configured threshold. JSON Format:$threshold_attribute_format
memory_utilized	json	Triggers alert if the memory being used by tasks in the service exceeds the configured threshold. JSON Format: $threshold_attribute_format
memory_reserved	json	Triggers alert if the memory that is reserved by tasks in the service exceeds the configured threshold. JSON Format: $threshold_attribute_format
network_rx	json	Triggers alert if the number of bytes received by the service exceeds the configured threshold. JSON Format: $threshold_attribute_format
network_tx	json	Triggers alert if the number of bytes sent by the service exceeds the configured threshold. JSON Format: $threshold_attribute_format
storage_readbytes	json	Triggers alert if the number of bytes read from storage exceeds the configured threshold. JSON Format: $threshold_attribute_format
storage_writebytes	json	Triggers alert if the number of bytes written to storage exceeds the configured threshold. JSON Format: $threshold_attribute_format
deployments	json	Triggers alert if the number of deployments in service exceeds the configured threshold. JSON Format: $threshold_attribute_format
insights_desired_tasks	json	Triggers alert if the desired number of tasks in service exceeds the configured threshold. JSON Format: $threshold_attribute_format
insights_pending_tasks	json	Triggers alert if the number of pending tasks in service exceeds the configured threshold. JSON Format: $threshold_attribute_format
insights_running_tasks	json	Triggers alert if the number of running tasks in service exceeds the configured threshold. JSON Format: $threshold_attribute_format
task_sets	json	Triggers alert if the number of task sets in service exceeds the configured threshold. JSON Format: $threshold_attribute_format

Redshift Cluster Monitor

Attribute	Type	Description
type	string	Mandatory REDSHIFT-CLUSTER
profile_name	string	Mandatory Name of the profile
cpu_threshold	json	Triggers alert when the aggregate CPU usage (average) across all nodes exceeds the configured value. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
redshift_health_status	json	Triggers alert when the reported health status metric changes from 1 to 0. JSON Format: $threshold_attribute_format
redshift_maintenance_mode	json	Triggers alert when the reported maintenance mode metric changes from 0 to 1. JSON Format: $threshold_attribute_format
redshift_database_connections	json	Triggers alert when the number of database connections to a cluster exceeds the configured value. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
redshift_network_transmit_throughput	json	Triggers alert when the average rate at which the cluster writes data exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
redshift_network_receive_throughput	json	Triggers alert when the average rate at which the cluster receives data exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
redshift_node_disk_used	json	Triggers alert when the average percent of disk space used exceeds the configured threshold. JSON Format: $threshold_attribute_format
redshift_planning_query_runtime_breakdown	json	Triggers alert when the average amount of time spent by active queries in the PLANNING stage exceeds the configured threshold. JSON Format: $threshold_attribute_format
redshift_waiting_query_runtime_breakdown	json	Triggers alert when the average amount of time spent by active queries in the WAITING stage exceeds the configured threshold. JSON Format:$threshold_attribute_format
redshift_read_query_runtime_breakdown	json	Triggers alert when the average amount of time spent by active queries in the READ stage exceeds the configured threshold. JSON Format:$threshold_attribute_format
redshift_insert_query_runtime_breakdown	json	Triggers alert when the average amount of time spent by active queries in the INSERT stage exceeds the configured threshold. JSON Format:$threshold_attribute_format
redshift_delete_query_runtime_breakdown	json	Triggers alert when the average amount of time spent by active queries in the DELETE stage exceeds the configured threshold. JSON Format: $threshold_attribute_format
redshift_update_query_runtime_breakdown	json	Triggers alert when the average amount of time spent by active queries in the CREATE TABLE AS stage exceeds the configured threshold. JSON Format: $threshold_attribute_format
redshift_ctas_query_runtime_breakdown	json	Triggers alert when the average time of all active queries had spent in the CTAS stage of execution exceeds the configured value. JSON Format: $threshold_attribute_format
redshift_unload_query_runtime_breakdown	json	Triggers alert when the average amount of time spent by active queries in the UNLOAD stage exceeds the configured threshold. JSON Format: $threshold_attribute_format
redshift_copy_query_runtime_breakdown	json	Triggers alert when the average amount of time spent by active queries in the COPY stage exceeds the configured threshold. JSON Format:$threshold_attribute_format
redshift_commit_query_runtime_breakdown	json	Triggers alert when the average amount of time spent by active queries in the COMMIT stage exceeds the configured threshold. JSON Format: $threshold_attribute_format
redshift_short_query_throughput	json	Triggers alert when the average number of short queries completed per second exceeds the configured threshold. JSON Format: $threshold_attribute_format
redshift_medium_query_throughput	json	Triggers alert when the average number of medium queries completed per second exceeds the configured threshold. JSON Format: $threshold_attribute_format
redshift_long_query_throughput	json	Triggers alert when the average number of long queries completed per second exceeds the configured threshold. JSON Format: $threshold_attribute_format
redshift_short_query_duration	json	Triggers alert when the average amount of time taken to complete a short query exceeds the configured threshold. JSON Format: $threshold_attribute_format
redshift_medium_query_duration	json	Triggers alert when the average amount of time taken to complete a medium query exceeds the configured threshold. JSON Format: $threshold_attribute_format
redshift_long_query_duration	json	Triggers alert when the average amount of time taken to complete a long query exceeds the configured threshold. JSON Format: $threshold_attribute_format
redshift_read_iops	json	Triggers alert when the average number of disk read operations per second across all nodes exceed the configured threshold. JSON Format: $threshold_attribute_format
redshift_write_iops	json	Triggers alert when the average number of disk write operations per second across all nodes exceeds the configured threshold. JSON Format: $threshold_attribute_format
redshift_read_latency	json	Triggers alert when the average amount of time taken for disk read operations across all nodes exceed the configured threshold. JSON Format: $threshold_attribute_format
redshift_write_latency	json	Triggers alert when the average amount of time taken for disk write operations across all nodes exceed the configured threshold. JSON Format: $threshold_attribute_format
redshift_read_throughput	json	Triggers alert when the average amount of time taken for read operations across all nodes exceed the configured threshold. JSON Format: $threshold_attribute_format
redshift_write_throughput	json	Triggers alert when the average amount of time taken for write operations across all nodes exceed the configured threshold. JSON Format: $threshold_attribute_format

Redshift Node Monitor

Attribute	Type	Description
type	string	Mandatory REDSHIFT-NODE
profile_name	string	Mandatory Name of the profile
cpu_threshold	json	Triggers alert when the average CPU usage for the node exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format:$threshold_attribute_format
redshift_network_transmit_throughput	json	Triggers alert when the average rate at which the node writes data exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
redshift_network_receive_throughput	json	Triggers alert when the average rate at which the node reads data exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
redshift_node_disk_used	json	Triggers alert when the average percent of disk space used by the node exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
redshift_read_iops	json	Triggers alert when the average number of disk read operations by the node exceeds the configured threshold. JSON Format: $threshold_attribute_format
redshift_write_iops	json	Triggers alert when the average number of disk write operations by the node exceeds the configured threshold. JSON Format: $threshold_attribute_format
redshift_read_latency	json	Triggers alert when the average amount of time taken for disk read operations at a node-level exceeds the configured value. JSON Format: $threshold_attribute_format
redshift_write_latency	json	Triggers alert when the average amount of time taken for disk write operations at a node-level exceeds the configured value. JSON Format: $threshold_attribute_format
redshift_read_throughput	json	Triggers alert when the average amount of time taken for read operations at a node-level exceeds the configured threshold. JSON Format: $threshold_attribute_format
redshift_write_throughput	json	Triggers alert when the average amount of time taken for write operations at a node-level exceeds the configured threshold. JSON Format: $threshold_attribute_format

Elastic File System Monitor

Attribute	Type	Description
type	string	Mandatory EFS
profile_name	string	Mandatory Name of the profile
burst_balance	json	Triggers alert when the number of burst credits in the file system exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
client_connection	json	Triggers alert when the number of client connections to the file system exceeds the configured threshold. JSON Format: $threshold_attribute_format
file_size	json	Triggers alert when the metered sized of a file system exceeds the configured threshold. JSON Format: $threshold_attribute_format
permitted_throughput	json	Triggers alert when the maximum amount of throughput allowed to the file system exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
data_read_io_bytes	json	Triggers alert when the total number of bytes associated with read operations exceeds the configured threshold. JSON Format: $threshold_attribute_format
data_write_io_bytes	json	Triggers alert when the total number of bytes associated with write operations exceeds the configured threshold. JSON Format: $threshold_attribute_format
metadata_io_bytes	json	Triggers alert when the total number of bytes associated with metadata operations exceeds the configured threshold. JSON Format: $threshold_attribute_format
percent_io_limit	json	Triggers alert when the file system I/O limit (General Purpose performance mode) exceeds the configured threshold. JSON Format: $threshold_attribute_format
total_io_bytes	json	Triggers alert when the total number of bytes associated with all file system operations exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format

Simple Email Service Monitor

Attribute	Type	Description
type	string	Mandatory SES
profile_name	string	Mandatory Name of the profile
total_sent	json	Triggers alert when the number of emails sent in last 24 hrs exceeds the configured threshold. JSON Format: $threshold_attribute_format
send	json	Triggers alert when the number of successful email sending API requests exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
reject	json	Triggers alert when the number of rejected send attempts exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
bounce	json	Triggers alert when the number of bounced emails exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
complaint	json	Triggers alert when the number of emails marked as spam exceeds the configured threshold. JSON Format: $threshold_attribute_format
delivery	json	Triggers alert when the number of emails delivered exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
open	json	Triggers alert when the number of emails opened by recipient exceeds the configured threshold. JSON Format: $threshold_attribute_format
click	json	Triggers alert when the number of times recipient clicked a link exceeds the configured threshold. JSON Format: $threshold_attribute_format
rendering_failure	json	Triggers alert when the number of events triggered due to email rendering issue exceeds the configured threshold. JSON Format: $threshold_attribute_format
reputation_bounce	json	Triggers alert when the bounce rate exceeds the configured threshold. JSON Format: $threshold_attribute_format
reputation_complaint	json	Triggers alert when the complaint rate exceeds the configured threshold. JSON Format: $threshold_attribute_format

Step Function State Machine Monitor

Attribute	Type	Description
type	string	Mandatory STEPFUNCTION
profile_name	string	Mandatory Name of the profile
stepfunction_resource_alert	json	Notify for monitored resource status change. JSON Format: {value:true/false, severity:“$status”}
execution_time	json	Triggers alert when the time interval between execution start and end exceeds the configured threshold. JSON Format: $threshold_attribute_format
execution_throttled	json	Triggers alert when the number of throttled StateEntered events and retries exceeds the configured threshold. JSON Format: $threshold_attribute_format
execution_aborted	json	Triggers alert when the number of aborted executions exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
execution_failed	json	Triggers alert when the number of failed executions exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
execution_started	json	Triggers alert when the number of started executions exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
execution_succeeded	json	Triggers alert when the number of successfully completed executions exceeds the configured threshold. JSON Format: $threshold_attribute_format
execution_timedout	json	Triggers alert when the number of executions that timed out exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format

Web Application Firewall Monitor

Attribute	Type	Description
type	string	Mandatory WAF
profile_name	string	Mandatory Name of the profile
total_allowed_requests	json	Triggers alert when the total number of allowed requests per web ACL exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
total_blocked_requests	json	Triggers alert when the total number of blocked requests per web ACL exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
total_passed_requests	json	Triggers alert when the total number of passed requests per web ACL exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
total_counted_requests	json	Triggers alert when the total number of counted requests per web ACL exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
webacl_capacity_units	json	Triggers alert when the Web ACL Rule capacity units used count violates the configured threshold. JSON Format: $threshold_attribute_format
allowed_requests	json	Triggers alert when the number of allowed requests per rule exceeds the configured threshold. JSON Format: $threshold_attribute_format
blocked_requests	json	Triggers alert when the number of blocked requests per rule exceeds the configured threshold. JSON Format: $threshold_attribute_format
passed_requests	json	Triggers alert when the number of passed requests per rule exceeds the configured threshold. JSON Format: $threshold_attribute_format
counted_requests	json	Triggers alert when the number of counted requests per rule exceeds the configured threshold. JSON Format: $threshold_attribute_format

CloudSearch Domain Monitor

Attribute	Type	Description
type	string	Mandatory CLOUDSEARCH
profile_name	string	Mandatory Name of the profile
successful_requests	json	Triggers alert when the total number of successful requests exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
searchable_documents	json	Triggers alert when the total number of searchable documents exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
index_utilization	json	Triggers alert when the total percentage of index utilization exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
partitions	json	Triggers alert when the total number of partitions exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format

Key Management Service Monitor

Attribute	Type	Description
type	string	Mandatory KMS
profile_name	string	Mandatory Name of the profile
key_age	json	Triggers alert when the number of days since key creation date exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
days_until_keydelete	json	Triggers alert when the number of days remaining untill CMK deletion exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
hours_until_keydelete	json	Triggers alert when the number of hours remaining until CMK deletion exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
minutes_until_keydelete	json	Triggers alert when the number of minutes remaining until CMK deletion exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
days_until_expirekeymaterial	json	Triggers alert when the number of days remaining until key material expiration exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
hours_until_expirekeymaterial	json	Triggers alert when the number of hours remaining until key material expiration exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
minutes_until_expirekeymaterial	json	Triggers alert when the minutes remaining until key material expiration exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format

Route 53 Health Check Monitor

Attribute	Type	Description
type	string	Mandatory R53_HEALTHCHECK
profile_name	string	Mandatory Name of the profile
r53_health_check	json	Notify for health check endpoint status failure. JSON Format: {value:true/false, severity:“$status”}
health_percent	json	Triggers alert when the percentage of health checker endpoint to be healthy goes below the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
connection_time	json	Triggers alert when the time taken by health checker to establish a TCP connection exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
ssl_handshake	json	Triggers alert when the time taken by health checker to complete the SSL handshake exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
time_to_first	json	Triggers alert when the time taken by health checker to receive the first byte of the response exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
child_healthcheck	json	Triggers alert when the number of healthy health checkers goes below the configured threshold. JSON Format: $threshold_attribute_format
connection_time_region	json	Triggers alert when the time taken by health checker to establish a TCP connection in region exceeds the configured threshold. JSON Format: $threshold_attribute_format
ssl_handshake_region	json	Triggers alert when the time taken by health checker to complete the SSL handshake in region exceeds the configured threshold. JSON Format: $threshold_attribute_format
time_to_first_region	json	Triggers alert when the time taken by health checker to receive the first byte of the response in region exceeds the configured threshold. JSON Format: $threshold_attribute_format

Route 53 Resolver Monitor

Attribute	Type	Description
type	string	Mandatory R53_RESOLVER
profile_name	string	Mandatory Name of the profile
total_inbound_query	json	Triggers alert when the number of DNS queries forwarded from network to VPCs exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
total_outbound_query	json	Triggers alert when the number of DNS queries forwarded from VPCs to network exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
inbound_query	json	Triggers alert when the number of DNS queries forwarded from network to VPCs per endpoint exceeds the configured threshold. JSON Format: $threshold_attribute_format
outbound_query	json	Triggers alert when the number of DNS queries forwarded from VPCs to network per endpoint exceeds the configured threshold. JSON Format: $threshold_attribute_format

Route 53 Hosted Zone Monitor

Attribute	Type	Description
type	string	Mandatory R53_HOSTEDZONE
profile_name	string	Mandatory Name of the profile
request_count	json	Triggers alert when the total number of DNS queries received by domain exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
query_a	json	Triggers alert when the number of queries received for A record type exceeds the configured threshold. JSON Format: $threshold_attribute_format
query_aaaa	json	Triggers alert when the number of queries received for AAAA record type exceeds the configured threshold. JSON Format: $threshold_attribute_format
query_caa	json	Triggers alert when the number of queries received for CAA record type exceeds the configured threshold. JSON Format: $threshold_attribute_format
query_cname	json	Triggers alert when the number of queries received for CNAME record type exceeds the configured threshold. JSON Format: $threshold_attribute_format
query_mx	json	Triggers alert when the number of queries received for MX record type exceeds the configured threshold. JSON Format: $threshold_attribute_format
query_naptr	json	Triggers alert when the number of queries received for NAPTR record type exceeds the configured threshold. JSON Format: $threshold_attribute_format
query_ns	json	Triggers alert when the number of queries received for NS record type exceeds the configured threshold. JSON Format: $threshold_attribute_format
query_ptr	json	Triggers alert when the number of queries received for PTR record type exceeds the configured threshold. JSON Format: $threshold_attribute_format
query_soa	json	Triggers alert when the number of queries received for SOA record type exceeds the configured threshold. JSON Format: $threshold_attribute_format
query_spf	json	Triggers alert when the number of queries received for SPF record type exceeds the configured threshold. JSON Format: $threshold_attribute_format
query_srv	json	Triggers alert when the number of queries received for SRV record type exceeds the configured threshold. JSON Format: $threshold_attribute_format
query_txt	json	Triggers alert when the number of queries received for TXT record type exceeds the configured threshold. JSON Format: $threshold_attribute_format
dns_noerror	json	Triggers alert when the number of DNS queries completed successfully goes below the configured threshold. JSON Format: $threshold_attribute_format
dns_formerr	json	Triggers alert when the number of DNS query format errors exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
dns_servfail	json	Triggers alert when the number of DNS queries failed by server exceeds the configured threshold. JSON Format: $threshold_attribute_format
dns_nxdomain	json	Triggers alert when the number of responses that return domain name does not exist exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
dns_notimp	json	Triggers alert when the number of DNS queries failed due to not implemented function exceeds the configured threshold. JSON Format: $threshold_attribute_format
dns_refused	json	Triggers alert when the number of DNS queries refused by the server exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
dns_yxdomain	json	Triggers alert when the number of invalid domain name queries exceeds the configured threshold. JSON Format: $threshold_attribute_format
dns_xrrset	json	Triggers alert when the number of invalid RRset queries exceeds the configured threshold. JSON Format: $threshold_attribute_format
dns_notauth	json	Triggers alert when the number of unauthorized DNS queries exceeds the configured threshold. JSON Format: $threshold_attribute_format
dns_notzone	json	Triggers alert when the number of invalid zone DNS queries exceeds the configured threshold. JSON Format: $threshold_attribute_format

Route 53 Hosted Zone Record Set Monitor

Attribute	Type	Description
type	string	Mandatory R53_RECORDSET
profile_name	string	Mandatory Name of the profile
request_count	json	Triggers alert when the total number of DNS queries received by record set exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
dns_noerror	json	Triggers alert when the number of DNS queries completed successfully goes below the configured threshold. JSON Format: $threshold_attribute_format
dns_formerr	json	Triggers alert when the number of DNS query format errors exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
dns_servfail	json	Triggers alert when the number of DNS queries failed by server exceeds the configured threshold. JSON Format: $threshold_attribute_format
dns_nxdomain	json	Triggers alert when the number of responses that return domain name does not exist exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
dns_notimp	json	Triggers alert when the number of DNS queries failed due to not implemented function exceeds the configured threshold. JSON Format: $threshold_attribute_format
dns_refused	json	Triggers alert when the number of DNS queries refused by the server exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
dns_yxdomain	json	Triggers alert when the number of invalid domain name queries exceeds the configured threshold. JSON Format: $threshold_attribute_format
dns_xrrset	json	Triggers alert when the number of invalid RRset queries exceeds the configured threshold. JSON Format: $threshold_attribute_format
dns_notauth	json	Triggers alert when the number of unauthorized DNS queries exceeds the configured threshold. JSON Format: $threshold_attribute_format
dns_notzone	json	Triggers alert when the number of invalid zone DNS queries exceeds the configured threshold. JSON Format: $threshold_attribute_format

Elasticsearch Monitor

Attribute	Type	Description
type	string	Mandatory ESD
profile_name	string	Mandatory Name of the profile
es_clusterstatus_green	json	Triggers alert if cluster status is green for longer than the configured threshold. JSON Format: $threshold_attribute_format
es_clusterstatus_yellow	json	Triggers alert if cluster status is yellow for longer than the configured threshold. JSON Format: $threshold_attribute_format
es_clusterstatus_red	json	Triggers alert if cluster status is red for longer than the configured threshold. JSON Format: $threshold_attribute_format
es_cluster_nodes	json	Triggers alert when the number of nodes in the ES cluster exceeds the configured threshold. JSON Format: $threshold_attribute_format
es_searchable_documents	json	Triggers alert when the total number of searchable documents across all indices exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
es_deleted_documents	json	Triggers alert when the total number of documents marked for deletion across all indices in the cluster exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
es_cpu_utilization	json	Triggers alert when the average CPU usage for data nodes in the cluster exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
es_free_storage_space	json	Triggers alert when the total free storage for the cluster exceeds the configured threshold. JSON Format: $threshold_attribute_format
es_cluster_used_space	json	Triggers alert when the maximum used space for the cluster exceeds the configured threshold. JSON Format: $threshold_attribute_format
es_cluster_index_writes_blocked	json	Triggers alert if cluster is blocking incoming requests for longer than the configured threshold. JSON Format: $threshold_attribute_format
es_jvm_memory_pressure	json	Triggers alert when the maximum percentage of the Java heap used for all data nodes exceeds the configured threshold. JSON Format: $threshold_attribute_format
es_automated_snapshot_failure	json	Triggers alert when the maximum number of failed snapshots for the cluster exceeds the configured threshold. JSON Format: $threshold_attribute_format
es_cpu_credit_balance	json	Triggers alert when the available remaining CPU credits exceeds the configured threshold. JSON Format: $threshold_attribute_format
es_kibana_healthy_nodes	json	Trigger alert if Kibana is inaccessible for longer than the configured threshold. JSON Format: $threshold_attribute_format
es_kms_key_error	json	Triggers alert if CMK has been disabled for longer than the configured threshold. JSON Format: $threshold_attribute_format
es_kms_key_inaccessible	json	Triggers alert if CMK has been deleted or revoked for longer than the configured threshold. JSON Format:$threshold_attribute_format
es_invalid_host_header_requests	json	Trigger alert when the number of requests made to the ES cluster that included an invalid (or missing) host header exceeds the configured threshold. JSON Format: $threshold_attribute_format
es_elasticsearch_requests	json	Triggers alert when the number of requests made to the cluster exceeds the configured threshold. JSON Format: $threshold_attribute_format
es_2xx	json	Triggers alert when the number of HTTP 2xx response codes generated by the domain exceeds the configured threshold. JSON Format: $threshold_attribute_format
es_3xx	json	Triggers alert when the number of HTTP 3xx response codes generated by the domain exceeds the configured threshold. JSON Format: $threshold_attribute_format
es_4xx	json	Triggers alert when the number of HTTP 4xx response codes generated by the domain exceeds the configured threshold. JSON Format: $threshold_attribute_format
es_5xx	json	Triggers alert when the number of HTTP 5xx response codes generated by the domain exceeds the configured threshold. JSON Format: $threshold_attribute_format
es_read_iops	json	Trigger alert when the number of I/O operations for read operations on EBS volumes exceeds the configured threshold. JSON Format: $threshold_attribute_format
es_write_iops	json	Trigger alert when the number of I/O operations for write operations on EBS volumes exceeds the configured threshold. JSON Format: $threshold_attribute_format
es_read_latency	json	Triggers alert when latency for read operations on EBS volumes exceeds the configured threshold. JSON Format: $threshold_attribute_format
es_write_latency	json	Triggers alert when latency for write operations on EBS volumes exceeds the configured threshold. JSON Format: $threshold_attribute_format
es_read_throughput	json	Triggers alert when throughput for read operations on EBS volumes exceeds the configured threshold. JSON Format: $threshold_attribute_format
es_write_throughput	json	Triggers alert when the average throughput for write operations on EBS volumes exceeds the configured threshold. JSON Format: $threshold_attribute_format
es_disk_queue_depth	json	Triggers alert when the maximum number of pending I/O requests for an EBS volume exceeds the configured threshold. JSON Format: $threshold_attribute_format

NAT Gateway Monitor

Attribute	Type	Description
type	string	Mandatory VPC_NATGATEWAY
profile_name	string	Mandatory Name of the profile
active_connection_count	json	Triggers alert if total number of concurrent active TCP connections through the NAT Gateway exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
bytes_in_frm_dest	json	Triggers alert if total number of bytes received by the NAT Gateway from the destination exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
bytes_in_frm_src	json	Triggers alert if total number of bytes received by the NAT Gateway from clients in your VPC exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
bytes_out_to_dest	json	Triggers alert if total number of bytes sent out through the NAT Gateway to the destination exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
bytes_out_to_source	json	Triggers alert if total number of bytes sent through the NAT Gateway to the clients in your VPC exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
conn_attempt_count	json	Triggers alert if total number of bytes sent through the NAT Gateway to the clients in your VPC exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
conn_establishment_count	json	Triggers alert if total number of connection attempts made through the NAT Gateway exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
connection_errport_alloc	json	Triggers alert if total number of times the NAT Gateway could not allocate a source port exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
idle_time_out_count	json	Triggers alert if number of connections that transitioned from the active state to the idle state exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
packet_drop_count	json	Triggers alert if total number of packets dropped by the NAT Gateway exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
packets_in_frm_dest	json	Triggers alert if total number of packets received by the NAT Gateway from the destination exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
packets_in_frm_src	json	Triggers alert if total number of packets received by the NAT Gateway from clients in your VPC exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
packets_out_dest	json	Triggers alert if total number of packets sent out through the NAT Gateway to the destination exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
packets_out_src	json	Triggers alert if total number of packets sent through the NAT Gateway to the clients in your VPC exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format

Elastic MapReduce Monitor

Attribute	Type	Description
type	string	Mandatory EMR
profile_name	string	Mandatory Name of the profile
emr_resource_alert	json	Notify for monitored resource status change. JSON Format: {value:true/false, severity:“$status”}
is_idle	json	Notify for Cluster Idle State. JSON Format. : {value:true/false, severity:“$status”}
backup_failed	json	Notify for HBase Backup Failed. JSON Format. : {value:true/false, severity:“$status”}
capacity_remaining_gb	json	Triggers alert when the amount of remaining HDFS disk capacity exceeds the configured threshold. JSON Format: $threshold_attribute_format
stepsfailed_count	json	Triggers alert when the total number of steps failed exceeds the configured threshold. JSON Format: $threshold_attribute_format
corrupt_blocks	json	Triggers alert when the number of blocks that HDFS reports as corrupted exceeds the configured threshold. JSON Format: $threshold_attribute_format
fsname_system_blocks	json	Triggers alert when the status of block replication exceeds the configured threshold. JSON Format: $threshold_attribute_format
hdfsbytes_read	json	Triggers alert when the number of bytes read from HDFS exceeds the configured threshold. JSON Format: $threshold_attribute_format
hdfsbytes_written	json	Triggers alert when the number of bytes written to HDFS exceeds the configured threshold. JSON Format: $threshold_attribute_format
hdfs_utilization	json	Triggers alert when the percentage of HDFS storage exceeds the configured threshold. JSON Format: $threshold_attribute_format
livedata_nodes	json	Triggers alert when the percentage of data nodes that are receiving work from Hadoop exceeds the configured threshold. JSON Format: $threshold_attribute_format
missing_blocks	json	Triggers alert when the number of blocks in which HDFS has no replicas exceeds the configured threshold. JSON Format: $threshold_attribute_format
pending_deletion_blocks	json	Triggers alert when the number of blocks marked for deletion exceeds the configured threshold. JSON Format: $threshold_attribute_format
s3bytes_read	json	Triggers alert when the number of bytes read from Amazon S3 exceeds the configured threshold. JSON Format: $threshold_attribute_format
s3bytes_written	json	Triggers alert when the number of bytes written to Amazon S3 exceeds the configured threshold. JSON Format:$threshold_attribute_format
total_load	json	Triggers alert when the total number of readers and writers reported by all DataNodes in a cluster exceeds the configured threshold. JSON Format: $threshold_attribute_format
under_replicated_blocks	json	Triggers alert when the number of blocks that need to be replicated one or more times exceeds the configured threshold. JSON Format: $threshold_attribute_format
apps_completed	json	Triggers alert when the number of applications submitted to YARN that have completed exceeds the configured threshold. JSON Format: $threshold_attribute_format
apps_failed	json	Triggers alert when the number of applications submitted to YARN that have failed to complete exceeds the configured threshold. JSON Format: $threshold_attribute_format
apps_killed	json	Triggers alert when the number of applications submitted to YARN that have been killed exceeds the configured threshold. JSON Format: $threshold_attribute_format
apps_pending	json	Triggers alert when the number of applications submitted to YARN that are in a pending state exceeds the configured threshold. JSON Format: $threshold_attribute_format
apps_running	json	Triggers alert when the number of applications submitted to YARN that are running exceeds the configured threshold. JSON Format: $threshold_attribute_format
apps_submitted	json	Triggers alert when the number of applications submitted to YARN exceeds the configured threshold. JSON Format: $threshold_attribute_format
container_allocated	json	Triggers alert when the number of resource containers allocated by the ResourceManager exceeds the configured threshold. JSON Format: $threshold_attribute_format
container_pending	json	Triggers alert when the number of containers in the queue that have not yet been allocated exceeds the configured threshold. JSON Format: $threshold_attribute_format
container_reserved	json	Triggers alert when the number of containers reserved exceeds the configured threshold. JSON Format:$threshold_attribute_format
memory_allocated	json	Triggers alert when the amount of memory allocated to the cluster exceeds the configured threshold. JSON Format: $threshold_attribute_format
memory_available	json	Triggers alert when the amount of memory available to be allocated exceeds the configured threshold. JSON Format: $threshold_attribute_format
memory_reserved	json	Triggers alert when the amount of memory reserved exceeds the configured threshold. JSON Format: $threshold_attribute_format
memory_total_mb	json	Triggers alert when the total amount of memory in the cluster exceeds the configured threshold. JSON Format: $threshold_attribute_format
mr_active_nodes	json	Triggers alert when the number of nodes presently running MapReduce tasks or jobs exceeds the configured threshold. JSON Format: $threshold_attribute_format
mr_decommissioned_nodes	json	Triggers alert when the number of nodes allocated to MapReduce applications that have been marked in a DECOMMISSIONED state exceeds the configured threshold. JSON Format:$threshold_attribute_format
mr_lost_nodes	json	Triggers alert when the number of nodes allocated to MapReduce that have been marked in a LOST state exceeds the configured threshold. JSON Format: $threshold_attribute_format
mr_rebooted_nodes	json	Triggers alert when the number of nodes available to MapReduce that have been rebooted and marked in a REBOOTED state exceeds the configured threshold. JSON Format: $threshold_attribute_format
mr_total_nodes	json	Triggers alert when the number of nodes presently available to MapReduce jobs exceeds the configured threshold. JSON Format: $threshold_attribute_format
mr_unhealthy_nodes	json	Triggers alert when the number of nodes available to MapReduce jobs marked in an UNHEALTHY state exceeds the configured threshold. JSON Format: $threshold_attribute_format
containerpending_ratio	json	Triggers alert when the ratio of pending containers to containers allocated exceeds the configured threshold. JSON Format: $threshold_attribute_format
yarn_available_percentage	json	Triggers alert when the percentage of remaining memory available to YARN exceeds the configured threshold. JSON Format: $threshold_attribute_format
jobs_failed	json	Triggers alert when the number of jobs in the cluster that have failed exceeds the configured threshold. JSON Format: $threshold_attribute_format
jobs_running	json	Triggers alert when the number of jobs in the cluster that are currently running exceeds the configured threshold. JSON Format: $threshold_attribute_format
livetask_trackers	json	Triggers alert when the percentage of task trackers that are functional exceeds the configured threshold. JSON Format: $threshold_attribute_format
mapslot_open	json	Triggers alert when the unused map task capacity exceeds the configured threshold. JSON Format: $threshold_attribute_format
blacklisted_task_trackers	json	Triggers alert when the number blacklisted task trackers exceeds the configured threshold. JSON Format:$threshold_attribute_format
graylisted_task_trackers	json	Triggers alert when the number graylisted task trackers exceeds the configured threshold. JSON Format: $threshold_attribute_format
reduce_slots_open	json	Triggers alert when the number unused reduce task capacity exceeds the configured threshold. JSON Format: $threshold_attribute_format
remaining_map_tasks	json	Triggers alert when the number of remaining map tasks exceeds the configured threshold. JSON Format:$threshold_attribute_format
remaining_maptasks_perslot	json	Triggers alert when the ratio of the total map tasks remaining to the total map slots available in the cluster exceeds the configured threshold. JSON Format: $threshold_attribute_format
remaining_reduce_tasks	json	Triggers alert when the number of remaining reduce tasks exceeds the configured threshold. JSON Format: $threshold_attribute_format
running_map_tasks	json	Triggers alert when the number of running map tasks exceeds the configured threshold. JSON Format: $threshold_attribute_format
running_reduce_tasks	json	Triggers alert when the number of running reduce tasks exceeds the configured threshold. JSON Format: $threshold_attribute_format
multi_masternodes_running	json	Triggers alert when the number of running master nodes exceeds the configured threshold. JSON Format: $threshold_attribute_format
multi_masternodes_runningpercentage	json	Triggers alert when the percentage of master nodes that are running over the requested master node instance count exceeds the configured threshold. JSON Format: $threshold_attribute_format
multi_masternodes_requested	json	Triggers alert when the number of requested master nodes exceeds the configured threshold. JSON Format: $threshold_attribute_format
core_nodes_pending	json	Triggers alert when the number of core nodes waiting to be assigned exceeds the configured threshold. JSON Format: $threshold_attribute_format
core_nodes_running	json	Triggers alert when the number of core nodes working exceeds the configured threshold. JSON Format: $threshold_attribute_format
task_nodes_pending	json	Triggers alert when the number of task nodes waiting to be assigned exceeds the configured threshold. JSON Format: $threshold_attribute_format
task_nodes_running	json	Triggers alert when the number of task nodes working exceeds the configured threshold. JSON Format: $threshold_attribute_format
backup_duration	json	Triggers alert when the amount of time taken for the previous backup to complete exceeds the configured threshold. JSON Format: $threshold_attribute_format
time_since_lastbackup	json	Triggers alert when the number of elapsed minutes after the last successful HBase backup exceeds the configured threshold. JSON Format: $threshold_attribute_format

WorkSpace Monitor

Attribute	Type	Description
type	string	Mandatory WORKSPACE
profile_name	string	Mandatory Name of the profile
available	json	Triggers alert if total number of available requests exceeds the configured threshold. JSON Format: $threshold_attribute_format
unhealthy	json	Triggers alert if total number of available requests rejected exceeds the configured threshold. JSON Format:$threshold_attribute_format
connection_attempt	json	Triggers alert if total number of connection attempts exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
connection_success	json	Triggers alert if total number of successful connections exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
connection_failure	json	Triggers alert if total number of failed connections exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
session_launch_time	json	Triggers alert if amount of time it takes to initiate a WorkSpaces session exceeds the configured threshold. JSON Format: $threshold_attribute_format
session_latency	json	Triggers alert if round trip time between the WorkSpaces client and the WorkSpace exceeds the configured threshold. JSON Format: $threshold_attribute_format
session_disconnect	json	Triggers alert if number of connections that were closed, including user-initiated and failed connections exceeds the configured threshold. JSON Format: $threshold_attribute_format
user_connected	json	Triggers alert if The number of times a user connected to the WorkSpace exceeds the configured threshold. JSON Format: $threshold_attribute_format
stopped	json	Triggers alert if number of times WorkSpaces has been stopped exceeds the configured threshold. JSON Format: $threshold_attribute_format
maintenance	json	Triggers alert if the number of times the WorkSpaces was under maintenance exceeds the configured threshold. JSON Format: $threshold_attribute_format

EC2 Auto Scaling Group Monitor

Attribute	Type	Description
type	string	Mandatory EC2AUTOSCALING
profile_name	string	Mandatory Name of the profile
status_checks	json	Notify for overall status check failures. JSON Format: {value:true/false, severity:“$status”}
status_checks_instance	json	Notify for instance status check failures. JSON Format: {value:true/false, severity:“$status”}
status_checks_system	json	Notify for system status check failures. JSON Format: {value:true/false, severity:“$status”}
min_size	json	Triggers alert when the minimum size of the auto scaling group exceeds the configured threshold. JSON Format: $threshold_attribute_format
max_size	json	Triggers alert when the maximum size of the auto scaling group exceeds the configured threshold. JSON Format: $threshold_attribute_format
desired_capacity	json	Triggers alert when the desired size of the auto scaling group exceeds the configured threshold. JSON Format: $threshold_attribute_format
inservice_instances	json	Triggers alert when the number of running instances drops below the configured threshold. JSON Format: $threshold_attribute_format
pending_instances	json	Triggers alert when the number of pending instances exceeds the configured threshold. JSON Format: $threshold_attribute_format
standby_instances	json	Triggers alert when the number of standby instances exceeds the configured threshold. JSON Format: $threshold_attribute_format
terminating_instances	json	Triggers alert when the number of terminating instances exceeds the configured threshold. JSON Format: $threshold_attribute_format
total_instances	json	Triggers alert when the total number of instances drops below the configured threshold. JSON Format: $threshold_attribute_format
cpu_threshold	json	Triggers alert when the CPU utilization exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
network_in_threshold	json	Triggers alert when the number of bytes received exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
network_out_threshold	json	Triggers alert when the number of bytes sent out exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
packets_in_threshold	json	Triggers alert when the number of packets received exceeds the configured threshold. JSON Format: $threshold_attribute_format
packets_out_threshold	json	Triggers alert when the number of packets sent out exceeds the configured threshold. JSON Format: $threshold_attribute_format
disk_read_ops_threshold	json	Triggers alert when the disk read operations exceed the configured threshold. JSON Format: $threshold_attribute_format
disk_write_ops_threshold	json	Triggers alert when the disk write operations exceed the configured threshold. JSON Format: $threshold_attribute_format
disk_read_bytes_threshold	json	Triggers alert when the bytes read exceeds the configured threshold. JSON Format: $threshold_attribute_format
disk_write_bytes_threshold	json	Triggers alert when the bytes written exceeds the configured threshold. JSON Format: $threshold_attribute_format

Neptune Cluster Monitor

Attribute	Type	Description
type	string	Mandatory NEPTUNE-CLUSTER
profile_name	string	Mandatory Name of the profile
neptune_resource_alert	json	Notify for monitored resource status change. JSON Format: {value:true/false, severity:“$status”}
cluster_replicalag_max	json	Triggers alert when the maximum amount of lag between the primary instance and each Neptune DB instance exceeds the configured threshold. JSON Format: $threshold_attribute_format
cluster_replicalag_min	json	Triggers alert when the minimum amount of lag between the primary instance and each Neptune DB instance exceeds the configured threshold. JSON Format: $threshold_attribute_format
cluster_replicalag	json	Triggers alert when the amount of lag when replicating updates from the primary instance exceeds the configured threshold. JSON Format: $threshold_attribute_format
cpu_utilization	json	Triggers alert when the percentage of CPU utilization exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
engine_uptime	json	Triggers alert when the amount of time that the cluster has been running exceeds the configured threshold. JSON Format: $threshold_attribute_format
freeable_memory	json	Triggers alert when the amount of available random access memory exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
free_localstorage	json	Triggers alert when the amount of storage available for temporary tables and logs exceeds the configured threshold. JSON Format: $threshold_attribute_format
gremlin_errors	json	Triggers alert when the number of errors in Gremlin traversals exceeds the configured threshold. JSON Format: $threshold_attribute_format
gremlin_requests	json	Triggers alert when the number of requests to Gremlin engine exceeds the configured threshold. JSON Format: $threshold_attribute_format
gremlin_requestspersec	json	Triggers alert when the number of requests to Gremlin engine per second exceeds the configured threshold. JSON Format: $threshold_attribute_format
gremlinwebsocket_availableconnections	json	Triggers alert when the number of potential WebSocket connections currently available exceeds the configured threshold. JSON Format: $threshold_attribute_format
gremlinwebsocket_clienterrors	json	Triggers alert when the number of WebSocket client errors on the Gremlin endpoint per second exceeds the configured threshold. JSON Format: $threshold_attribute_format
gremlinwebsocket_servererrors	json	Triggers alert when the number of WebSocket server errors on the Gremlin endpoint per second exceeds the configured threshold. JSON Format: $threshold_attribute_format
gremlinwebsocket_success	json	Triggers alert when the number of successful WebSocket connections to the Gremlin endpoint per second exceeds the configured threshold. JSON Format: $threshold_attribute_format
loader_errors	json	Triggers alert when the number of errors from Loader requests exceeds the configured threshold. JSON Format: $threshold_attribute_format
loader_requests	json	Triggers alert when the number of Loader Requests exceeds the configured threshold. JSON Format: $threshold_attribute_format
networkreceive_throughput	json	Triggers alert when the incoming (Receive) network traffic on the DB instance, including both customer database traffic and Neptune traffic used for monitoring and replication exceeds the configured threshold. JSON Format: $threshold_attribute_format
network_throughput	json	Triggers alert when the amount of network throughput both received from and transmitted to clients by each instance in the Neptune DB cluster exceeds the configured threshold. JSON Format: $threshold_attribute_format
networktransmit_throughput	json	Triggers alert when the outgoing (Transmit) network traffic on the DB instance, including both customer database traffic and Neptune traffic used for monitoring and replication exceeds the configured threshold. JSON Format: $threshold_attribute_format
sparql_errors	json	Triggers alert when the number of errors in the SPARQL queries exceeds the configured threshold. JSON Format:$threshold_attribute_format
sparql_requests	json	Triggers alert when the number of requests to the SPARQL engine exceeds the configured threshold. JSON Format: $threshold_attribute_format
sparqlrequests_persec	json	Triggers alert when the number of requests to the SPARQL engine per second exceeds the configured threshold. JSON Format: $threshold_attribute_format
status_errors	json	Triggers alert when the number of errors from the status endpoint exceeds the configured threshold. JSON Format:$threshold_attribute_format
status_requests	json	Triggers alert when the number of requests to the status endpoint exceeds the configured threshold. JSON Format: $threshold_attribute_format
http_1xx	json	Triggers alert when the number of HTTP 1xx errors for the endpoint per second exceeds the configured threshold. JSON Format: $threshold_attribute_format
http_2xx	json	Triggers alert when the number of HTTP 2xx errors for the endpoint per second exceeds the configured threshold. JSON Format: $threshold_attribute_format
http_4xx	json	Triggers alert when the number of HTTP 4xx errors for the endpoint per second exceeds the configured threshold. JSON Format: $threshold_attribute_format
http_5xx	json	Triggers alert when the number of HTTP 5xx errors for the endpoint per second exceeds the configured threshold. JSON Format: $threshold_attribute_format
gremlin_http1xx	json	Triggers alert when the number of HTTP 1xx errors for the Gremlin endpoint per second exceeds the configured threshold. JSON Format: $threshold_attribute_format
gremlin_http2xx	json	Triggers alert when the number of HTTP 2xx errors for the Gremlin endpoint per second exceeds the configured threshold. JSON Format: $threshold_attribute_format
gremlin_http4xx	json	Triggers alert when the total number of HTTP 4xx errors for the Gremlin endpoint per second exceeds the configured threshold. JSON Format: $threshold_attribute_format
gremlin_http5xx	json	Triggers alert when the number of HTTP 5xx errors for the Gremlin endpoint per second exceeds the configured threshold. JSON Format: $threshold_attribute_format
sparql_http1xx	json	Triggers alert the number of HTTP 1xx errors for the SPARQL endpoint per second exceeds the configured threshold. JSON Format: $threshold_attribute_format
sparql_http2xx	json	Triggers alert when the number of HTTP 2xx errors for the SPARQL endpoint per second exceeds the configured threshold. JSON Format: $threshold_attribute_format
sparql_http4xx	json	Triggers alert when the number of HTTP 4xx errors for the SPARQL endpoint per second exceeds the configured threshold. JSON Format: $threshold_attribute_format
sparql_http5xx	json	Triggers alert when the number of HTTP 5xx errors for the SPARQL endpoint per second exceeds the configured threshold. JSON Format: $threshold_attribute_format
backupretention_periodstorage	json	Triggers alert when the amount of billed backup storage used to support the point-in-time restore feature within backup retention window exceeds the configured threshold. JSON Format: $threshold_attribute_format
totalbackup_storage	json	Triggers alert when the total amount of billed backup storage exceeds the configured threshold. JSON Format: $threshold_attribute_format
volume_readiops	json	Triggers alert when the average number of billed read I/O operations from a cluster volume exceeds the configured threshold. JSON Format: $threshold_attribute_format
volume_writeiops	json	Triggers alert when the average number of write disk I/O operations to the cluster volume exceeds the configured threshold. JSON Format: $threshold_attribute_format
volumebytes_used	json	Triggers alert when the amount of storage used by your Neptune DB instance exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format

Neptune Instance Monitor

Attribute	Type	Description
type	string	Mandatory NEPTUNE-INSTANCE
profile_name	string	Mandatory Name of the profile
cluster_replicalag_max	json	Triggers alert when the maximum amount of lag between the primary instance and each Neptune DB instance exceeds the configured threshold. JSON Format: $threshold_attribute_format
cluster_replicalag_min	json	Triggers alert when the minimum amount of lag between the primary instance and each Neptune DB instance exceeds the configured threshold. JSON Format: $threshold_attribute_format
cpu_utilization	json	Triggers alert when the percentage of CPU utilization exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
engine_uptime	json	Triggers alert when the amount of time that the instance has been running exceeds the configured threshold. JSON Format: $threshold_attribute_format
freeable_memory	json	Triggers alert when the amount of available random access memory exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
free_localstorage	json	Triggers alert when the amount of storage available for temporary tables and logs exceeds the configured threshold. JSON Format: $threshold_attribute_format
gremlin_errors	json	Triggers alert when the number of errors in Gremlin traversals exceeds the configured threshold. JSON Format: $threshold_attribute_format
gremlin_requests	json	Triggers alert when the number of requests to Gremlin engine exceeds the configured threshold. JSON Format: $threshold_attribute_format
gremlin_requestspersec	json	Triggers alert when the number of requests to Gremlin engine per second exceeds the configured threshold. JSON Format: $threshold_attribute_format
gremlinwebsocket_availableconnections	json	Triggers alert when the number of potential WebSocket connections currently available exceeds the configured threshold. JSON Format: $threshold_attribute_format
gremlinwebsocket_clienterrors	json	Triggers alert when the number of WebSocket client errors on the Gremlin endpoint per second exceeds the configured threshold. JSON Format:$threshold_attribute_format
gremlinwebsocket_servererrors	json	Triggers alert when the number of WebSocket server errors on the Gremlin endpoint per second exceeds the configured threshold. JSON Format: $threshold_attribute_format
gremlinwebsocket_success	json	Triggers alert when the number of successful WebSocket connections to the Gremlin endpoint per second exceeds the configured threshold. JSON Format: $threshold_attribute_format
loader_errors	json	Triggers alert when the number of errors from Loader requests exceeds the configured threshold. JSON Format: $threshold_attribute_format
loader_requests	json	Triggers alert when the number of Loader Requests exceeds the configured threshold. JSON Format: $threshold_attribute_format
networkreceive_throughput	json	Triggers alert when the incoming (Receive) network traffic on the DB instance, including both customer database traffic and Neptune traffic used for monitoring and replication exceeds the configured threshold. JSON Format: $threshold_attribute_format
network_throughput	json	Triggers alert when the amount of network throughput both received from and transmitted to clients by each instance in the Neptune DB cluster exceeds the configured threshold. JSON Format: $threshold_attribute_format
networktransmit_throughput	json	Triggers alert when the outgoing (Transmit) network traffic on the DB instance, including both customer database traffic and Neptune traffic used for monitoring and replication exceeds the configured threshold. JSON Format: $threshold_attribute_format
sparql_errors	json	Triggers alert when the number of errors in the SPARQL queries exceeds the configured threshold. JSON Format: $threshold_attribute_format
sparql_requests	json	Triggers alert when the number of requests to the SPARQL engine exceeds the configured threshold. JSON Format:$threshold_attribute_format
sparqlrequests_persec	json	Triggers alert when the number of requests to the SPARQL engine per second exceeds the configured threshold. JSON Format: $threshold_attribute_format
status_errors	json	Triggers alert when the number of errors from the status endpoint exceeds the configured threshold. JSON Format: $threshold_attribute_format
status_requests	json	Triggers alert when the number of requests to the status endpoint exceeds the configured threshold. JSON Format: $threshold_attribute_format
http_1xx	json	Triggers alert when the number of HTTP 5xx errors for the endpoint per second exceeds the configured threshold. JSON Format: $threshold_attribute_format
http_2xx	json	Triggers alert when the number of HTTP 5xx errors for the endpoint per second exceeds the configured threshold. JSON Format: $threshold_attribute_format
http_4xx	json	Triggers alert when the number of HTTP 5xx errors for the endpoint per second exceeds the configured threshold. JSON Format: $threshold_attribute_format
http_5xx	json	Triggers alert when the number of HTTP 5xx errors for the endpoint per second exceeds the configured threshold. JSON Format: $threshold_attribute_format
gremlin_http1xx	json	Triggers alert when the number of HTTP 1xx errors for the Gremlin endpoint per second exceeds the configured threshold. JSON Format:$threshold_attribute_format
gremlin_http2xx	json	Triggers alert when the number of HTTP 2xx errors for the Gremlin endpoint per second exceeds the configured threshold. JSON Format: $threshold_attribute_format
gremlin_http4xx	json	Triggers alert when the total number of HTTP 4xx errors for the Gremlin endpoint per second exceeds the configured threshold. JSON Format: $threshold_attribute_format
gremlin_http5xx	json	Triggers alert when the number of HTTP 5xx errors for the Gremlin endpoint per second exceeds the configured threshold. JSON Format: $threshold_attribute_format
sparql_http1xx	json	Triggers alert the number of HTTP 1xx errors for the SPARQL endpoint per second exceeds the configured threshold. JSON Format: $threshold_attribute_format
sparql_http2xx	json	Triggers alert when the number of HTTP 2xx errors for the SPARQL endpoint per second exceeds the configured threshold. JSON Format: $threshold_attribute_format
sparql_http4xx	json	Triggers alert when the number of HTTP 4xx errors for the SPARQL endpoint per second exceeds the configured threshold. JSON Format: $threshold_attribute_format
sparql_http5xx	json	Triggers alert when the number of HTTP 5xx errors for the SPARQL endpoint per second exceeds the configured threshold. JSON Format: $threshold_attribute_format

Certificate Manager Monitor

Attribute	Type	Description
type	string	Mandatory ACM
profile_name	string	Mandatory Name of the profile
certificate_age	json	Triggers alert when the number of days since certificate creation date exceeds the configured threshold. JSON Format: $threshold_attribute_format
days_until_expiry	json	Triggers alert when the number of days remaining untill certificate expiry exceeds the configured threshold. JSON Format: $threshold_attribute_format
hours_until_expiry	json	Triggers alert when the number of hours remaining until certificate expiry exceeds the configured threshold. JSON Format: $threshold_attribute_format
minutes_until_expiry	json	Triggers alert when the number of minutes remaining until certificate expiry exceeds the configured threshold. JSON Format: $threshold_attribute_format

Lightsail Instance Monitor

Attribute	Type	Description
type	string	Mandatory LIGHTSAIL-INSTANCE
profile_name	string	Mandatory Name of the profile
agent_alert	json	Notify for Agent Failure. JSON Format: {value:true/false, severity:“$status”}
status_checks	json	Notify the status check failures of either the instance or the system. JSON Format: {value:true/false, severity:“$status”}
status_checks_instance	json	Notify for instance status check failures. JSON Format: {value:true/false, severity:“$status”}
status_checks_system	json	Notify for system status check failures. JSON Format: {value:true/false, severity:“$status”}
cpu_threshold	json	Triggers alert when the CPU utilization exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
network_in_threshold	json	Triggers alert when the number of bytes received exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
network_out_threshold	json	Triggers alert when the number of bytes sent out exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
cpu_burstcapacity_percent	json	Triggers alert when the CPU burst capacity percentage exceeds the configured threshold. JSON Format: $threshold_attribute_format
cpu_burstcapacity_time	json	Triggers alert when the CPU burst capacity time exceeds the configured threshold. JSON Format: $threshold_attribute_format

EKS Cluster Monitor

Attribute	Type	Description
type	string	Mandatory EKSCLUSTER
profile_name	string	Mandatory Name of the profile
node_resource_alert	json	Notify for monitored EKS node status change. JSON Format: {value:true/false, severity:“$status”}
namespace_resource_alert	json	Notify for monitored EKS namespace status change. JSON Format: {value:true/false, severity:“$status”}
failed_nodes	json	Triggers alert when the total number of failed nodes exceeds the configured threshold. JSON Format: $threshold_attribute_format
total_nodes	json	Triggers alert when the total number of nodes exceeds the configured threshold. JSON Format:$threshold_attribute_format
namespace_running_pods	json	Triggers alert when the number of pods running in namespace exceeds the configured threshold. JSON Format: $threshold_attribute_format
service_running_pods	json	Triggers alert when the number of pods running in service exceeds the configured threshold. JSON Format: $threshold_attribute_format
node_cpu_limit	json	Triggers alert when the CPU assigned to nodes exceeds the configured threshold. JSON Format: $threshold_attribute_format
node_cpu_reserved	json	Triggers alert when the CPU reserved for nodes exceeds the configured threshold. JSON Format: $threshold_attribute_format
node_cpu_usage	json	Triggers alert when the CPU units used by nodes exceeds the configured threshold. JSON Format: $threshold_attribute_format
node_cpu_utilized	json	Triggers alert when the CPU utilized by nodes exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
node_file_utilized	json	Triggers alert when the file system capacity on nodes exceeds the configured threshold. JSON Format: $threshold_attribute_format
node_memory_limit	json	Triggers alert when the memory assigned to nodes exceeds the configured threshold. JSON Format: $threshold_attribute_format
node_memory_reserved	json	Triggers alert when the memory reserved for nodes exceeds the configured threshold. JSON Format: $threshold_attribute_format
node_memory_utilized	json	Triggers alert when the memory utilized by nodes exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
node_memory_sets	json	Triggers alert when the memory used in working sets of nodes exceeds the configured threshold. JSON Format: $threshold_attribute_format
node_network_bytes	json	Triggers alert when the total network traffic in nodes exceeds the configured threshold. JSON Format: $threshold_attribute_format
node_running_containers	json	Triggers alert when the number of containers running in node exceeds the configured threshold. JSON Format: $threshold_attribute_format
node_running_pods	json	Triggers alert when the number of pods running in node exceeds the configured threshold. JSON Format: $threshold_attribute_format
pod_cpu_reserved	json	Triggers alert when the CPU reserved for pods exceeds the configured threshold. JSON Format: $threshold_attribute_format
pod_cpu_utilized	json	Triggers alert when the CPU utilized by pods exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
pod_cpu_utilized_over_limit	json	Triggers alert when the CPU utilized over pod limit exceeds the configured threshold. JSON Format: $threshold_attribute_format
pod_memory_reserved	json	Triggers alert when the memory reserved for pods exceeds the configured threshold. JSON Format: $threshold_attribute_format
pod_memory_utilized	json	Triggers alert when the memory utilized by pods exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
pod_memory_utilized_over_limit	json	Triggers alert when the memory utilized over pod limit exceeds the configured threshold. JSON Format: $threshold_attribute_format
pod_network_rx	json	Triggers alert when the total bytes received by pods exceeds the configured threshold. JSON Format: $threshold_attribute_format
pod_network_tx	json	Triggers alert when the total bytes sent by pods exceeds the configured threshold. JSON Format: $threshold_attribute_format

EKS Namespace Monitor

Attribute	Type	Description
type	string	Mandatory EKSNAMESPACE
profile_name	string	Mandatory Name of the profile
namespace_running_pods	json	Triggers alert when the number of pods running in namespace exceeds the configured threshold. JSON Format: $threshold_attribute_format
cpu_utilized	json	Triggers alert when the CPU utilized by pods in namespace exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
cpu_over_limit	json	Triggers alert when the CPU utilized over pod limit in namespace exceeds the configured threshold. JSON Format: $threshold_attribute_format
memory_utilized	json	Triggers alert when the memory utilized by pods in namespace exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
memory_over_limit	json	Triggers alert when the memory utilized over pod limit in namespace exceeds the configured threshold. JSON Format: $threshold_attribute_format
network_rx	json	Triggers alert when the total bytes received by pods in namespace exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
network_tx	json	Triggers alert when the total bytes sent by pods in namespace exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
service_cpu_utilized	json	Triggers alert when the CPU utilized by pods in service exceeds the configured threshold. JSON Format: $threshold_attribute_format
service_cpu_overlimit	json	Triggers alert when the CPU utilized over pod limit in service exceeds the configured threshold. JSON Format: $threshold_attribute_format
service_memory_utilized	json	Triggers alert when the memory utilized by pods in service exceeds the configured threshold. JSON Format: $threshold_attribute_format
service_memory_overlimit	json	Triggers alert when the memory utilized over pod limit in service exceeds the configured threshold. JSON Format: $threshold_attribute_format
service_network_rx	json	Triggers alert when the total bytes received by pods in service exceeds the configured threshold. JSON Format: $threshold_attribute_format
service_network_tx	json	Triggers alert when the total bytes sent by pods in service exceeds the configured threshold. JSON Format: $threshold_attribute_format
service_running_pods	json	Triggers alert when the number of pods running in service exceeds the configured threshold. JSON Format: $threshold_attribute_format
pod_cpu_reserved	json	Triggers alert when the CPU reserved for pod exceeds the configured threshold. JSON Format: $threshold_attribute_format
pod_cpu_utilized	json	Triggers alert when the CPU utilized by pod exceeds the configured threshold. JSON Format: $threshold_attribute_format
pod_cpu_overlimit	json	Triggers alert when the CPU utilized over pod limit exceeds the configured threshold. JSON Format: $threshold_attribute_format
pod_memory_reserved	json	Triggers alert when the memory reserved for pod exceeds the configured threshold. JSON Format: $threshold_attribute_format
pod_memory_utilized	json	Triggers alert when the memory utilized by pod exceeds the configured threshold. JSON Format: $threshold_attribute_format
pod_memory_overlimit	json	Triggers alert when the memory utilized over pod limit exceeds the configured threshold. JSON Format: $threshold_attribute_format
pod_container_restarts	json	Triggers alert when the number of container restarts exceeds the configured threshold. JSON Format: $threshold_attribute_format
pod_network_rx	json	Triggers alert when the total bytes received by pod exceeds the configured threshold. JSON Format: $threshold_attribute_format
pod_network_tx	json	Triggers alert when the total bytes sent by pod exceeds the configured threshold. JSON Format: $threshold_attribute_format

EKS Node Monitor

Attribute	Type	Description
type	string	Mandatory EKSNODE
profile_name	string	Mandatory Name of the profile
cpu_reserved_per_node	json	Triggers alert when the CPU reserved for node exceeds the configured threshold. JSON Format: $threshold_attribute_format
cpu_utilized_per_node	json	Triggers alert when the CPU utilized by node exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
file_utilized_per_node	json	Triggers alert when the file system capacity on node exceeds the configured threshold. JSON Format: $threshold_attribute_format
memory_reserved_per_node	json	Triggers alert when the memory reserved for node exceeds the configured threshold. JSON Format: $threshold_attribute_format
memory_utilized_per_node	json	Triggers alert when the memory utilized by node exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
network_per_node	json	Triggers alert when the total network traffic in node exceeds the configured threshold. JSON Format: $threshold_attribute_format
running_container_per_node	json	Triggers alert when the number of containers running in node exceeds the configured threshold. JSON Format: $threshold_attribute_format
running_pod_per_node	json	Triggers alert when the number of pods running in node exceeds the configured threshold. JSON Format: $threshold_attribute_format

Amazon MQ Broker Monitor

Attribute	Type	Description
type	string	Mandatory AMQ
profile_name	string	Mandatory Name of the profile
amq_resource_alert	json	Notify for monitored resource status change. JSON Format: {value:true/false, severity:“$status”}
cpu_credit_balance_broker	json	Triggers alert when the number of earned CPU credits that an instance has accrued since it was launched or started exceeds the configured threshold. JSON Format: $threshold_attribute_format
cpu_utilization_broker	json	Triggers alert when the CPU utilization exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
current_conn_count	json	Triggers alert when the number of current number of active connections on the current broker exceeds the configured threshold. JSON Format: $threshold_attribute_format
established_conn_count	json	Triggers alert when the total number of connections, active and inactive, that have been established on the broker exceeds the configured threshold. JSON Format: $threshold_attribute_format
inactive_drtopic_sub_count	json	Triggers alert when the number of inactive durable topic subscribers exceeds the configured threshold. JSON Format: $threshold_attribute_format
jrn_files_fast_revcovery	json	Triggers alert when the number of journal files that will be replayed after a clean shutdown exceeds the configured threshold. JSON Format: $threshold_attribute_format
jrn_files_full_revcovery	json	Triggers alert when number of journal files that will be replayed after an unclean shutdown exceeds the configured threshold. JSON Format: $threshold_attribute_format
heap_usage_broker	json	Triggers alert when percentage of the ActiveMQ JVM memory limit that the broker currently uses exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
network_in_broker	json	Triggers alert when volume of incoming traffic for the broker exceeds the configured threshold. JSON Format: $threshold_attribute_format
network_out_broker	json	Triggers alert when volume of outgoing traffic for the broker exceeds the configured threshold. JSON Format: $threshold_attribute_format
open_trasaction_count	json	Triggers alert when total number of transactions in progress exceeds the configured threshold. JSON Format: $threshold_attribute_format
store_percent_usage	json	Triggers alert when percent used by the storage limit exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
total_consumer_count	json	Triggers alert when the number of message consumers subscribed to destinations on the current broker exceeds the configured threshold. JSON Format: $threshold_attribute_format
total_message_count	json	Triggers alert when the number of messages stored on the broker exceeds the configured threshold. JSON Format: $threshold_attribute_format
total_producer_count	json	Triggers alert when the number of message producers active on destinations on the current broker exceeds the configured threshold. JSON Format: $threshold_attribute_format
total_enqueue_count	json	Triggers alert when the total number of messages that have been sent to the broker exceeds the configured threshold. JSON Format: $threshold_attribute_format
total_dequeue_count	json	Triggers alert when total number of messages that have been consumed by clients exceeds the configured threshold. JSON Format: $threshold_attribute_format

Amazon MQ Topic Monitor

Attribute	Type	Description
type	string	Mandatory AMQTOPIC
profile_name	string	Mandatory Name of the profile
consumer_count_topic	json	Triggers alert when the number of consumers subscribed to the destination exceeds the configured threshold. JSON Format: $threshold_attribute_format
enqueue_count_topic	json	Triggers alert when the number of messages sent to the destination, per minute exceeds the configured threshold. JSON Format: $threshold_attribute_format
enqueue_time_topic	json	Triggers alert when the end-to-end latency from when a message arrives at a broker until it is delivered to a consumer exceeds the configured threshold. JSON Format: $threshold_attribute_format
dequeue_count_topic	json	Triggers alert when the number of messages acknowledged by consumers exceeds the configured threshold. JSON Format: $threshold_attribute_format
proudcer_count_topic	json	Triggers alert when the number of producers for the destination exceeds the configured threshold. JSON Format: $threshold_attribute_format
memory_usage_topic	json	Triggers alert when the percentage of the memory limit that the destination currently uses exceeds the configured threshold. JSON Format: $threshold_attribute_format
inflight_topic	json	Triggers alert when the number of messages sent to consumers that have not been acknowledged exceeds the configured threshold. JSON Format: $threshold_attribute_format
expired_count_topic	json	Triggers alert when the number of messages that couldn’t be deliverd exceeds the configured threshold. JSON Format: $threshold_attribute_format

Amazon MQ Queue Monitor

Attribute	Type	Description
type	string	Mandatory AMQQUEUE
profile_name	string	Mandatory Name of the profile
consumer_count_queue	json	Triggers alert when the number of consumers subscribed to the destination exceeds the configured threshold. JSON Format: $threshold_attribute_format
enqueue_count_queue	json	Triggers alert when the number of messages sent to the destination, per minute exceeds the configured threshold. JSON Format: $threshold_attribute_format
enqueue_time_queue	json	Triggers alert when the end-to-end latency from when a message arrives at a broker until it is delivered to a consumer exceeds the configured threshold. JSON Format: $threshold_attribute_format
dequeue_count_queue	json	Triggers alert when the number of messages acknowledged by consumers exceeds the configured threshold. JSON Format: $threshold_attribute_format
proudcer_count_queue	json	Triggers alert when the number of producers for the destination exceeds the configured threshold. JSON Format: $threshold_attribute_format
memory_usage_queue	json	Triggers alert when the percentage of the memory limit that the destination currently uses exceeds the configured threshold. JSON Format: $threshold_attribute_format
inflight_queue	json	Triggers alert when the number of messages sent to consumers that have not been acknowledged exceeds the configured threshold. JSON Format: $threshold_attribute_format
expired_count_queue	json	Triggers alert when the number of messages that couldn’t be deliverd exceeds the configured threshold. JSON Format: $threshold_attribute_format
queue_size	json	Triggers alert when the number of messages in the queue exceeds the configured threshold. JSON Format: $threshold_attribute_format

Amazon MQ Network Connector Monitor

Attribute	Type	Description
type	string	Mandatory AMQNC
profile_name	string	Mandatory Name of the profile
enqueue_count_nc	json	Triggers alert when the number of messages sent to the destination, per minute exceeds the configured threshold. JSON Format: $threshold_attribute_format
dequeue_count_nc	json	Triggers alert when the number of messages acknowledged by consumers exceeds the configured threshold. JSON Format: $threshold_attribute_format
receive_count_nc	json	Triggers alert when the number of messages that have been received from the remote broker for a duplex network connector exceeds the configured threshold. JSON Format: $threshold_attribute_format

Lightsail Database Monitor

Attribute	Type	Description
type	string	Mandatory LIGHTSAIL-DATABASE
profile_name	string	Mandatory Name of the profile
cpu_utilization	json	Triggers alert when the CPU utilization violates the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
db_connections	json	Triggers alert when the number of database connections in use violates the configured threshold. JSON Format: $threshold_attribute_format
disk_queue_depth	json	Triggers alert when the number of outstanding read/write requests waiting to access the disk violates the configured threshold. JSON Format: $threshold_attribute_format
free_storage_threshold	json	Triggers alert when the amount of available storage space violates the configured threshold. JSON Format: $threshold_attribute_format
networkreceive_throughput	json	Triggers alert when the incoming network traffic to the database violates the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
networktransmit_throughput	json	Triggers alert when the outgoing network traffic to the database violates the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format

Lightsail Load Balancer Monitor

Attribute	Type	Description
type	string	Mandatory LIGHTSAIL-LB
profile_name	string	Mandatory Name of the profile
lb_resource_alert	json	Notify for monitored resource status change. JSON Format: {value:true/false, severity:“$status”}
instance_health_alert	json	Notify for attached lightsail instance’s health status change. JSON Format: {value:true/false, severity:“$status”}
client_tls_negotiation_error	json	Triggers alert when the Client TLS Negotiation Error Count violates the configured threshold. JSON Format: $threshold_attribute_format
healthyhost_count	json	Triggers alert when the Healthy Host Count violates the configured threshold. JSON Format: $threshold_attribute_format
unhealthyhost_count	json	Triggers alert when the Unhealthy Host Count violates the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
http_4xx_lb	json	Triggers alert when the number of HTTP 4xx Response Codes by load balancer violates the configured threshold. JSON Format: $threshold_attribute_format
http_5xx_lb	json	Triggers alert when the number of HTTP 5xx Response Codes by load balancer violates the configured threshold. JSON Format: $threshold_attribute_format
http_2xx_instance	json	Triggers alert when the number of HTTP 2xx Response Codes by instance violates the configured threshold. JSON Format: $threshold_attribute_format
http_3xx_instance	json	Triggers alert when the number of HTTP 3xx Response Codes by instance violates the configured threshold. JSON Format: $threshold_attribute_format
http_4xx_instance	json	Triggers alert when the number of HTTP 4xx Response Codes by instance violates the configured threshold. JSON Format: $threshold_attribute_format
http_5xx_instance	json	Triggers alert when the number of HTTP 5xx Response Codes by instance violates the configured threshold. JSON Format: $threshold_attribute_format
rejected_connection_count	json	Triggers alert when the Rejected Connection Count violates the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
request_count	json	Triggers alert when the Request Count violates the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
instance_response_time	json	Triggers alert when the Instance Response Time violates the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format

Storage Gateway Monitor

Attribute	Type	Description
type	string	Mandatory STORAGEGATEWAY
profile_name	string	Mandatory Name of the profile
asg_resouce_alert	json	Notify for monitored resource status change. JSON Format: {value:true/false, severity:“$status”}
cache_hit_percent	json	Triggers alert when the percent of application reads served from the cache exceeds the configured threshold. JSON Format: $threshold_attribute_format
upload_buffer_percent_used	json	Triggers alert when the percent use of the gateway’s upload buffer exceeds the configured threshold. JSON Format: $threshold_attribute_format
upload_buffer_used	json	Triggers alert when the total number of bytes being used in the gateway’s upload buffer exceeds the configured threshold. JSON Format: $threshold_attribute_format
cache_used_sg	json	Triggers alert when the total number of bytes being used in the gateway’s cache storage exceeds the configured threshold. JSON Format: $threshold_attribute_format
queued_writes	json	Triggers alert when the number of bytes waiting to be written to AWS, sampled at the end of the reporting period for all volumes in the gateway exceeds the configured threshold. JSON Format:$threshold_attribute_format
read_bytes_sum	json	Triggers alert when the total number of bytes read from your on-premises applications exceeds the configured threshold. JSON Format: $threshold_attribute_format
read_time	json	Triggers alert when the total time in milliseconds spent to do read operations from your on-premises applications exceeds the configured threshold. JSON Format: $threshold_attribute_format
total_cache_size	json	Triggers alert when the total size of the cache in bytes exceeds the configured threshold. JSON Format: $threshold_attribute_format
write_bytes_sum	json	Triggers alert when the total number of bytes written to your on-premises applications exceeds the configured threshold. JSON Format: $threshold_attribute_format
write_time	json	Triggers alert when the total time in milliseconds spent to do write operations from your on-premises applications exceeds the configured threshold. JSON Format: $threshold_attribute_format
time_since_recvry_pnt	json	Triggers alert when the time since the last available recovery point exceeds the configured threshold. JSON Format: $threshold_attribute_format
working_storage_free	json	Triggers alert when the total amount of unused space in the gateway’s working storage exceeds the configured threshold. JSON Format: $threshold_attribute_format
working_storage_prct_used	json	Triggers alert when the percent use of the gateway’s upload buffer exceeds the configured threshold. JSON Format: $threshold_attribute_format
working_storage_used	json	Triggers alert when the total number of bytes being used in the gateway’s upload buffer exceeds the configured threshold. JSON Format: $threshold_attribute_format
user_cpu_percent	json	Triggers alert when the percent of CPU time spent on gateway processing, averaged across all cores exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
io_wait_percent	json	Triggers alert when the percent of time that the gateway is waiting on a response from the local disk. exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
mem_total_bytes	json	Triggers alert when the amount of RAM provisioned to the gateway VM, in bytes exceeds the configured threshold. JSON Format:$threshold_attribute_format
mem_used_bytes	json	Triggers alert when the amount of RAM currently in use by the gateway VM, in bytes exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
smb_vone_sessions	json	Triggers alert when the number of Server Message Block (SMB) version 1 sessions that are active on the gateway exceeds the configured threshold. JSON Format: $threshold_attribute_format
smb_vtwo_sessions	json	Triggers alert when the number of SMB version 2 sessions that are active on the gateway exceeds the configured threshold. JSON Format: $threshold_attribute_format
smb_vthree_sessions	json	Triggers alert when the number of SMB version 3 sessions that are active on the gateway exceeds the configured threshold. JSON Format: $threshold_attribute_format
index_evictions_sum	json	Triggers alert when the number of files whose metadata was evicted from the cached index of file metadata to make room for new entries exceeds the configured threshold. JSON Format: $threshold_attribute_format
index_fetches_sum	json	Triggers alert when the number of files for which metadata was fetched exceeds the configured threshold. JSON Format: $threshold_attribute_format
avilbality_noitifications	json	Triggers alert when the number of availability-related health notifications generated by the gateway exceeds the configured threshold. JSON Format: $threshold_attribute_format
health_noitifications	json	Triggers alert when the number of health notificiations exceeds the configured threshold. JSON Format: $threshold_attribute_format
cloud_bytes_uploaded_gateway	json	Triggers alert when the total number of bytes that the gateway uploaded exceeds the configured threshold. JSON Format: $threshold_attribute_format
cloud_bytes_downl_gateway	json	Triggers alert when the total number of bytes that the gateway downloaded exceeds the configured threshold. JSON Format: $threshold_attribute_format
cloud_down_latency	json	Triggers alert when the latency while downloading bytes from the cloud exceeds the configured threshold. JSON Format: $threshold_attribute_format
index_evictions_average	json	Triggers alert when the average number of files whose metadata was evicted from the cached index of file metadata to make room for new entries exceeds the configured threshold. JSON Format: $threshold_attribute_format
index_fetches_average	json	Triggers alert when the average number of files for which metadata was fetched exceeds the configured threshold. JSON Format: $threshold_attribute_format
cache_percent_dirty	json	Triggers alert when overall percentage of the gateway’s cache that has not been persisted to AWS exceeds the configured threshold. JSON Format: $threshold_attribute_format
cloud_down_latency	json	Triggers alert when the percent of application reads served from the cache exceeds the configured threshold. JSON Format: $threshold_attribute_format
cache_percent_used	json	Triggers alert when the overall percent use of the gateway’s cache storage exceeds the configured threshold. JSON Format: $threshold_attribute_format
upload_buffer_free	json	Triggers alert when the amount of upload buffer that is not used exceeds the configured threshold. JSON Format: $threshold_attribute_format
cache_free	json	Triggers alert when the amount of cache that is not used exceeds the configured threshold. JSON Format: $threshold_attribute_format

Storage Gateway File Share Monitor

Attribute	Type	Description
type	string	Mandatory SGFILE
profile_name	string	Mandatory Name of the profile
cache_hit_percent_file	json	Triggers alert when the percent of application read operations from the file shares that are served from cache exceeds the configured threshold. JSON Format: $threshold_attribute_format
cache_percent_dirty_file	json	Triggers alert when the file share’s contribution to the overall percentage of the gateway’s cache that has not been persisted to AWS exceeds the configured threshold. JSON Format: $threshold_attribute_format
cache_percent_used_file	json	Triggers alert when the file share’s contribution to the overall percent use of the gateway’s cache storage exceeds the configured threshold. JSON Format: $threshold_attribute_format
read_bytes_file	json	Triggers alert when the total number of bytes read from your on-premises applications in the reporting period for a file share exceeds the configured threshold. JSON Format: $threshold_attribute_format
index_fetches_file	json	Triggers alert when the number of files for which metadata was fetched exceeds the configured threshold. JSON Format: $threshold_attribute_format
write_bytes_file	json	Triggers alert when the total number of bytes written to your on-premises applications in the reporting period exceeds the configured threshold. JSON Format: $threshold_attribute_format
cloud_bytes_uploaded_file	json	Triggers alert when the total number of bytes that the gateway uploaded to AWS during the reporting period exceeds the configured threshold. JSON Format: $threshold_attribute_format
cloud_bytes_downl_file	json	Triggers alert when the total number of bytes that the gateway downloaded from AWS during the reporting period exceeds the configured threshold. JSON Format: $threshold_attribute_format

Storage Gateway Volume Monitor

Attribute	Type	Description
type	string	Mandatory SGVOLUME
profile_name	string	Mandatory Name of the profile
cache_hit_percent_volume	json	Triggers alert when the percent of application read operations from the volume that are served from cache exceeds the configured threshold. JSON Format: $threshold_attribute_format
cache_percent_dirty_volume	json	Triggers alert when the volume’s contribution to the overall percentage of the gateway’s cache that isn’t persisted to AWS exceeds the configured threshold. JSON Format: $threshold_attribute_format
cache_percent_used_volume	json	Triggers alert when the volume’s contribution to the overall percent use of the gateway’s cache storage exceeds the configured threshold. JSON Format: $threshold_attribute_format
client_traffic_volume	json	Triggers alert when the number of bytes that the volume sent and received from on-premises clients exceeds the configured threshold. JSON Format: $threshold_attribute_format
cloud_traffic_volume	json	Triggers alert when the number of bytes uploaded and downloaded from the cloud to the volume exceeds the configured threshold. JSON Format: $threshold_attribute_format
cpu_usage_volume	json	Triggers alert when the percentage of allocated CPU compute units that are currently used by the volume exceeds the configured threshold. JSON Format: $threshold_attribute_format
heath_notification_count_vol	json	Triggers alert when the number of health notifications sent by the volume exceeds the configured threshold. JSON Format: $threshold_attribute_format
memory_usage_volume	json	Triggers alert when the percentage of allocated memory that is currently used by the volume exceeds the configured threshold. JSON Format: $threshold_attribute_format
write_bytes_sum_volume	json	Triggers alert when the otal number of bytes written to your on-premises applications exceeds the configured threshold. JSON Format: $threshold_attribute_format
write_time_volume	json	Triggers alert when the total time in milliseconds spent on write operations from your on-premises applications exceeds the configured threshold. JSON Format: $threshold_attribute_format
read_bytes_sum_volume	json	Triggers alert when the total number of bytes read from your on-premises applications exceeds the configured threshold. JSON Format: $threshold_attribute_format
read_time_volume	json	Triggers alert when the total time in milliseconds spent on read operations from your on-premises applications exceeds the configured threshold. JSON Format: $threshold_attribute_format
queued_writes_volume	json	Triggers alert when the number of bytes waiting to be written to AWS, sampled at the end of the reporting period exceeds the configured threshold. JSON Format: $threshold_attribute_format

Transit Gateway Monitor

Attribute	Type	Description
type	string	Mandatory TRANSITGATEWAY
profile_name	string	Mandatory Name of the profile
tg_bytes_in	json	Triggers alert when the number of bytes received by the transit gateway exceeds the configured threshold. JSON Format: $threshold_attribute_format
tg_bytes_out	json	Triggers alert when the number of bytes sent from the transit gateway exceeds the configured threshold. JSON Format: $threshold_attribute_format
tg_packets_in	json	Triggers alert when the number of packets received by the transit gateway exceeds the configured threshold. JSON Format: $threshold_attribute_format
tg_packets_out	json	Triggers alert when number of packets sent by the transit gateway exceeds the configured threshold. JSON Format:$threshold_attribute_format
packet_drop_blackhole	json	Triggers alert when the Packet Drop Black Hole count exceeds the configured threshold JSON Format: $threshold_attribute_format
packets_drop_no_route	json	Triggers alert when the Packet Drop No Route count exceeds the configured threshold JSON Format: $threshold_attribute_format
bytes_drop_blackhole	json	Triggers alert when the Bytes Drop Black Hole count exceeds the configured threshold JSON Format:$threshold_attribute_format
bytes_drop_no_route	json	Triggers alert when the Bytes Drop No Route count exceeds the configured threshold JSON Format: $threshold_attribute_format
tg_attachment_failure	json	Notify for Transit Gateway attachment failure. JSON Format: {value:true/false, severity:“$status”}
tgw_resource_alert	json	Notify for monitored resource status change. JSON Format: {value:true/false, severity:“$status”}

Direct Connect Virtual Interface Monitor

Attribute	Type	Description
type	string	Mandatory DIRECTCONNECTVI
profile_name	string	Mandatory Name of the profile
vi_bps_egress	json	Triggers alert when the bitrate for outbound data from the AWS side of the virtual interface exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
vi_bps_ingress	json	Triggers alert when the bitrate for inbound data to the AWS side of the virtual interface exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
vi_pps_egress	json	Triggers alert when the packet rate for outbound data from the AWS side of the virtual interface exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
vi_pps_ingress	json	Triggers alert when the packet rate for inbound data from the AWS side of the virtual interface exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
bgp_state	json	Notify for BGP status change. JSON Format: {value:true/false, severity:“$status”}

DMS Replication Task Monitor

Attribute	Type	Description
type	string	Mandatory DMSTASK
profile_name	string	Mandatory Name of the profile
flt_bw_source	json	Triggers alert when the incoming data received from a full load from the source exceeds the configured threshold. JSON Format: $threshold_attribute_format
flt_bw_target	json	Triggers alert when the outgoing data transmitted from a full load for the target in KB per second exceeds the configured threshold. JSON Format: $threshold_attribute_format
flt_row_source	json	Triggers alert when the incoming changes from a full load from the source in rows per second exceeds the configured threshold. JSON Format: $threshold_attribute_format
flt_row_target	json	Triggers alert when the Outgoing changes from a full load for the target in rows per second exceeds the configured threshold. JSON Format: $threshold_attribute_format
cdc_incoming_changes	json	Triggers alert when the total number of change events at a point-in-time that are waiting to be applied to the target exceeds the configured threshold. JSON Format: $threshold_attribute_format
cdc_changes_memory_source	json	Triggers alert when the amount of rows accumulating in a memory and waiting to be committed from the source exceeds the configured threshold. JSON Format: $threshold_attribute_format
cdc_changes_memory_target	json	Triggers alert when the amount of rows accumulating in a memory and waiting to be committed to the target exceeds the configured threshold. JSON Format: $threshold_attribute_format
cdc_changes_disc_source	json	Triggers alert when amount of rows accumulating on disk and waiting to be committed from the source exceeds the configured threshold. JSON Format: $threshold_attribute_format
cdc_changes_disc_target	json	Triggers alert when the amount of rows accumulating on disk and waiting to be committed to the target exceeds the configured threshold. JSON Format: $threshold_attribute_format
cdc_thr_bw_source	json	Triggers alert when the incoming data received for the source in KB per second exceeds the configured threshold. JSON Format: $threshold_attribute_format
cdc_thr_bw_target	json	Triggers alert when the outgoing data received for the source in KB per second exceeds the configured threshold. JSON Format: $threshold_attribute_format
cdc_thr_row_source	json	Triggers alert when the incoming task changes from the source in rows per second exceeds the configured threshold. JSON Format: $threshold_attribute_format
cdc_thr_row_target	json	Triggers alert when the outgoing task changes from the source in rows per second exceeds the configured threshold. JSON Format: $threshold_attribute_format
cdc_latency_source	json	Triggers alert when the gap, in seconds, between the last event captured from the source endpoint and current system time stamp of the AWS DMS instance exceeds the configured threshold. JSON Format: $threshold_attribute_format
cdc_latency_target	json	Triggers alert when the gap, in seconds, between the last event captured from the target endpoint and current system time stamp of the AWS DMS instance exceeds the configured threshold. JSON Format: $threshold_attribute_format
task_memory_usage	json	Triggers alert when the portion of memory occupied by a task held in main memory exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
task_cpu_utilization	json	Triggers alert when the percentage of CPU being used by a task exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
vsr_count	json	Triggers alert when the number of rows that AWS DMS validated, per minute exceeds the configured threshold. JSON Format: $threshold_attribute_format
var_count	json	Triggers alert when the number of rows that validation was attempted, per minute exceeds the configured threshold. JSON Format: $threshold_attribute_format
vfo_count	json	Triggers alert when the number of rows where validation failed exceeds the configured threshold. JSON Format: $threshold_attribute_format
vso_count	json	Triggers alert when number of rows where validation was suspended exceeds the configured threshold. JSON Format: $threshold_attribute_format
vpo_count	json	Triggers alert when the number of rows where the validation is still pending exceeds the configured threshold. JSON Format: $threshold_attribute_format
vbq_source_latency	json	Triggers alert when the latency required to read a bulk set of data from the source endpoint exceeds the configured threshold. JSON Format: $threshold_attribute_format
vbq_target_latency	json	Triggers alert when the latency required to read a bulk set of data on the target endpoint exceeds the configured threshold. JSON Format: $threshold_attribute_format
viq_source_latency	json	Triggers alert when the latency in reading the changes from the source exceeds the configured threshold. JSON Format: $threshold_attribute_format
viq_target_latency	json	Triggers alert when the latency in reading the changes from the target exceeds the configured threshold. JSON Format: $threshold_attribute_format
dms_swap_usage	json	Triggers alert when the amount of swap space used on the replication task exceeds the configured threshold. JSON Format: $threshold_attribute_format
dms_memory_allocated	json	Triggers alert when the maximum allocation of memory for the task exceeds the configured threshold. JSON Format: $threshold_attribute_format
flt_bw_total	json	Triggers alert when the total full load throughput bandwidth at Target and Source exceeds the configured threshold. JSON Format: $threshold_attribute_format
flt_row_total	json	Triggers alert when the full load throughput rows at Target and Source exceeds the configured threshold. JSON Format: $threshold_attribute_format
cdc_changes_memory_total	json	Triggers alert when the total number of CDC Changes in memory at Target and Source exceeds the configured threshold. JSON Format: $threshold_attribute_format
cdc_changes_disc_total	json	Triggers alert when the total number of CDC Changes in disk at Target and Source exceeds the configured threshold. JSON Format: $threshold_attribute_format
cdc_thr_bw_total	json	Triggers alert when the total CDC throughput bandwidth at Target and Source exceeds the configured threshold. JSON Format: $threshold_attribute_format
cdc_thr_row_total	json	Triggers alert when total CDC throughput bandwidth at Target and Source exceeds the configured threshold. JSON Format: $threshold_attribute_format
cdc_latency_total	json	Triggers alert when the total CDC latency at Target and Source exceeds the configured threshold. JSON Format: $threshold_attribute_format
vbq_total_latency	json	Triggers alert when the total latency of validation bulk query at Target and Source exceeds the configured threshold. JSON Format: $threshold_attribute_format
viq_total_latency	json	Triggers alert when total latency of validation item query at Target and Source exceeds the configured threshold. JSON Format: $threshold_attribute_format

DMS Replication Instance Monitor

Attribute	Type	Description
type	string	Mandatory DMSINSTANCE
profile_name	string	Mandatory Name of the profile
dms_instance_cpu_threshold	json	Triggers alert when the amount of CPU used exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
dms_free_storage_mb	json	Triggers alert when the amount of available storage space exceeds the configured threshold. JSON Format: $threshold_attribute_format
dms_read_ops_threshold	json	Triggers alert when the average number of disk read I/O operations per second exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
dms_write_ops_threshold	json	Triggers alert when the average number of disk write I/O operations per second exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
dms_read_latency_threshold	json	Triggers alert when the average amount of time taken per disk I/O (input) operation exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
dms_write_latency_threshold	json	Triggers alert when the average amount of time taken per disk I/O (output) operation exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
dms_read_throughput_threshold	json	Triggers alert when the average number of bytes read from disk per second exceeds the configured threshold. JSON Format: $threshold_attribute_format
dms_write_throughput_threshold	json	Triggers alert when the average number of bytes write from disk per second exceeds the configured threshold. JSON Format: $threshold_attribute_format
dms_freeable_memory	json	Triggers alert when the amount of available random access memory exceeds the configured threshold. JSON Format: $threshold_attribute_format
dms_swap_usage	json	Triggers alert when the amount of swap space used on the replication instance exceeds the configured threshold. JSON Format: $threshold_attribute_format
dms_disk_queue_depth	json	Triggers alert when the number of outstanding IO requests that are waiting to be performed on a disk exceeds the configured threshold. JSON Format: $threshold_attribute_format
dms_receive_throughput	json	Triggers alert when the incoming (Receive) network traffic on the replication instance exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format

Amazon FSx Monitor

Attribute	Type	Description
type	string	Mandatory FSX
profile_name	string	Mandatory Name of the profile
fsx_data_read_bytes	json	Triggers alert when the amount of CPU used exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
fsx_data_write_bytes	json	Triggers alert when the number of bytes for file system write operations exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
fsx_data_read_operation	json	Triggers alert when the number of read operations exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
data_write_operation	json	Triggers alert when the number of write operations exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
fsx_meta_data_operation	json	Triggers alert when the number of metadata operations exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
fsx_free_storage_capacity	json	Triggers alert when the amount of available storage capacity exceeds the configured threshold. JSON Format: $threshold_attribute_format
fsx_total_throughput	json	Triggers alert when the average number of bytes read and write from disk exceeds the configured threshold. JSON Format: $threshold_attribute_format
fsx_read_throughput	json	Triggers alert when average number of bytes read from disk exceeds the configured threshold. JSON Format: $threshold_attribute_format
fsx_write_throughput	json	Triggers alert when the average number of bytes write from disk exceeds the configured threshold. JSON Format: $threshold_attribute_format
fsx_total_iops	json	Triggers alert when the average number of disk I/O operations per second exceeds the configured threshold. JSON Format: $threshold_attribute_format
fsx_read_iops	json	Triggers alert when the average number of disk read I/O operations per second exceeds the configured threshold. JSON Format: $threshold_attribute_format
fsx_write_iops	json	Triggers alert when the average number of disk write I/O operations per second exceeds the configured threshold. JSON Format: $threshold_attribute_format
fsx_meta_data_iops	json	Triggers alert when the average number of disk write I/O operations per second exceeds the configured threshold. JSON Format: $threshold_attribute_format
fsx_failed_count	json	Triggers alert when the number of files failed to export exceeds the configured threshold. JSON Format: $threshold_attribute_format
fsx_succeded_count	json	Triggers alert when the number of files successfully exported exceeds the configured threshold. JSON Format: $threshold_attribute_format
fsx_total_count	json	Triggers alert when the total number of files to export exceeds the configured threshold. JSON Format: $threshold_attribute_format

Lambda Edge Function Monitor

Attribute	Type	Description
type	string	Mandatory LAMBDA-EDGE
profile_name	string	Mandatory Name of the profile
success_percentage	json	Triggers alert when the Success Percentage violates the configured threshold. JSON Format: $threshold_attribute_format
invocations_lambda	json	Triggers alert when the number of Invocations violates the configured threshold. JSON Format: $threshold_attribute_format
errors_lambda	json	Triggers alert when the number of Errors violates the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
duration_avg_lambda	json	Triggers alert when the Duration violates the configured threshold. JSON Format: $threshold_attribute_format
throttles_lambda	json	Triggers alert when the number of Throttles violates the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
iterator_age	json	Triggers alert when the Iterator Age violates the configured threshold. JSON Format: $threshold_attribute_format
concurrent_executions	json	Triggers alert when the Concurrent Executions violates the configured threshold. JSON Format: $threshold_attribute_format
provisioned_con_invocations	json	Triggers alert when the Provisioned Concurrency Invocations violates the configured threshold. JSON Format: $threshold_attribute_format
provisioned_con_executions	json	Triggers alert when the Provisioned Concurrent Executions violates the configured threshold. JSON Format: $threshold_attribute_format
provisioned_con_utilization	json	Triggers alert when the Provisioned Concurrency Utilization violates the configured threshold. JSON Format: $threshold_attribute_format
success_rate	json	Triggers alert when the Success Rate (Regional Edge Caches) violates the configured threshold. JSON Format: $threshold_attribute_format
invocations_cloudfront	json	Triggers alert when the number of Invocations (Regional Edge Caches) violates the configured threshold. JSON Format: $threshold_attribute_format
errors_cloudfront	json	Triggers alert when the number of Errors (Regional Edge Caches) violates the configured threshold. JSON Format: $threshold_attribute_format
duration_avg_cloudfront	json	Triggers alert when the Duration (Regional Edge Caches) violates the configured threshold. JSON Format: $threshold_attribute_format
throttles_cloudfront	json	Triggers alert when the Throttles (Regional Edge Caches) violates the configured threshold. JSON Format: $threshold_attribute_format
concurrent_executions_cloudfront	json	Triggers alert when the Concurrent Executions (Regional Edge Caches) violates the configured threshold. JSON Format: $threshold_attribute_format

Inspector Monitor

Attribute	Type	Description
type	string	Mandatory INSPECTOR
profile_name	string	Mandatory Name of the profile
high_total_count	json	Triggers alert when the High severity finding count exceeds the configured threshold. JSON Format: $threshold_attribute_format
medium_total_count	json	Triggers alert when the Medium severity finding count exceeds the configured threshold. JSON Format:$threshold_attribute_format
low_total_count	json	Triggers alert when the Low severity finding count exceeds the configured threshold. JSON Format: $threshold_attribute_format
info_total_count	json	Triggers alert when the Info severity finding count exceeds the configured threshold. JSON Format: $threshold_attribute_format
total_count_per_run	json	Triggers alert when the Findings count per run exceeds the configured threshold. JSON Format: $threshold_attribute_format
count_by_resource	json	Triggers alert when the Finding count of particular Resource type exceeds the configured threshold. JSON Format:$threshold_attribute_format
count_by_region	json	Triggers alert when the Finding count of particular Region exceeds the configured threshold. JSON Format:$threshold_attribute_format

SFTP Monitor

Attribute	Type	Description
type	string	Mandatory SFTP
profile_name	string	Mandatory Name of the profile
bytes_in_avg	json	Triggers alert when Bytes In Average crosses the configured threshold. Anomaly Enabled Attribute. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
bytes_in_sum	json	Triggers alert when Bytes In Sum crosses the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
bytes_out_avg	json	Triggers alert when Bytes Out Average crosses the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
bytes_out_sum	json	Triggers alert when Bytes Out Sum crosses the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format

EC2_CWAGENT Monitor

Attribute	Type	Description
type	string	Mandatory SFTP
profile_name	string	Mandatory Name of the profile
memory_committed_bytes_in_use	json	Triggers alert when MemoryCommittedBytesInUse crosses the configured threshold. JSON Format: $threshold_attribute_format
logicaldisk_free_space	json	Triggers alert when LogicalDisk_Free_Space crosses the configured threshold. JSON Format: $threshold_attribute_format
paging_file_usage	json	Triggers alert when Paging_File_Usage crosses the configured threshold. JSON Format: $threshold_attribute_format
processor_idle_time	json	Triggers alert when Processor_Idle_Time crosses the configured threshold. JSON Format: $threshold_attribute_format
processor_interrupt_time	json	Triggers alert when Processor_Interrupt_Time crosses the configured threshold. JSON Format: $threshold_attribute_format
processor_user_time	json	Triggers alert when Processor_User_Time crosses the configured threshold. JSON Format: $threshold_attribute_format
physicaldisk_disk_time	json	Triggers alert when PhysicalDisk_Disk_Time crosses the configured threshold. JSON Format: $threshold_attribute_format
physicaldisk_disk_write_bytes_sec	json	Triggers alert when PhysicalDisk_Disk_Write_Bytes_sec crosses the configured threshold. JSON Format: $threshold_attribute_format
physicaldisk_disk_read_bytes_sec	json	Triggers alert when PhysicalDisk_Disk_Read_Bytes_sec crosses the configured threshold. JSON Format: $threshold_attribute_format
physicaldisk_disk_writes_sec	json	Triggers alert when PhysicalDisk_Disk_Writes_sec crosses the configured threshold. JSON Format: $threshold_attribute_format
physicaldisk_disk_reads_sec	json	Triggers alert when PhysicalDisk_Disk_Reads_sec crosses the configured threshold. JSON Format: $threshold_attribute_format
tcpv4_connections_established	json	Triggers alert when Tcpv4_Connections_Established crosses the configured threshold. JSON Format: $threshold_attribute_format
tcpv6_connections_established	json	Triggers alert when Tcpv6_Connections_Established crosses the configured threshold. JSON Format: $threshold_attribute_format
mem_used_percent	json	Triggers alert when Mem_Used_Percent crosses the configured threshold. JSON Format: $threshold_attribute_format
swap_used_percent	json	Triggers alert when Swap_Used_Percent crosses the configured threshold. JSON Format: $threshold_attribute_format
disk_used_percent	json	Triggers alert when Disk_Used_Percent crosses the configured threshold. JSON Format: $threshold_attribute_format
disk_inodes_free	json	Triggers alert when Disk_Inodes_Free crosses the configured threshold. JSON Format: $threshold_attribute_format
cpu_usage_idle	json	Triggers alert when Cpu_Usage_Idle crosses the configured threshold. JSON Format: $threshold_attribute_format
cpu_usage_iowait	json	Triggers alert when Cpu_Usage_Iowait crosses the configured threshold. JSON Format: $threshold_attribute_format
cpu_usage_user	json	Triggers alert when Cpu_Usage_User crosses the configured threshold. JSON Format: $threshold_attribute_format
cpu_usage_system	json	Triggers alert when Cpu_Usage_System crosses the configured threshold. JSON Format: $threshold_attribute_format
diskio_io_time	json	Triggers alert when Diskio_Io_Time crosses the configured threshold. JSON Format: $threshold_attribute_format
diskio_write_bytes	json	Triggers alert when Diskio_Write_Bytes crosses the configured threshold. JSON Format: $threshold_attribute_format
diskio_read_bytes	json	Triggers alert when Diskio_Read_Bytes crosses the configured threshold. JSON Format: $threshold_attribute_format
diskio_writes	json	Triggers alert when Diskio_Writes crosses the configured threshold. JSON Format: $threshold_attribute_format
diskio_reads	json	Triggers alert when Diskio_Reads crosses the configured threshold. JSON Format: $threshold_attribute_format
netstat_tcp_established	json	Triggers alert when Netstat_Tcp_Established crosses the configured threshold. JSON Format: $threshold_attribute_format
netstat_tcp_time_wait	json	Triggers alert when Netstat_Tcp_Time_Wait crosses the configured threshold. JSON Format: $threshold_attribute_format

AppStream 2.0 Monitor

Attribute	Type	Description
type	string	Mandatory APPSTREAM 2.0
profile_name	string	Mandatory The profile name.
service_endpoint_connected	json	Triggers an alert when the stack is disassociated from the fleet. JSON Format: $threshold_attribute_format
fleet_actual_capacity	json	Triggers an alert when the actual capacity crosses the configured threshold. JSON Format: $threshold_attribute_format
fleet_available_capacity	json	Triggers an alert when the available capacity crosses the configured threshold. JSON Format: $threshold_attribute_format
fleet_capacity_utilization	json	Triggers an alert when the capacity utilization crosses the configured threshold. JSON Format: $threshold_attribute_format
fleet_desired_capacity	json	Triggers an alert when the desired capacity crosses the configured threshold. JSON Format: $threshold_attribute_format
fleet_in_use_capacity	json	Triggers an alert when the in use capacity crosses the configured threshold. JSON Format: $threshold_attribute_format
fleet_pending_capacity	json	Triggers an alert when the pending capacity crosses the configured threshold. JSON Format: $threshold_attribute_format
fleet_running_capacity	json	Triggers an alert when the running capacity crosses the configured threshold. JSON Format: $threshold_attribute_format
in_sufficient_capacity_error	json	Triggers an alert when the insufficient capacity error crosses the configured threshold. JSON Format: $threshold_attribute_format
in_sufficient_concurrent_limit	json	Triggers an alert when the insufficient concurrency limit error crosses the configured threshold. JSON Format: $threshold_attribute_format
fleet_active_session_count	json	Triggers an alert when the active sessions (API) crosses the configured threshold. JSON Format: $threshold_attribute_format
active_session_count_saml	json	Triggers an alert when the active sessions (SAML) crosses the configured threshold. JSON Format: $threshold_attribute_format
active_session_count_user_pool	json	Triggers an alert when the active sessions (Userpool) crosses the configured threshold. JSON Format: $threshold_attribute_format
expired_session_count_api	json	Triggers an alert when the expired sessions (API) crosses the configured threshold. JSON Format: $threshold_attribute_format
expired_session_count_saml	json	Triggers an alert when the expired sessions (SAML) crosses the configured threshold. JSON Format: $threshold_attribute_format
expired_session_count_userpool	json	Triggers an alert when the expired sessions (Userpool) crosses the configured threshold. JSON Format: $threshold_attribute_format
connected_user_api	json	Triggers an alert when the connected users (API) crosses the configured threshold. JSON Format: $threshold_attribute_format
connected_user_saml	json	Triggers an alert when the connected user’s (SAML) crosses the configured threshold. JSON Format: $threshold_attribute_format
connected_user_userpool	json	Triggers an alert when the connected user’s (Userpool) crosses the configured threshold. JSON Format: $threshold_attribute_format

Systems Manager Monitor

Attribute	Type	Description
type	string	Mandatory SSM
profile_name	string	Mandatory The profile name.
ssm_resource_alert	json	Notify for monitored resource status change. JSON Format: {value:true/false, severity:“$status”}
ssm_ping_alert	json	Notify when the ping status is down. JSON Format: {value:true/false, severity:“$status”}
ssm_command_delivery_timed_out	json	Triggers an alert when the number of commands with Delivery Timed Out terminal status crosses the configured threshold. JSON Format: $threshold_attribute_format
ssm_commands_failed	json	Triggers an alert when the number of commands with Failed terminal status crosses the configured threshold. JSON Format: $threshold_attribute_format
ssm_commands_succeeded	json	Triggers an alert when the number of commands Success terminal status crosses the configured threshold. JSON Format: $threshold_attribute_format

AWS Health Monitor

Attribute	Type	Description
type	string	Mandatory AWSHEALTH
profile_name	string	Mandatory The profile name.
health_event_public	json	Notify for public health event. JSON Format: {value:true/false, severity:“$status”}
health_event_private	json	Notify for account specific health event. JSON Format: {value:true/false, severity:“$status”}
events_open	json	Triggers an alert when the number of events with Open status crosses the configured threshold. JSON Format: $threshold_attribute_format
events_upcoming	json	Triggers an alert when the number of events with Upcoming status crosses the configured threshold. JSON Format: $threshold_attribute_format
events_closed	json	Triggers an alert when the number of events with Closed status crosses the configured threshold. JSON Format: $threshold_attribute_format
total_events	json	Triggers an alert when the total number of events crosses the configured threshold. JSON Format: $threshold_attribute_format
public_region_events_open	json	Triggers an alert when the total number of public events in a region with Open status, crosses the configured threshold. JSON Format: $threshold_attribute_format
public_region_events_closed	json	Triggers an alert when the total number of public events in a region with Closed status, crosses the configured threshold. JSON Format: $threshold_attribute_format
public_region_events_total	json	Triggers an alert when the total number of public events in a region crosses the configured threshold. JSON Format: $threshold_attribute_format
account_region_events_open	json	Triggers an alert when the total number of account specific events in a region with Open status crosses the configured threshold. JSON Format: $threshold_attribute_format
account_region_events_upcoming	json	Triggers an alert when the total number of account specific events in a region with Upcoming status, crosses the configured threshold. JSON Format: $threshold_attribute_format
account_region_events_closed	json	Triggers an alert when the total number of account specific events in a region with Closed status, crosses the configured threshold. JSON Format: $threshold_attribute_format
account_region_events_total	json	Triggers an alert when the total number of account specific events in a region crosses the configured threshold. JSON Format: $threshold_attribute_format
public_service_events_open	json	Triggers an alert when the total number of public events for a service with Open status crosses the configured threshold. JSON Format: $threshold_attribute_format
public_service_events_closed	json	Triggers an alert when the total number of public events for a service with Closed status crosses the configured threshold. JSON Format: $threshold_attribute_format
public_service_events_total	json	Triggers an alert when the total number of public events for a service crosses the configured threshold. JSON Format: $threshold_attribute_format
account_service_events_open	json	Triggers an alert when the total number of account specific events for a service with Open status crosses the configured threshold. JSON Format: $threshold_attribute_format
account_service_events_upcoming	json	Triggers an alert when the total number of account specific events for a service with Upcoming status crosses the configured threshold. JSON Format: $threshold_attribute_format
account_service_events_closed	json	Triggers an alert when the total number of account specific events for a service with Closed status crosses the configured threshold. JSON Format: $threshold_attribute_format
account_service_events_total	json	Triggers an alert when the total number of account specific events for a service crosses the configured threshold. JSON Format: $threshold_attribute_format
event_type_events_open	json	Triggers an alert when the total number of events for a event type with Open status crosses the configured threshold. JSON Format: $threshold_attribute_format
event_type_events_upcoming	json	Triggers an alert when the total number of events for a event type that have a status of upcoming crosses the configured threshold. JSON Format: $threshold_attribute_format
event_type_events_closed	json	Triggers an alert when the total number of events for a event type that have a status of closed crosses the configured threshold. JSON Format: $threshold_attribute_format
event_type_events_total	json	Triggers an alert when the total number of events for a event type crosses the configured threshold. JSON Format: $threshold_attribute_format

AWS AppSync Monitor

Attribute	Type	Description
type	string	Mandatory APPSYNC
profile_name	string	Mandatory Name of the profile
5xx_error	json	Triggers an alert when the total number of 5xx error crosses the configured threshold.: $threshold_attribute_format
4xx_error	json	Triggers an alert when the total number of 4xx error crosses the configured threshold. JSON Format: $threshold_attribute_format
latency	json	Triggers an alert when the total number of latency (in milliseconds) crosses the configured threshold. JSON Format: $threshold_attribute_format
connect_success	json	Triggers an alert when the total number of connect success crosses the configured threshold. JSON Format: $threshold_attribute_format
connect_client_error	json	Triggers an alert when the total number of connect client error crosses the configured threshold. JSON Format: $threshold_attribute_format
connect_server_error	json	Triggers an alert when the total number of connect server error crosses the configured threshold. JSON Format: $threshold_attribute_format
disconnect_success	json	Triggers an alert when the total number of disconnect success crosses the configured threshold. JSON Format: $threshold_attribute_format
disconnect_client_error	json	Triggers an alert when the total number of disconnect client error crosses the configured threshold. JSON Format: $threshold_attribute_format
disconnect_server_error	json	Triggers an alert when the total number of disconnect server error crosses the configured threshold. JSON Format: $threshold_attribute_format
subscribe_success	json	Triggers an alert when the total number of subscribe success crosses the configured threshold. JSON Format: $threshold_attribute_format
subscribe_client_error	json	Triggers an alert when the total number of subscribe client error crosses the configured threshold. JSON Format: $threshold_attribute_format
subscribe_server_error	json	Triggers an alert when the total number of subscribe server error crosses the configured threshold. JSON Format: $threshold_attribute_format
unsubscribe_success	json	Triggers an alert when the total number of unsubscribe success crosses the configured threshold. JSON Format: $threshold_attribute_format
unsubscribe_client_error	json	Triggers an alert when the total number of unsubscribe client error crosses the configured threshold. JSON Format: $threshold_attribute_format
unsubscribe_server_error	json	Triggers an alert when the total number of unsubscribe server error crosses the configured threshold. JSON Format: $threshold_attribute_format
publish_data_message_success	json	Triggers an alert when the total number of publish data message success crosses the configured threshold. JSON Format: $threshold_attribute_format
publish_data_message_client_error	json	Triggers an alert when the total number of publish data message client error crosses the configured threshold. JSON Format: $threshold_attribute_format
publish_data_message_server_error	json	Triggers an alert when the total number of publish data message server error crosses the configured threshold. JSON Format: $threshold_attribute_format
publish_data_message_size	json	Triggers an alert when the total number of publish data message size crosses the configured threshold. JSON Format: $threshold_attribute_format
active_connections	json	Triggers an alert when the total number of active connections crosses the configured threshold. JSON Format: $threshold_attribute_format
active_subscriptions	json	Triggers an alert when the total number of active subscriptions crosses the configured threshold. JSON Format: $threshold_attribute_format
connection_duration	json	Triggers an alert when the total number of connection duration crosses the configured threshold. JSON Format: $threshold_attribute_format
invalidation_success	json	Triggers an alert when the total number of invalidation success crosses the configured threshold. JSON Format: $threshold_attribute_format
cache_hits	json	Triggers an alert if the number of hits exceeds the configured threshold. JSON Format: $threshold_attribute_format
cache_misses	json	Triggers an alert if the number of misses exceeds the configured threshold. JSON Format: $threshold_attribute_format
curr_items	json	Triggers an alert if the number of current items exceeds the configured threshold. JSON Format: $threshold_attribute_format
evictions	json	Triggers an alert if the number of evictions exceeds the configured threshold. JSON Format: $threshold_attribute_format
reclaimed	json	Triggers an alert if the number of reclaims exceeds the configured threshold. JSON Format: $threshold_attribute_format
bytes_used_for_cache	json	Triggers an alert if the bytes used by the cache exceeds the configured threshold. JSON Format: $threshold_attribute_format
status_deleted	json	Notify for cache deletion. JSON Format: {value:true/false, severity:“$status”}
status_failed	json	Notify for cache failure. JSON Format: {value:true/false, severity:“$status”}
status_modified	json	Notify when cache is modified. JSON Format: {value:true/false, severity:“$status”}

Network Devices

Attribute	Type	Description
type	string	Mandatory NETWORKDEVICE
profile_name	string	Mandatory Name of the profile
response_time_threshold_exceeds	json	Triggers alert if the device Response Time exceeds the configured threshold. JSON Format: $threshold_attribute_format
packet_loss_threshold	json	Triggers alert if the device Packet Loss exceeds the configured threshold. JSON Format: $threshold_attribute_format
in_traffic	json	Triggers alert if the In Traffic of any interface exceeds the configured threshold. JSON Format: {“trouble”: $in_traffic, “comparison_operator”:$comparison_operator, “polls_check”:$poll_check_value, “strategy”: $strategy,“unit_id”: $unit_id}
rx_util	json	Triggers alert if the Rx Utilization of any interface exceeds the configured threshold. JSON Format: $threshold_attribute_format
out_traffic	json	Triggers alert if the Out Traffic of any interface exceeds the configured threshold. JSON Format: {“trouble”: $out_traffic, “comparison_operator”:$comparison_operator, “polls_check”:$poll_check_value, “strategy”: $strategy,“unit_id”: $unit_id}
tx_util	json	Triggers alert if the Tx Utilization of any interface exceeds the configured threshold. JSON Format: $threshold_attribute_format
error_rate	json	Triggers alert if the Error Rate of any interface exceeds the configured threshold. JSON Format: $threshold_attribute_format
discard_rate	json	Triggers alert if the Discard Rate of any interface exceeds the configured threshold. JSON Format: $threshold_attribute_format
interface_trouble_down_alert	boolean	To mark the device as Trouble when an interface is Down/Trouble.

SOAP Web Service

Attribute	Type	Description
type	string	Mandatory SOAP
profile_name	string	Mandatory Name of the profile
down_location_threshold	int	Mandatory Triggers alert when the monitor is down from configured number of locations. Downtime Rules Constants
response _time_threshold	json	Response time threshold for primary and secondary monitoring location. Anomaly Enabled Attribute. JSON Format: {“primary”: {$threshold_attribute_format} “secondary”: {$threshold_attribute_format}}

Biztalk Server Monitor

Attribute	Type	Description
type	string	Mandatory BIZTALKSERVER
profile_name	string	Mandatory Name of the profile
p_used_physical_memory_threshold	json	Triggers alert when the total physical memory used on the machine exceeds the threshold. JSON Format: $threshold_attribute_format
database_transactions_per_sec_threshold	json	Triggers alert when the number of database transactions performed exceeds the threshold. JSON Format:$threshold_attribute_format
idle_orchestrations_threshold	json	Triggers alert when the number of idle orchestration instances currently hosted by the host instance exceeds the threshold. JSON Format: $threshold_attribute_format
msg_box_database_conn_failures_threshold	json	Triggers alert when the failed number of attempted database connections exceeds the threshold. JSON Format: $threshold_attribute_format
orchestrations_suspended_per_sec_threshold	json	Triggers alert when the average number of suspended orchestrations exceeds the threshold. JSON Format: $threshold_attribute_format
pending_messages_threshold	json	Triggers alert when the number of received messages unacknowledged by the message box exceeds the threshold. JSON Format: $threshold_attribute_format
orchestrations_discarded_per_sec_threshold	json	Triggers alert when the number of discarded orchestrations per second exceeds the threshold. JSON Format: $threshold_attribute_format
orchestrations_created_per_sec_threshold	json	Triggers alert when the number of created orchestrations per second exceeds the threshold. JSON Format: $threshold_attribute_format
running_orchestrations_threshold	json	Triggers alert when the number of active orchestration instances exceeds the threshold. JSON Format: $threshold_attribute_format
active_instance_count_threshold	json	Triggers alert when the number of service instances active in memory exceeds the threshold. JSON Format: $threshold_attribute_format
database_session_threshold	json	Triggers alert when the number of concurrent MessageBox database connections exceeds the threshold. JSON Format: $threshold_attribute_format
database_size_threshold	json	Triggers alert when the number of published messages in the database queue exceeds the threshold. JSON Format: $threshold_attribute_format
total_messages_delivered_threshold	json	Triggers alert when the number of delivered outbound messages to the Orchestration engine exceeds set threshold. JSON Format: $threshold_attribute_format
pending_receive_batches_threshold	json	Triggers alert when the number of batches received by the Messaging Engine and have not been processed exceeds the threshold. JSON Format: $threshold_attribute_format
pending_transmitted_messages_threshold	json	Triggers alert when the number of pending messages to be sent to the adapters exceeds the threshold. JSON Format: $threshold_attribute_format
throttled_receive_batches_threshold	json	Triggers alert when the number of batches blocked by the Messaging Engine due to high service load exceeds the threshold. JSON Format: $threshold_attribute_format
inbound_latency_threshold	json	Triggers alert when the average inbound latency (in milliseconds) exceeds the threshold. JSON Format: $threshold_attribute_format
outbound_latency_threshold	json	Triggers alert when the average outbound latency (in milliseconds) exceeds the threshold. JSON Format: $threshold_attribute_format
file_messages_received_per_sec_threshold	json	Triggers alert when the number of messages received per second by the file receive adapter exceeds the threshold. JSON Format: $threshold_attribute_format
file_messages_sent_per_sec_threshold	json	Triggers alert when the number of messages sent per second by the file adapter exceeds the threshold. JSON Format: $threshold_attribute_format
ftp_messages_received_per_sec_threshold	json	Triggers alert when the number of messages received per second by the FTP receive adapter exceeds the threshold. JSON Format: $threshold_attribute_format
ftp_messages_sent_per_sec_threshold	json	Triggers alert when the number of messages sent per second by the FTP send adapter exceeds the threshold. JSON Format: $threshold_attribute_format
http_messages_received_per_sec_threshold	json	Triggers alert when the number of HTTP requests received per second by the HTTP receive adapter exceeds the threshold. JSON Format: $threshold_attribute_format
http_messages_sent_per_sec_threshold	json	Triggers alert when the number of HTTP requests sent per second by the HTTP send adapter exceeds the threshold. JSON Format: $threshold_attribute_format
msmq_messages_received_per_sec_threshold	json	Triggers alert when the number of messages received per second by the MSMQ receive adapter exceeds the threshold. JSON Format: $threshold_attribute_format
msmq_messages_sent_per_sec_threshold	json	Triggers alert when the number of messages sent per second by the MSMQ send adapter exceeds the threshold. JSON Format: $threshold_attribute_format
pop3_active_sessions_threshold	json	Triggers alert when the number of open POP3 connections manageable by the POP3 adapter at a time exceeds the threshold. JSON Format: $threshold_attribute_format
pop3_messages_received_per_sec_threshold	json	Triggers alert when the number of email messages downloaded per second by the POP3 adapter exceeds the threshold. JSON Format: $threshold_attribute_format
smtp_messages_sent_per_sec_threshold	json	Triggers alert when the number of messages sent per second by the SMTP adapter exceeds the threshold. JSON Format: $threshold_attribute_format
soap_messages_received_per_sec_threshold	json	Triggers alert when the number of messages received per second by the SOAP adapter exceeds the threshold. JSON Format: $threshold_attribute_format
soap_messages_sent_per_sec_threshold	json	Triggers alert when the number of messages sent per second by the SOAP adapter exceeds the threshold. JSON Format: $threshold_attribute_format
message_delivery_delay_exceeds	json	Triggers alert when the current delay in ms imposed on each message delivery batch exceeds the threshold. JSON Format: $threshold_attribute_format
sql_messages_received_per_sec_threshold	json	Triggers alert when the number of messages read per second by the SQL adapter exceeds the threshold. JSON Format: $threshold_attribute_format
sql_messages_sent_per_sec_threshold	json	Triggers alert when the number of messages sent per second by the SQL adapter exceeds the threshold. JSON Format: $threshold_attribute_format
spool_size	json	Triggers alert when the cumulative size of all Host Queues exceeds the threshold. JSON Format: $threshold_attribute_format
tracking_data_size	json	Triggers alert when the size of the tracking data table on the Message Box exceeds the threshold. JSON Format: $threshold_attribute_format
total_instances_threshold	json	Triggers alert when the sum of all the host instances within a particular Message Box exceeds the threshold. JSON Format: $threshold_attribute_format
suspended_msg_length	json	Triggers alert when the suspended messages length exceeds the threshold. JSON Format: $threshold_attribute_format
is_enabled	boolean	Triggers alert if any host instance is disabled
receive_enabled	boolean	Triggers alert if any receive location is disabled

Office 365 Monitor

Attribute	Type	Description
type	string	Mandatory OFFICE365
profile_name	string	Mandatory Name of the profile
msex_group_created_threshold	json	Triggers alert if exchange mail group creation exceeds configured threshold. JSON Format: $threshold_attribute_format
msex_group_deleted_threshold	json	Triggers alert if exchange mail group deletion exceeds configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
msex_mailbox_count_threshold	json	Triggers alert if total mailbox count exceeds configured threshold. JSON Format: $threshold_attribute_format
msex_active_mailbox_threshold	json	Triggers alert if active mailbox count exceeds configured threshold. JSON Format: $threshold_attribute_format
msex_inactive_mailbox_threshold	json	Triggers alert if inactive mailbox count exceeds configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
msex_overwarn_mailbox_threshold	json	Triggers alert if over warning mailbox count exceeds configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_formathref=“#threshold_attribute_format”>$threshold_attribute_format
lync_active_users_threshold	json	Triggers alert if active lync users count exceeds configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
lync_total_conferences_threshold	json	Triggers alert if total lync conferences count exceeds configured threshold. JSON Format: $threshold_attribute_format
lync_web_conferences_threshold	json	Triggers alert if lync web conferences count exceeds configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
lync_tele_conferences_threshold	json	Triggers alert if lync tele conferences count exceeds configured threshold. JSON Format:$threshold_attribute_format
lync_im_conferences_threshold	json	Triggers alert if lync IM conferences count exceeds configured threshold. Anomaly Enabled Attribute. JSON Format:$threshold_attribute_format
lync_av_conferences_threshold	json	Triggers alert if lync AV conferences count exceeds configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
lync_aps_conferences_threshold	json	Triggers alert if lync Application Sharing conferences count exceeds configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
lync_total_session_threshold	json	Triggers alert if toal lync sessions count exceeds configured threshold. JSON Format:$threshold_attribute_format
lync_audio_session_threshold	json	Triggers alert if lync audio sessions count exceeds configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
lync_ft_session_threshold	json	Triggers alert if lync file transfer sessions count exceeds configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
lync_im_session_threshold	json	Triggers alert if lync IM sessions count exceeds configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
lync_video_session_threshold	json	Triggers alert if lync video sessions count exceeds configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
lync_aps_session_threshold	json	Triggers alert if lync Application Sharing sessions count exceeds configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
shp_active_drive_threshold	json	Triggers alert if Active Drive Deployment count exceeds configured threshold. JSON Format:$threshold_attribute_format
shp_inactive_drive_threshold	json	Triggers alert if InactiveDrive Deployment count exceeds configured threshold. JSON Format: $threshold_attribute_format
shp_drive_usage_threshold	json	Triggers alert if Drive Usage exceeds configured threshold. JSON Format: $threshold_attribute_format
shp_active_site_threshold	json	Triggers alert if Active Site Deployment count exceeds configured threshold. JSON Format: $threshold_attribute_format
shp_inactive_site_threshold	json	Triggers alert if Active Site Deployment count exceeds configured threshold. JSON Format: $threshold_attribute_format
shp_site_usage_threshold	json	Triggers alert if Site Usage exceeds configured threshold. JSON Format: $threshold_attribute_format

Microsoft SharePoint Server

Attribute	Type	Description
type	string	Mandatory SHAREPOINT
profile_name	string	Mandatory Name of the profile
access_failed_insert_req_per_sec	json	Failed Access insert requests/sec exceeds. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
access_failed_delete_req_per_sec	json	Failed Access delete requests/sec exceeds. JSON Format: $threshold_attribute_format
infopath_avg_session_duration	json	Average InfoPath form session exceeds. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
data_connect_submit_failures	json	InfoPath submit data connection failure rate exceeds. JSON Format: $threshold_attribute_format
misses_per_sec	json	Publishing Cache misses/sec exceeds. JSON Format: $threshold_attribute_format
failed_timer_jobs	json	Failed timer jobs exceeds. JSON Format: $threshold_attribute_format
error_req_per_sec_visio	json	Visio error requests/sec exceeds. JSON Format:$threshold_attribute_format
errors_per_sec_asp	json	ASP errors/sec exceeds. Anomaly Enabled Attribute. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
req_in_queue_asp	json	ASP requests waiting for service/sec exceeds. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
req_rejected_asp_insufficient_resource	json	ASP requests rejected due to insufficient resource exceeds. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
current_sessions_asp	json	ASP current session count exceeds. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
pending_transactions_in_progress_asp	json	ASP pending transactions count exceeds. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
oss_gatherer_threads_accessing_nw	json	OSS gatherer threads accessing network exceeds. JSON Format:$threshold_attribute_format
oss_gatherer_threads_in_plugin	json	OSS gatherer threads waiting for plugins exceeds. JSON Format:$threshold_attribute_format
oss_gatherer_active_docs_queue	json	OSS gatherer documents waiting for robot threads exceeds. JSON Format: $threshold_attribute_format
oss_gatherer_delayed_docs	json	OSS gatherer documents delayed due to site hit frequency rules exceeds. JSON Format: $threshold_attribute_format
oss_indexer_failed_queries	json	OSS archival plugin failed queries exceeds. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
oss_archival_queues_waiting	json	OSS archival plugin queues waiting exceeds. JSON Format: $threshold_attribute_format
oss_archival_retry_docs	json	OSS archival plugin documents marked for retry exceeds. JSON Format: $threshold_attribute_format
oss_archival_blocked_docs	json	OSS archival plugin total documents waiting for a queue exceeds. JSON Format: $threshold_attribute_format
excel_err_req_per_sec	json	Excel calculation services total requests returned with error/sec. JSON Format: $threshold_attribute_format
service_status	json	Notify when SharePoint service is offline. JSON Format: {value:true/false, severity:“$status”}
admin_service_status	json	Notify when admin service is stopped. JSON Format: {value:true/false, severity:“$status”}
timer_service_status	json	Notify when timer service is stopped. JSON Format: {value:true/false, severity:“$status”}
trace_service_status	json	Notify when trace service is stopped. JSON Format: {value:true/false, severity:“$status”}
user_code_service_status	json	Notify when user code service is stopped. JSON Format: {value:true/false, severity:“$status”}
writer_service_status	json	Notify when writer service is stopped. JSON Format: {value:true/false, severity:“$status”}
search_service_status	json	Notify when search service is stopped. JSON Format: {value:true/false, severity:“$status”}
office_search_service_status	json	Notify when office search service is stopped. JSON Format: {value:true/false, severity:“$status”}
service_instance_status	json	Notify when service instance is down. JSON Format: {value:true/false, severity:“$status”}
web_application_status	json	Notify when web application is down. JSON Format: {value:true/false, severity:“$status”}
content_db_status	json	Notify when content database is down. JSON Format: {value:true/false, severity:“$status”}

Microsoft SQL Server

Attribute	Type	Description
type	string	Mandatory SQLSERVER
profile_name	string	Mandatory Name of the profile
sql_agent_threshold	boolean	Notify when SQL Agent Service is down
sql_browser_threshold	boolean	Notify when SQL Browser Service is down
user_connection_threshold	json	User Connection Exceeds. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
login_threshold	json	Login Exceeds. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
logout_threshold	json	Logout Exceeds. JSON Format: $threshold_attribute_format
requests_threshold	json	Batch Requests Exceeds. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
sql_compilation_threshold	json	SQL Compilations Exceeds. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
sql_recompilation_threshold	json	SQL Re-Compilations Exceeds. JSON Format:$threshold_attribute_format
replication_merge_conflict_threshold	json	Replication Merge Conflicts Exceeds. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
backup_device_throughput_threshold	json	Backup Device Throughput Exceeds. JSON Format: $threshold_attribute_format
transaction_time_threshold	json	Transaction Exceeds. JSON Format: $threshold_attribute_format
error_threshold	json	Number of Errors Exceeds. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
page_split_threshold	json	Page Splits Exceeds. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
page_scan_threshold	json	Full Scans Exceeds. Anomaly Enabled Attribute. JSON Format:$threshold_attribute_format
target_memory_threshold	json	Target Server Memory Exceeds. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
total_memory_threshold	json	Total Server Memory Exceeds. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
sql_cache_memory_threshold	json	SQL Cache Memory Exceeds. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
optimizer_memory_threshold	json	Optimizer Memory Exceeds. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
connection_memory_threshold	json	Connection Memory Exceeds. JSON Format: $threshold_attribute_format
lock_memory_threshold	json	Lock Memory Exceeds. JSON Format: $threshold_attribute_format
workspace_memory_threshold	json	Granted Workspace Memory Exceeds. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
pending_memory_grants_threshold	json	Pending Memory Grants Exceeds. JSON Format: $threshold_attribute_format
buffer_cache_hit_threshold	json	Buffer Cache Hit Ratio < JSON Format: $threshold_attribute_format
check_pint_pages_threshold	json	Checkpoint Pages Exceeds. Anomaly Enabled Attribute. JSON Format:$threshold_attribute_format
lazy_writes_threshold	json	Lazy Writes Exceeds. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
page_life_expectency_threshold	json	Page Life Expectancy Anomaly Enabled Attribute. JSON Format:$threshold_attribute_format
page_reads_threshold	json	Page Read Exceeds. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
page_writes_threshold	json	Page Write Exceeds. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
total_pages_threshold	json	Total Pages Exceeds. JSON Format: $threshold_attribute_format
db_pages_threshold	json	DB Pages Exceeds. JSON Format: $threshold_attribute_format
free_pages_threshold	json	Free Pages <. JSON Format: $threshold_attribute_format
lock_requests_threshold	json	Lock Requests Exceeds. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
lock_timeouts_threshold	json	Lock Timeouts Exceeds. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
lock_waits_threshold	json	Lock Waits Exceeds. JSON Format: $threshold_attribute_format
dead_locks_threshold	json	Deadlocks Exceeds. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
avg_lock_wait_time_threshold	json	Average Lock Wait Time Exceeds. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
latch_waits_threshold	json	Latch Waits Exceeds. JSON Format: $threshold_attribute_format
plan_cache_hit_threshold	json	Plan Cache Hit Ratio <. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
plan_cache_pages_threshold	json	Cache Pages <. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
plan_cache_objects_threshold	json	Cache Objects <. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
active_jobs_threshold	json	Active Jobs Count <. JSON Format: $threshold_attribute_format
jobs_success_rate_threshold	json	Job Success Rate <. JSON Format: $threshold_attribute_format
queued_jobs_threshold	json	Queued Jobs Exceeds. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
failed_jobs_threshold	json	Failed Jobs Exceeds. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format

Microsoft Failover Cluster

Attribute	Type	Description
type	string	Mandatory WINDOWSCLUSTER
profile_name	string	Mandatory Name of the profile
cluster_quorum_modified	boolean	Notify Quorum Owner Node Changes
cluster_rg_movement	boolean	Notify Resource Group Movement
cluster_node_down_threshold	boolean	Notify if a cluster node is down
cluster_network_down_threshold	boolean	Notify if a cluster network is down
resource_group_down_threshold	boolean	Notify if a cluster resource group is down
outmsg_threshold	json	Triggers alert if outstanding messages count exceeds configured threshold. JSON Format: $threshold_attribute_format
disk_usage_threshold	json	Triggers alert if disk usage(%) exceeds configured threshold. JSON Format: $threshold_attribute_format
disk_usedsize_threshold	json	Triggers alert if disk usage(MB) exceeds configured threshold. JSON Format: $threshold_attribute_format
offline_resource_threshold	json	Triggers alert if offline resources count exceeds configured threshold. JSON Format: $threshold_attribute_format
offline_resourcegroup_threshold	json	Triggers alert if offline resource groups count exceeds configured threshold. JSON Format: $threshold_attribute_format
rhs_restarts_threshold	json	Triggers alert if host subsystem process restarts count exceeds configured threshold. JSON Format: $threshold_attribute_format
byte_sent_threshold	json	Triggers alert if bytes sent(MB) exceeds configured threshold. JSON Format: $threshold_attribute_format
byte_received_threshold	json	Triggers alert if bytes received(MB) exceeds configured threshold. JSON Format: $threshold_attribute_format
msg_received_threshold	json	Triggers alert if messages received count exceeds configured threshold. JSON Format: $threshold_attribute_format
msg_sent_threshold	json	Triggers alert if messages sent count exceeds configured threshold. JSON Format: $threshold_attribute_format

Microsoft Active Directory

Attribute	Type	Description
type	string	Mandatory ADSERVER
profile_name	string	Mandatory Name of the profile
addressbook_browses_threshold	json	Triggers alert if Address Book Browses exceeds configured threshold. JSON Format: $threshold_attribute_format
addressbook_client_sessions_threshold	json	Triggers alert if Address Book Client sessions exceeds configured threshold. JSON Format: $threshold_attribute_format
replication_traffic_in_threshold	json	Triggers alert if Replication Inbound Bytes exceeds configured threshold. JSON Format: $threshold_attribute_format
replication_objects_in_threshold	json	Triggers alert if Replication Inbound Objects exceeds configured threshold. JSON Format: $threshold_attribute_format
replication_values_in_threshold	json	Triggers alert if Replication Inbound Values exceeds configured threshold. JSON Format: $threshold_attribute_format
replication_traffic_out_threshold	json	Triggers alert if Replication Outbound Bytes exceeds configured threshold. JSON Format: $threshold_attribute_format
replication_objects_out_threshold	json	Triggers alert if Replication Outbound Objects exceeds configured threshold. JSON Format: $threshold_attribute_format
replication_values_out_threshold	json	Triggers alert if Replication Outbound Values exceeds configured threshold. JSON Format:$threshold_attribute_format
replication_objects_applied_threshold	json	Triggers alert if Replication Applied Object exceeds configured threshold. JSON Format: $threshold_attribute_format
sync_request_threshold	json	Triggers alert if Total Synchronization Request exceeds configured threshold. JSON Format: $threshold_attribute_format
sync_request_fails_threshold	json	Triggers alert if Total Synchronization request fails exceeds configured threshold. JSON Format: $threshold_attribute_format
dra_replication_remupdates_threshold	json	Triggers alert if Replication remaining updated exceeds configured threshold. JSON Format: $threshold_attribute_format
dra_pending_repsync_threshold	json	Triggers alert if Pending Replication Synchronization exceeds configured threshold. JSON Format: $threshold_attribute_format
ds_client_binds_threshold	json	Triggers alert if Domain services client binds exceeds configured threshold. JSON Format:$threshold_attribute_format
ds_directory_reads_threshold	json	Triggers alert if Domain services directory reads exceeds configured threshold. JSON Format: $threshold_attribute_format
ds_directory_writes_threshold	json	Triggers alert if Domain services directory writes exceeds configured threshold. JSON Format: $threshold_attribute_format
ds_directory_searches_threshold	json	Triggers alert if Domain services directory searches exceeds configured threshold. JSON Format: $threshold_attribute_format
ldap_active_threads_threshold	json	Triggers alert if LDAP active threads exceeds configured threshold. JSON Format: $threshold_attribute_format
ldap_client_sessions_threshold	json	Triggers alert if LDAP client sessions exceeds configured threshold. JSON Format: $threshold_attribute_format
ldap_search_threshold	json	Triggers alert if LDAP search exceeds configured threshold. JSON Format: $threshold_attribute_format
ldap_writes_threshold	json	Triggers alert if LDAP writes exceeds configured threshold. JSON Format: $threshold_attribute_format
ldap_successful_binds_threshold	json	Triggers alert if LDAP successful binds exceeds configured threshold. JSON Format: $threshold_attribute_format
sam_accgrop_evallatency_threshold	json	Triggers alert if Security Account Manager Account group evaluation latency exceeds configured threshold. JSON Format: $threshold_attribute_format
sam_maccreation_threshold	json	Triggers alert if Security Account Manager Machine Creation exceeds configured threshold. JSON Format: $threshold_attribute_format
sam_usercreation_threshold	json	Triggers alert if Security Account Manager User Creation exceeds configured threshold. JSON Format: $threshold_attribute_format
ad_iodb_reads_threshold	ad_dbi_avg_dbreads_threshold	Triggers alert if Database I/O reads exceeds configured threshold. JSON Format: $threshold_attribute_format
ad_iodb_writes_threshold	ad_dbi_avg_dbreads_threshold	Triggers alert if Database I/O writes exceeds configured threshold. JSON Format: $threshold_attribute_format
ad_db_cache_threshold	json	Triggers alert if Database cache size exceeds configured threshold. JSON Format: $threshold_attribute_format
ad_logrecord_stall_threshold	json	Triggers alert if Database Log record stall exceeds configured threshold. JSON Format: $threshold_attribute_format
ad_log_thread_wait_threshold	json	Triggers alert if Database waiting log threads exceeds configured threshold. JSON Format: $threshold_attribute_format
ad_log_writes_threshold	json	Triggers alert if Database log writes exceeds configured threshold. JSON Format: $threshold_attribute_format
ad_dbi_avg_logwrites_threshold	ad_dbi_avg_dbreads_threshold	Triggers alert if Database Instance Average Log writes exceeds configured threshold. JSON Format: $threshold_attribute_format
ad_dbi_avg_dbreads_threshold	ad_dbi_avg_dbreads_threshold	Triggers alert if Database Instance Average DB reads exceeds configured threshold. JSON Format: $threshold_attribute_format

Microsoft Hyperv Server

Attribute	Type	Description
type	string	Mandatory HYPERV
profile_name	string	Mandatory Name of the profile
vm_down_alert	json	Triggers alert if the VM is down. JSON Format: $threshold_attribute_format
hyperv_healthcritical_vms_threshold	json	Triggers alert if the critical state VMs exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
hyperv_healthok_vms_threshold	json	Triggers alert if the normal state VMs exceeds the configured threshold. JSON Format:$threshold_attribute_format
vm_replication_health	json	Triggers alert if the replication health of the VM is changed. JSON Format: $threshold_attribute_format
hyperv_logical_processes_threshold	json	Triggers alert if the logical processes exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
hyperv_vm_partitions_threshold	json	Triggers alert if the VM partitions exceeds the configured threshold. JSON Format: $threshold_attribute_format
hyperv_virtual_processors_threshold	json	Triggers alert if the virtual processors exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
hyperv_total_pages_threshold	json	Triggers alert if the number of bootstrap and deposited pages exceeds the configured threshold. JSON Format: $threshold_attribute_format
hyperv_interrupts_received_threshold	json	Triggers alert if the total number of interrupts received exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
hyperv_interrupts_sent_threshold	json	Triggers alert if the total number of interrupts sent exceeds the configured threshold. JSON Format: $threshold_attribute_format
hyperv_throttle_events_threshold	json	Triggers alert if the number of throttle events exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
hyperv_logical_guest_runtime_threshold	json	Triggers alert if the percentage of logical processor guest run time exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
hyperv_logical_hypervisor_runtime_threshold	json	Triggers alert if the percentage of logical processor hypervisor run time exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
hyperv_logical_idletime_threshold	json	Triggers alert if the percentage of logical processor idle time exceeds the configured threshold. JSON Format: $threshold_attribute_format
hyperv_logical_total_runtime_threshold	json	Triggers alert if the percentage of logical processor run time exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
hyperv_rootvirtual_guest_runtime_threshold	json	Triggers alert if the percentage of root virtual processor guest run time exceeds the configured threshold. JSON Format: $threshold_attribute_format
hyperv_rootvirtual_hypervisor_runtime_threshold	json	Triggers alert if the percentage of root virtual processor hypervisor run time exceeds the configured threshold. JSON Format: $threshold_attribute_format
hyperv_rootvirtual_total_runtime_threshold	json	Triggers alert if the percentage of root virtual processor total run time exceeds the configured threshold. JSON Format: $threshold_attribute_format
hyperv_root_totalintercepts_threshold	json	Triggers alert if the total rate of hypervisor intercepts messages on root virtual processor exceeds the configured threshold. JSON Format: $threshold_attribute_format
hyperv_root_hypercalls_threshold	json	Triggers alert if the rate of hypercalls on root virtual processor exceeds the configured threshold. JSON Format: $threshold_attribute_format
hyperv_root_hltinstructions_threshold	json	Triggers alert if the rate of HLT instructions on root virtual processor exceeds the configured threshold. JSON Format: $threshold_attribute_format
hyperv_root_ioinstructions_threshold	json	Triggers alert if the rate of IO instructions on root virtual processor exceeds the configured threshold. JSON Format: $threshold_attribute_format
hyperv_root_pagefaultintercepts_threshold	json	Triggers alert if the rate of page fault exceptions intercepted by the hypervisor on root virtual processor exceeds the configured threshold. JSON Format: $threshold_attribute_format
hyperv_root_emulatedinstructions_threshold	json	Triggers alert if the rate of emulated instructions on root virtual processor exceeds the configured threshold. JSON Format: $threshold_attribute_format
hyperv_root_msraccesses_threshold	json	Triggers alert if the rate of MSR instructions on root virtual processor exceeds the configured threshold. JSON Format: $threshold_attribute_format
hyperv_root_controlregisteraccesses_threshold	json	Triggers alert if the rate of control register accesses on root virtual processor exceeds the configured threshold. JSON Format: $threshold_attribute_format
hyperv_root_mwaitinstructions_threshold	json	Triggers alert if the rate of MWAIT instructions on root virtual processor exceeds the configured threshold. JSON Format: $threshold_attribute_format
hyperv_virtual_guestruntime_threshold	json	Triggers alert if the percentage of virtual processor guest run time exceeds the configured threshold. JSON Format: $threshold_attribute_format
hyperv_virtual_hypervisorruntime_threshold	json	Triggers alert if the percentage of virtual processor hypervisor run time exceeds the configured threshold. JSON Format: $threshold_attribute_format
hyperv_virtual_totalruntime_threshold	json	Triggers alert if the percentage of virtual processor total run time exceeds the configured threshold. JSON Format: $threshold_attribute_format
hyperv_virtual_totalintercepts_threshold	json	Triggers alert if the total rate of hypervisor intercepts messages on virtual processor exceeds the configured threshold. JSON Format: $threshold_attribute_format
hyperv_virtual_hypercalls_threshold	json	Triggers alert if the rate of hypercalls on virtual processor exceeds the configured threshold. JSON Format: $threshold_attribute_format
hyperv_virtual_htlinstructions_threshold	json	Triggers alert if the rate of HLT instructions on virtual processor exceeds the configured threshold. JSON Format: $threshold_attribute_format
hyperv_virtual_ioinstructions_threshold	json	Triggers alert if the rate of IO instructions on virtual processor exceeds the configured threshold. JSON Format: $threshold_attribute_format
hyperv_virtual_pagefaultintercepts_threshold	json	Triggers alert if the rate of page fault exceptions intercepted by the hypervisor on virtual processor exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
hyperv_virtual_emulatedinstructions_threshold	json	Triggers alert if the rate of emulated instructions on virtual processor exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
hyperv_virtual_msraccesses_threshold	json	Triggers alert if the rate of MSR instructions on virtual processor exceeds the configured threshold. Anomaly Enabled Attribute. JSON Format: $threshold_attribute_format
hyperv_virtual_controlregisteraccesses_threshold	json	Triggers alert if the rate of control register accesses on virtual processor exceeds the configured threshold. JSON Format: $threshold_attribute_format
hyperv_virtual_mwaitinstructions_threshold	json	Triggers alert if the rate of MWAIT instructions on virtual processor exceeds the configured threshold. JSON Format: $threshold_attribute_format
hyperv_rootpartition_1ggpapages_threshold	json	Triggers alert if the number of 1G pages present in the GPA space exceeds the configured threshold. JSON Format: $threshold_attribute_format
hyperv_rootpartition_2mgpapages_threshold	json	Triggers alert if the number of 2M pages present in the GPA space exceeds the configured threshold. JSON Format: $threshold_attribute_format
hyperv_rootpartition_depositedpages_threshold	json	Triggers alert if the number of deposited pages exceeds the configured threshold. JSON Format: $threshold_attribute_format
hyperv_vmvid_physical_pagesallocated_threshold	json	Triggers alert if the number of VM Vid Partition physical pages allocated exceeds the configured threshold. JSON Format: $threshold_attribute_format
hyperv_vmvid_remote_physicalpages_threshold	json	Triggers alert if the number of VM Vid Partition remote physical pages exceeds the configured threshold. JSON Format: $threshold_attribute_format

SMART Disk

Attribute	Type	Description
type	string	Mandatory SMARTDISK
profile_name	string	Mandatory Name of the profile
temperature_celsius	json	Triggers alert when configured threshold is exceeded. JSON Format: $threshold_attribute_format
load_cycle_count	json	Triggers alert when configured threshold is exceeded. JSON Format: $threshold_attribute_format
power_cycle_count	json	Triggers alert when configured threshold is exceeded. JSON Format: $threshold_attribute_format
power_on_hours	json	Triggers alert when configured threshold is exceeded. JSON Format: $threshold_attribute_format
raw_read_error_rate	json	Triggers alert when configured threshold is exceeded. JSON Format: $threshold_attribute_format
seek_error_rate	json	Triggers alert when configured threshold is exceeded. JSON Format: $threshold_attribute_format
seek_time_performance	json	Triggers alert when configured threshold is exceeded. JSON Format: $threshold_attribute_format
spin_up_time	json	Triggers alert when configured threshold is exceeded. JSON Format: $threshold_attribute_format
start_stop_count	json	Triggers alert when configured threshold is exceeded. JSON Format: $threshold_attribute_format
throughput_performance	json	Triggers alert when configured threshold is exceeded. JSON Format: $threshold_attribute_format
reallocated_sector_ct	json	Triggers alert when configured threshold is exceeded. JSON Format: $threshold_attribute_format

Heartbeat

Attribute	Type	Description
type	string	Mandatory HEARTBEAT
profile_name	string	Mandatory Name of the profile
hb_availability1	json	Triggers trouble Alert, if not pinged for more than the defined time period (minutes) JSON Format: $threshold_attribute_format
hb_availability2	json	Triggers down Alert, if not pinged for more than the defined time period (minutes) JSON Format: $threshold_attribute_format
hb_availability3	json	Triggers trouble Alert, if two pings are recieved within the defined time period (minutes) JSON Format: $threshold_attribute_format

Cron

Attribute	Type	Description
type	string	Mandatory CRON
profile_name	string	Mandatory Name of the profile
cron_no_run_alert	json	Triggers Alert, if job does not start on schedule JSON Format: {“severity”:0,“value”:true}
cron_duration_alert	json	Triggers down Alert, if Job runs longer than the given time period (seconds) JSON Format: $threshold_attribute_format

Real User Monitor

Attribute	Type	Description
type	string	Mandatory RUM-Application
profile_name	string	Mandatory Name of the profile
response_time_threshold_exceeds	json	Triggers Alert, if the response time exceeds the configured threshold JSON Format: $threshold_attribute_format
front_end_time_threshold	json	Triggers Alert, if the front end time exceeds the configured threshold JSON Format: $threshold_attribute_format
network_end_time_threshold	json	Triggers Alert, if the network time exceeds the configured threshold JSON Format: $threshold_attribute_format
back_end_time_threshold	json	Triggers Alert, if the back end time exceeds the configured threshold JSON Format: $threshold_attribute_format
apdex_threshold	json	Triggers Alert, if the apdex score exceeds the configured threshold JSON Format: $threshold_attribute_format
error_count	json	Triggers Alert, if the error count exceeds the configured threshold JSON Format: $threshold_attribute_format

Threshold Attribute Response JSON Format

Attribute	Description
trouble	Attribute Threshold Value Supported until version 2.0
value	Attribute Threshold Value Mandatory in case of Static Threshold
strategy	Strategy to validate the threshold breach. Strategy
comparison_operator	Validate threshold breach by applying multiple conditions Comparison Operator on specified threshold.
polls_check	Poll Check Value
severity	Severity
anomaly_severity	Anomaly Severity Mandatory in case of AI-based Threshold
action_ids	Array of IT Automation IDs.

Threshold Profiles

Threshold and Availability Profiles help the alarms engine to decide if a specific resource has to be declared critical or down. Configure Downtime Rules to reduce false alerts.

Note : API Version has to be passed as “2.1” in the Accept header for the Threshold APIs.

e.g., Accept: application/json; version=2.1

Create Threshold Profile

POST /threshold_profiles

Request Example

$ curl https://www.site24x7.com/api/threshold_profiles \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Accept: application/json; version=2.1" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \
    -d '{
        "type": "URL",
        "down_location_threshold": 3,
        "website_content_modified": {
          "severity": 2,
          "value": false
        },
        "profile_name": "URL Threshold and Availability Profile",
        "profile_type": 1,
        "website_content_changes": [
         {
           "severity": 2,
           "value" : 20,
           "comparison_operator": 1
         }
        ],
        "response_time_threshold": {
          "primary": [
            {
              "severity": 2,
              "comparison_operator": 1,
              "strategy": 1,
              "polls_check": 5,
              "value": 1000
            },
            {
              "severity": 3,
              "comparison_operator": 1,
              "strategy": 3,
              "polls_check": 5,
              "value": 2000
           }
          ],
          "secondary": [
            {
              "severity": 2,
              "comparison_operator": 1,
              "strategy": 1,
              "polls_check": 5,
              "value": 1000
            },
            {
              "severity": 3,
              "comparison_operator": 1,
              "strategy": 3,
              "polls_check": 5,
              "value": 2000
           }
          ],
        }
     }'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "success",
    "data": {
        "profile_name": "URL Threshold and Availability Profile",
        "website_content_changes": [
            {
                "severity": 2,
                "comparison_operator": 1,
                "value": 20,
                "strategy": 1,
                "polls_check": 1
            }
        ],
        "subtype": "",
        "response_time_threshold": {
            "secondary": [
                {
                    "severity": 2,
                    "comparison_operator": 1,
                    "value": 1000,
                    "strategy": 1,
                    "polls_check": 5
                },
                {
                    "severity": 3,
                    "comparison_operator": 1,
                    "value": 2000,
                    "strategy": 3,
                    "polls_check": 5
                }
            ],
            "primary": [
                {
                    "severity": 2,
                    "comparison_operator": 1,
                    "value": 1000,
                    "strategy": 1,
                    "polls_check": 5
                },
                {
                    "severity": 3,
                    "comparison_operator": 1,
                    "value": 2000,
                    "strategy": 3,
                    "polls_check": 5
                }
            ]
        },
        "profile_id": "113770000041195208",
        "profile_type": 1,
        "down_location_threshold": 3,
        "type": "URL",
        "website_content_modified": {
            "severity": 2,
            "value": false
        }
    }
}

Create a new Threshold and Availability profile.

oauthscope : Site24x7.Admin.Create
Current Version : 2.1
Supported Versions : 2.0

Website
Web Page Speed (Browser)
Web Transaction
REST API Transaction
Web Transaction (Browser)
REST API
Ping
TCP Port (Custom Protocol)
UDP
DNS Server
POP Server
SMTP Server
FTP Server
SSL Certificate
Mail Delivery
FTP Transfer
Server Monitor
Microsoft IIS Server Monitor
Microsoft SQL Server Monitor
Microsoft Exchange Server
EC2 Instance Monitor
RDS Instance Monitor
SNS Topic Monitor
DynamoDB Table Monitor
Classic Load Balancer
Application Load Balancer
Network Load Balancer
Gateway Load Balancer
Lambda Function Monitor
EC Memcached Cluster Monitor
EC Memcached Node Monitor
EC Redis Node Monitor
S3 Bucket Monitor
S3 Object Monitor
S3 Folder Monitor
SQS Queue Monitor
CloudFront Distribution Monitor
Kinesis Data Stream Monitor
Kinesis Firehose Delivery Stream Monitor
Kinesis Analytics Application Monitor
Kinesis Video Stream Monitor
Elastic Beanstalk Environment Monitor
Direct Connect Monitor
VPC - Virtual Private Network Monitor
API Gateway Stage Monitor
API Gateway Resource Monitor
API Gateway Route Monitor
ECS Cluster Monitor
ECS Cluster Service Monitor
Redshift Cluster Monitor
Redshift Node Monitor
Elastic File System Monitor
Simple Email Service Monitor
Step Function State Machine Monitor
Web Application Firewall Monitor
CloudSearch Domain Monitor
Key Management Service Monitor
Route 53 Health Check Monitor
Route 53 Resolver Monitor
Route 53 Hosted Zone Monitor
Route 53 Hosted Zone Record Set Monitor
Elasticsearch Monitor
NAT Gateway Monitor
Elastic MapReduce Monitor
WorkSpace Monitor
EC2 Auto Scaling Group Monitor
Neptune Cluster Monitor
Neptune Instance Monitor
Certificate Manager Monitor
Lightsail Instance Monitor
EKS Cluster Monitor
EKS Namespace Monitor
EKS Node Monitor
Amazon MQ Broker Monitor
Amazon MQ Topic Monitor
Amazon MQ Queue Monitor
Amazon MQ Network Connector Monitor
Lightsail Database Monitor
Lightsail Load Balancer Monitor
Storage Gateway Monitor
Storage Gateway File Share Monitor
Storage Gateway Volume Monitor
Transit Gateway Monitor
Direct Connect Virtual Interface Monitor
DMS Replication Task Monitor
DMS Replication Instance Monitor
Amazon FSx Monitor
Lambda@Edge Function Monitor
Inspector Monitor
SFTP Monitor
EC2 Cloudwatch Agent Monitor
AppStream 2.0 Monitor
Systems Manager Monitor
AWS Health Monitor
AWS AppSync
VCenter Monitor
VMWare ESX/ESXi Server Monitor
VMWare VM Monitor
Network Devices
SOAP Web Service
BizTalk Server Monitor
Office 365
Microsoft SharePoint Server
Heartbeat Monitor
Cron Monitor
Real User Monitor

Retrieve Threshold Profile

GET /threshold_profiles/{profile_id}

Request Example

$ curl https://www.site24x7.com/api/threshold_profiles/113770000041195208 \
    -H "Accept: application/json; version=2.1" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "success",
    "data": {
        "profile_name": "URL Threshold and Availability Profile",
        "website_content_changes": [
            {
                "severity": 2,
                "comparison_operator": 1,
                "value": 20,
                "strategy": 1,
                "polls_check": 1
            }
        ],
        "subtype": "",
        "profile_type": 1,
        "response_time_threshold": {
            "secondary": [
                {
                    "severity": 2,
                    "comparison_operator": 1,
                    "value": 1000,
                    "strategy": 1,
                    "polls_check": 5
                },
                {
                    "severity": 3,
                    "comparison_operator": 1,
                    "value": 2000,
                    "strategy": 3,
                    "polls_check": 5
                }
            ],
            "primary": [
                {
                    "severity": 2,
                    "comparison_operator": 1,
                    "value": 1000,
                    "strategy": 1,
                    "polls_check": 5
                },
                {
                    "severity": 3,
                    "comparison_operator": 1,
                    "value": 2000,
                    "strategy": 3,
                    "polls_check": 5
                }
            ]
        },
        "profile_id": "113770000041195208",
        "down_location_threshold": 3,
        "type": "URL",
        "website_content_modified": {
            "severity": 2,
            "value": false
        }
    }
}

Retrieve the configuration of a Threshold and Availability Profile.

oauthscope : Site24x7.Admin.Read
Current Version : 2.1
Supported Versions : 2.0

Website
Web Page Speed (Browser)
Web Transaction
Web Transaction (Browser)
REST API
Ping
Port (Custom Protocol)
UDP
DNS Server
POP Server
SMTP Server
FTP Server
SSL Certificate
Mail Delivery
FTP Transfer
Server Monitor
Microsoft IIS Server Monitor
Microsoft SQL Server Monitor
Microsoft Exchange Server
EC2 Instance Monitor
RDS Instance Monitor
SNS Topic Monitor
DynamoDB Table Monitor
Classic Load Balancer
Application Load Balancer
Network Load Balancer
Gateway Load Balancer
Lambda Function Monitor
EC Memcached Cluster Monitor
EC Memcached Node Monitor
EC Redis Node Monitor
S3 Bucket Monitor
S3 Object Monitor
S3 Folder Monitor
SQS Queue Monitor
CloudFront Distribution Monitor
Kinesis Data Stream Monitor
Kinesis Firehose Delivery Stream Monitor
Kinesis Analytics Application Monitor
Kinesis Video Stream Monitor
Elastic Beanstalk Environment Monitor
Direct Connect Monitor
VPC - Virtual Private Network Monitor
API Gateway Stage Monitor
API Gateway Resource Monitor
API Gateway Route Monitor
ECS Cluster Monitor
ECS Cluster Service Monitor
Redshift Cluster Monitor
Redshift Node Monitor
Elastic File System Monitor
Simple Email Service Monitor
Step Function State Machine Monitor
Web Application Firewall Monitor
CloudSearch Domain Monitor
Key Management Service Monitor
Route 53 Health Check Monitor
Route 53 Resolver Monitor
Route 53 Hosted Zone Monitor
Route 53 Hosted Zone Record Set Monitor
Elasticsearch Monitor
NAT Gateway Monitor
Elastic MapReduce Monitor
WorkSpace Monitor
EC2 Auto Scaling Group Monitor
Neptune Cluster Monitor
Neptune Instance Monitor
Certificate Manager Monitor
Lightsail Instance Monitor
EKS Cluster Monitor
EKS Namespace Monitor
EKS Node Monitor
Amazon MQ Broker Monitor
Amazon MQ Topic Monitor
Amazon MQ Queue Monitor
Amazon MQ Network Connector Monitor
Lightsail Database Monitor
Lightsail Load Balancer Monitor
Storage Gateway Monitor
Storage Gateway File Share Monitor
Storage Gateway Volume Monitor
Transit Gateway Monitor
Direct Connect Virtual Interface Monitor
DMS Replication Task Monitor
DMS Replication Instance Monitor
Amazon FSx Monitor
Lambda@Edge Function Monitor
Inspector Monitor
SFTP Monitor
EC2 Cloudwatch Agent Monitor
AppStream 2.0 Monitor
Systems Manager Monitor
AWS Health Monitor
AWS AppSync
VCenter Monitor
VMWare ESX/ESXi Server Monitor
VMWare VM Monitor
Network Devices
SOAP Web Service
BizTalk Server Monitor
Office 365
Microsoft SharePoint Server

Path Parameters

Param	Type	Description
profile_id	string	Mandatory Unique ID generated by the server for a Threshold and Availability Profile.

Update Threshold Profile

PUT /threshold_profiles/{profile_id}

Request Example

$ curl https://www.site24x7.com/api/threshold_profiles \
    -X PUT \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Accept: application/json; version=2.1" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \
    -d '{
        "type": "URL",
        "down_location_threshold": 3,
        "website_content_modified": {
          "severity": 2,
          "value": false
        },
        "profile_name": "URL Threshold and Availability Profile",
        "profile_type": 1,
        "website_content_changes": [
         {
           "severity": 2,
           "value" : 20,
           "comparison_operator": 1
         }
        ],
        "response_time_threshold": {
          "primary": [
            {
              "severity": 2,
              "comparison_operator": 1,
              "strategy": 1,
              "polls_check": 5,
              "value": 2000
            },
            {
              "severity": 3,
              "comparison_operator": 1,
              "strategy": 3,
              "polls_check": 5,
              "value": 3000
           }
          ],
          "secondary": [
            {
              "severity": 2,
              "comparison_operator": 1,
              "strategy": 1,
              "polls_check": 5,
              "value": 2000
            },
            {
              "severity": 3,
              "comparison_operator": 1,
              "strategy": 3,
              "polls_check": 5,
              "value": 3000
           }
          ],
        }
    }'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "success",
    "data": {
        "profile_name": "URL Threshold and Availability Profile",
        "website_content_changes": [
            {
                "severity": 2,
                "comparison_operator": 1,
                "value": 20,
                "strategy": 1,
                "polls_check": 1
            }
        ],
        "subtype": "",
        "profile_type": 1,
        "response_time_threshold": {
            "secondary": [
                {
                    "severity": 2,
                    "comparison_operator": 1,
                    "value": 2000,
                    "strategy": 1,
                    "polls_check": 5
                },
                {
                    "severity": 3,
                    "comparison_operator": 1,
                    "value": 3000,
                    "strategy": 3,
                    "polls_check": 5
                }
            ],
            "primary": [
                {
                    "severity": 2,
                    "comparison_operator": 1,
                    "value": 2000,
                    "strategy": 1,
                    "polls_check": 5
                },
                {
                    "severity": 3,
                    "comparison_operator": 1,
                    "value": 3000,
                    "strategy": 3,
                    "polls_check": 5
                }
            ]
        },
        "profile_id": "113770000041195208",
        "down_location_threshold": 3,
        "type": "URL",
        "website_content_modified": {
            "severity": 2,
            "value": false
        }
    }
}

Update an existing Monitor Group.

oauthscope : Site24x7.Admin.Update
Current Version : 2.1
Supported Versions : 2.0

Website
Web Page Speed (Browser)
Web Transaction
Web Transaction (Browser)
REST API
Ping
Port (Custom Protocol)
UDP
DNS Server
Pop Server
SMTP Server
FTP Server
SSL Certificate
Mail Delivery
FTP Transfer
Server Monitor
Microsoft IIS Server Monitor
Microsoft SQL Server Monitor
Microsoft Exchange Server
EC2 Instance Monitor
RDS Instance Monitor
SNS Topic Monitor
DynamoDB Table Monitor
Classic Load Balancer
Application Load Balancer
Network Load Balancer
Gateway Load Balancer
Lambda Function Monitor
EC Memcached Cluster Monitor
EC Memcached Node Monitor
EC Redis Node Monitor
S3 Bucket Monitor
S3 Object Monitor
S3 Folder Monitor
SQS Queue Monitor
CloudFront Distribution Monitor
Kinesis Data Stream Monitor
Kinesis Firehose Delivery Stream Monitor
Kinesis Analytics Application Monitor
Kinesis Video Stream Monitor
Elastic Beanstalk Environment Monitor
Direct Connect Monitor
VPC - Virtual Private Network Monitor
API Gateway Stage Monitor
API Gateway Resource Monitor
API Gateway Route Monitor
ECS Cluster Monitor
ECS Cluster Service Monitor
Redshift Cluster Monitor
Redshift Node Monitor
Elastic File System Monitor
Simple Email Service Monitor
Step Function State Machine Monitor
Web Application Firewall Monitor
CloudSearch Domain Monitor
Key Management Service Monitor
Route 53 Health Check Monitor
Route 53 Resolver Monitor
Route 53 Hosted Zone Monitor
Route 53 Hosted Zone Record Set Monitor
Elasticsearch Monitor
NAT Gateway Monitor
Elastic MapReduce Monitor
WorkSpace Monitor
EC2 Auto Scaling Group Monitor
Neptune Cluster Monitor
Neptune Instance Monitor
Certificate Manager Monitor
Lightsail Instance Monitor
EKS Cluster Monitor
EKS Namespace Monitor
EKS Node Monitor
Amazon MQ Broker Monitor
Amazon MQ Topic Monitor
Amazon MQ Queue Monitor
Amazon MQ Network Connector Monitor
Lightsail Database Monitor
Lightsail Load Balancer Monitor
Storage Gateway Monitor
Storage Gateway File Share Monitor
Storage Gateway Volume Monitor
Transit Gateway Monitor
Direct Connect Virtual Interface Monitor
DMS Replication Task Monitor
DMS Replication Instance Monitor
Amazon FSx Monitor
Lambda@Edge Function Monitor
Inspector Monitor
SFTP Monitor
EC2 Cloudwatch Agent Monitor
AppStream 2.0 Monitor
Systems Manager Monitor
AWS Health Monitor
AWS AppSync
VCenter Monitor
VMWare ESX/ESXi Server Monitor
VMWare VM Monitor
Network Devices
SOAP Web Service
BizTalk Server Monitor
Office 365
Microsoft SharePoint Server

Path Parameters

Param	Type	Description
profile_id	string	Mandatory Unique ID generated by the server for a Threshold and Availability Profile.

Delete a Threshold Profile

DELETE /threshold_profiles/{profile_id}

Request Example

$ curl https://www.site24x7.com/api/threshold_profiles/113770000041195208 \
    -X DELETE \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \

Response Example

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

Delete an existing Threshold and Availability Profile.

oauthscope : Site24x7.Admin.Delete

Path Parameters

Param	Type	Description
profile_id	string	Mandatory Unique ID generated by the server for a Threshold and Availability Profile.

List Threshold Profiles

GET /threshold_profiles

Request Example

$ curl https://www.site24x7.com/api/threshold_profiles \
    -H "Accept: application/json; version=2.1" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": [{
            "profile_name": "URL Threshold and Availability Profile",
            "website_content_changes": {
                "severity": 2,
                "comparison_operator": 1,
                "value": 20,
                "strategy": 1,
                "polls_check": 1
            },
            "subtype": "",
            "response_time_threshold": {
                "secondary": [
                {
                    "severity": 2,
                    "comparison_operator": 1,
                    "value": 2000,
                    "strategy": 1,
                    "polls_check": 5
                },
                {
                    "severity": 3,
                    "comparison_operator": 1,
                    "value": 3000,
                    "strategy": 3,
                    "polls_check": 5
                }
            ],
            "primary": [
                {
                    "severity": 2,
                    "comparison_operator": 1,
                    "value": 2000,
                    "strategy": 1,
                    "polls_check": 5
                },
                {
                    "severity": 3,
                    "comparison_operator": 1,
                    "value": 3000,
                    "strategy": 3,
                    "polls_check": 5
                }
              ]
            },
            "profile_id": "4000000176014",
            "down_location_threshold": 3,
            "type": "URL",
            "website_content_modified": {
                "severity": 2,
                "value": false
            }
        },
  {..},
  {..}
  ]
}

List of all Threshold and Availability Profiles.

oauthscope : Site24x7.Admin.Read
Current Version : 2.1
Supported Versions : 2.0

Website
Web Page Speed (Browser)
Web Transaction
Web Transaction (Browser)
REST API
Ping
Port (Custom Protocol)
UDP
DNS Server
POP Server
SMTP Server
FTP Server
Mail Delivery
FTP Transfer
SSL Certificate
Server Monitor
Microsoft IIS Server Monitor
Microsoft SQL Server Monitor
Microsoft Exchange Server
EC2 Instance Monitor
RDS Instance Monitor
SNS Topic Monitor
DynamoDB Table Monitor
Classic Load Balancer
Application Load Balancer
Network Load Balancer
Gateway Load Balancer
Lambda Function Monitor
EC Memcached Cluster Monitor
EC Memcached Node Monitor
EC Redis Node Monitor
S3 Bucket Monitor
S3 Object Monitor
S3 Folder Monitor
SQS Queue Monitor
CloudFront Distribution Monitor
Kinesis Data Stream Monitor
Kinesis Firehose Delivery Stream Monitor
Kinesis Analytics Application Monitor
Kinesis Video Stream Monitor
Elastic Beanstalk Environment Monitor
Direct Connect Monitor
VPC - Virtual Private Network Monitor
API Gateway Stage Monitor
API Gateway Resource Monitor
API Gateway Route Monitor
ECS Cluster Monitor
ECS Cluster Service Monitor
Redshift Cluster Monitor
Redshift Node Monitor
Elastic File System Monitor
Simple Email Service Monitor
Step Function State Machine Monitor
Web Application Firewall Monitor
CloudSearch Domain Monitor
Key Management Service Monitor
Route 53 Health Check Monitor
Route 53 Resolver Monitor
Route 53 Hosted Zone Monitor
Route 53 Hosted Zone Record Set Monitor
Elasticsearch Monitor
NAT Gateway Monitor
Elastic MapReduce Monitor
WorkSpace Monitor
EC2 Auto Scaling Group Monitor
Neptune Cluster Monitor
Neptune Instance Monitor
Certificate Manager Monitor
Lightsail Instance Monitor
EKS Cluster Monitor
EKS Namespace Monitor
EKS Node Monitor
Amazon MQ Broker Monitor
Amazon MQ Topic Monitor
Amazon MQ Queue Monitor
Amazon MQ Network Connector Monitor
Lightsail Database Monitor
Lightsail Load Balancer Monitor
Storage Gateway Monitor
Storage Gateway File Share Monitor
Storage Gateway Volume Monitor
Transit Gateway Monitor
Direct Connect Virtual Interface Monitor
DMS Replication Task Monitor
DMS Replication Instance Monitor
Amazon FSx Monitor
Lambda@Edge Function Monitor
Inspector Monitor
SFTP Monitor
EC2 Cloudwatch Agent Monitor
AppStream 2.0 Monitor
Systems Manager Monitor
AWS Health Monitor
AWS AppSync
VCenter Monitor
VMWare ESX/ESXi Server Monitor
VMWare VM Monitor
Network Devices
SOAP Web Service
BizTalk Server Monitor
Office 365
Microsoft SharePoint Server

Notification Profiles

Notification Profiles help you tweak when alerts have to be sent out.

Create Notification Profile

POST /notification_profiles

Request Example

$ curl https://www.site24x7.com/api/notification_profiles \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \
    -d '{
        "template_id": "113770000039021005",
        "downtime_notification_delay": 3,
        "persistent_notification": 1,
        "rca_needed": true,
        "suppress_automation": true,
        "notify_after_executing_actions": true,
        "profile_name": "Notification Profile",
        "escalation_user_group_id": "113770000000025019",
        "escalation_wait_time": 60,
        "escalation_automations":["113770000000025041", "113770000000025043"],
        "escalation_services":["113770000000025027", "113770000000025029"]
    }'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": {
    "profile_id": "113770000041409003",
    "profile_name": "Notification Profile",
    "rca_needed": true,
    "suppress_automation": true,
    "downtime_notification_delay": 3,
    "persistent_notification": 1,
    "escalation_user_group_id": "113770000000025019",
    "escalation_wait_time": 60,
    "template_id": "113770000039021005",
    "notify_after_executing_actions": true,
    "escalation_automations":["113770000000025041", "113770000000025043"],
    "escalation_services":["113770000000025027", "113770000000025029"]
  }
}

Create a new Notification Profile.

oauthscope : Site24x7.Admin.Create

Request Parameters

Param	Type	Description
profile_name	string	Mandatory Display name for the notification profile.
rca_needed	boolean	Mandatory Settings to send root cause analysis when monitor goes down.
notify_after_executing_actions	boolean	Mandatory Settings to downtime only after executing configured monitor actions.
downtime_notification_delay	array	Configuration for delayed notification
persistent_notification	int	Settings to receive persistent notification after number of errors.
escalation_user_group_id	string	User group for downtime escalation.
escalation_wait_time	int	Mandatory, if any user group is added for escalation Downtime duration for escalation in mins
escalation_automations	array	Execute configured IT automations during an escalation.
escalation_services	array	Invoke and manage escalations in your preferred third party services.
template_id	string	Email template for notification
suppress_automation	boolean	Settings to stop an automation being executed on the dependent monitors.

Response Attributes

Attribute	Type	Description
profile_id	string	Unique ID generated by the server for the notification profile.
profile_name	string	Display name for the notification profile.
rca_needed	boolean	Settings to send root cause analysis when monitor goes down.
notify_after_executing_actions	boolean	Settings to downtime only after executing configured monitor actions.
downtime_notification_delay	array	Configuration for delayed notification
persistent_notification	int	Settings to receive persistent notification after number of errors.
escalation_user_group_id	string	User group for downtime escalation.
escalation_wait_time	int	Mandatory, if any user group is added for escalation Downtime duration for escalation in mins
escalation_automations	array	Execute configured IT automations during an escalation.
escalation_services	array	Invoke and manage escalations in your preferred third party services.
template_id	string	Email template for notification
suppress_automation	boolean	Settings to stop an automation being executed on the dependent monitors.

Retrieve Notification Profile

GET /notification_profiles/{profile_id}

Request Example

$ curl https://www.site24x7.com/api/notification_profiles/113770000041409003 \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": {
    "profile_id": "113770000041409003",
    "profile_name": "Notification Profile",
    "rca_needed": true,
    "suppress_automation": true,
    "downtime_notification_delay": 3,
    "persistent_notification": 1,
    "escalation_user_group_id": "113770000000025019",
    "escalation_wait_time": 60,
    "template_id": "113770000039021005",
    "notify_after_executing_actions": true,
    "escalation_automations":["113770000000025041", "113770000000025043"],
    "escalation_services":["113770000000025027", "113770000000025029"]
  }
}

Retrieve configuration of a notification profile.

oauthscope : Site24x7.Admin.Read

Path Parameters

Param	Type	Description
profile_id	string	Mandatory Unique ID generated by the server for the notification profile.

Response Attributes

Attribute	Type	Description
profile_id	string	Unique ID generated by the server for the notification profile.
profile_name	string	Display name for the notification profile.
rca_needed	boolean	Settings to send root cause analysis when monitor goes down.
notify_after_executing_actions	boolean	Settings to downtime only after executing configured monitor actions.
downtime_notification_delay	array	Configuration for delayed notification
persistent_notification	int	Settings to receive persistent notification after number of errors.
escalation_user_group_id	string	User group for downtime escalation.
escalation_wait_time	int	Mandatory, if any user group is added for escalation Downtime duration for escalation in mins
escalation_automations	array	Execute configured IT automations during an escalation.
escalation_services	array	Invoke and manage escalations in your preferred third party services.
template_id	string	Email template for notification
suppress_automation	boolean	Settings to stop an automation being executed on the dependent monitors.

Update Notification Profile

PUT /notification_profiles/{profile_id}

Request Example

$ curl https://www.site24x7.com/api/notification_profiles \
    -X PUT \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \
    -d '{
        "template_id": "113770000039021005",
        "downtime_notification_delay": 3,
        "persistent_notification": 1,
        "rca_needed": true,
        "suppress_automation": true,
        "notify_after_executing_actions": true,
        "profile_name": "Notification Profile",
        "escalation_user_group_id": "113770000000025019",
        "escalation_wait_time": 60,
        "escalation_automations":["113770000000025041", "113770000000025043"],
        "escalation_services":["113770000000025027", "113770000000025029"]
    }'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": {
    "profile_id": "113770000041409003",
    "profile_name": "Notification Profile",
    "rca_needed": true,
    "suppress_automation": true,
    "downtime_notification_delay": 3,
    "persistent_notification": 1,
    "escalation_user_group_id": "113770000000025019",
    "escalation_wait_time": 60,
    "template_id": "113770000039021005",
    "notify_after_executing_actions": true,
    "escalation_automations":["113770000000025041", "113770000000025043"],
    "escalation_services":["113770000000025027", "113770000000025029"]
  }
}

oauthscope : Site24x7.Admin.Update

Path Parameters

Param	Type	Description
profile_id	string	Mandatory Unique ID generated by the server for the notification profile.

Request Parameters

Param	Type	Description
profile_name	string	Mandatory Display name for the notification profile.
rca_needed	boolean	Mandatory Settings to send root cause analysis when monitor goes down.
notify_after_executing_actions	boolean	Mandatory Settings to downtime only after executing configured monitor actions.
downtime_notification_delay	array	Configuration for delayed notification
persistent_notification	int	Settings to receive persistent notification after number of errors.
escalation_user_group_id	string	User group for downtime escalation.
escalation_wait_time	int	Mandatory, if any user group is added for escalation Downtime duration for escalation in mins
escalation_automations	array	Execute configured IT automations during an escalation.
escalation_services	array	Invoke and manage escalations in your preferred third party services.
template_id	string	Email template for notification
suppress_automation	boolean	Settings to stop an automation being executed on the dependent monitors.

Response Attributes

Attribute	Type	Description
profile_id	string	Unique ID generated by the server for the notification profile.
profile_name	string	Display name for the notification profile.
rca_needed	boolean	Settings to send root cause analysis when monitor goes down.
notify_after_executing_actions	boolean	Settings to downtime only after executing configured monitor actions.
downtime_notification_delay	array	Configuration for delayed notification
persistent_notification	int	Settings to receive persistent notification after number of errors.
escalation_user_group_id	string	User group for downtime escalation.
escalation_wait_time	int	Mandatory, if any user group is added for escalation Downtime duration for escalation in mins
escalation_automations	array	Execute configured IT automations during an escalation.
escalation_services	array	Invoke and manage escalations in your preferred third party services.
template_id	string	Email template for notification
suppress_automation	boolean	Settings to stop an automation being executed on the dependent monitors.

Delete Notification Profile

DELETE /notification_profiles/{profile_id}

Request Example

$ curl https://www.site24x7.com/api/notification_profiles/113770000041409003 \
    -X DELETE \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

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

Delete an existing Notification Profile.

oauthscope : Site24x7.Admin.Delete

Path Parameters

Param	Type	Description
profile_id	string	Mandatory Unique ID generated by the server for the notification profile.

List Notification Profiles

GET /notification_profiles

Request Example

$ curl https://www.site24x7.com/api/notification_profiles \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": [
    {
        "profile_id": "113770000041409003",
        "profile_name": "Notification Profile",
        "rca_needed": true,
        "suppress_automation": true,
        "downtime_notification_delay": 3,
        "persistent_notification": 1,
        "escalation_user_group_id": "113770000000025019",
        "escalation_wait_time": 60,
        "template_id": "113770000039021005",
        "notify_after_executing_actions": true,
        "escalation_automations":["113770000000025041", "113770000000025043"],
        "escalation_services":["113770000000025027", "113770000000025029"]
    }
    ]
}

List of all Notification Profiles.

oauthscope : Site24x7.Admin.Read

Response Attributes

Attribute	Type	Description
profile_id	string	Unique ID generated by the server for the notification profile.
profile_name	string	Display name for the notification profile.
rca_needed	boolean	Settings to send root cause analysis when monitor goes down.
notify_after_executing_actions	boolean	Settings to downtime only after executing configured monitor actions.
downtime_notification_delay	array	Configuration for delayed notification
persistent_notification	int	Settings to receive persistent notification after number of errors.
escalation_user_group_id	string	User group for downtime escalation.
escalation_wait_time	int	Mandatory, if any user group is added for escalation Downtime duration for escalation in mins
escalation_automations	array	Execute configured IT automations during an escalation.
escalation_services	array	Invoke and manage escalations in your preferred third party services.
template_id	string	Email template for notification
suppress_automation	boolean	Settings to stop an automation being executed on the dependent monitors.

Enhanced Notification Profiles

Notification Profiles help you set configurations related to alerts to be sent out. You can now configure multiple notification delays, persistent, and escalation alert settings.

Create Notification Profile

POST /notification_profiles

Request Example

$ curl https://www.site24x7.com/api/notification_profiles \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \
    -d '{
        "profile_name": "Notification Profile",
        "rca_needed": true,
        "notify_after_executing_actions": true,
        "suppress_automation": true,
        "template_id":"1137700012039021005"
        "alert_configuration":[
          {
            "notification_medium":[1,3,4],
            "business_hours_id" : "113770000039121005",
            "outside_business_hours":true,
            "status" : 1
          },
          {}....
        ],
        "notification_delay_configuration":[
          {
            "status" :1,
            "business_hours_id":"113770000039121005",
            "notification_delay": 3,
            "outside_business_hours":true
          },
          {
            "status" :2,
            "business_hours_id":"113770000039121005",
            "notification_delay": 3,
            "outside_business_hours":false
          },
          {}...

        ],
        "persistent_alert_configuration" : [
          {
            "notify_every": 1,
            "notification_medium":[1,3,4],
            "third_party_services" : ["113770000039121065", "113770000039121075"]
          }
          {}...
        ],
        "escalation_configuration" : {
          "escalation_levels":[{
            "escalation_wait_time" : 2,
            "user_group_id":"113770000039121005",
            "notification_medium":[1,3,4],
            "third_party_services" : ["113770000039121065", "113770000039121075"]
          },
          {}...
          ]
          "escalation_automations":["113770000039121305", "113770000039121405"],
        }
    }'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": {
    "profile_id": "113770000041409003",
    "profile_name": "Notification Profile",
    "rca_needed": true,
    "notify_after_executing_actions": true,
    "suppress_automation": true,
    "template_id":"1137700012039021005"
    "alert_configuration":[
      {
      "notification_medium":[1,3,4],
      "business_hours_id" : "113770000039021005",
      "outside_business_hours":true,
      "status" : 1
      },
          {}....
        ],
        "notification_delay_configuration":[
          {
            "status" :1,
            "business_hours_id":"113770000039021005",
            "notification_delay": 3,
            "outside_business_hours":true
          },
          {
            "status" :2,
            "business_hours_id":"113770000039021005",
            "notification_delay": 3,
            "outside_business_hours":false
          },
          {}...

        ],
        "persistent_alert_configuration" : [
          {
            "notify_every": 1,
            "notification_medium":[1,3,4],
            "third_party_services" : ["113770000039021065", "113770000039021075"]
          }
          {}...
        ],
        "escalation_configuration" : {
          "escalation_levels":[{
            "escalation_wait_time" : 2,
            "user_group_id":"113770000039021005",
            "notification_medium":[1,3,4],
            "third_party_services" : ["113770000039021065", "113770000039021075"]
          },
          {}...
          ]
          "escalation_automations":["113770000039121305", "113770000039121405"],
        }
  }
}

Create a new Notification Profile.

oauthscope : Site24x7.Admin.Create

Request Parameters

Param	Type	Description
profile_name	string	Mandatory Display Name for the notification profile.
rca_needed	boolean	Mandatory Configuration to send root cause analysis when the monitor is down.
notify_after_executing_actions	boolean	Mandatory Configuration to raise alerts for downtime only after executing the pre-configured monitor actions.
suppress_automation	boolean	Configuration to stop automation from being executed on the dependent monitors.
alert_configuration	JSON Array	Configuration to alert the user JSON Format: {notification_medium: “$notification_medium", business_hours_id: “$business_hours_id",status : “$status”,“outside_business_hours”:“$outside_business_hours”}
notification_medium	array	Medium through which you’d wish to receive the notifications. Default value is 1.
business_hours_id	array	Predefined business hours during which alerts should be sent.
status	int	Status for which alerts should be raised.
outside_business_hours	boolean	To specify is the user would receive alerts within or beyond business hours. Default value is false.
notification_delay_configuration	JSON Array	Configuration for delayed notification JSON Format: {business_hours_id: “$business_hours_id",notification_delay : “$notification_delay”,“outside_business_hours”:“$outside_business_hours”}
notification_delay	int	To notify after specified failure Default value is 1.
persistent_alert_configuration	JSON Array	Configuration to receive persistent notifications after a specific number of errors.{notify_every : “$notify_every”,notification_medium : “$notification_medium”,thirdparty_services:“$thirdparty_services”}
notify_every	int	Receive persistent alert notifications.
thirdparty_services	array	Invoke and manage escalations through third-party services of your choice.
escalation_configuration	JSON Object	Configure escalation alert settings.
escalation_levels	JSON Array	Configure multiple levels of escalations. JSON Format: {user_group_id:“$user_group_id”,notification_medium : “$notification_medium”,thirdparty_services:“$thirdparty_services”}
user_group_id	string	User group for downtime escalation.
escalation_wait_time	int	Mandatory, if any User Alert Group is added for escalation Downtime duration for escalation in mins
escalation_automations	array	Execute configured IT automations during an escalation.

Response Attributes

Attribute	Type	Description
profile_id	string	Unique ID generated by the server for the notification profile.
profile_name	string	Display Name for the notification profile.
rca_needed	boolean	Configuration to send root cause analysis when the monitor is down.
notify_after_executing_actions	boolean	Configuration to raise alerts for downtime only after executing the pre-configured monitor actions.
suppress_automation	boolean	Configuration to stop automation from being executed on the dependent monitors.
alert_configuration	JSON Array	Configuration to alert the user JSON Format: {notification_medium: “$notification_medium", business_hours_id: “$business_hours_id",status : “$status”,“outside_business_hours”:“$outside_business_hours”}
notification_medium	array	Medium through which you’d wish to receive the notifications. Default value is 1.
business_hours_id	array	Predefined business hours during which alerts should be sent.
status	int	Status for which alerts should be raised.
outside_business_hours	boolean	To specify is the user would receive alerts within or beyond business hours. Default value is false.
notification_delay_configuration	JSON Array	Configuration for delayed notification JSON Format: {business_hours_id: “$business_hours_id",notification_delay : “$notification_delay”,“outside_business_hours”:“$outside_business_hours”}
notification_delay	int	To notify after specified failure Default value is 1.
persistent_alert_configuration	JSON Array	Configuration to receive persistent notifications after a specific number of errors.{notify_every : “$notify_every”,notification_medium : “$notification_medium”,thirdparty_services:“$thirdparty_services”}
notify_every	int	Receive persistent alert notifications.
thirdparty_services	array	Invoke and manage escalations through third-party services of your choice.
escalation_configuration	JSON Object	Configure escalation alert settings.
escalation_levels	JSON Array	Configure multiple levels of escalations. JSON Format: {user_group_id:“$user_group_id”,notification_medium : “$notification_medium”,thirdparty_services:“$thirdparty_services”}
user_group_id	string	User group for downtime escalation.
escalation_wait_time	int	Downtime duration for escalation in mins
escalation_automations	array	Execute configured IT automations during an escalation.

Retrieve Notification Profile

GET /notification_profiles/{profile_id}

Request Example

$ curl https://www.site24x7.com/api/notification_profiles/113770000041409003 \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": {
    "profile_id": "113770000041409003",
    "profile_name": "Notification Profile",
    "rca_needed": true,
    "notify_after_executing_actions": true,
    "suppress_automation": true,
    "template_id":"1137700012039021005"
    "alert_configuration":[
      {
      "notification_medium":[1,3,4],
      "business_hours_id" : "113770000039021005",
      "outside_business_hours":true,
      "status" : 1
      },
          {}....
        ],
        "notification_delay_configuration":[
          {
            "status" :1,
            "business_hours_id":"113770000039021005",
            "notification_delay": 3,
            "outside_business_hours":true
          },
          {
            "status" :2,
            "business_hours_id":"113770000039021005",
            "notification_delay": 3,
            "outside_business_hours":false
          },
          {}...

        ],
        "persistent_alert_configuration" : [
          {
            "notify_every": 1,
            "notification_medium":[1,3,4],
            "third_party_services" : ["113770000039021065", "113770000039021075"]
          }
          {}...
        ],
        "escalation_configuration" : {
          "escalation_levels":[{
            "escalation_wait_time" : 2,
            "user_group_id":"113770000039021005",
            "notification_medium":[1,3,4],
            "third_party_services" : ["113770000039021065", "113770000039021075"]
          },
          {}...
          ]
          "escalation_automations":["113770000039121305", "113770000039121405"],
        }
  }
}

Retrieve configuration of a notification profile.

oauthscope : Site24x7.Admin.Read

Path Parameters

Param	Type	Description
profile_id	string	Mandatory Unique ID generated by the server for the notification profile.

Response Attributes

Attribute	Type	Description
profile_id	string	Unique ID generated by the server for the notification profile.
profile_name	string	Display Name for the notification profile.
rca_needed	boolean	Configuration to send root cause analysis when the monitor is down.
notify_after_executing_actions	boolean	Configuration to raise alerts for downtime only after executing the pre-configured monitor actions.
suppress_automation	boolean	Configuration to stop automation from being executed on the dependent monitors.
alert_configuration	JSON Array	Configuration to alert the user JSON Format: {notification_medium: “$notification_medium", business_hours_id: “$business_hours_id",status : “$status”,“outside_business_hours”:“$outside_business_hours”}
notification_medium	array	Medium through which you’d wish to receive the notifications. Default value is 1.
business_hours_id	array	Predefined business hours during which alerts should be sent.
status	int	Status for which alerts should be raised.
outside_business_hours	boolean	To specify is the user would receive alerts within or beyond business hours. Default value is false.
notification_delay_configuration	JSON Array	Configuration for delayed notification JSON Format: {business_hours_id: “$business_hours_id",notification_delay : “$notification_delay”,“outside_business_hours”:“$outside_business_hours”}
notification_delay	int	To notify after specified failure Default value is 1.
persistent_alert_configuration	JSON Array	Configuration to receive persistent notifications after a specific number of errors.{notify_every : “$notify_every”,notification_medium : “$notification_medium”,thirdparty_services:“$thirdparty_services”}
notify_every	int	Receive persistent alert notifications.
thirdparty_services	array	Invoke and manage escalations through third-party services of your choice.
escalation_configuration	JSON Object	Configure escalation alert settings.
escalation_levels	JSON Array	Configure multiple levels of escalations. JSON Format: {user_group_id:“$user_group_id”,notification_medium : “$notification_medium”,thirdparty_services:“$thirdparty_services”}
user_group_id	string	User group for downtime escalation.
escalation_wait_time	int	Downtime duration for escalation in mins.
escalation_automations	array	Execute configured IT automations during an escalation.

Update Notification Profile

PUT /notification_profiles/{profile_id}

Request Example

$ curl https://www.site24x7.com/api/notification_profiles \
    -X PUT \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \
    -d '{
        "profile_name": "Notification Profile_TestUpdate",
        "rca_needed": true,
        "notify_after_executing_actions": true,
        "suppress_automation": true,
        "template_id":"1137700012039021005"
        "alert_configuration":[
          {
            "notification_medium":[1,3,4],
            "business_hours_id" : "113770000039121005",
            "outside_business_hours":true,
            "status" : 1
          },
          {}....
        ],
        "notification_delay_configuration":[
          {
            "status" :1,
            "business_hours_id":"113770000039121005",
            "notification_delay": 3,
            "outside_business_hours":true
          },
          {
            "status" :2,
            "business_hours_id":"113770000039121005",
            "notification_delay": 3,
            "outside_business_hours":false
          },
          {}...

        ],
        "persistent_alert_configuration" : [
          {
            "notify_every": 1,
            "notification_medium":[1,3,4],
            "third_party_services" : ["113770000039121065", "113770000039121075"]
          }
          {}...
        ],
        "escalation_configuration" : {
          "escalation_levels":[{
            "escalation_wait_time" : 2,
            "user_group_id":"113770000039121005",
            "notification_medium":[1,3,4],
            "third_party_services" : ["113770000039121065", "113770000039121075"]
          },
          {}...
          ]
          "escalation_automations":["113770000039121305", "113770000039121405"],
        }
    }'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": {
    "profile_id": "113770000041409003",
    "profile_name": "Notification Profile_TestUpdate",
    "rca_needed": true,
    "notify_after_executing_actions": true,
    "suppress_automation": true,
    "template_id":"1137700012039021005"
    "alert_configuration":[
      {
      "notification_medium":[1,3,4],
      "business_hours_id" : "113770000039021005",
      "outside_business_hours":true,
      "status" : 1
      },
          {}....
        ],
        "notification_delay_configuration":[
          {
            "status" :1,
            "business_hours_id":"113770000039021005",
            "notification_delay": 3,
            "outside_business_hours":true
          },
          {
            "status" :2,
            "business_hours_id":"113770000039021005",
            "notification_delay": 3,
            "outside_business_hours":false
          },
          {}...

        ],
        "persistent_alert_configuration" : [
          {
            "notify_every": 1,
            "notification_medium":[1,3,4],
            "third_party_services" : ["113770000039021065", "113770000039021075"]
          }
          {}...
        ],
        "escalation_configuration" : {
          "escalation_levels":[{
            "escalation_wait_time" : 2,
            "user_group_id":"113770000039021005",
            "notification_medium":[1,3,4],
            "third_party_services" : ["113770000039021065", "113770000039021075"]
          },
          {}...
          ]
          "escalation_automations":["113770000039121305", "113770000039121405"],
        }
  }
}

oauthscope : Site24x7.Admin.Update

Path Parameters

Param	Type	Description
profile_id	string	Mandatory Unique ID generated by the server for the notification profile.

Request Parameters

Param	Type	Description
profile_name	string	Mandatory Display Name for the notification profile.
rca_needed	boolean	Mandatory Configuration to send root cause analysis when the monitor is down.
notify_after_executing_actions	boolean	Mandatory Configuration to raise alerts for downtime only after executing the pre-configured monitor actions.
suppress_automation	boolean	Configuration to stop automation from being executed on the dependent monitors.
alert_configuration	JSON Array	Configuration to alert the user JSON Format: {notification_medium: “$notification_medium", business_hours_id: “$business_hours_id",status : “$status”,“outside_business_hours”:“$outside_business_hours”}
notification_medium	array	Medium through which you’d wish to receive the notifications. Default value is 1.
business_hours_id	array	Predefined business hours during which alerts should be sent.
status	int	Status for which alerts should be raised.
outside_business_hours	boolean	To specify is the user would receive alerts within or beyond business hours. Default value is false.
notification_delay_configuration	JSON Array	Configuration for delayed notification JSON Format: {business_hours_id: “$business_hours_id",notification_delay : “$notification_delay”,“outside_business_hours”:“$outside_business_hours”}
notification_delay	int	To notify after specified failure Default value is 1.
persistent_alert_configuration	JSON Array	Configuration to receive persistent notifications after a specific number of errors.{notify_every : “$notify_every”,notification_medium : “$notification_medium”,thirdparty_services:“$thirdparty_services”}
notify_every	int	Receive persistent alert notifications.
thirdparty_services	array	Invoke and manage escalations through third-party services of your choice.
escalation_configuration	JSON Object	Configure escalation alert settings.
escalation_levels	JSON Array	Configure multiple levels of escalations. JSON Format: {user_group_id:“$user_group_id”,notification_medium : “$notification_medium”,thirdparty_services:“$thirdparty_services”}
user_group_id	string	User group for downtime escalation.
escalation_wait_time	int	Mandatory, if any User Alert Group is added for escalation Downtime duration for escalation in mins
escalation_automations	array	Execute configured IT automations during an escalation.

Response Attributes

Attribute	Type	Description
profile_id	string	Unique ID generated by the server for the notification profile.
profile_name	string	Display Name for the notification profile.
rca_needed	boolean	Configuration to send root cause analysis when the monitor is down.
notify_after_executing_actions	boolean	Configuration to raise alerts for downtime only after executing the pre-configured monitor actions.
suppress_automation	boolean	Configuration to stop automation from being executed on the dependent monitors.
alert_configuration	JSON Array	Configuration to alert the user JSON Format: {notification_medium: “$notification_medium", business_hours_id: “$business_hours_id",status : “$status”,“outside_business_hours”:“$outside_business_hours”}
notification_medium	array	Medium through which you’d wish to receive the notifications. Default value is 1.
business_hours_id	array	Predefined business hours during which alerts should be sent.
status	int	Status for which alerts should be raised.
outside_business_hours	boolean	To specify is the user would receive alerts within or beyond business hours. Default value is false.
notification_delay_configuration	JSON Array	Configuration for delayed notification JSON Format: {business_hours_id: “$business_hours_id",notification_delay : “$notification_delay”,“outside_business_hours”:“$outside_business_hours”}
notification_delay	int	To notify after specified failure Default value is 1
persistent_alert_configuration	JSON Array	Configuration to receive persistent notifications after a specific number of errors.{notify_every : “$notify_every”,notification_medium : “$notification_medium”,thirdparty_services:“$thirdparty_services”}
notify_every	int	Receive persistent alert notifications.
thirdparty_services	array	Invoke and manage escalations through third-party services of your choice.
escalation_configuration	JSON Object	Configure escalation alert settings.
escalation_levels	JSON Array	Configure multiple levels of escalations. JSON Format: {user_group_id:“$user_group_id”,notification_medium : “$notification_medium”,thirdparty_services:“$thirdparty_services”}
user_group_id	string	User group for downtime escalation.
escalation_wait_time	int	Downtime duration for escalation in mins
escalation_automations	array	Execute configured IT automations during an escalation.

Delete Notification Profile

DELETE /notification_profiles/{profile_id}

Request Example

$ curl https://www.site24x7.com/api/notification_profiles/113770000041409003 \
    -X DELETE \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

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

Delete an existing Notification Profile.

oauthscope : Site24x7.Admin.Delete

Path Parameters

Param	Type	Description
profile_id	string	Mandatory Unique ID generated by the server for the notification profile.

List Notification Profiles

GET /notification_profiles

Request Example

$ curl https://www.site24x7.com/api/notification_profiles \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": [
    {
    "profile_id": "113770000041409003",
    "profile_name": "Notification Profile",
    "rca_needed": true,
    "notify_after_executing_actions": true,
    "suppress_automation": true,
    "template_id":"1137700012039021005"
    "alert_configuration":[
      {
      "notification_medium":[1,3,4],
      "business_hours_id" : "113770000039021005",
      "outside_business_hours":true,
      "status" : 1
      },
          {}....
        ],
        "notification_delay_configuration":[
          {
            "status" :1,
            "business_hours_id":"113770000039021005",
            "notification_delay": 3,
            "outside_business_hours":true
          },
          {
            "status" :2,
            "business_hours_id":"113770000039021005",
            "notification_delay": 3,
            "outside_business_hours":false
          },
          {}...

        ],
        "persistent_alert_configuration" : [
          {
            "notify_every": 1,
            "notification_medium":[1,3,4],
            "third_party_services" : ["113770000039021065", "113770000039021075"]
          }
          {}...
        ],
        "escalation_configuration" : {
          "escalation_levels":[{
            "escalation_wait_time" : 2,
            "user_group_id":"113770000039021005",
            "notification_medium":[1,3,4],
            "third_party_services" : ["113770000039021065", "113770000039021075"]
          },
          {}...
          ]
          "escalation_automations":["113770000039121305", "113770000039121405"],
        }
  },
  {}
  ]
}

List of all Notification Profiles.

oauthscope : Site24x7.Admin.Read

Response Attributes

Attribute	Type	Description
profile_id	string	Unique ID generated by the server for the notification profile.
profile_name	string	Display Name for the notification profile.
rca_needed	boolean	Configuration to send root cause analysis when the monitor is down.
notify_after_executing_actions	boolean	Configuration to raise alerts for downtime only after executing the pre-configured monitor actions.
suppress_automation	boolean	Configuration to stop automation from being executed on the dependent monitors.
alert_configuration	JSON Array	Configuration to alert the user JSON Format: {notification_medium: “$notification_medium", business_hours_id: “$business_hours_id",status : “$status”,“outside_business_hours”:“$outside_business_hours”}
notification_medium	array	Medium through which you’d wish to receive the notifications. Default value is 1.
business_hours_id	array	Predefined business hours during which alerts should be sent.
status	int	Status for which alerts should be raised.
outside_business_hours	boolean	To specify is the user would receive alerts within or beyond business hours. Default value is false.
notification_delay_configuration	JSON Array	Configuration for delayed notification JSON Format: {business_hours_id: “$business_hours_id",notification_delay : “$notification_delay”,“outside_business_hours”:“$outside_business_hours”}
notification_delay	int	To notify after specified failure Default value is 1.
persistent_alert_configuration	JSON Array	Configuration to receive persistent notifications after a specific number of errors.{notify_every : “$notify_every”,notification_medium : “$notification_medium”,thirdparty_services:“$thirdparty_services”}
notify_every	int	Receive persistent alert notifications.
thirdparty_services	array	Invoke and manage escalations through third-party services of your choice.
escalation_configuration	JSON Object	Configure escalation alert settings.
escalation_levels	JSON Array	Configure multiple levels of escalations. JSON Format: {user_group_id:“$user_group_id”,notification_medium : “$notification_medium”,thirdparty_services:“$thirdparty_services”}
user_group_id	string	User group for downtime escalation.
escalation_wait_time	int	Downtime duration for escalation in mins
escalation_automations	array	Execute configured IT automations during an escalation.

Resource Checks Profiles

Site24x7 Server Monitoring includes monitoring of internal resources like files, event logs, syslogs, and directories on a server by creating them as Resource Checks. To start monitoring these resources, first create a resource check profile by grouping different resource checks together.

Note: While generating a new API call, ensure to append the old one when making a new request.

Create Resource Check Profiles

POST /resource_profile

Request Example

$ curl https://www.site24x7.com/api/resource_profile \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Accept: application/json; version=2.1" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \
    -d '{
        "checks":[
                {
                "resource": "http://$$HOSTNAME$$:8080",
                "checkname": "urlcheck",
                "checktype": 1000
                },
                {
                "checkname": "port check",
                "resource": 8443,
                "checktype": 4000
                },
                {
                "parentdir": "/home/local/folder/",
                "file": "file.txt",
                "checkname": "File access check",
                "resource": "/home/local/folder/file.txt",
                "checktype": 2001
                },
                {
                "parentdir": "/home/local/folder/",
                "file": "file.txt",
                "checkname": "Permission check",
                "resource": "/home/local/folder/file.txt",
                "checktype": 2002
                },
                {
                "parentdir": "/home/local/folder/",
                "file": "file.txt",
                "checkname": "size check",
                "threshold": 10,
                "sizeunit": "k",
                "resource": "/home/local/folder/file.txt",
                "checktype": 2003
                },
                {
                "parentdir": "/home/local/folder/",
                "file": "file.txt",
                "modify": "m",
                "checkname": "Last Modified check",
                "resource": "/home/local/folder/file.txt",
                "checktype": 2004
                },
                {
                "parentdir": "/home/local/folder/",
                "file": "file.txt",
                "checkname": "content check",
                "resource": "/home/local/folder/file.txt",
                "strings": "[{\"casesensitive\":true,\"searchstr\":\"\\\"Exception\\\"\",\"max\":4}]",
                "checktype": 2005
                },
                {
                "resource": "/home/local/folder/",
                "checkname": "Directory size check",
                "threshold": 100,
                "sizeunit": "m",
                "checktype": 3003
                },
                {
                "watchevent": "A",
                "resource": "/home/local/folder/",
                "selector": "a",
                "checkname": "Subdirectory Added",
                "checktype": 3005
                },
                {
                "watchevent": "D",
                "resource": "/home/local/folder/",
                "selector": "a",
                "checkname": "Subdirectory Deleted",
                "checktype": 3005
                },
                {
                "watchevent": "A",
                "resource": "/home/local/folder/",
                "selector": "a",
                "checkname": "File Added",
                "checktype": 3004
                },
                {
                "watchevent": "D",
                "resource": "/home/local/folder/",
                "selector": "a",
                "checkname": "File Deleted",
                "checktype": 3004
                },
                {
                "resource": "/home/local/folder/",
                "checkname": "Permissions check",
                "checktype": 3002
                },      
        ],
        "profile_name": "test test",
        "monitor_list": [
            "1000000008005"
        ]
    }'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "success",
    "data": '{
        "profile_name": "test test",
        "profileid": "1000000018010",
        "checks": [
            {
                "checkid": "1000000018017",
                "checkname": "urlcheck",
                "checktype": 1000,
                "configjson": "dwp24jbrl3gspWFcso4pjR7krzJAjLm2mA=="
            },
            {
                "checkid": "1000000018019",
                "checkname": "port check",
                "checktype": 4000,
                "configjson": "WCOQRNTqOeLQjfVJ9cG7NhU"
            },
            {
                "checkid": "1000000018021",
                "checkname": "File access check",
                "checktype": 2001,
                "configjson": "aPdnscWTzBpTifCV0IpeDkR1pcLEH6g=="
            },
            {
                "checkid": "1000000018023",
                "checkname": "Permission check",
                "checktype": 2002,
                "configjson": "mM-dWetKf5vMpTifCV0IpeDkR1pcLEH6g=="
            },
            {
                "checkid": "1000000018025",
                "checkname": "size check",
                "checktype": 2003,
                "configjson": "nZYJwNL4OGB9h78"
            },
            {
                "checkid": "1000000018027",
                "checkname": "Last Modified check",
                "checktype": 2004,
                "configjson": "n2KqB1QVWg89s5xAwtr_SJKsJ5DlNEr3v0Rg_5MU="
            },
            {
                "checkid": "1000000018029",
                "checkname": "content check",
                "checktype": 2005,
                "configjson": "ULT7078ury63KYEbqBw1NgCEU2hDW0mxWBASS"
            },
            {
                "checkid": "1000000018031",
                "checkname": "Directory size check",
                "checktype": 3003,
                "configjson": "ZWx6EzNFgg3IMhTmsurlIw8piAf32lz41vhIZqMHcI5LSP5vEkI="
            },
            {
                "checkid": "1000000018033",
                "checkname": "Subdirectory Added",
                "checktype": 3005,
                "configjson": "VmjAfLuV3sLBPCBCammnIcnwEiK3ue6Ji1Q=="
            },
            {
                "checkid": "1000000018035",
                "checkname": "Subdirectory Deleted",
                "checktype": 3005,
                "configjson": "VmjAfLIammnIcnwEiK3ue6Ji1Q=="
            },
            {
                "checkid": "1000000018037",
                "checkname": "File Added",
                "checktype": 3004,
                "configjson": "xi5XTHLBPCBCammnIcnwEiK3ue6Ji1Q=="
            },
            {
                "checkid": "1000000018039",
                "checkname": "File Deleted",
                "checktype": 3004,
                "configjson": "xi5XTHsA_mnIcnwEiK3ue6Ji1Q=="
            },
            {
                "checkid": "1000000018041",
                "checkname": "Permissions check",
                "checktype": 3002,
                "configjson": "2NDZTcnTdypWy8TKtKA00BlrYYct7YlSqxUHuFxfgo="
            },   
        ],
        "monitor_list": ""
    }'
}

Create a new Resource Check Profiles.

oauthscope : Site24x7.Admin.Create

URL Check
Port Check
File Checks
Directory Checks

Retrieve Resource Check Profiles

GET /resource_profile/{profile_id}

Request Example

$ curl https://www.site24x7.com/api/resource_profile/113770000041195208 \
    -H "Accept: application/json; version=2.1" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "success",
    "data": '{
        "checks": [
            {
                "configjson": "{\"ctype\":1000,\"url\":\"http://$$HOSTNAME$$:8080\",\"timelimit\":5}",
                "status": 1,
                "checkname": "urlcheck",
                "checktype": 1000,
                "checkid": "1000000018017"
            },
            {
                "configjson": "{\"ctype\":4000,\"port\":8443,\"timelimit\":-1}",
                "status": 1,
                "checkname": "port check",
                "checktype": 4000,
                "checkid": "1000000018019"
            },
            {
                "configjson": "{\"ctype\":2001,\"pdir\":\"/home/local/folder/\",\"file\":\"file.txt\",\"timelimit\":-1}",
                "status": 1,
                "checkname": "File access check",
                "checktype": 2001,
                "checkid": "1000000018021"
            },
            {
                "configjson": "{\"ctype\":2002,\"pdir\":\"/home/local/folder/\",\"file\":\"file.txt\",\"timelimit\":-1}",
                "status": 1,
                "checkname": "Permission check",
                "checktype": 2002,
                "checkid": "1000000018023"
            },
            {
                "configjson": "{\"ctype\":2003,\"pdir\":\"/home/local/folder/\",\"file\":\"file.txt\",\"threshold\":10240,\"sizeunit\":\"k\",\"timelimit\":-1}",
                "status": 1,
                "checkname": "size check",
                "checktype": 2003,
                "checkid": "1000000018025"
            },
            {
                "configjson": "{\"ctype\":2004,\"modify\":\"m\",\"timelimit\":-1,\"pdir\":\"/home/local/folder/\",\"file\":\"file.txt\"}",
                "status": 1,
                "checkname": "Last Modified check",
                "checktype": 2004,
                "checkid": "1000000018027"
            },
            {
                "configjson": "{\"ctype\":2005,\"pdir\":\"/home/local/folder/\",\"file\":\"file.txt\",\"search\":[{\"casesensitive\":true,\"searchstr\":\"\\\"Exception\\\"\",\"max\":4}],\"timelimit\":-1}",
                "status": 1,
                "checkname": "content check",
                "checktype": 2005,
                "checkid": "1000000018029"
            },
            {
                "configjson": "{\"ctype\":3003,\"pdir\":\"/home/local/folder/\",\"threshold\":104857600,\"sizeunit\":\"m\",\"timelimit\":-1}",
                "status": 1,
                "checkname": "Directory size check",
                "checktype": 3003,
                "checkid": "1000000018031"
            },
            {
                "configjson": "{\"ctype\":3005,\"pdir\":\"/home/local/folder/\",\"watch\":\"a\",\"event\":\"A\",\"timelimit\":-1}",
                "status": 1,
                "checkname": "Subdirectory Added",
                "checktype": 3005,
                "checkid": "1000000018033"
            },
            {
                "configjson": "{\"ctype\":3005,\"pdir\":\"/home/local/folder/\",\"watch\":\"a\",\"event\":\"D\",\"timelimit\":-1}",
                "status": 1,
                "checkname": "Subdirectory Deleted",
                "checktype": 3005,
                "checkid": "1000000018035"
            },
            {
                "configjson": "{\"ctype\":3004,\"pdir\":\"/home/local/folder/\",\"watch\":\"a\",\"event\":\"A\",\"timelimit\":-1}",
                "status": 1,
                "checkname": "File Added",
                "checktype": 3004,
                "checkid": "1000000018037"
            },
            {
                "configjson": "{\"ctype\":3004,\"pdir\":\"/home/local/folder/\",\"watch\":\"a\",\"event\":\"D\",\"timelimit\":-1}",
                "status": 1,
                "checkname": "File Deleted",
                "checktype": 3004,
                "checkid": "1000000018039"
            },
            {
                "configjson": "{\"ctype\":3002,\"pdir\":\"/home/local/folder/\",\"timelimit\":-1}",
                "status": 1,
                "checkname": "Permissions check",
                "checktype": 3002,
                "checkid": "1000000018041"
            }, 
        ],
        "profile_name": "test test",
        "profileid": "1000000018010"
    }'
}

Retrieve the configuration of a Resource Check Profiles.

Note: While generating a new API call, ensure to append the old one when making a new request.

oauthscope : Site24x7.Admin.Read

URL Check
Port Check
File Checks
Directory Checks

Path Parameters

Param	Type	Description
profile_id	string	Mandatory Unique ID generated by the server for a Resource Check Profile.

Update Resource Check Profile

PUT /resource_profile/{profile_id}

Request Example

$ curl https://www.site24x7.com/api/resource_profile \
    -X PUT \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Accept: application/json; version=2.1" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \
    -d '{
  "checks": [
    {
      "configjson": "{\"ctype\":1000,\"url\":\"http://$$HOSTNAME$$:8080\",\"timelimit\":5}",
      "status": 1,
      "checkname": "urlcheck",
      "checktype": 1000,
      "checkid": "1000000018133",
      "resource": "http://$$HOSTNAME$$:8080"
    },
    {
      "configjson": "{\"ctype\":4000,\"port\":8443,\"timelimit\":-1}",
      "status": 1,
      "checkname": "port check",
      "checktype": 4000,
      "checkid": "1000000018134",
      "resource": 8443
    },
    {
      "configjson": "{\"ctype\":2001,\"pdir\":\"/home/local/folder/\",\"file\":\"file.txt\",\"timelimit\":-1}",
      "status": 1,
      "checkname": "File access check",
      "checktype": 2001,
      "checkid": "1000000018135",
      "resource": "/home/local/folder/file.txt",
      "parentdir": "/home/local/folder/"
    },
    {
      "configjson": "{\"ctype\":2002,\"pdir\":\"/home/local/folder/\",\"file\":\"file.txt\",\"timelimit\":-1}",
      "status": 1,
      "checkname": "Permission check",
      "checktype": 2002,
      "checkid": "1000000018136",
      "resource": "/home/local/folder/file.txt",
      "parentdir": "/home/local/folder/"
    },
    {
      "configjson": "{\"ctype\":2003,\"pdir\":\"/home/local/folder/\",\"file\":\"file.txt\",\"threshold\":10240,\"sizeunit\":\"k\",\"timelimit\":-1}",
      "status": 1,
      "checkname": "size check",
      "checktype": 2003,
      "checkid": "1000000018137",
      "resource": "/home/local/folder/file.txt"
    },
    {
      "configjson": "{\"ctype\":2004,\"modify\":\"m\",\"timelimit\":-1,\"pdir\":\"/home/local/folder/\",\"file\":\"file.txt\"}",
      "status": 1,
      "checkname": "Last Modified check",
      "checktype": 2004,
      "checkid": "1000000018138",
      "resource": "/home/local/folder/file.txt",
      "parentdir": "/home/local/folder/"
    },
    {
      "configjson": "{\"ctype\":2005,\"pdir\":\"/home/local/folder/\",\"file\":\"file.txt\",\"search\":[{\"casesensitive\":true,\"searchstr\":\"\\\"Exception\\\"\",\"max\":4}],\"timelimit\":-1}",
      "status": 1,
      "checkname": "content check",
      "checktype": 2005,
      "checkid": "1000000018139",
      "resource": "/home/local/folder/file.txt"
    },
    {
      "configjson": "{\"ctype\":3003,\"pdir\":\"/home/local/folder/\",\"threshold\":104857600,\"sizeunit\":\"m\",\"timelimit\":-1}",
      "status": 1,
      "checkname": "Directory size check",
      "checktype": 3003,
      "checkid": "1000000018140",
      "resource": "/home/local/folder/"
    },
    {
      "configjson": "{\"ctype\":3005,\"pdir\":\"/home/local/folder/\",\"watch\":\"a\",\"event\":\"A\",\"timelimit\":-1}",
      "status": 1,
      "checkname": "Subdirectory Added",
      "checktype": 3005,
      "checkid": "1000000018141",
      "resource": "/home/local/folder/"
    },
    {
      "configjson": "{\"ctype\":3005,\"pdir\":\"/home/local/folder/\",\"watch\":\"a\",\"event\":\"D\",\"timelimit\":-1}",
      "status": 1,
      "checkname": "Subdirectory Deleted",
      "checktype": 3005,
      "checkid": "1000000018142",
      "resource": "/home/local/folder/"
    },
    {
      "configjson": "{\"ctype\":3004,\"pdir\":\"/home/local/folder/\",\"watch\":\"a\",\"event\":\"A\",\"timelimit\":-1}",
      "status": 1,
      "checkname": "File Added",
      "checktype": 3004,
      "checkid": "1000000018143",
      "resource": "/home/local/folder/"
    },
    {
      "configjson": "{\"ctype\":3004,\"pdir\":\"/home/local/folder/\",\"watch\":\"a\",\"event\":\"D\",\"timelimit\":-1}",
      "status": 1,
      "checkname": "File Deleted",
      "checktype": 3004,
      "checkid": "1000000018144",
      "resource": "/home/local/folder/"
    },
    {
      "configjson": "{\"ctype\":3002,\"pdir\":\"/home/local/folder/\",\"timelimit\":-1}",
      "status": 1,
      "checkname": "Permissions check",
      "checktype": 3002,
      "checkid": "1000000018145",
      "resource": "/home/local/folder/"
    },
    {
      "configjson": "{\"ctype\":4000,\"port\":8444,\"timelimit\":-1}",
      "status": 1,
      "checkname": "port check 2",
      "checktype": 4000,
      "checkid": "1000000018162",
      "resource": 8444
    },
    {
      "checkname": "port check 3",
      "resource": 8080,
      "checktype": 4000
    }
  ],
  "profile_name": "test test",
  "monitor_list": [
    "1000000008005"
  ]
}'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "success",
    "data": {
        "checks": [
            {
                "configjson": "{\"ctype\":1000,\"url\":\"http://$$HOSTNAME$$:8080\",\"timelimit\":5}",
                "status": 1,
                "checkname": "urlcheck",
                "checktype": 1000,
                "checkid": "1000000018133"
            },
            {
                "configjson": "{\"ctype\":4000,\"port\":8443,\"timelimit\":-1}",
                "status": 1,
                "checkname": "port check",
                "checktype": 4000,
                "checkid": "1000000018134"
            },
            {
                "configjson": "{\"ctype\":2001,\"pdir\":\"/home/local/folder/\",\"file\":\"file.txt\",\"timelimit\":-1}",
                "status": 1,
                "checkname": "File access check",
                "checktype": 2001,
                "checkid": "1000000018135"
            },
            {
                "configjson": "{\"ctype\":2002,\"pdir\":\"/home/local/folder/\",\"file\":\"file.txt\",\"timelimit\":-1}",
                "status": 1,
                "checkname": "Permission check",
                "checktype": 2002,
                "checkid": "1000000018136"
            },
            {
                "configjson": "{\"ctype\":2003,\"pdir\":\"/home/local/folder/\",\"file\":\"file.txt\",\"threshold\":10240,\"sizeunit\":\"k\",\"timelimit\":-1}",
                "status": 1,
                "checkname": "size check",
                "checktype": 2003,
                "checkid": "1000000018137"
            },
            {
                "configjson": "{\"ctype\":2004,\"modify\":\"m\",\"timelimit\":-1,\"pdir\":\"/home/local/folder/\",\"file\":\"file.txt\"}",
                "status": 1,
                "checkname": "Last Modified check",
                "checktype": 2004,
                "checkid": "1000000018138"
            },
            {
                "configjson": "{\"ctype\":2005,\"pdir\":\"/home/local/folder/\",\"file\":\"file.txt\",\"search\":[{\"casesensitive\":true,\"searchstr\":\"\\\"Exception\\\"\",\"max\":4}],\"timelimit\":-1}",
                "status": 1,
                "checkname": "content check",
                "checktype": 2005,
                "checkid": "1000000018139"
            },
            {
                "configjson": "{\"ctype\":3003,\"pdir\":\"/home/local/folder/\",\"threshold\":104857600,\"sizeunit\":\"m\",\"timelimit\":-1}",
                "status": 1,
                "checkname": "Directory size check",
                "checktype": 3003,
                "checkid": "1000000018140"
            },
            {
                "configjson": "{\"ctype\":3005,\"pdir\":\"/home/local/folder/\",\"watch\":\"a\",\"event\":\"A\",\"timelimit\":-1}",
                "status": 1,
                "checkname": "Subdirectory Added",
                "checktype": 3005,
                "checkid": "1000000018141"
            },
            {
                "configjson": "{\"ctype\":3005,\"pdir\":\"/home/local/folder/\",\"watch\":\"a\",\"event\":\"D\",\"timelimit\":-1}",
                "status": 1,
                "checkname": "Subdirectory Deleted",
                "checktype": 3005,
                "checkid": "1000000018142"
            },
            {
                "configjson": "{\"ctype\":3004,\"pdir\":\"/home/local/folder/\",\"watch\":\"a\",\"event\":\"A\",\"timelimit\":-1}",
                "status": 1,
                "checkname": "File Added",
                "checktype": 3004,
                "checkid": "1000000018143"
            },
            {
                "configjson": "{\"ctype\":3004,\"pdir\":\"/home/local/folder/\",\"watch\":\"a\",\"event\":\"D\",\"timelimit\":-1}",
                "status": 1,
                "checkname": "File Deleted",
                "checktype": 3004,
                "checkid": "1000000018144"
            },
            {
                "configjson": "{\"ctype\":3002,\"pdir\":\"/home/local/folder/\",\"timelimit\":-1}",
                "status": 1,
                "checkname": "Permissions check",
                "checktype": 3002,
                "checkid": "1000000018145"
            },
            {
                "configjson": "{\"ctype\":4000,\"port\":8444,\"timelimit\":-1}",
                "status": 1,
                "checkname": "port check 2",
                "checktype": 4000,
                "checkid": "1000000018162"
            },
            {
                "configjson": "{\"ctype\":4000,\"port\":8080,\"timelimit\":-1}",
                "status": 1,
                "checkname": "port check 3",
                "checktype": 4000,
                "checkid": "1000000018166"
            }
        ],
        "profile_name": "test test",
        "profileid": "1000000018010"
    }
}

Update an existing Resource Check Profile.

Note: While generating a new API call, ensure to append the old one when making a new request.

oauthscope : Site24x7.Admin.Update

URL Check
Port Check
File Checks
Directory Checks

Path Parameters

Param	Type	Description
profile_id	string	Mandatory Unique ID generated by the server for a Resource Check Profile.

Resource Checks Parameters

This section lists all the supported resource checks.

URLCheck

Note:
1.While generating a new API call, ensure to append the old one when making a new request.
2.checkid, status and configjson should be used only during the updation of a resource check profile.

Attribute	Type	Description
resource	string	Mandatory The URL to be monitored. Examples include http://127.0.0.1:8080; http://localhost; http://$$HOSTNAME$$:8080; http://$$IP$$
checkname	string	Mandatory Name of the check
checktype	int	Mandatory 1000
checkid	int	Mandatory Id recieved using get method api
status	int	Mandatory 1
configjson	json	Mandatory Configuration of the URL check JSON Format: {“ctype”:1000,“url”:“http://$$HOSTNAME$$:8080”,“timelimit”:5}

PortCheck

Note:
1.While generating a new API call, ensure to append the old one when making a new request.
2.checkid, status and configjson should be used only during the updation of a resource check profile.

Attribute	Type	Description
resource	int	Mandatory The Port to be monitored
checkname	string	Mandatory Name of the check
checktype	int	Mandatory 4000
checkid	int	Mandatory Id recieved using get method api
status	int	Mandatory 1
configjson	json	Mandatory Configuration of the Port check JSON Format: {“ctype”:4000,“port”:8080,“timelimit”:-1}

FileChecks

Note:
1.While generating a new API call, ensure to append the old one when making a new request.
2.checkid, status and configjson should be used only during the updation of a resource check profile.

Attribute	Type	Description
resource	string	Mandatory Specify the Absolute Path of the File
checkname	string	Mandatory Name of the check
checktype	int	Mandatory To configure required file check
checkid	int	Mandatory Id recieved using get method api
status	int	Mandatory 1
configjson	json	Mandatory Configuration of the File Checks Refer the below table for configuration details.
parentdir	string	Specify the Absolute Path of the Directory (Not required for size and content check)

Resource File checks configjson

FILE CHECK	SAMPLE JSON FORMAT
Resource Check File Access	JSON Format:{ “ctype ”:2001, “pdir ”: “ /home/local/folder/ ”, “file ”: “file.txt ”, “timelimit ”:-1}
Resource Check File Permission	JSON Format:{ “ctype ”:2002, “pdir ”: “ /home/local/folder/ ”, “file ”: “file.txt ”, “timelimit ”:-1}
Resource Check File Size	JSON Format:{ “ctype ”:2003, “pdir ”: “ /home/local/folder/ ”, “file ”: “file.txt ”, “threshold ”:10240, “sizeunit ”: “k ”, “timelimit ”:-1}
Resource Check File Modify	JSON Format:{ “ctype ”:2004, “modify ”: “m ”, “timelimit ”:-1, “pdir ”: “ /home/local/folder/ ”, “file ”: “file.txt ”}
Resource Check File Content	JSON Format:{ “ctype ”:2005, “pdir ”: “ /home/local/folder/ ”, “file ”: “file.txt ”, “search ”:[{ “casesensitive ”:true, “searchstr ”: “ "Exception ” “, "max ”:4}], “timelimit ”:-1}

DirectoryChecks

Note:
1.While generating a new API call, ensure to append the old one when making a new request.
2.checkid, status and configjson should be used only during the updation of a resource check profile.

Attribute	Type	Description
resource	string	Mandatory Specify the Absolute Path of the Directory
checkname	string	Mandatory Name of the check
checktype	int	Mandatory To configure required directory check
checkid	int	Mandatory Id recieved using get method api
status	int	Mandatory 1
configjson	json	Mandatory Configuration of the Directory Checks Refer the below table for configuration details.

Resource Directory checks configjson

Directory CHECK	SAMPLE JSON FORMAT
Resource Check Directory Access	JSON Format:{“ctype”:3001,“pdir”:“/home/local/folder/”,“timelimit”:-1}
Resource Check Directory Permission	JSON Format:{“ctype”:3002,“pdir”:“/home/local/folder/”,“timelimit”:-1}
Resource Check Directory Size	JSON Format:{“ctype”:3003,“pdir”:“/home/local/folder/”,“threshold”:104857600,“sizeunit”:“m”,“timelimit”:-1}
Resource Check Directory File	To check file addition “event”:“A”,to check file deletion “event”:“D” JSON Format:{“ctype”:3004,“pdir”:“/home/local/folder/”,“watch”:“a”,“event”:“D”,“timelimit”:-1}
Resource Check Directory SubDirectory	To check directory addition “event”:“A”,to check directory deletion “event”:“D” JSON Format:{“ctype”:3005,“pdir”:“/home/local/folder/”,“watch”:“a”,“event”:“D”,“timelimit”:-1}

OAuth Providers

Register Site24x7 with your OAuth provider to monitor OAuth protected resources.

Create OAuth Provider - Client Credentials

POST /oauth2_providers

Request Example

$ curl https://www.site24x7.com/api/oauth2_providers \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \
    -d'{
        "access_token_uri": "https://www.acounts.zoho.com/oauth/v2/auth",
        "auth_method": "B",
        "client_id": "100005498423413561-nlv4ticqf9nom3sh0",
        "client_secret": "EtU_Te3lvQ5MVJ_pC0kP_2MR",
        "oauth2_flow": 2,
        "provider_name": "OAuth Provider - Client Credentials",
        "request_body": [
            {
                "name": "param1", 
                "value": "value1"
            }
        ],
        "send_token_as": {
            "method": "H", 
            "name": "Authorization", 
            "value": "Bearer ${access.token}"
        },
        "user_group_ids": [
            "8000000000017"
        ]
    }'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code":0,
    "message":"success",
    "data":{
        "access_token":"oHw31O4KDwxzPDLaXIn7TmpbhNFaLuPAyVCjSPF7R0mFBACaHr",
        "auth_method":"B",
        "oauth2_flow":2,
        "provider_id":"8000000156001",
        "client_secret":"EtU_Te3lvQ5MVJ_pC0kP_2MR",
        "auto_reauthorize":true,
        "provider_name":"client-credentials- dwolla",
        "expiry_time":"29 October, 2019 11:02 PM SST",
        "user_group_ids":["8000000000017"],
        "client_id":"100005498423413561-nlv4ticqf9nom3sh0",
        "request_body": [
            {
                "name": "param1", 
                "value": "value1"
            }
        ]
        "send_token_as":{
            "method":"H",
            "name":"Authorization",
            "value":"Bearer ${access.token}"
            },
        "access_token_uri":"https://accounts.zoho.com/oauth/v2/token"
    }
}  

Create an OAuth Provider that uses Client Credentials grant.

oauthscope : Site24x7.Admin.Create

Request Attributes

Attribute	Type	Description
access_token_uri	string	Mandatory The API Token Endpoint of the OAuth 2 Provider.
client_id	string	Mandatory The client ID obtained from your OAuth provider.
client_secret	string	Mandatory The client secret obtained from your OAuth provider.
oauth2_flow	int	Mandatory The grant type of the OAuth provider. Use 2 for Client Credentials
provider_name	string	Mandatory A name to identify this OAuth provider in the dashboard.
send_token_as	json	Mandatory Specifies if the access token will has to be sent via query parameters or request headers. JSON Format: {method: “$method”,name: “$query_parameter_name or $header_name”, value: “$query_parameter_value or $header_value”}
auth_method	string	Specifies the authentication method to be used for sending the Client ID and Client Secret to the authorization server.
request_body	json	Specifies the parameters to be sent in the request body. JSON Format: {name: “$parameter_name”, value: “$parameter_value”}
user_group_ids	array	List of User Groups that are notified when an access token can’t be refreshed even after three consecutive retries.

Response Attributes

Attribute	Type	Description
access_token	string	An access token is used for authorization and authentication while gaining access to resources on the OAuth provider application.
auth_method	string	Specifies the authentication method to be used for sending the Client ID and Client Secret to the authorization server.
oauth2_flow	int	The grant type of the OAuth provider. Use 2 for Client Credentials Grant type.
provider_id	string	Unique ID generated by the server for the OAuth provider.
client_secret	string	The client secret obtained from your OAuth provider.
auto_reauthorize	string	Automatic reauthorization for fetching access token when refresh token fails. This value is set to True by default.
provider_name	string	A name to identify this OAuth provider in the dashboard.
expiry_time	string	It defines the expiration time for the current access token.
user_group_ids	array	List of User Groups that are notified when an access token can’t be refreshed even after three consecutive retries.
client_id	string	The client ID obtained from your OAuth provider.
request_body	json	Specifies the parameters to be sent in the request body. JSON Format: {name: “$parameter_name”, value: “$parameter_value”}
send_token_as	json	Specifies if the access token will has to be sent via query parameters or request headers. JSON Format: {method: “$method”,name: “$query_parameter_name or $header_name”, value: “$query_parameter_value or $header_value”}
access_token_uri	string	The API Token Endpoint of the OAuth 2 Provider.

Create OAuth Provider - Resource Owner Password Credentials

POST /oauth2_providers

Request Example

$ curl https://www.site24x7.com/api/oauth2_providers \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \
    -d'{
        "access_token_uri": "https://www.acounts.zoho.com/oauth/v2/auth",
        "auth_method": "B",
        "auth_pass":"password",
        "auth_user":"username",
        "client_id": "100005498423413561-nlv4ticqf9nom3sh0",
        "client_secret": "EtU_Te3lvQ5MVJ_pC0kP_2MR",
        "oauth2_flow": 3,
        "provider_name": "OAuth Provider - Resource Owner",
        "request_body": [
            {
                "name": "param1", 
                "value": "value1"
            }
        ],
        "send_token_as": {
            "method": "H", 
            "name": "Authorization", 
            "value": "Bearer ${access.token}"
        },
        "user_group_ids": [
            "8000000000017"
        ]
    }'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code":0,
    "message":"success",
    "data":{
        "access_token":"oHw31O4KDwxzPDLaXIn7TmpbhNFaLuPAyVCjSPF7R0mFBACaHr",
        "auth_method":"B",
        "auth_pass":"password",
        "auth_user":"username",
        "oauth2_flow":2,
        "provider_id":"8000000156001",
        "client_secret":"EtU_Te3lvQ5MVJ_pC0kP_2MR",
        "auto_reauthorize":true,
        "provider_name":"OAuth Provider - Resource Owner",
        "expiry_time":"29 October, 2019 11:02 PM SST",
        "user_group_ids":["8000000000017"],
        "client_id":"100005498423413561-nlv4ticqf9nom3sh0",
        "send_token_as":{
            "method":"H",
            "name":"Authorization",
            "value":"Bearer ${access.token}"
            },
        "access_token_uri":"https://accounts.zoho.com/oauth/v2/token"
    }
}  

Create an OAuth Provider that uses Resource Owner Password Credentials grant.

oauthscope : Site24x7.Admin.Create

Request Attributes

Attribute	Type	Description
access_token_uri	string	Mandatory The API Token Endpoint of the OAuth 2 Provider.
client_id	string	Mandatory The client ID obtained from your OAuth provider.
client_secret	string	Mandatory The client secret obtained from your OAuth provider.
oauth2_flow	int	Mandatory The grant type of the OAuth provider. Use 3 for Resource Owner Password Credentials Grant type.
provider_name	string	Mandatory A name to identify this OAuth provider in the dashboard.
auth_method	string	Specifies the authentication method to be used for sending the Client ID and Client Secret to the authorization server.
send_token_as	json	Mandatory Specifies if the access token will has to be sent via query parameters or request headers. JSON Format: {method: “$method”,name: “$query_parameter_name or $header_name”, value: “$query_parameter_value or $header_value”}
auth_user	string	Resource owner’s username
auth_pass	string	Resource owner’s password
request_body	json	Specifies the parameters to be sent in the request body. JSON Format: {name: “$parameter_name”, value: “$parameter_value”}
user_group_ids	array	List of User Groups that are notified when an access token can’t be refreshed even after three consecutive retries.

Response Attributes

Attribute	Type	Description
access_token	string	An access token is used for authorization and authentication while gaining access to resources on the OAuth provider application.
auth_method	string	Specifies the authentication method to be used for sending the Client ID and Client Secret to the authorization server.
auth_user	string	Resource owner’s username
auth_pass	string	Resource owner’s password
oauth2_flow	int	The grant type of the OAuth provider. Use 2 for Client Credentials Grant type.
provider_id	string	Unique ID generated by the server for the OAuth provider.
client_secret	string	The client secret obtained from your OAuth provider.
auto_reauthorize	string	Automatic reauthorization for fetching access token when refresh token fails. This value is set to True by default.
provider_name	string	A name to identify this OAuth provider in the dashboard.
expiry_time	string	It defines the expiration time for the current access token.
user_group_ids	array	List of User Groups that are notified when an access token can’t be refreshed even after three consecutive retries.
client_id	string	The client ID obtained from your OAuth provider.
send_token_as	json	Specifies if the access token will has to be sent via query parameters or request headers. JSON Format: {method: “$method”,name: “$query_parameter_name or $header_name”, value: “$query_parameter_value or $header_value”}
access_token_uri	string	The API Token Endpoint of the OAuth 2 Provider.

List OAuth Providers

GET /oauth2_providers

Request Example

$ curl https://www.site24x7.com/api/oauth2_providers \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": [
    {
    "provider_id": "2486000000098007",
    "provider_name": "Google", 
    "client_id": "5498423413561-nlv4ticqf9nom3sho406r1thggaleomp.apps.googleusercontent.com",
    "client_secret": "EtU_Te3lvQ5MVJ_pC0kP_2MR",
    "authorization_uri": "https://accounts.google.com/o/oauth2/v2/auth",
    "query_params": [
        {
            "name": "prompt",
            "value": "consent"
        },
        {
            "name": "access_type",
            "value": "offline"
        }
    ],
    "oauth2_scopes": [
        {
            "value": "profile"
        }
    ],
    "send_token_as": {
        "method": "H",
        "name": "Authorization",
        "value": "Bearer ${access.token}"
    },
    "access_token_uri": "https://www.googleapis.com/oauth2/v4/token",                                 
    "access_token": "ya29.Glt3BLDD9jwp-k5EKq4ZxliCwmRnEeTnZrB2J5TdyHLxjeRZIFT_MFoeAQQ0MlEhUtT4coXK3YcBDNEjWRNCx1-FKuoVTGFjT6K-fEd_73vuv2v85UeA_hUNs6BP",
    "expiry_time": "June 28, 2017 3:55 PM IST",    
    "refresh_token": "1/4S1IFeF_NkQA1nY3B6AYYtOaskFi9ueJlXbxE8sgtJLUKu1i_s0He9vwUruYbKRj",
    "user_group_ids":["7000000000013"]
  }
    ]
}

List of all OAuth Providers.

oauthscope : Site24x7.Admin.Read

Response Attributes

Attribute	Type	Description
provider_id	string	Unique ID generated by the server for the OAuth provider.
provider_name	string	A name to identify this OAuth provider in the dashboard.
client_id	string	The client ID obtained from your OAuth provider.
client_secret	string	The client secret obtained from your OAuth provider.
authorization_uri	string	The URL to your OAuth provider’s authorization endpoint.
query_params	JSON array	Additional query parameters to the authorization URL. JSON Format: {name: “$query_parameter_name”, value: “$query_parameter_value”}
oauth2_scopes	JSON array	Specifies the level of access that the application is requesting.
send_token_as	json	Specifies if the access token will has to be sent via query parameters or request headers. JSON Format: {method: “$method”,name: “$query_parameter_name or $header_name”, value: “$query_parameter_value or $header_value”}
access_token_uri	string	The API Token Endpoint of the OAuth 2 Provider.
access_token	string	An access token is used for authorization and authentication while gaining access to resources on the OAuth provider application.
expiry_time	string	It defines the expiration time for the current access token.
refresh_token	string	Refresh token is used to retrieve a new access token before the old one expires.
user_group_ids	array	List of User Groups that are notified when an access token can’t be refreshed even after three consecutive retries.

Retrieve OAuth Provider Configuration

GET /oauth2_providers/{provider_id}

Request Example

$ curl https://www.site24x7.com/api/oauth2_providers/113770000041409003 \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": {
    "provider_id": "2486000000098007",
    "provider_name": "Google",
    "oauth2_flow": 1, 
    "client_id": "5498423413561-nlv4ticqf9nom3sho406r1thggaleomp.apps.googleusercontent.com",
    "client_secret": "EtU_Te3lvQ5MVJ_pC0kP_2MR",
    "authorization_uri": "https://accounts.google.com/o/oauth2/v2/auth",
    "query_params": [
        {
            "name": "prompt",
            "value": "consent"
        },
        {
            "name": "access_type",
            "value": "offline"
        }
    ],
    "oauth2_scopes": [
        {
            "value": "profile"
        }
    ],
    "send_token_as": {
        "method": "H",
        "name": "Authorization",
        "value": "Bearer ${access.token}"
    },
    "access_token_uri": "https://www.googleapis.com/oauth2/v4/token",                                 
    "access_token": "ya29.Glt3BLDD9jwp-k5EKq4ZxliCwmRnEeTnZrB2J5TdyHLxjeRZIFT_MFoeAQQ0MlEhUtT4coXK3YcBDNEjWRNCx1-FKuoVTGFjT6K-fEd_73vuv2v85UeA_hUNs6BP",
    "expiry_time": "June 28, 2017 3:55 PM IST",    
    "refresh_token": "1/4S1IFeF_NkQA1nY3B6AYYtOaskFi9ueJlXbxE8sgtJLUKu1i_s0He9vwUruYbKRj",
    "user_group_ids":["7000000000013"]
  }
}

Retrieve configuration of an OAuth 2 Provider.

oauthscope : Site24x7.Admin.Read

Path Parameters

Param	Type	Description
provider_id	string	Mandatory Unique ID generated by the server for the OAuth provider.

Response Attributes

Attribute	Type	Description
provider_id	string	Unique ID generated by the server for the OAuth provider.
provider_name	string	A name to identify this OAuth provider in the dashboard.
oauth2_flow	int	The grant type of the OAuth provider.
client_id	string	The client ID obtained from your OAuth provider.
client_secret	string	The client secret obtained from your OAuth provider.
authorization_uri	string	The URL to your OAuth provider’s authorization endpoint.
query_params	JSON array	Additional query parameters to the authorization URL. JSON Format: {name: “$query_parameter_name”, value: “$query_parameter_value”}
oauth2_scopes	JSON array	Specifies the level of access that the application is requesting.
auth_method	string	Specifies the authentication method to be used for sending the Client ID and Client Secret to the authorization server.
send_token_as	json	Specifies if the access token will has to be sent via query parameters or request headers. JSON Format: {method: “$method”,name: “$query_parameter_name or $header_name”, value: “$query_parameter_value or $header_value”}
access_token_uri	string	The API Token Endpoint of the OAuth 2 Provider.
access_token	string	An access token is used for authorization and authentication while gaining access to resources on the OAuth provider application.
expiry_time	string	It defines the expiration time for the current access token.
refresh_token	string	Refresh token is used to retrieve a new access token before the old one expires.
auth_user	string	Resource owner’s username
auth_pass	string	Resource owner’s password
user_group_ids	array	List of User Groups that are notified when an access token can’t be refreshed even after three consecutive retries.

Update OAuth Provider

PUT /oauth2_providers/{provider_id}

Request Example

$ curl https://www.site24x7.com/api/oauth2_providers/8000000156001 \
    -X PUT \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \
    -d'{
        "access_token_uri": "https://www.acounts.zoho.com/oauth/v2/auth",
        "auth_method": "B",
        "client_id": "100005498423413561-nlv4ticqf9nom3sh0",
        "client_secret": "EtU_Te3lvQ5MVJ_pC0kP_2MR",
        "oauth2_flow": 2,
        "provider_name": "OAuth Provider - Client Credentials",
        "request_body": [
            {
                "name": "param1", 
                "value": "value1"
            }
        ],
        "send_token_as": {
            "method": "H", 
            "name": "Authorization", 
            "value": "Bearer ${access.token}"
        },
        "user_group_ids": [
            "8000000000017"
        ]
    }'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code":0,
    "message":"success",
    "data":{
        "access_token":"oHw31O4KDwxzPDLaXIn7TmpbhNFaLuPAyVCjSPF7R0mFBACaHr",
        "auth_method":"B",
        "oauth2_flow":2,
        "provider_id":"8000000156001",
        "client_secret":"SR9ouQkPKyMNOI38BWmWjfwGYHutIB46mweKWP6MeMamJDRshr",
        "auto_reauthorize":true,
        "provider_name":"OAuth Provider - Client Credentials",
        "expiry_time":"29 October, 2019 11:02 PM SST",
        "user_group_ids":["8000000000017"],
        "client_id":"ioOgqnAoHWpgNBN6sihflrgWwaxXChinD0kULtEeGI1ki56VM4",
        "send_token_as":{
            "method":"H",
            "name":"Authorization",
            "value":"Bearer ${access.token}"
            },
        "access_token_uri":"https://acounts.zoho.com/oauth/v2/token"
    }
}  

Update an existing OAuth Provider.

oauthscope : Site24x7.Admin.Update

Path Parameters

Param	Type	Description
provider_id	string	Mandatory Unique ID generated by the server for OAuth Provider.

Request Attributes

Attribute	Type	Description
access_token_uri	string	Mandatory The API Token Endpoint of the OAuth 2 Provider.
client_id	string	Mandatory The client ID obtained from your OAuth provider.
client_secret	string	Mandatory The client secret obtained from your OAuth provider.
oauth2_flow	int	Mandatory The grant type of the OAuth provider. Use 2 for Client Credentials
provider_name	string	Mandatory A name to identify this OAuth provider in the dashboard.
send_token_as	json	Mandatory Specifies if the access token will has to be sent via query parameters or request headers. JSON Format: {method: “$method”,name: “$query_parameter_name or $header_name”, value: “$query_parameter_value or $header_value”}
auth_method	string	Specifies the authentication method to be used for sending the Client ID and Client Secret to the authorization server.
request_body	json	Specifies the parameters to be sent in the request body. JSON Format: {name: “$parameter_name”, value: “$parameter_value”}
user_group_ids	array	List of User Groups that are notified when an access token can’t be refreshed even after three consecutive retries.

Response Attributes

Attribute	Type	Description
access_token	string	An access token is used for authorization and authentication while gaining access to resources on the OAuth provider application.
auth_method	string	Specifies the authentication method to be used for sending the Client ID and Client Secret to the authorization server.
oauth2_flow	int	The grant type of the OAuth provider. Use 2 for Client Credentials
provider_id	string	Unique ID generated by the server for the OAuth provider.
client_secret	string	The client secret obtained from your OAuth provider.
auto_reauthorize	string	Automatic reauthorization for fetching access token when refresh token fails. This value is set to True by default.
provider_name	string	A name to identify this OAuth provider in the dashboard.
expiry_time	string	It defines the expiration time for the current access token.
user_group_ids	array	List of User Groups that are notified when an access token can’t be refreshed even after three consecutive retries.
client_id	string	The client ID obtained from your OAuth provider.
send_token_as	json	Specifies if the access token will has to be sent via query parameters or request headers. JSON Format: {method: “$method”,name: “$query_parameter_name or $header_name”, value: “$query_parameter_value or $header_value”}
access_token_uri	string	The API Token Endpoint of the OAuth 2 Provider.

Delete OAuth Provider

DELETE /oauth2_providers/{provider_id}

Request Example

$ curl https://www.site24x7.com/api/oauth2_providers/113770000041409003 \
    -X DELETE \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

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

Delete an existing OAuth Provider.

oauthscope : Site24x7.Admin.Delete

Path Parameters

Param	Type	Description
provider_id	string	Mandatory Unique ID generated by the server for the OAuth provider.

Web Tokens

Use the Web Token fetched from your authentication server to monitor protected resources with Site24x7.

List Web Tokens

GET /jwt

Request Example

$ curl https://www.site24x7.com/api/jwt \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": [{
    "token_id": "113770000041409003",
    "token_name": "Zoho",
    "token_uri": "https://accounts.zoho.com/apiauthtoken/nb/create",
    "token_refresh_time": 1440, 
    "http_method": "P",
    "response_type": "J",
    "send_token_as": {
        "method": "H",
        "name": "Authorization",
        "value": "Bearer ${access.token}"
    },
    "request_param":"username=Hello123\npassword=Testing456\n",
    "request_content_type":"F",
    "custom_headers":[{
        "name":"Content-Type",
        "value":"application/x-www-form-urlencoded"
    }],
    "token_fetch_expression": "$.access_token",                                 
    "webtoken": "ya29.Glt3BLDD9jwp-k5EKq4ZxliCwmRnEeTnZrB2J5TdyHLxjeRZIFT_MFoeAQQ0MlEhUtT4coXK3YcBDNEjWRNCx1-FKuoVTGFjT6K-fEd_73vuv2v85UeA_hUNs6BP",
    "user_group_ids":["7000000000013"]
  }]
}

List of all Web Tokens

oauthscope : Site24x7.Admin.Read

Response Attributes

Attribute	Type	Description
token_id	string	Unique ID generated by the server for the Web Token.
token_name	string	A name to identify the Web Token in the dashboard.
token_uri	string	The authenticating server endpoint which generates Web Tokens.
token_refresh_time	int	Time interval (in minutes) after which the Web Token will be refreshed.
http_method	string	HTTP Method to be used for accessing the website.
send_token_as	json	Specify if the access token is to be sent via query parameters or request headers. JSON Format: {method: “$method”,name: “$query_parameter_name or $header_name”, value: “$query_parameter_value or $header_value”}
response_type	string	Response content type. Response Content Types
request_param	string	Parameters passed to the authenticating server while fetching Web Token.
request_content_type	string	Content type for request params. Content Types
custom_headers	JSON array	Header name and value in a string array. JSON Format: {name: “$Header Name”, value: “$Header Value”}
token_fetch_expression	string	Expression to fetch the Web Token from the authenticating server response.
webtoken	string	An access token used for authorization and authentication while gaining access to resources on the client application.
user_group_ids	array	List of User Groups that are notified when a Web Token refresh fail three consecutive times.

Create Web Token

POST /jwt

Request Example for creating a Web Token

$ curl https://www.site24x7.com/api/jwt \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \
    -d '{
          "token_name": "Display name for the Web Token",
          "request_content_type":"F",
          "request_param":"username=Hello123\npassword=Testing456\n",
          "response_type":"J",
          "token_fetch_expression":"$.access_token",
          "token_uri":"https://accounts.zoho.com/apiauthtoken/nb/create",
          "http_method":"P",
          "token_refresh_time":1440,
          "send_token_as":{
            "method":"H",
            "name":"Authorization",
            "value":"Bearer ${access.token}"
          },
          "custom_headers":[
            {
                "name":"Content-Type",
                "value":"application/x-www-form-urlencoded"
            }
          ],
          "user_group_ids":[
            "7000000000013"
          ]
    }'

Response Example

HTTP/1.1 201 Created
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
    "message": "success",
    "data": {
        "token_name": "Display name for the Web Token",
        "token_refresh_time": 1440,
        "token_uri": "https://accounts.zoho.com/apiauthtoken/nb/create",
        "request_content_type": "F",
        "request_param": "username=Hello123\npassword=Testing456\n",
        "http_method": "P",
        "custom_headers": [
            {
                "name": "Content-Type",
                "value": "application/x-www-form-urlencoded"
            }
        ],
        "response_type": "J",
        "token_fetch_expression": "$.access_token",
        "token_id": "113770000041409003",
        "webtoken": "ya29.Glt3BLDD9jwp-k5EKq4ZxliCwmRnEeTnZrB2J5TdyHLxjeRZIFT_MFoeAQQ0MlEhUtT4coXK3YcBDNEjWRNCx1-FKuoVTGFjT6K-fEd_73vuv2v85UeA_hUNs6BP",
        "user_group_ids": [
            "7000000000013"
        ]
    }
}

Create a new Web Token.

oauthscope : Site24x7.Admin.Create

Request Parameters

Param	Type	Description
token_name	string	Mandatory Display name for the Web Token.
token_uri	string	Mandatory The authenticating server endpoint which generates Web Tokens.
http_method	string	Mandatory HTTP Method to be used for accessing the website.
token_refresh_time	int	Mandatory Time interval (in minutes) after which the Web Token will be refreshed.
send_token_as	json	Mandatory Specify if the access token is to be sent via query parameters or request headers. JSON Format: {method: “$method”,name: “$query_parameter_name or $header_name”, value: “$query_parameter_value or $header_value”}
token_fetch_expression	string	Mandatory Expression to fetch the Web Token from the authenticating server response.
response_type	string	Mandatory Response content type. Response Content Types
user_group_ids	array	Mandatory List of User Groups that are notified when a Web Token refresh fail three consecutive times.
custom_headers	JSON array	Header name and value in a string array. JSON Format: {name: “$Header Name”, value: “$Header Value”}
auth_user	string	Authentication user name to access the authenticating server.
auth_pass	string	Authentication password to access the authenticating server.
request_param	string	Parameters passed to the authenticating server while fetching Web Token.
request_content_type	string	Content type for request params. Content Types

Response Attributes

Attribute	Type	Description
token_id	string	Unique ID generated by the server for the Web Token.
token_name	string	A name to identify the Web Token in the dashboard.
token_uri	string	The authenticating server endpoint which generates Web Tokens.
token_refresh_time	int	Time interval (in minutes) after which the Web Token will be refreshed.
http_method	string	HTTP Method to be used for accessing the website.
send_token_as	json	Specify if the access token is to be sent via query parameters or request headers. JSON Format: {method: “$method”,name: “$query_parameter_name or $header_name”, value: “$query_parameter_value or $header_value”}
response_type	string	Response content type. Response Content Types
request_param	string	Parameters passed to the authenticating server while fetching Web Token.
request_content_type	string	Content type for request params. Content Types
auth_user	string	Authentication user name to access the authenticating server.
auth_pass	string	Authentication password to access the authenticating server.
custom_headers	JSON array	Header name and value in a string array. JSON Format: {name: “$Header Name”, value: “$Header Value”}
token_fetch_expression	string	Expression to fetch the Web Token from the authenticating server response.
webtoken	string	An access token used for authorization and authentication while gaining access to resources on the client application.
user_group_ids	array	List of User Groups that are notified when a Web Token refresh fail three consecutive times.

Update Web Token

PUT /jwt/{token_id}

Request Example for updating an existing Web Token

$ curl https://www.site24x7.com/api/jwt/113770000041409003 \
    -X PUT \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \
    -d '{
          "token_name": "Display name for the Web Token",
          "request_content_type":"F",
          "request_param":"username=Hello123\npassword=Testing456\n",
          "response_type":"J",
          "token_fetch_expression":"$.access_token",
          "token_uri":"https://accounts.zoho.com/apiauthtoken/nb/create",
          "http_method":"P",
          "token_refresh_time":1440,
          "send_token_as":{
            "method":"H",
            "name":"Authorization",
            "value":"Bearer ${access.token}"
          },
          "custom_headers":[
            {
                "name":"Content-Type",
                "value":"application/x-www-form-urlencoded"
            }
          ],
          "user_group_ids":[
            "7000000000013"
          ]
    }'


> Response Example

```json
HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
    "message": "success",
    "data": {
        "token_name": "Display name for the Web Token",
        "token_refresh_time": 1440,
        "token_uri": "https://accounts.zoho.com/apiauthtoken/nb/create",
        "request_content_type": "F",
        "request_param": "username=Hello123\npassword=Testing456\n",
        "http_method": "P",
        "custom_headers": [
            {
                "name": "Content-Type",
                "value": "application/x-www-form-urlencoded"
            }
        ],
        "response_type": "J",
        "token_fetch_expression": "$.access_token",
        "token_id": "113770000041409003",
        "webtoken": "ya29.Glt3BLDD9jwp-k5EKq4ZxliCwmRnEeTnZrB2J5TdyHLxjeRZIFT_MFoeAQQ0MlEhUtT4coXK3YcBDNEjWRNCx1-FKuoVTGFjT6K-fEd_73vuv2v85UeA_hUNs6BP",
        "user_group_ids": [
            "7000000000013"
        ]
    }
}

Update an existing Web Token.

oauthscope : Site24x7.Admin.Update

Path Parameters

Param	Type	Description
token_id	string	Mandatory Unique ID of the Web Token. You can find token_id using the Web Token list api.

Request Parameters

Param	Type	Description
token_name	string	Mandatory Display name for the Web Token.
token_uri	string	Mandatory The authenticating server endpoint which generates Web Tokens.
http_method	string	Mandatory HTTP Method to be used for accessing the website.
token_refresh_time	int	Mandatory Time interval (in minutes) after which the Web Token will be refreshed.
send_token_as	json	Mandatory Specify if the access token is to be sent via query parameters or request headers. JSON Format: {method: “$method”,name: “$query_parameter_name or $header_name”, value: “$query_parameter_value or $header_value”}
token_fetch_expression	string	Mandatory Expression to fetch the Web Token from the authenticating server response.
response_type	string	Mandatory Response content type. Response Content Types
user_group_ids	array	Mandatory List of User Groups that are notified when a Web Token refresh fail three consecutive times.
custom_headers	JSON array	Header name and value in a string array. JSON Format: {name: “$Header Name”, value: “$Header Value”}
auth_user	string	Authentication user name to access the authenticating server.
auth_pass	string	Authentication password to access the authenticating server.
request_param	string	Parameters passed to the authenticating server while fetching Web Token.
request_content_type	string	Content type for request params. Content Types

Response Attributes

Attribute	Type	Description
token_id	string	Unique ID generated by the server for the Web Token.
token_name	string	A name to identify the Web Token in the dashboard.
token_uri	string	The authenticating server endpoint which generates Web Tokens.
token_refresh_time	int	Time interval (in minutes) after which the Web Token will be refreshed.
http_method	string	HTTP Method to be used for accessing the website.
send_token_as	json	Specify if the access token is to be sent via query parameters or request headers. JSON Format: {method: “$method”,name: “$query_parameter_name or $header_name”, value: “$query_parameter_value or $header_value”}
response_type	string	Response content type. Response Content Types
request_param	string	Parameters passed to the authenticating server while fetching Web Token.
request_content_type	string	Content type for request params. Content Types
auth_user	string	Authentication user name to access the authenticating server.
auth_pass	string	Authentication password to access the authenticating server.
custom_headers	JSON array	Header name and value in a string array. JSON Format: {name: “$Header Name”, value: “$Header Value”}
token_fetch_expression	string	Expression to fetch the Web Token from the authenticating server response.
webtoken	string	An access token used for authorization and authentication while gaining access to resources on the client application.
user_group_ids	array	List of User Groups that are notified when a Web Token refresh fail three consecutive times.

Delete Web Token

DELETE /jwt/{token_id}

Request Example

$ curl https://www.site24x7.com/api/jwt/113770000041409003 \
    -X DELETE \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

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

Delete an existing Web Token.

oauthscope : Site24x7.Admin.Delete

Path Parameters

Param	Type	Description
token_id	string	Mandatory Unique ID provided by server, used to monitor protected resources via Web Tokens.

Email Templates

Email Templates help you customize the content of alert email sent.

Create Email Template

POST /email_templates

Request Example

$ curl https://www.site24x7.com/api/email_templates \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \
    -d '{
      "display_name": "Down_Template",
      "subject": "$MONITORNAME is $STATUS",
      "message": "$MONITORNAME is $STATUS from $LOCATIONS"
  }'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "success",
    "data":    {
      "template_id": "726000000002465",
      "display_name": "Down_Template",
      "subject": "$MONITORNAME is $STATUS",
      "message": "$MONITORNAME is $STATUS from $LOCATIONS"
    }
}

Create a new Email Template.

oauthscope : Site24x7.Admin.Create

Request Parameters

Param	Type	Description
display_name	string	Mandatory Display name for the Email template.
subject	string	Mandatory Alert mail subject of the Email template.
message	string	Content to be included in the alert Email.

Response Attributes

Attribute	Type	Description
template_id	string	Unique ID generated by the server. This can be used as an identifier.
display_name	string	Display name for the Email template.
subject	string	Alert mail subject of the Email template.
message	string	Content to be included in the alert Email.

Retrieve Email Template

GET /email_templates/{template_id}

Request Example

$ curl https://www.site24x7.com/api/email_templates/726000000002465 \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "success",
    "data":    {
      "template_id": "726000000002465",
      "display_name": "Down_Template",
      "subject": "$MONITORNAME is $STATUS",
      "message": "$MONITORNAME is $STATUS from $LOCATIONS"
    }
}

Retrieve configuration of a Email Template.

oauthscope : Site24x7.Admin.Read

Path Parameters

Param	Type	Description
template_id	string	Mandatory Unique ID generated by the server. This can be used as an identifier.

Response Attributes

Attribute	Type	Description
template_id	string	Unique ID generated by the server. This can be used as an identifier.
display_name	string	Display name for the Email template.
subject	string	Alert mail subject of the Email template.
message	string	Content to be included in the alert Email.

Update Email Template

PUT /email_templates/{template_id}

Request Example

$ curl https://www.site24x7.com/api/email_templates/726000000002465 \
    -X PUT \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \
    -d '{
      "display_name": "Down_Template",
      "subject": "$MONITORNAME is $STATUS",
      "message": "$MONITORNAME is $STATUS from $LOCATIONS"
    }'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "success",
    "data": {
      "template_id": "726000000002465",
      "display_name": "Down_Template",
      "subject": "$MONITORNAME is $STATUS",
      "message": "$MONITORNAME is $STATUS from $LOCATIONS"
    }
}

Update an existing Email Template.

oauthscope : Site24x7.Admin.Update

Path Parameters

Param	Type	Description
template_id	string	Mandatory Unique ID generated by the server. This can be used as an identifier.

Request Parameters

Param	Type	Description
display_name	string	Mandatory Display name for the Email template.
subject	string	Mandatory Alert mail subject of the Email template.
message	string	Content to be included in the alert Email.

Response Attributes

Attribute	Type	Description
template_id	string	Unique ID generated by the server. This can be used as an identifier.
display_name	string	Display name for the Email template.
subject	string	Alert mail subject of the Email template.
message	string	Content to be included in the alert Email.

Delete Email Template

DELETE /email_templates/{template_id}

Request Example

$ curl https://www.site24x7.com/api/email_templates/726000000002465 \
    -X DELETE \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

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

Delete an existing Email Template.

oauthscope : Site24x7.Admin.Delete

Path Parameters

Param	Type	Description
template_id	string	Mandatory Unique ID generated by the server. This can be used as an identifier.

List Email Templates

GET /email_templates

Request Example

$ curl https://www.site24x7.com/api/email_templates \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": [
    {
      "template_id": "726000000002465",
      "display_name": "Down_Template",
      "subject": "$MONITORNAME is $STATUS",
      "message": "$MONITORNAME is $STATUS from $LOCATIONS"
    },
    {..},
    {..}
  ]
}

List of all Email Templates.

oauthscope : Site24x7.Admin.Read

Response Attributes

Attribute	Type	Description
template_id	string	Unique ID generated by the server. This can be used as an identifier.
display_name	string	Display name for the Email template.
subject	string	Alert mail subject of the Email template.
message	string	Content to be included in the alert Email.

Global Parameters

Global Parameters are custom name-value pairs that can be defined as part of your Site24x7 global configuration.

Create Global Parameters

POST /global_parameters

Request Example

$ curl https://www.site24x7.com/api/global_parameters \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \
    -d '{
      "parameter_name": "date",
      "function_type": "true",
      "function_value": "dd/MM/yyyy",
      "member_id": 0
  }'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "success",
    "data":    {
      "parameter_id": "726000000002465",
      "parameter_name": "date",
      "function_type": "true",
      "function_value": "dd/MM/yyyy",
      "member_id": 0
    }
}

Create a new Global Parameter.

oauthscope : Site24x7.Admin.Create

Request Parameters

Param	Type	Description
parameter_name	string	Mandatory Display name for the global Parameter.
parameter_value	string	Mandatory, if function_type is false Static value of the global parameter.
function_value	string	Mandatory, if function_type is true Dynamic value of the global parameter.
function_type	boolean	Mandatory Is the parameter dynamic.
member_id	int	Mandatory, if function_type is true Functions List

Response Attributes

Attribute	Type	Description
parameter_id	string	Unique ID generated by the server. This can be used as an identifier.
parameter_name	string	Display name for the global Parameter.
parameter_value	string	Static value of the global parameter.
function_value	string	Dynamic value of the global parameter.
function_type	boolean	Is the parameter dynamic.
member_id	int	Functions List

Update Global Parameters

PUT /global_parameters/{parameter_id}

Request Example

$ curl https://www.site24x7.com/api/global_parameters/726000000002465 \
    -X PUT \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \
    -d '{
      "parameter_name": "Sample name",
      "parameter_value": "Sample value",
      "function_type": "false"
    }'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "success",
    "data": {
      "parameter_id": "726000000002465",
      "parameter_name": "Sample name",
      "parameter_value": "Sample value",
      "function_type": "false"
    }
}

Update an existing Global Parameter.

oauthscope : Site24x7.Admin.Update

Path Parameters

Param	Type	Description
parameter_id	string	Mandatory Unique ID generated by the server. This can be used as an identifier.

Request Parameters

Param	Type	Description
parameter_name	string	Mandatory Display name for the global Parameter.
parameter_value	string	Mandatory, if function_type is false Static value of the global parameter.
function_value	string	Mandatory, if function_type is true Dynamic value of the global parameter.
function_type	boolean	Mandatory Is the parameter dynamic.
member_id	int	Mandatory, if function_type is true Functions List

Response Attributes

Attribute	Type	Description
parameter_id	string	Unique ID generated by the server. This can be used as an identifier.
parameter_name	string	Display name for the global Parameter.
parameter_value	string	Static value of the global parameter.
function_value	string	Dynamic value of the global parameter.
function_type	boolean	Is the parameter dynamic.
member_id	int	Functions List

Delete Global Parameters

DELETE /global_parameters/{parameter_id}

Request Example

$ curl https://www.site24x7.com/api/global_parameters/726000000002465 \
    -X DELETE \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

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

Delete an existing Global Parameter.

oauthscope : Site24x7.Admin.Delete

Path Parameters

Param	Type	Description
parameter_id	string	Mandatory Unique ID generated by the server. This can be used as an identifier.

List Global Parameters

GET /global_parameters

Request Example

$ curl https://www.site24x7.com/api/global_parameters \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": [
    {
      "parameter_id": "726000000002465",
      "parameter_name": "test name",
      "parameter_value": "test value",
      "function_type": "false"
    },
    {"parameter_id": "726000000002469",
      "parameter_name": "Date",
      "function_type": "true",
      "function_value": "dd/MM/yyyy",
      "member_id": 0
    },
    {..}
  ]
}

List of all Global Parameters.

oauthscope : Site24x7.Admin.Read

Response Attributes

Attribute	Type	Description
parameter_id	string	Unique ID generated by the server. This can be used as an identifier.
parameter_name	string	Display name for the global Parameter.
parameter_value	string	Static value of the global parameter.
function_value	string	Dynamic value of the global parameter.
function_type	boolean	Is the parameter dynamic.
member_id	int	Functions List

Audit Logs

Retrieve a detailed record of all the events and user operations in your Site24x7 account.

Retrieve Action

GET /audit_logs

Request Example

$ curl "https://www.site24x7.com/api/audit_logs?time_greater_than=2018-09-04T00:00:00%2B0530&time_less_than=2018-09-14T23:59:59%2B0530" \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": [
    {
      "resource_type": "Monitors , Url",
      "modified_by": "Admin",
      "remarks": "Created",
      "time": "2017-01-13T18:13:39+0530",
      "params": "http_method=G,  display_name=monitor1,  type=URL,  check_frequency=5",
      "previous_params": "http_method=P,  display_name=monitor1,  type=URL,  check_frequency=10",
      "resource_name": "monitor1",
      "resource_id": "19013000000006003"
    },
    {
      "resource_type": "Users ",
      "modified_by": "Admin",
      "remarks": "Login",
      "time": "2017-01-13T18:10:32+0530",
      "params": "none",
      "resource_name": "Admin",
      "resource_id": "19013000000007000"
    }
  ]
}

Retrieve Audit Logs.

oauthscope : Site24x7.Operations.Read

Query Parameters

Param	Type	Description
time_less_than	string	Audit logs will be retrieved up to the specified timestamp value. Format - yyyy-MM-dd’T'HH:mm:ssZZZZ ,where ZZZZ indicates the offset from UTC. Example: 2018-09-04T00:00:00%2B0530
time_greater_than	string	Audit logs will be retrieved from this specified timestamp value. Format - yyyy-MM-dd’T'HH:mm:ssZZZZ ,where ZZZZ indicates the offset from UTC. Example: 2018-09-04T00:00:00%2B0530

Response Attributes

Attribute	Type	Description
resource_type	string	The category under which the resource falls under.
modified_by	string	The account member who has modified the resource.
remarks	string	Type of action performed on the resource.
time	string	The time at which the resource has been modified.
params	string	Configuration for the creation or modification of the resource.
previous_params	string	The configuration that existed prior to the modification of the resource (applicable only for update requests).
resource_name	string	Name of the resource as provided by the user.
resource_id	string	Unique Id of the resource.

Alert Logs

Retrieve a detailed log of all the alerts sent from your Site24x7 account.

Retrieve Action

GET /alert_logs

Request Example

$ curl "https://www.site24x7.com/api/alert_logs?date=2020-11-09" \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": [
     {
      "msg": "Website - Zylker.com is Up.",
      "sent_time": "2020-11-09T20:34:50-0600",
      "contact": [
        "boyle.p"
      ],
      "alert_type": 1
    },
    {
      "msg": "Website - Zylker.com is Down",
      "sent_time": "2020-11-09T15:30:50-0600",
      "alert_type": 11,
      "contact": [
        "boyle.p"
      ]
    },
    {
      "msg": "Root Cause Analysis Report - Vtitan",
      "sent_time": "2020-11-09T12:21:20-0600",
      "alert_type": 1,
      "contact": [
        "boyle.p"
      ]
    },
    {
      "msg": "Vtitan is Critical",
      "sent_time": "2020-11-09T12:20:20-0600",
      "alert_type": 9
    }
  ]
}

Retrieve Alert Logs.

oauthscope : Site24x7.Operations.Read

Query Parameters

Param	Type	Description
date	string	Alert logs will be retrieved for the specified date. Format - yyyy-MM-dd

Response Attributes

Attribute	Type	Description
msg	string	Description of the alert.
sent_time	string	Alert sent time in ISO format.
alert_type	string	Mode by which alert has been sent.
contact	array	Contact names of users to whom alert has been sent. This node will be sent for EMAIL, SMS, VOICE, CHAT alert types.

IT Automation Parameters

This section list all the Types of Automation supported along with their params

Invoke URL

Param	Type	Description
action_name	string	Mandatory Display name for the Action.
action_url	string	Mandatory URL to be invoked for action execution.
action_timeout	int	Mandatory Timeout for connecting to URL. Range 1 - 90.
action_type	int	Mandatory 1
action_method	string	Mandatory HTTP Method to access the action url.
suppress_alert	boolean	Suppress alert when dependent monitor is down
send_incident_parameters	boolean	Configuration to send incident parameters while executing the action.
send_custom_parameters	boolean	Configuration to send custom parameters while executing the action.
custom_parameters	boolean	Mandatory, if send_custom_parameters is set as true. Custom parameters to be passed while accessing the action url.
send_in_json_format	boolean	Optional, use only if HTTP Method chosen is GET. Configuration to enable json format for post parameters.
auth_method	string	Authentication method to access the action url.
username	string	Username for Authentication.
password	string	Password for Authentication.
oauth2_provider	string	Provider ID of the OAuth Provider to be associated with the action.
user_agent	string	User Agent to be used while monitoring the website.

Server Script

Param	Type	Description
action_name	string	Mandatory Display name for the Action.
action_type	int	Mandatory 2
action_timeout	int	Mandatory Max Allowed Action Execution Time
script_type	int	Mandatory Script Type
send_incident_parameters	boolean	Configuration to send incident parameters while executing the action.
send_mail	boolean	Mandatory Consider to send the mail of Action result
os_type	int	Mandatory OS Type
path	string	Mandatory The path where the Server Script is present
args	string	Arguments for the script if necessary
destination_monitors	JSON Array	The list of monitors on which the Script has to be executed. -1 for localhost

Server Command

Param	Type	Description
action_name	string	Mandatory Display name for the Action.
action_type	int	Mandatory 3
action_timeout	int	Mandatory Max Allowed Action Execution Time
command	string	Mandatory Command which has to be executed
send_mail	boolean	Mandatory Consider to send the mail of Action result
destination_monitors	JSON Array	The list of monitors on which the Script has to be executed. -1 for localhost

Windows Service

Param	Type	Description
action_name	string	Mandatory Display name for the Action.
action_type	int	Mandatory 4
action_timeout	int	Mandatory Max Allowed Action Execution Time
send_mail	boolean	Mandatory Consider to send the mail of Action result
service_action_type	int	Mandatory Service Action Type
service_name	string	Mandatory Name of the Service to be automated
destination_monitors	JSON Array	The list of monitors on which the Script has to be executed. -1 for localhost

Server Reboot

Param	Type	Description
action_name	string	Mandatory Display name for the Action.
action_type	int	Mandatory 5
action_timeout	int	Mandatory Max Allowed Action Execution Time
send_mail	boolean	Mandatory Consider to send the mail of Action result
destination_monitors	JSON Array	The list of monitors on which the Script has to be executed. -1 for localhost
args	string	Any arguments which needs to passed for rebooting

Hyper-V

Param	Type	Description
action_name	string	Mandatory Display name for the Action.
action_type	int	Mandatory 6
action_timeout	int	Mandatory Max Allowed Action Execution Time
send_mail	boolean	Mandatory Consider to send the mail of Action result
hyperv_action_type	int	Mandatory Hyper-V Action Type
hyperv_monitor	long	The Hyper-V server on which the VM Action has to be executed
hypervms	JSON Array	The VM(s) on which the Automation has to be run

IIS

Param	Type	Description
action_name	string	Mandatory Display name for the Action.
action_type	int	Mandatory 7
action_timeout	int	Mandatory Max Allowed Action Execution Time
send_mail	boolean	Mandatory Consider to send the mail of Action result
iis_monitor	long	Mandatory The Monitor on which the selected Action has to be executed
iis_action_type	int	Mandatory IIS Action type
iis_child	JSON Array	Mandatory The list of Website/app pools on which the IIS Action has to be executed

Mark as Maintenance

Param	Type	Description
action_name	string	Mandatory Display name for the Action.
action_type	int	Mandatory 8
send_mail	boolean	Mandatory Consider to send the mail of Action result
destination_monitors	JSON Array	The list of monitors on which the Script has to be executed. -1 for localhost
args	string	Denotes the amount of time, the maintenance to be applied since the time of execution

Start/Stop/Stop-Hibernate/Reboot EC2

Param	Type	Description
action_name	string	Mandatory Display name for the Action.
action_type	int	Mandatory 9
aws_action_type	int	Mandatory values
action_timeout	int	Mandatory Timeout value in seconds
send_mail	boolean	Mandatory Consider to send the mail of Action result
destination_monitor	JSON Array	The list of monitors on which the Script has to be executed. -1 for localhost

Start/Stop/Reboot/Reboot With Failover RDS

Param	Type	Description
action_name	string	Mandatory Display name for the Action.
action_type	int	Mandatory 10
aws_action_type	int	Mandatory values
action_timeout	int	Mandatory Timeout value in seconds
send_mail	boolean	Mandatory Consider to send the mail of Action result
destination_monitor	JSON Array	The list of monitors on which the Script has to be executed. -1 for localhost

Trigger Lambda Function

Param	Type	Description
action_name	string	Mandatory Display name for the Action.
action_type	int	Mandatory 11
aws_action_type	int	Mandatory 4
action_timeout	int	Mandatory Timeout value in seconds
send_mail	boolean	Mandatory Consider to send the mail of Action result
destination_monitor	JSON Array	The list of monitors on which the Script has to be executed. -1 for localhost

Publish to SNS Topic

Param	Type	Description
action_name	string	Mandatory Display name for the Action.
action_type	int	Mandatory 12
aws_action_type	int	Mandatory 4
action_message	string	Mandatory Message For SNS Topic
action_subject	string	Mandatory Subject For SNS Topic
action_timeout	int	Mandatory Timeout value in seconds
send_mail	boolean	Mandatory Consider to send the mail of Action result
destination_monitor	JSON Array	The list of monitors on which the Script has to be executed. -1 for localhost

EC Memcached Node Reboot

Param	Type	Description
action_name	string	Mandatory Display name for the Action.
action_type	int	Mandatory 13
aws_action_type	int	Mandatory 1
action_timeout	int	Mandatory Timeout value in seconds
send_mail	boolean	Mandatory Consider to send the mail of Action result
destination_monitor	JSON Array	The list of monitors on which the Script has to be executed. -1 for localhost

EC Memcached Cluster Reboot

Param	Type	Description
action_name	string	Mandatory Display name for the Action.
action_type	int	Mandatory 14
aws_action_type	int	Mandatory 1
action_timeout	int	Mandatory Timeout value in seconds
send_mail	boolean	Mandatory Consider to send the mail of Action result
destination_monitor	JSON Array	The list of monitors on which the Script has to be executed. -1 for localhost

EC Redis Node Reboot

Param	Type	Description
action_name	string	Mandatory Display name for the Action.
action_type	int	Mandatory 15
aws_action_type	int	Mandatory 1
action_timeout	int	Mandatory Timeout value in seconds
send_mail	boolean	Mandatory Consider to send the mail of Action result
destination_monitor	JSON Array	The list of monitors on which the Script has to be executed. -1 for localhost

Send Message to SQS Queue

Param	Type	Description
action_name	string	Mandatory Display name for the Action.
action_type	int	Mandatory 16
aws_action_type	int	Mandatory 4
action_message	string	Mandatory Message For SQS Queue
action_timeout	int	Mandatory Timeout value in seconds
send_mail	boolean	Mandatory Consider to send the mail of Action result
destination_monitor	JSON Array	The list of monitors on which the Script has to be executed. -1 for localhost

Start/Stop Kinesis Analytics

Param	Type	Description
action_name	string	Mandatory Display name for the Action.
action_type	int	Mandatory 17
aws_action_type	int	Mandatory 2 for stop, 3 for start
action_timeout	int	Mandatory Timeout value in seconds
send_mail	boolean	Mandatory Consider to send the mail of Action result
destination_monitor	JSON Array	The list of monitors on which the Script has to be executed. -1 for localhost

Elastic Beanstalk Actions

Param	Type	Description
action_name	string	Mandatory Display name for the Action.
action_type	int	Mandatory 19
aws_action_type	int	Mandatory 1
action_timeout	int	Mandatory Timeout value in seconds
send_mail	boolean	Mandatory Consider to send the mail of Action result
destination_monitor	JSON Array	The list of monitors on which the Script has to be executed. -1 for localhost

Invoke API Gateway Resource URL

Param	Type	Description
action_name	string	Mandatory Display name for the Action.
action_type	int	Mandatory 20
action_method	String	Mandatory “G” for GET and “P” for POST
aws_action_type	int	Mandatory 4
action_timeout	int	Mandatory Timeout value in seconds
send_mail	boolean	Mandatory Consider to send the mail of Action result
send_in_json_format	boolean	Mandatory Format for request body
custom_headers	JSON array	Header name and value in a string array. JSON Format: {name: “$Header Name”, value: “$Header Value”}
destination_monitor	JSON Array	The list of monitors on which the Script has to be executed. -1 for localhost

Reboot Redshift Cluster

Param	Type	Description
action_name	string	Mandatory Display name for the Action.
action_type	int	Mandatory 21
aws_action_type	int	Mandatory 1
action_timeout	int	Mandatory Timeout value in seconds
send_mail	boolean	Mandatory Consider to send the mail of Action result
destination_monitor	JSON Array	The list of monitors on which the Script has to be executed. -1 for localhost

SES Send Email

Param	Type	Description
action_name	string	Mandatory Display name for the Action.
action_type	int	Mandatory 22
aws_action_type	int	Mandatory 1
action_timeout	int	Mandatory Timeout value in seconds
send_mail	boolean	Mandatory Consider to send the mail of Action result
aws_ses_monitors	JSON Array	Mandatory The list of endpoints from which email identity has to be chosen
ses_from_email	string	Mandatory SES From Identity
email_destinations	JSON Array	Mandatory The list of recipient Address
action_subject	string	Mandatory Email subject
action_message	string	Mandatory Email message
conf_set	string	Configuration Set Name

Push Record to Kinesis Data Stream

Param	Type	Description
action_name	string	Mandatory Display name for the Action.
action_type	int	Mandatory 23
aws_action_type	int	Mandatory 4
action_timeout	int	Mandatory Timeout value in seconds
send_mail	boolean	Mandatory Consider to send the mail of Action result
request_body	string	Mandatory Data to push into stream
destination_monitor	JSON Array	The list of monitors on which the Script has to be executed. -1 for localhost
partition_key	string	Partition key
explicit_hash_key	string	Explicit hash key

Execute Step Function

Param	Type	Description
action_name	string	Mandatory Display name for the Action.
action_type	int	Mandatory 24
aws_action_type	int	Mandatory 3
action_timeout	int	Mandatory Timeout value in seconds
send_mail	boolean	Mandatory Consider to send the mail of Action result
action_message	string	Mandatory JSON Input for Execution
destination_monitor	JSON Array	The list of monitors on which the Script has to be executed. -1 for localhost

Add Step to EMR Cluster

Param	Type	Description
action_name	string	Mandatory Display name for the Action.
action_type	int	Mandatory 25
aws_action_type	int	Mandatory 3
action_timeout	int	Mandatory Timeout value in seconds
send_mail	boolean	Mandatory Consider to send the mail of Action result
aws_emr_monitors	long	The monitor on which the steps has to be cloned
step_ids	JSON Array	The list of steps to clone in the cluster

Start/Stop/Reboot/Rebuild Workspace

Param	Type	Description
action_name	string	Mandatory Display name for the Action.
action_type	int	Mandatory 26
aws_action_type	int	Mandatory values
action_timeout	int	Mandatory Timeout value in seconds
send_mail	boolean	Mandatory Consider to send the mail of Action result
destination_monitor	JSON Array	The list of monitors on which the Script has to be executed. -1 for localhost

Reboot Neptune Instance

Param	Type	Description
action_name	string	Mandatory Display name for the Action.
action_type	int	Mandatory 27
aws_action_type	int	Mandatory 3
action_timeout	int	Mandatory Timeout value in seconds
send_mail	boolean	Mandatory Consider to send the mail of Action result
destination_monitor	JSON Array	The list of monitors on which the Script has to be executed. -1 for localhost

Start/Stop/Reboot Lightsail Instance

Param	Type	Description
action_name	string	Mandatory Display name for the Action.
action_type	int	Mandatory 28
aws_action_type	int	Mandatory values
action_timeout	int	Mandatory Timeout value in seconds
send_mail	boolean	Mandatory Choose to receive the result of the executed action via email
destination_monitor	JSON Array	The list of monitors on which the Script has to be executed. -1 for localhost

Reboot Amazon MQ Broker

Param	Type	Description
action_name	string	Mandatory Display name for the Action.
action_type	int	Mandatory 29
aws_action_type	int	Mandatory 3
action_timeout	int	Mandatory Timeout value in seconds
send_mail	boolean	Mandatory Choose to receive the result of the executed action via email
destination_monitor	JSON Array	The list of monitors on which the Script has to be executed. -1 for localhost

Start/Stop/Reboot Lightsail Database

Param	Type	Description
action_name	string	Mandatory Display name for the Action.
action_type	int	Mandatory 30
aws_action_type	int	Mandatory values
action_timeout	int	Mandatory Timeout value in seconds
send_mail	boolean	Mandatory Choose to receive the result of the executed action via email
destination_monitor	JSON Array	The list of monitors on which the Script has to be executed. -1 for localhost

Start/Stop/Resume/Reload DMS Task

Param	Type	Description
action_name	string	Mandatory Display name for the Action.
action_type	int	Mandatory 32
aws_action_type	int	Mandatory values
action_timeout	int	Mandatory Timeout value in seconds
send_mail	boolean	Mandatory Choose to receive the result of the executed action via email
destination_monitor	JSON Array	The list of monitors on which the Script has to be executed. -1 for localhost

Amazon FSX Actions

Param	Type	Description
action_name	string	Mandatory Display name for the Action.
action_type	int	Mandatory 33
aws_action_type	int	Mandatory values
template_tags	JSON array	Tag name and value in a string array. JSON Format: {name: “$Tag Name ”, value: “$Tag Value”}
filepath	string	The path on the Amazon FSx file system to use when the data repository task is processed.
report	boolean	true to generate a completion report when the task is completed. If set to true, then you need to provide a report path.
report_path	string	Mandatory,if report is set as true. An absolute path that defines where the completion report will be stored in the destination location.
action_timeout	int	Mandatory Timeout value in seconds.
send_mail	boolean	Mandatory Choose to receive the result of the executed action via email.
aws_fsx_monitor	long	Mandatory The monitor on which the action need to be executed.

Lambda@Edge Function Actions

Param	Type	Description
action_name	string	Mandatory Display name for the Action.
action_type	int	Mandatory 34
aws_action_type	int	Mandatory value
action_timeout	int	Mandatory Timeout value in seconds
send_mail	boolean	Mandatory Consider to send the mail of Action result
destination_monitor	JSON Array	The list of monitors on which the Script has to be executed. -1 for localhost

Start/Stop SFTP Server

Param	Type	Description
action_name	string	Mandatory Display name for the Action.
action_type	int	Mandatory 35
aws_action_type	int	Mandatory values
action_timeout	int	Mandatory Timeout value in seconds
send_mail	boolean	Mandatory Consider to send the mail of Action result
destination_monitor	JSON Array	The list of monitors on which the Script has to be executed. -1 for localhost

Start/Stop/Failover DDB Cluster

Param	Type	Description
action_name	string	Mandatory Display name for the Action.
action_type	int	Mandatory 39
aws_action_type	int	Mandatory values
action_timeout	int	Mandatory Timeout value in seconds
send_mail	boolean	Mandatory Consider to send the mail of Action result
destination_monitor	array	The list of monitors on which the Script has to be executed. -1 for localhost

Reboot DDB Instance

Param	Type	Description
action_name	string	Mandatory Display name for the Action.
action_type	int	Mandatory 40
aws_action_type	int	Mandatory Unique value to identify appropriate action type
action_timeout	int	Mandatory Timeout value in seconds
send_mail	boolean	Mandatory Consider to send the mail of Action result
destination_monitor	array	The list of monitors on which the Script has to be executed. -1 for localhost

Start/Stop AppStream 2.0

Param	Type	Description
action_name	string	Mandatory The action display name.
action_type	int	Mandatory 41
aws_action_type	int	Mandatory values
action_timeout	int	Mandatory The timeout value in seconds.
send_mail	boolean	Mandatory Send the action result email.
destination_monitor	array	The list of monitors in which the script has to be executed. -1 for localhost

Invoke API URL

Param	Type	Description
action_name	string	Mandatory The action display name.
action_type	int	Mandatory 42
aws_action_type	int	Mandatory Unique value to identify appropriate action type
action_timeout	int	Mandatory The timeout value in seconds.
send_mail	boolean	Mandatory Send the action result email.
request_body	string	Mandatory Query to get execute.
destination_monitor	array	The list of monitors in which the script has to be executed. -1 for localhost

IT Automation

Prioritize and remediate routine actions automatically, and increase IT efficiency and streamline your processes to reduce performance degrade

Create Automation

POST /it_automation

Request Example

$ curl https://www.site24x7.com/api/it_automation \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \
    -d '{
      "action_type": 2,
      "action_timeout": 30,
      "script_type": 200,
      "send_mail": false,
      "ostype": 1,
      "destination_monitors": [
        "-1",
        "25000001008191",
        "25000001002061"
      ],
      "action_name": "api script",
      "command": "sh",
      "path": "\$\$DEFAULT_PATH\$\$/action_script/event/event.vbs",
      "script_id": "25000000997001",
      "args": "asd"
    }'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "success",
    "data": {
        "action_id": "25000001020037",
        "action_name": "api script",
        "action_type": 2,
        "action_run_enable": 0
    }
}

Create a new Automation.

oauthscope : Site24x7.Operations.Create

Invoke URL
Server Script
Server Command
Windows Service
Server Reboot
Hyper-V
IIS
Mark as Maintenance
Start/Stop/Stop-Hibernate/Reboot EC2
Start/Stop/Reboot/Reboot With Failover RDS
Trigger Lambda Function
Publish to SNS Topic
EC Memcached Node Reboot
EC Memcached Cluster Reboot
EC Redis Node Reboot
Send Message to SQS Queue
Start/Stop Kinesis Analytics
Elastic Beanstalk Actions
Invoke API Gateway Resource URL
Reboot Redshift Cluster
SES Send Email
Push Record to Kinesis Data Stream
Execute Step Function
Add Step to EMR Cluster
Start/Stop/Reboot/Rebuild Workspace
Reboot Neptune Instance
Start/Stop/Reboot Lightsail Instance
Reboot Amazon MQ Broker
Start/Stop/Reboot Lightsail Database
Start/Stop/Resume/Reload DMS Task
Amazon FSX Actions
Lambda@Edge Function Actions
Start/Stop SFTP Server
Start/Stop/Failover DDB Cluster
Reboot DDB Instance
Start/Stop AppStream 2.0
Invoke API URL

Retrive Automation

GET /it_automation/{action_id}

Request Example

$ curl https://www.site24x7.com/api/it_automation/25000001020037 \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" 

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "success",
    "data": {
        "send_mail": false,
        "command": "sh",
        "action_name": "api script",
        "destination_monitor": [
            "-1",
            "25000001008191",
            "25000001002061"
        ],
        "args": "asd",
        "script_type": 200,
        "action_timeout": 30,
        "action_id": "25000001020037",
        "script_id": "25000000997001",
        "path": "$$DEFAULT_PATH$$/action_script/event/event.vbs"
    }
}

Retrive the configuration of Automation.

oauthscope : Site24x7.Operations.Read

Invoke URL
Server Script
Server Command
Windows Service
Server Reboot
Hyper-V
IIS
Mark as Maintenance
Start/Stop/Stop-Hibernate/Reboot EC2
Start/Stop/Reboot/Reboot With Failover RDS
Trigger Lambda Function
Publish to SNS Topic
EC Memcached Node Reboot
EC Memcached Cluster Reboot
EC Redis Node Reboot
Send Message to SQS Queue
Start/Stop Kinesis Analytics
Elastic Beanstalk Actions
Invoke API Gateway Resource URL
Reboot Redshift Cluster
SES Send Email
Push Record to Kinesis Data Stream
Execute Step Function
Add Step to EMR Cluster
Start/Stop/Reboot/Rebuild Workspace
Reboot Neptune Instance
Start/Stop/Reboot Lightsail Instance
Reboot Amazon MQ Broker
Start/Stop/Reboot Lightsail Database
Start/Stop/Resume/Reload DMS Task
Amazon FSX Actions
Lambda@Edge Function Actions
Start/Stop SFTP Server
Start/Stop/Failover DDB Cluster
Reboot DDB Instance
Start/Stop AppStream 2.0
Invoke API URL

Path Parameters

Param	Type	Description
action_id	long	Mandatory Unique ID generated by the server for an Automation.

Update Automation

PUT /it_automation/{action_id}

Request Example

$ curl https://www.site24x7.com/api/it_automation/25000001020037 \
    -X PUT \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \
    -d '{
      "send_mail": false,
      "action_name": "api script 1",
      "args": "asd",
      "script_type": 200,
      "action_timeout": 30,
      "script_id": "25000000997001",
      "path": "$$DEFAULT_PATH$$/action_script/event/event.vbs",
      "action_type": 2,
      "destination_monitors": [
        "-1",
        "25000001008191",
        "25000001008301"
      ],
      "ostype": 1
    }'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "success",
    "data": {
        "action_id": "25000001020037",
        "action_name": "api script 1",
        "action_type": 2,
        "action_run_enable": 1
    }
}

Update the configuration of Automation.

oauthscope : Site24x7.Operations.Update

Invoke URL
Server Script
Server Command
Windows Service
Server Reboot
Hyper-V
IIS
Mark as Maintenance
Start/Stop/Stop-Hibernate/Reboot EC2
Start/Stop/Reboot/Reboot With Failover RDS
Trigger Lambda Function
Publish to SNS Topic
EC Memcached Node Reboot
EC Memcached Cluster Reboot
EC Redis Node Reboot
Send Message to SQS Queue
Start/Stop Kinesis Analytics
Elastic Beanstalk Actions
Invoke API Gateway Resource URL
Reboot Redshift Cluster
SES Send Email
Push Record to Kinesis Data Stream
Execute Step Function
Add Step to EMR Cluster
Start/Stop/Reboot/Rebuild Workspace
Reboot Neptune Instance
Start/Stop/Reboot Lightsail Instance
Reboot Amazon MQ Broker
Start/Stop/Reboot Lightsail Database
Start/Stop/Resume/Reload DMS Task
Amazon FSX Actions
Lambda@Edge Function Actions
Start/Stop SFTP Server
Start/Stop/Failover DDB Cluster
Reboot DDB Instance
Start/Stop AppStream 2.0
Invoke API URL

Path Parameters

Param	Type	Description
action_id_id	long	Mandatory Unique ID generated by the server for an Automation.

Delete Automation

DELETE /it_automation/{action_id}

Request Example

$ curl https://www.site24x7.com/api/it_automation/25000001020037 \
    -X DELETE \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \

Response Example

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

Delete an existing Automation.

oauthscope : Site24x7.Operations.Delete

Path Parameters

Param	Type	Description
action_id	string	Mandatory Unique ID generated by the server for an Automation.

List Automations

GET /it_automation

Request Example

$ curl https://www.site24x7.com/api/it_automation \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": [
    {
      "password": "admin",
      "action_type": 1,
      "monitors": [],
      "username": "admin",
      "action_method": "P",
      "send_mail": false,
      "action_url": "http://192.168.223.94:8090/manager/status",
      "send_incident_parameters": true,
      "test_action_status": "0",
      "send_in_json_format": true,
      "action_timeout": 15,
      "send_custom_parameters": false,
      "action_run_enable": 1,
      "last_executed_time": "August 29, 2017 1:44 PM IST",
      "test_action_time": "2017-08-29T13:44:09+0530",
      "auth_method": "B",
      "action_name": "Updated Actions",
      "action_id": "25000000139280"
    },
    {
      "action_run_enable": 0,
      "send_mail": true,
      "action_name": "Action - Server Script",
      "destination_monitor": [
        "-1"
      ],
      "args": "sag",
      "script_type": 100,
      "action_timeout": 30,
      "action_id": "25000000941003",
      "script_id": "25000000997001",
      "action_type": 2,
      "path": "$$DEFAULT_PATH$$\\action_script\\event\\event.vbs"
    }
  ]
}

List of all Automations

oauthscope : Site24x7.Operations.Read

Invoke URL
Server Script
Server Command
Windows Service
Server Reboot
Hyper-V
IIS
Mark as Maintenance
Start/Stop/Stop-Hibernate/Reboot EC2
Start/Stop/Reboot/Reboot With Failover RDS
Trigger Lambda Function
Publish to SNS Topic
EC Memcached Node Reboot
EC Memcached Cluster Reboot
EC Redis Node Reboot
Send Message to SQS Queue
Start/Stop Kinesis Analytics
Elastic Beanstalk Actions
Invoke API Gateway Resource URL
Reboot Redshift Cluster
SES Send Email
Push Record to Kinesis Data Stream
Execute Step Function
Add Step to EMR Cluster
Start/Stop/Reboot/Rebuild Workspace
Reboot Neptune Instance
Start/Stop/Reboot Lightsail Instance
Reboot Amazon MQ Broker
Start/Stop/Reboot Lightsail Database
Start/Stop/Resume/Reload DMS Task
Amazon FSX Actions
Lambda@Edge Function Actions
Start/Stop SFTP Server
Start/Stop/Failover DDB Cluster
Reboot DDB Instance
Start/Stop AppStream 2.0
Invoke API URL

Execute Automation

PUT /it_automation/execute

Request Example

 $ curl https://www.site24x7.com/api/it_automation/execute \
    -X PUT \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \
    -d '{
        "action_name":"sitestop",
        "action_id":"1000000370117",
        "destination_monitors":["1000000324003","1000000334011","1000000378017","1000000412003","1000000421003"]
        }'

Execute the Automation whose action_id is passed and on the selected destination_monitors

oauthscope : Site24x7.Operations.Update

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": {
            "test_action_time":"2017-09-28T10:00:53+0530"
            }

}  ```

IT Automation Logs

Retrieve detailed IT Automation logs of all actions performed in your Site24x7 account for a specified time interval.

Retrieve Action

GET /it_automation/log_report

Request Example

$ curl "https://www.site24x7.com/api/it_automation/log_report?date=2018-09-04" \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": [
  {
    "incident_reason": "Execute on Trouble",
    "action_id": "2999531111001750068",
    "action_status": 1,
    "monitor_name": "monitor_name",
    "action_name": "webhook.site",
    "action_reason": "",
    "action_type": 1,
    "executed_time": "2020-09-21T23:25:52+0530"
  },
  {
    "incident_reason": "Execute on Up",
    "action_id": "2999511110001750068",
    "action_status": 0,
    "monitor_name": "monitor_name",
    "action_name": "webhook.site",
    "action_reason": "Request URI does not exist.",
    "action_type": 1,
    "executed_time": "2020-09-21T23:18:52+0530"
  }
]
}

Retrieve IT Automation Logs.

oauthscope : Site24x7.Operations.Read

Query Parameters

Param	Type	Description
date	string	Mandatory,Choose the date for which you want to generate the IT Automation log report. Format - yyyy-mm-dd

Response Attributes

Attribute	Type	Description
incident_reason	string	Reason why the IT automation is executed.
action_id	long	Unique ID generated by the server for an Automation.
action_status	int	Status of IT automation. 1 means Success. 0 means Failed.
monitor_name	string	Name of the monitor where IT automation is executed.
action_name	string	Display name for the Action.
action_reason	string	Response from the Action.
action_type	int	Unique ID generated by the server for an Automation.
executed_time	string	The time when the IT automation is executed.

Third-Party Integrations

Third-Party Integrations help you post the site24x7 alerts as alarms or incidents or messages based on the type of integration to notify the customer about the failure immediately.

Create WebHook

POST /integration/webhooks

Request Example

$ curl https://www.site24x7.com/api/integration/webhooks \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \
    -d '{
  "selection_type": 0,
  "method": "P",
  "send_incident_parameters": false,
  "timeout": 30,
  "is_poller_webhook": false,
  "custom_headers": [
    {
      "name": "",
      "value": ""
    }
  ],
  "trouble_alert": false,
  "critical_alert": false,
  "auth_method": "B",
  "manage_tickets": false,
  "username": "username",
  "password": "password",
  "name": "webhook_cloud",
  "url": "http://example.com",
  "send_custom_parameters": true,
  "send_in_json_format": true,
  "custom_parameters": "{\"test\":\"abcd\"}",
  "custom_headers": [
        {
          "name": "Accept-Charset",
          "value": "UTF-8"
        }
   ],
   "alert_tags_id": ["113770000023231001"]
}'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "success",
    "data": {
        "password": "password",
        "method": "P",
        "type": 8,
        "username": "username",
        "url": "http://example.com",
        "is_poller_webhook": false,
        "send_incident_parameters": false,
        "timeout": 30,
        "manage_tickets": false,
        "send_in_json_format": true,
        "send_custom_parameters": true,
        "trouble_alert": false,
        "service_id": "364007852013",
        "service_status": 0,
        "custom_parameters": {
            "test": "abcd"
        },
        "auth_method": "B",
        "critical_alert": false,
        "selection_type": 0,
        "name": "webhook_cloud",
        "alert_tags_id": ["113770000023231001"]
    }
}

Create a new WebHook.

oauthscope : Site24x7.Admin.Create

Request Parameters

Param	Type	Description
name	string	Mandatory Display name for the WebHook.
url	string	Mandatory URL to be invoked for action execution.
timeout	int	Mandatory The amount of time a connection waits to time out. Range 1 - 45.
method	string	Mandatory HTTP Method to access the URL.
selection_type	int	Mandatory Resource Type associated with this integration. Monitor Group not supported.
is_poller_webhook	boolean	URL to be invoked from an On-Premise Poller agent.
poller	string	Mandatory, if is_poller_webhook is set as true. Denotes On-Premise Poller ID.
send_incident_parameters	boolean	Configuration to send incident parameters while executing the action.
send_custom_parameters	boolean	Configuration to send custom parameters while executing the action.
custom_parameters	string	Mandatory, if send_custom_parameters is set as true. Custom parameters to be passed while accessing the URL.
send_in_json_format	boolean	Configuration to enable json format for post parameters.
auth_method	string	Authentication method to access the action url.
username	string	Username for Authentication.
password	string	Password for Authentication.
oauth2_provider	string	Provider ID of the OAuth Provider to be associated with the action.
user_agent	string	User Agent to be used while monitoring the website.
monitors	array	Monitors associated with the integration.
manage_tickets	boolean	Configuration to handle ticketing based integration.
update_url	string	URL to be invoked to update the request.
update_method	string	HTTP Method to access the URL.
update_send_incident_parameters	boolean	Configuration to send incident parameters while executing the action.
update_send_custom_parameters	boolean	Configuration to send custom parameters while executing the action.
update_custom_parameters	string	Mandatory, When update_send_custom_parameters is set as true. Custom parameters to be passed while accessing the URL.
close_url	string	URL to be invoked to close the request.
close_method	string	HTTP Method to access the URL.
close_send_incident_parameters	boolean	Configuration to send incident parameters while executing the action.
close_send_custom_parameters	boolean	Configuration to send custom parameters while executing the action.
close_custom_parameters	string	Mandatory, When close_send_custom_parameters is set as true. Custom parameters to be passed while accessing the URL.
alert_tags_id	array	Tag id’s to be associated with the integration.

Response Attributes

Attribute	Type	Description
service_id	string	Unique ID generated by the server. This can be used as an identifier.
service_status	int	Integration Status
name	string	Display name for the WebHook.
url	string	URL to be invoked for action execution.
timeout	int	The amount of time a connection waits to time out.
method	string	HTTP Method to access the URL.
is_poller_webhook	boolean	URL to be invoked from an On-Premise poller agent.
poller	string	Denotes On-Premise Poller ID.
send_incident_parameters	boolean	Configuration to send incident parameters while executing the action.
send_custom_parameters	boolean	Configuration to send custom parameters while executing the action.
custom_parameters	string	Custom parameters to be passed while accessing the URL.
send_in_json_format	boolean	Configuration to enable json format for post parameters.
auth_method	string	Authentication method
username	string	Username for Authentication.
password	string	Password for Authentication.
oauth2_provider	string	Provider ID of the OAuth Provider associated with the action.
user_agent	string	User Agent to be used while monitoring the website.
selection_type	int	Resource Type associated with this integration.
monitors	array	Monitors associated with the integration.
manage_tickets	boolean	Configuration to handle ticketing based integration.
alert_tags_id	array	Tag id’s to be associated with the integration.

Retrieve Webhook

GET /integration/webhooks/{service_id}

Request Example

$ curl https://www.site24x7.com/api/integration/webhooks/113770000023231022 \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": {
    "service_id":"113770000023231022",
    "service_status":0,
    "name": "Test WebHook",
    "url": "http://requestb.in",
    "is_poller_webhook":false,
    "custom_headers": [
      {
        "name": "Accept-Charset",
        "value": "UTF-8"
      }
    ],
    "timeout": 30,
    "method": "P",
    "auth_method": "B",
    "username": "username",
    "password": "password",
    "send_custom_parameters": true,
    "custom_parameters": "param=value",
    "send_incident_parameters": true,
    "send_in_json_format": true,
    "user_agent": "Mozilla",
    "selection_type":0,
    "alert_tags_id": ["113770000023231001"]
  }
}

Retrieve configuration of a WebHook.

oauthscope : Site24x7.Admin.Read

Path Parameters

Param	Type	Description
service_id	string	Mandatory Unique ID generated by the server. This can be used as an identifier.

Response Attributes

Attribute	Type	Description
service_id	string	Unique ID generated by the server. This can be used as an identifier.
service_status	int	Integration Status
name	string	Display name for the WebHook.
url	string	URL to be invoked for action execution.
timeout	int	The amount of time a connection waits to time out.
method	string	HTTP Method to access the URL.
is_poller_webhook	boolean	URL to be invoked from an On-Premise poller agent.
poller	string	Denotes On-Premise Poller ID.
send_incident_parameters	boolean	Configuration to send incident parameters while executing the action.
send_custom_parameters	boolean	Configuration to send custom parameters while executing the action.
custom_parameters	string	Custom parameters to be passed while accessing the URL.
send_in_json_format	boolean	Configuration to enable json format for post parameters.
auth_method	string	Authentication method
username	string	Username for Authentication.
password	string	Password for Authentication.
oauth2_provider	string	Provider ID of the OAuth Provider associated with the action.
user_agent	string	User Agent to be used while monitoring the website.
selection_type	int	Resource Type associated with this integration.
monitors	array	Monitors associated with the integration.
alert_tags_id	array	Tag id’s to be associated with the integration.

Update WebHook

PUT /integration/webhooks/{service_id}

Request Example

$ curl https://www.site24x7.com/api/integration/webhooks/113770000023231022 \
    -X PUT \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \
    -d '{
      "name": "Test WebHook",
      "url": "http://requestb.in",
      "is_poller_webhook":false,
      "custom_headers": [
        {
          "name": "Accept-Charset",
          "value": "UTF-8"
        }
      ],
      "timeout": 30,
      "method": "P",
      "auth_method": "B",
      "username": "username",
      "password": "password",
      "send_custom_parameters": true,
      "custom_parameters": "param=value",
      "send_incident_parameters": true,
      "send_in_json_format": true,
      "user_agent": "Mozilla",
      "selection_type":2,
      "monitors":["113770000023231032","113770000023231043"],
      "alert_tags_id": ["113770000023231001", "113770000023231002"]
}'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": {
    "service_id":"113770000023231022",
    "service_status":0,
    "name": "Test WebHook",
    "url": "http://requestb.in",
    "is_poller_webhook":false,
    "custom_headers": [
      {
        "name": "Accept-Charset",
        "value": "UTF-8"
      }
    ],
    "timeout": 30,
    "method": "P",
    "auth_method": "B",
    "username": "username",
    "password": "password",
    "send_custom_parameters": true,
    "custom_parameters": "param=value",
    "send_incident_parameters": true,
    "send_in_json_format": true,
    "user_agent": "Mozilla",
    "selection_type":2,
    "monitors":["113770000023231032","113770000023231043"],
    "alert_tags_id": ["113770000023231001", "113770000023231002"]
  }
}

Update an existing WebHook.

oauthscope : Site24x7.Admin.Update

Path Parameters

Param	Type	Description
service_id	string	Mandatory Unique ID generated by the server. This can be used as an identifier.

Request Parameters

Param	Type	Description
name	string	Mandatory Display name for the WebHook.
url	string	Mandatory URL to be invoked for action execution.
timeout	int	Mandatory The amount of time a connection waits to time out. Range 1 - 45.
method	string	Mandatory HTTP Method to access the URL.
selection_type	int	Mandatory Resource Type associated with this integration. Monitor Group is not supported.
is_poller_webhook	boolean	URL to be invoked from an On-Premise Poller agent.
poller	string	Mandatory, if is_poller_webhook is set as true. Denotes On-Premise Poller ID.
send_incident_parameters	boolean	Configuration to send incident parameters while executing the action.
send_custom_parameters	boolean	Configuration to send custom parameters while executing the action.
custom_parameters	string	Mandatory, if send_custom_parameters is set as true. Custom parameters to be passed while accessing the URL.
send_in_json_format	boolean	Configuration to enable json format for post parameters.
auth_method	string	Authentication method to access the action url.
username	string	Username for Authentication.
password	string	Password for Authentication.
oauth2_provider	string	Provider ID of the OAuth Provider to be associated with the action.
user_agent	string	User Agent to be used while monitoring the website.
monitors	array	Monitors associated with the integration.
alert_tags_id	array	Tag id’s to be associated with the integration.

Response Attributes

Attribute	Type	Description
service_id	string	Unique ID generated by the server. This can be used as an identifier.
service_status	int	Integration Status
name	string	Display name for the WebHook.
url	string	URL to be invoked for action execution.
timeout	int	The amount of time a connection waits to time out.
method	string	HTTP Method to access the URL.
is_poller_webhook	boolean	URL to be invoked from an On-Premise poller agent.
poller	string	Denotes On-Premise Poller ID.
send_incident_parameters	boolean	Configuration to send incident parameters while executing the action.
send_custom_parameters	boolean	Configuration to send custom parameters while executing the action.
custom_parameters	string	Custom parameters to be passed while accessing the URL.
send_in_json_format	boolean	Configuration to enable json format for post parameters.
auth_method	string	Authentication method
username	string	Username for Authentication.
password	string	Password for Authentication.
oauth2_provider	string	Provider ID of the OAuth Provider associated with the action.
user_agent	string	User Agent to be used while monitoring the website.
selection_type	int	Resource Type associated with this integration.
monitors	array	Monitors associated with the integration.
alert_tags_id	array	Tag id’s to be associated with the integration.

Create PagerDuty

POST /integration/pager_duty

Request Example

$ curl https://www.site24x7.com/api/integration/pager_duty \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \
    -d '{
      "name": "Site24x7-PagerDuty Integration",
      "service_key": "f12345678d987654321045690cc1043ag",
      "sender_name":"Site24x7",
      "selection_type":0,
      "title":"$MONITOR_NAME is $STATUS",
      "trouble_alert":false,
      "manual_resolve":false,
      "alert_tags_id": ["113770000023231001"]
}'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": {
    "service_id": "113770000023231022",
    "service_status ": 0,
    "name": "Site24x7-PagerDuty Integration",
    "service_key": "f12345678d987654321045690cc1043ag",
    "sender_name":"Site24x7",
    "selection_type":0,
    "title":"$MONITOR_NAME is $STATUS",
    "trouble_alert":false,
    "manual_resolve":false,
    "alert_tags_id": ["113770000023231001"]
  }
}

Create a new PagerDuty integration.

oauthscope : Site24x7.Admin.Create

Request Parameters

Param	Type	Description
name	string	Mandatory Display name for the integration.
service_key	string	Mandatory Unique integration key provided by PagerDuty to facilitate incident creation in PagerDuty.
sender_name	string	Mandatory Name of the service who posted the incident.
title	string	Mandatory Title of the incident.
selection_type	int	Mandatory Resource Type associated with this integration. Monitor Group is not supported.
trouble_alert	boolean	Configuration to create an incident during a TROUBLE alert.
monitors	array	Monitors associated with the integration.
manual_resolve	boolean	Configuration to resolve the incidents manually when the monitor changes to UP status.
alert_tags_id	array	Tag id’s to be associated with the integration.

Response Attributes

Attribute	Type	Description
service_id	string	Unique ID generated by the server. This can be used as an identifier.
service_status	int	Integration Status
service_key	string	Unique integration key provided by PagerDuty to facilitate incident creation in PagerDuty.
selection_type	int	Resource Type associated with this integration.
name	string	Display name for the integration.
sender_name	string	Name of the service who posted the incident.
title	string	Title of the incident.
trouble_alert	boolean	Configuration to create an incident during a TROUBLE alert.
monitors	array	Monitors associated with the integration.
manual_resolve	boolean	Configuration to resolve the incidents manually when the monitor changes to UP status.
alert_tags_id	array	Tag id’s to be associated with the integration.

Retrieve PagerDuty

GET /integration/pager_duty/{service_id}

Request Example

$ curl https://www.site24x7.com/api/integration/pager_duty/113770000023231022 \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": {
    "service_id": "113770000023231022",
    "service_status ": 0,
    "name": "Site24x7-PagerDuty Integration",
    "service_key": "f12345678d987654321045690cc1043ag",
    "sender_name":"Site24x7",
    "selection_type":0,
    "title":"$MONITOR_NAME is $STATUS",
    "trouble_alert":false,
    "manual_resolve":false,
    "alert_tags_id": ["113770000023231001"]
  }
}

Retrieve configuration of a PagerDuty.

oauthscope : Site24x7.Admin.Read

Path Parameters

Param	Type	Description
service_id	string	Mandatory Unique ID generated by the server. This can be used as an identifier.

Response Attributes

Attribute	Type	Description
service_id	string	Unique ID generated by the server. This can be used as an identifier.
service_status	int	Integration Status
service_key	string	Unique integration key provided by PagerDuty to facilitate incident creation in PagerDuty.
selection_type	int	Resource Type associated with this integration.
name	string	Display name for the integration.
sender_name	string	Name of the service who posted the incident.
title	string	Title of the incident.
trouble_alert	boolean	Configuration to create an incident during a TROUBLE alert.
monitors	array	Monitors associated with the integration.
manual_resolve	boolean	Configuration to resolve the incidents manually when the monitor changes to UP status.
alert_tags_id	array	Tag id’s to be associated with the integration.

Update PagerDuty

PUT /integration/pager_duty/{service_id}

Request Example

$ curl https://www.site24x7.com/api/integration/pager_duty/113770000023231022 \
    -X PUT \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \
    -d '{
      "name": "Site24x7-PagerDuty Integration",
      "service_key": "f12345678d987654321045690cc1043ag",
      "sender_name":"Site24x7",
      "selection_type":0,
      "title":"$MONITOR_NAME is $STATUS",
      "trouble_alert":false,
      "manual_resolve":false,
      "alert_tags_id": ["113770000023231001", "113770000023231002"]
}'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": {
    "service_id": "113770000023231022",
    "service_status ": 0,
    "name": "Site24x7-PagerDuty Integration",
    "service_key": "f12345678d987654321045690cc1043ag",
    "sender_name":"Site24x7",
    "selection_type":0,
    "title":"$MONITOR_NAME is $STATUS",
    "trouble_alert":false,
    "manual_resolve":false,
    "alert_tags_id": ["113770000023231001", "113770000023231002"]
  }
}

Update an existing PagerDuty.

oauthscope : Site24x7.Admin.Update

Path Parameters

Param	Type	Description
service_id	string	Mandatory Unique ID generated by the server. This can be used as an identifier.

Request Parameters

Param	Type	Description
name	string	Mandatory Display name for the integration.
service_key	string	Mandatory Unique integration key provided by PagerDuty to facilitate incident creation in PagerDuty.
sender_name	string	Mandatory Name of the service who posted the incident.
title	string	Mandatory Title of the incident.
selection_type	int	Mandatory Resource Type associated with this integration. Monitor Group is not supported.
trouble_alert	boolean	Configuration to create an incident during a TROUBLE alert.
monitors	array	Monitors associated with the integration.
manual_resolve	boolean	Configuration to resolve the incidents manually when the monitor changes to UP status.
alert_tags_id	array	Tag id’s to be associated with the integration.

Response Attributes

Attribute	Type	Description
service_id	string	Unique ID generated by the server. This can be used as an identifier.
service_status	int	Integration Status
service_key	string	Unique integration key provided by PagerDuty to facilitate incident creation in PagerDuty.
selection_type	int	Resource Type associated with this integration.
name	string	Display name for the integration.
sender_name	string	Name of the service who posted the incident.
title	string	Title of the incident.
trouble_alert	boolean	Configuration to create an incident during a TROUBLE alert.
monitors	array	Monitors associated with the integration.
manual_resolve	boolean	Configuration to resolve the incidents manually when the monitor changes to UP status.
alert_tags_id	array	Tag id’s to be associated with the integration.

Create Slack

POST /integration/slack

Request Example

$ curl https://www.site24x7.com/api/integration/slack \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \
    -d '{
      "name": "Site24x7-Slack Integration",
      "url": "https://hooks.slack.com/services/B27AG46BW/W27JLYuDE/acc3vmmJIGrNuBG9CVRwiBxU",
      "sender_name":"Site24x7",
      "selection_type":0,
      "title":"$MONITOR_NAME is $STATUS",
      "alert_tags_id": ["113770000023231001"]
}'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": {
    "service_id": "113770000023231022",
    "service_status ": 0,
    "name": "Site24x7-Slack Integration",
    "url": "https://hooks.slack.com/services/B27AG46BW/W27JLYuDE/acc3vmmJIGrNuBG9CVRwiBxU",
    "sender_name":"Site24x7",
    "selection_type":0,
    "title":"$MONITOR_NAME is $STATUS",
    "alert_tags_id": ["113770000023231001"]
  }
}

Create a new Slack integration.

oauthscope : Site24x7.Admin.Create

Request Parameters

Param	Type	Description
name	string	Mandatory Display name for the integration.
sender_name	string	Mandatory Name of the service who posted the message.
url	string	Mandatory Hook URL to which the message will be posted.
title	string	Mandatory Title of the incident.
selection_type	int	Mandatory Resource Type associated with this integration. Monitor Group is not supported.
monitors	array	Monitors associated with the integration
alert_tags_id	array	Tag id’s to be associated with the integration.

Response Attributes

Attribute	Type	Description
service_id	string	Unique ID generated by the server. This can be used as an identifier.
service_status	int	Integration Status
name	string	Display name for the integration.
sender_name	string	Name of the service who posted the message.
url	string	Hook URL to which the message will be posted.
title	string	Title of the incident.
selection_type	int	Resource Type associated to this integration.
monitors	array	Monitors associated with the integration.
alert_tags_id	array	Tag id’s to be associated with the integration.

Retrieve slack

GET /integration/slack/{service_id}

Request Example

$ curl https://www.site24x7.com/api/integration/slack/113770000023231022 \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": {
    "service_id": "113770000023231022",
    "service_status ": 0,
    "name": "Site24x7-Slack Integration",
    "url": "https://hooks.slack.com/services/B27AG46BW/W27JLYuDE/acc3vmmJIGrNuBG9CVRwiBxU",
    "sender_name":"Site24x7",
    "selection_type":0,
    "title":"$MONITOR_NAME is $STATUS",
    "alert_tags_id": ["113770000023231001"]
  }
}

Retrieve configuration of a slack.

oauthscope : Site24x7.Admin.Read

Path Parameters

Param	Type	Description
service_id	string	Mandatory Unique ID generated by the server. This can be used as an identifier.

Response Attributes

Attribute	Type	Description
service_id	string	Unique ID generated by the server. This can be used as an identifier.
service_status	int	Integration Status
url	string	Hook URL to which the message will be posted.
name	string	Display name for the integration.
sender_name	string	Name of the service who posted the incident.
title	string	Title of the incident.
selection_type	int	Resource Type associated with this integration.
monitors	array	Monitors associated with the integration.
alert_tags_id	array	Tag id’s to be associated with the integration.

Update Slack

PUT /integration/slack/{service_id}

Request Example

$ curl https://www.site24x7.com/api/integration/slack/113770000023231022 \
    -X PUT \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \
    -d '{
      "name": "Site24x7-Slack Integration",
      "url": "https://hooks.slack.com/services/B27AG46BW/W27JLYuDE/acc3vmmJIGrNuBG9CVRwiBxU",
      "sender_name":"Site24x7",
      "selection_type":2,
      "monitors":["113770000023231032","113770000023231043"],
      "title":"$MONITOR_NAME is $STATUS",
      "alert_tags_id": ["113770000023231001", "113770000023231002"]
}'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": {
    "service_id": "113770000023231022",
    "service_status ": 0,
    "name": "Site24x7-Slack Integration",
    "url": "https://hooks.slack.com/services/B27AG46BW/W27JLYuDE/acc3vmmJIGrNuBG9CVRwiBxU",
    "sender_name":"Site24x7",
    "selection_type":2,
    "monitors":["113770000023231032","113770000023231043"],
    "title":"$MONITOR_NAME is $STATUS",
    "alert_tags_id": ["113770000023231001", "113770000023231002"]
  }
}

Update an existing Slack.

oauthscope : Site24x7.Admin.Update

Path Parameters

Param	Type	Description
service_id	string	Mandatory Unique ID generated by the server. This can be used as an identifier.

Request Parameters

Param	Type	Description
name	string	Mandatory Display name for the integration.
sender_name	string	Mandatory Name of the service who posted the message.
url	string	Mandatory Hook URL to which the message will be posted.
title	string	Mandatory Title of the incident.
selection_type	int	Mandatory Resource Type associated to this integration. Monitor Group is not supported.
monitors	array	Monitors associated with the integration
alert_tags_id	array	Tag id’s to be associated with the integration.

Response Attributes

Attribute	Type	Description
service_id	string	Unique ID generated by the server. This can be used as an identifier.
service_status	int	Integration Status
name	string	Display name for the integration.
sender_name	string	Name of the service who posted the message.
url	string	Hook URL to which the message will be posted.
title	string	Title of the incident.
selection_type	int	Resource Type associated to this integration.
monitors	array	Monitors associated with the integration.
alert_tags_id	array	Tag id’s to be associated with the integration.

Create Hipchat

POST /integration/hipchat

Request Example

$ curl https://www.site24x7.com/api/integration/hipchat \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \
    -d '{
      "name": "Site24x7-Hipchat Integration",
      "url": "https://s247hipchat.hipchat.com/v2/room/8023124/notification?auth_token=k2HvdZcyiRHwoqJNMWE7FuioXXertyuQU3hbLVm6",
      "sender_name":"Site24x7",
      "selection_type":0,
      "title":"$MONITOR_NAME is $STATUS"
}'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": {
    "service_id": "113770000023231022",
    "service_status ": 0,
    "name": "Site24x7-Hipchat Integration",
    "url": "https://s247hipchat.hipchat.com/v2/room/8023124/notification?auth_token=k2HvdZcyiRHwoqJNMWE7FuioXXertyuQU3hbLVm6",
    "sender_name":"Site24x7",
    "selection_type":0,
    "title":"$MONITOR_NAME is $STATUS"
  }
}

Create a new Hipchat integration.

oauthscope : Site24x7.Admin.Create

Request Parameters

Param	Type	Description
name	string	Mandatory Display name for the integration.
sender_name	string	Mandatory Name of the service who posted the message.
url	string	Mandatory Hook URL to which the message will be posted.
title	string	Mandatory Title of the incident.
selection_type	int	Mandatory Resource Type associated with this integration. Monitor Group is not supported.
monitors	array	Monitors associated with the integration

Response Attributes

Attribute	Type	Description
service_id	string	Unique ID generated by the server. This can be used as an identifier.
service_status	int	Integration Status
name	string	Display name for the integration.
sender_name	string	Name of the service who posted the message.
url	string	Hook URL to which the message will be posted.
title	string	Title of the incident.
selection_type	int	Resource Type associated with this integration.
monitors	array	Monitors associated with the integration.

Retrieve Hipchat

GET /integration/hipchat/{service_id}

Request Example

$ curl https://www.site24x7.com/api/hipchat/113770000023231022 \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": {
    "service_id": "113770000023231022",
    "service_status ": 0,
    "name": "Site24x7-Hipchat Integration",
    "url": "https://s247hipchat.hipchat.com/v2/room/8023124/notification?auth_token=k2HvdZcyiRHwoqJNMWE7FuioXXertyuQU3hbLVm6",
    "sender_name":"Site24x7",
    "selection_type":0,
    "title":"$MONITOR_NAME is $STATUS"
  }
}

Retrieve configuration of a Hipchat.

oauthscope : Site24x7.Admin.Read

Path Parameters

Param	Type	Description
service_id	string	Mandatory Unique ID generated by the server. This can be used as an identifier.

Response Attributes

Attribute	Type	Description
service_id	string	Unique ID generated by the server. This can be used as an identifier.
service_status	int	Integration Status
url	string	Mandatory Hook URL to which the message will be posted.
name	string	Display name for the integration.
sender_name	string	Name of the service who posted the incident.
title	string	Title of the incident.
selection_type	int	Resource Type associated with this integration. Monitor Group is not supported.
monitors	array	Monitors associated with the integration.

Update Hipchat

PUT /integration/hipchat/{service_id}

Request Example

$ curl https://www.site24x7.com/api/integration/hipchat/113770000023231022 \
    -X PUT \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \
    -d '{
      "name": "Site24x7-Hipchat Integration",
      "url": "https://s247hipchat.hipchat.com/v2/room/8023124/notification?auth_token=k2HvdZcyiRHwoqJNMWE7FuioXXertyuQU3hbLVm6",
      "sender_name":"Site24x7",
      "selection_type":2,
      "monitors":["113770000023231032","113770000023231043"],
      "title":"$MONITOR_NAME is $STATUS"
}'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": {
    "service_id": "113770000023231022",
    "service_status ": 0,
    "name": "Site24x7-Hipchat Integration",
    "url": "https://s247hipchat.hipchat.com/v2/room/8023124/notification?auth_token=k2HvdZcyiRHwoqJNMWE7FuioXXertyuQU3hbLVm6",
    "sender_name":"Site24x7",
    "selection_type":2,
    "monitors":["113770000023231032","113770000023231043"],
    "title":"$MONITOR_NAME is $STATUS"
  }
}

Update an existing Hipchat.

oauthscope : Site24x7.Admin.Update

Path Parameters

Param	Type	Description
service_id	string	Mandatory Unique ID generated by the server. This can be used as an identifier.

Request Parameters

Param	Type	Description
name	string	Mandatory Display name for the integration.
sender_name	string	Mandatory Name of the service who posted the message.
url	string	Mandatory Hook URL to which the message will be posted.
title	string	Mandatory Title of the incident.
selection_type	int	Mandatory Resource Type associated with this integration. Monitor Group is not supported.
monitors	array	Monitors associated with the integration

Response Attributes

Attribute	Type	Description
service_id	string	Unique ID generated by the server. This can be used as an identifier.
service_status	int	Integration Status
name	string	Display name for the integration.
sender_name	string	Name of the service who posted the message.
url	string	Hook URL to which the message will be posted.
title	string	Title of the incident.
selection_type	int	Resource Type associated with this integration.
monitors	array	Monitors associated with the integration.

Create OpsGenie

POST /integration/opsgenie

Request Example

$ curl https://www.site24x7.com/api/integration/opsgenie \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \
    -d '{
      "name": "OpsGenie Integration With Site24x7",
      "url": "https://api.opsgenie.com/v1/json/site24x7?apiKey=a19y1cdd-bz7a-455a-z4b1-c1528323502s",
      "selection_type":2,
      "monitors":["6111000000000068", "6111000000000130", "6111000000015045", "6111000000015057", "6111000000015069", "6111000000015083"],
      "trouble_alert":false,
      "manual_resolve":false,
      "alert_tags_id": ["113770000023231001"]
}'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": {
    "service_id":"61110000000524211",
    "service_status":0,
    "name": "OpsGenie Integration With Site24x7",
    "url": "https://api.opsgenie.com/v1/json/site24x7?apiKey=a19y1cdd-bz7a-455a-z4b1-c1528323502s",
    "selection_type":2,
    "monitors":["6111000000000068", "6111000000000130", "6111000000015045", "6111000000015057", "6111000000015069", "6111000000015083"],
    "trouble_alert":false,
    "manual_resolve":false,
    "alert_tags_id": ["113770000023231001"]
  }
}

Create a new OpsGenie.

oauthscope : Site24x7.Admin.Create

Request Parameters

Param	Type	Description
name	string	Mandatory Display name for the OpsGenie Integration.
url	string	Mandatory URL to be invoked for action execution.
selection_type	int	Mandatory Resource Type associated with this integration. Monitor Group not supported.
monitors	array	Monitors associated with the integration.
trouble_alert	boolean	Configuration to create an incident during a TROUBLE alert.
manual_resolve	boolean	Configuration to resolve the incidents manually when the monitor changes to UP status.
alert_tags_id	array	Tag id’s to be associated with the integration.

Response Attributes

Attribute	Type	Description
service_id	string	Unique ID generated by the server. This can be used as an identifier.
service_status	int	Integration Status
name	string	Display name for the OpsGenie Integration.
url	string	URL to be invoked for action execution.
selection_type	int	Resource Type associated with this integration.
monitors	array	Monitors associated with the integration.
trouble_alert	boolean	Configuration to create an incident during a TROUBLE alert.
manual_resolve	boolean	Configuration to resolve the incidents manually when the monitor changes to UP status.
alert_tags_id	array	Tag id’s to be associated with the integration.

Retrieve OpsGenie

GET /integration/opsgenie/{service_id}

Request Example

$ curl https://www.site24x7.com/api/integration/opsgenie/113770000023231022 \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": {
    "service_id":"113770000023231022",
    "service_status":0,
    "name": "OpsGenie Integration With Site24x7",
    "url": "https://api.opsgenie.com/v1/json/site24x7?apiKey=a19y1cdd-bz7a-455a-z4b1-c1528323502s",
    "selection_type":2,
    "monitors":["6111000000000068", "6111000000000130", "6111000000015045", "6111000000015057", "6111000000015069", "6111000000015083"],
    "trouble_alert":false,
    "manual_resolve":false,
    "alert_tags_id": ["113770000023231001"]
  }
}

Retrieve configuration of a OpsGenie.

oauthscope : Site24x7.Admin.Read

Path Parameters

Param	Type	Description
service_id	string	Mandatory Unique ID generated by the server. This can be used as an identifier.

Response Attributes

Attribute	Type	Description
service_id	string	Unique ID generated by the server. This can be used as an identifier.
service_status	int	Integration Status
name	string	Display name for the OpsGenie Integration.
url	string	URL to be invoked for action execution.
selection_type	int	Resource Type associated with this integration.
monitors	array	Monitors associated with the integration.
trouble_alert	boolean	Configuration to create an incident during a TROUBLE alert.
manual_resolve	boolean	Configuration to resolve the incidents manually when the monitor changes to UP status.
alert_tags_id	array	Tag id’s to be associated with the integration.

Update OpsGenie

PUT /integration/opsgenie/{service_id}

Request Example

$ curl https://www.site24x7.com/api/integration/opsgenie/113770000023231022 \
    -X PUT \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \
    -d '{
      "name": "Update OpsGenie Integration With Site24x7",
      "url": "https://api.opsgenie.com/v1/json/site24x7?apiKey=a19y1cdd-bz7a-455a-z4b1-c1528323502s",
      "selection_type":2,
      "monitors":["6111000000000068", "6111000000000130", "6111000000015045"],
      "trouble_alert":false,
      "manual_resolve":false,
      "alert_tags_id": ["113770000023231001", "113770000023231002"]

}'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": {
    "service_id":"113770000023231022",
    "service_status":0,
    "name": "Update OpsGenie Integration With Site24x7",
    "url": "https://api.opsgenie.com/v1/json/site24x7?apiKey=a19y1cdd-bz7a-455a-z4b1-c1528323502s",
    "selection_type":2,
    "monitors":["6111000000000068", "6111000000000130", "6111000000015045"],
    "trouble_alert":false,
    "manual_resolve":false,
    "alert_tags_id": ["113770000023231001", "113770000023231002"]

  }
}

Update an existing OpsGenie.

oauthscope : Site24x7.Admin.Update

Path Parameters

Param	Type	Description
service_id	string	Mandatory Unique ID generated by the server. This can be used as an identifier.

Request Parameters

Param	Type	Description
name	string	Mandatory Display name for the OpsGenie Integration.
url	string	Mandatory URL to be invoked for action execution.
selection_type	int	Mandatory Resource Type associated with this integration. Monitor Group is not supported.
monitors	array	Monitors associated with the integration.
trouble_alert	boolean	Configuration to create an incident during a TROUBLE alert.
manual_resolve	boolean	Configuration to resolve the incidents manually when the monitor changes to UP status.
alert_tags_id	array	Tag id’s to be associated with the integration.

Response Attributes

Attribute	Type	Description
service_id	string	Unique ID generated by the server. This can be used as an identifier.
service_status	int	Integration Status
name	string	Display name for the OpsGenie Integration.
url	string	URL to be invoked for action execution.
selection_type	int	Resource Type associated with this integration.
monitors	array	Monitors associated with the integration.
trouble_alert	boolean	Configuration to create an incident during a TROUBLE alert.
manual_resolve	boolean	Configuration to resolve the incidents manually when the monitor changes to UP status.
alert_tags_id	array	Tag id’s to be associated with the integration.

Create ServiceNow

POST /integration/service_now

Request Example

$ curl https://www.site24x7.com/api/integration/service_now \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \
    -d '{
      "name": "Test ServiceNow",
      "instance_url": "https://zylker.service-now.com",
      "sender_name":"Site24x7",
      "action_on_availability": 1,
      "username": "username",
      "password": "password",
      "send_custom_parameters": true,
      "custom_parameters": "param=value \n param2=value2",
      "trouble_alert": true,
      "title": "$MONITORNAME is $STATUS from $FAILED_LOCATIONS",
      "selection_type":2,
      "monitors":["113770000023231032","113770000023231043"],
      "alert_tags_id": ["113770000023231001"]
}'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": {
      "service_id":"113770000023231022",
      "service_status":0,
      "name": "Test ServiceNow",
      "instance_url": "https://zylker.service-now.com",
      "sender_name":"Site24x7",
      "action_on_availability": 1,
      "username": "username",
      "password": "password",
      "send_custom_parameters": true,
      "custom_parameters": "param=value \n param2=value2",
      "trouble_alert": true,
      "title": "$MONITORNAME is $STATUS from $FAILED_LOCATIONS",
      "selection_type":2,
      "monitors":["113770000023231032","113770000023231043"],
      "alert_tags_id": ["113770000023231001"]
  }
}

Create a new ServiceNow Integration.

oauthscope : Site24x7.Admin.Create

Request Parameters

Param	Type	Description
name	string	Mandatory Display name for the ServiceNow integration.
instance_url	string	Mandatory ServiceNow instance URL.
selection_type	int	Mandatory Resource Type associated with this integration. Monitor Group not supported.
send_custom_parameters	boolean	Configuration to send custom parameters while executing the action.
custom_parameters	string	Mandatory, if send_custom_parameters is set as true. Custom parameters to be passed as JSON while accessing the ServiceNow Instance URL.
username	string	Mandatory Username for Authentication.
password	string	Mandatory Password for Authentication.
sender_name	string	ServiceNow caller id who posted the incident.
title	string	Title of the incident.
trouble_alert	boolean	Configuration to create an incident during a TROUBLE alert.
action_on_availability	int	Provide the configuration settings to resolve or close incidents automatically in ServiceNow, when the monitor’s status changes to UP. Add “1” to resolve an incident and “2” to close an incident automatically. Add “0” to resolve an incident manually.
monitors	array	Monitors associated with the integration.
alert_tags_id	array	Tag id’s to be associated with the integration.

Response Attributes

Attribute	Type	Description
service_id	string	Unique ID generated by the server. This can be used as an identifier.
service_status	int	Integration Status
name	string	Display name for the ServiceNow integration.
instance_url	string	ServiceNow instance URL.
send_custom_parameters	boolean	Configuration to send custom parameters while executing the action.
custom_parameters	string	Custom parameters to be passed while accessing the URL.
username	string	Username for Authentication.
password	string	Password for Authentication.
selection_type	int	Resource Type associated with this integration.
monitors	array	Monitors associated with the integration.
sender_name	string	ServiceNow caller id who posted the incident.
title	string	Title of the incident.
trouble_alert	boolean	Configuration to create an incident during a TROUBLE alert.
action_on_availability	int	Configuration settings to resolve or close incidents automatically in ServiceNow, when the monitor’s status changes to UP. Add “1” to resolve an incident and “2” to close an incident automatically. Add “0” to resolve an incident manually.
alert_tags_id	array	Tag id’s to be associated with the integration.

Retrieve ServiceNow Integration.

GET /integration/service_now/{service_id}

Request Example

$ curl https://www.site24x7.com/api/integration/service_now/113770000023231022 \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": {
      "service_id":"113770000023231022",
      "service_status":0,
      "name": "Test ServiceNow",
      "instance_url": "https://zylker.service-now.com",
      "sender_name":"Site24x7",
      "action_on_availability": 1,
      "username": "username",
      "password": "password",
      "send_custom_parameters": true,
      "custom_parameters": "param=value \n param2=value2",
      "trouble_alert": true,
      "title": "$MONITORNAME is $STATUS from $FAILED_LOCATIONS",
      "selection_type":2,
      "monitors":["113770000023231032","113770000023231043"],
      "alert_tags_id": ["113770000023231001"]
  }
}

Retrieve configuration of a ServiceNow Integration.

oauthscope : Site24x7.Admin.Read

Path Parameters

Param	Type	Description
service_id	string	Mandatory Unique ID generated by the server. This can be used as an identifier.

Response Attributes

Attribute	Type	Description
service_id	string	Unique ID generated by the server. This can be used as an identifier.
service_status	int	Integration Status
name	string	Display name for the ServiceNow integration.
instance_url	string	ServiceNow instance URL.
send_custom_parameters	boolean	Configuration to send custom parameters while executing the action.
custom_parameters	string	Custom parameters to be passed as JSON while accessing the ServiceNow Instance URL.
username	string	Username for Authentication.
password	string	Password for Authentication.
selection_type	int	Resource Type associated with this integration.
monitors	array	Monitors associated with the integration.
sender_name	string	ServiceNow caller id who posted the incident.
title	string	Title of the incident.
trouble_alert	boolean	Configuration to create an incident during a TROUBLE alert.
action_on_availability	int	Provide the configuration settings to resolve or close incidents automatically in ServiceNow, when the monitor’s status changes to UP. Add “1” to resolve an incident and “2” to close an incident automatically. Add “0” to resolve an incident manually.
alert_tags_id	array	Tag id’s to be associated with the integration.

Update ServiceNow

PUT /integration/service_now/{service_id}

Request Example

$ curl https://www.site24x7.com/api/integration/service_now/113770000023231022 \
    -X PUT \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \
    -d '{
      "name": "Test ServiceNow",
      "instance_url": "https://zylker.service-now.com",
      "sender_name":"Site24x7",
      "action_on_availability": 1,
      "username": "username",
      "password": "password",
      "send_custom_parameters": true,
      "custom_parameters": "param=value \n param2=value2",
      "trouble_alert": true,
      "title": "$MONITORNAME is $STATUS from $FAILED_LOCATIONS",
      "selection_type":0,
      "alert_tags_id": ["113770000023231001", "113770000023231002"]
      }'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": {
    "service_id":"113770000023231022",
      "service_status":0,
      "name": "Test ServiceNow",
      "instance_url": "https://zylker.service-now.com",
      "sender_name":"Site24x7",
      "action_on_availability": 1,
      "username": "username",
      "password": "password",
      "send_custom_parameters": true,
      "custom_parameters": "param=value \n param2=value2",
      "trouble_alert": true,
      "title": "$MONITORNAME is $STATUS from $FAILED_LOCATIONS",
      "selection_type":0,
      "alert_tags_id": ["113770000023231001", "113770000023231002"]
  }
}

Update an existing ServiceNow Integration.

oauthscope : Site24x7.Admin.Update

Path Parameters

Param	Type	Description
service_id	string	Mandatory Unique ID generated by the server. This can be used as an identifier.

Request Parameters

Param	Type	Description
name	string	Mandatory Display name for the ServiceNow integration.
instance_url	string	Mandatory ServiceNow instance URL.
selection_type	int	Mandatory Resource Type associated with this integration. Monitor Group not supported.
send_custom_parameters	boolean	Configuration to send custom parameters while executing the action.
custom_parameters	string	Mandatory, if send_custom_parameters is set as true. Custom parameters to be passed as JSON while accessing the ServiceNow Instance URL.
username	string	Mandatory Username for Authentication.
password	string	Mandatory Password for Authentication.
sender_name	string	ServiceNow caller id who posted the incident.
title	string	Title of the incident.
trouble_alert	boolean	Configuration to create an incident during a TROUBLE alert.
action_on_availability	int	Provide the configuration settings to resolve or close incidents automatically in ServiceNow, when the monitor’s status changes to UP. Add “1” to resolve an incident and “2” to close an incident automatically. Add “0” to resolve an incident manually.
monitors	array	Monitors associated with the integration.
alert_tags_id	array	Tag id’s to be associated with the integration.

Response Attributes

Attribute	Type	Description
service_id	string	Unique ID generated by the server. This can be used as an identifier.
service_status	int	Integration Status
name	string	Display name for the ServiceNow integration.
instance_url	string	ServiceNow instance URL.
send_custom_parameters	boolean	Configuration to send custom parameters while executing the action.
custom_parameters	string	Custom parameters to be passed as JSON while accessing the ServiceNow Instance URL.
username	string	Username for Authentication.
password	string	Password for Authentication.
selection_type	int	Resource Type associated with this integration.
monitors	array	Monitors associated with the integration.
sender_name	string	ServiceNow caller id who posted the incident.
title	string	Title of the incident.
trouble_alert	boolean	Configuration to create an incident during a TROUBLE alert.
action_on_availability	int	Provide the configuration settings to resolve or close incidents automatically in ServiceNow, when the monitor’s status changes to UP. Add “1” to resolve an incident and “2” to close an incident automatically. Add “0” to resolve an incident manually.
alert_tags_id	array	Tag id’s to be associated with the integration.

Create ConnectWise

POST /integration/connectwise

Request Example

$ curl https://www.site24x7.com/api/integration/connectwise \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \
    -d '{
      "name": "Test ConnectWise",
      "url": "https://api-staging.connectwisedev.com/v2019_4",
      "selection_type":2,
      "company": "zylker_c",
      "public_key": "KaxKPKiP88i6rmAb",
      "private_key": "Fkb7dlqwhQGIxcc5",
      "company_id": "GreenInc",
      "send_custom_parameters": true,
      "custom_parameters": "City=Chennai \n Source={name=Phone}",
      "monitors":["113770000023231032","113770000023231043"],
      "critical_alert": true,
      "trouble_alert":true,
      "manual_resolve":false,
      "close_status":"Resolved",
      "alert_tags_id": ["113770000023231001"]
}'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "success",
    "data": {
        "name": "Test ConnectWise",
        "url": "https://api-staging.connectwisedev.com/v2019_4",
        "selection_type": 2,
        "company": "zylker_c",
        "public_key": "KaxKPKiP88i6rmAb",
        "private_key": "Fkb7dlqwhQGIxcc5",
        "company_id": "GreenInc",
        "send_custom_parameters": true,
        "custom_parameters": "City=Chennai \n Source={name=Phone}",
        "monitors":["113770000023231032","113770000023231043"],
        "critical_alert": true,
        "service_status": 0,
        "service_id": "12977000000074123",
        "manual_resolve": false,
        "trouble_alert": true,
        "close_status":"Resolved",
        "alert_tags_id": ["113770000023231001"]
    }
}

Create a new ConnectWise.

oauthscope : Site24x7.Admin.Create

Request Parameters

Param	Type	Description
name	string	Mandatory Display name for the ConnectWise Integration.
url	string	Mandatory URL to be invoked for action execution.
company	string	Mandatory Company for Authentication.
public_key	string	Mandatory Public Key for Authentication.
private_key	string	Mandatory Private Key for Authentication.
company_id	string	Mandatory Tickets to your ConnectWise account will be assigned to this Company ID.
selection_type	int	Mandatory Resource Type associated with this integration. Monitor Group not supported.
monitors	array	Monitors associated with the integration.
send_custom_parameters	boolean	Configuration to send custom parameters while executing the action.
custom_parameters	string	Mandatory, if send_custom_parameters is set as true. Custom parameters to be passed while accessing the URL.
trouble_alert	boolean	Configuration to create an incident during a TROUBLE alert.
critical_alert	boolean	Configuration to create an incident during a CRITICAL alert.
manual_resolve	boolean	Configuration to resolve the incidents manually when the monitor changes to UP status.
close_status	string	Mandatory, if manual_resolve is set as false. Provide the configuration settings to resolve or close incidents automatically in Connectwise, when the monitor status changes to UP.
alert_tags_id	array	Tag id’s to be associated with the integration.

Response Attributes

Attribute	Type	Description
service_id	string	Unique ID generated by the server. This can be used as an identifier.
service_status	int	Integration Status
name	string	Display name for the ConnectWise Integration.
url	string	URL to be invoked for action execution.
selection_type	int	Resource Type associated with this integration.
monitors	array	Monitors associated with the integration.
company	string	Company for Authentication.
public_key	string	Public Key for Authentication.
private_key	string	Private Key for Authentication.
company_id	string	Tickets to your ConnectWise account will be assigned to this Company ID.
send_custom_parameters	boolean	Configuration to send custom parameters while executing the action.
custom_parameters	string	Custom parameters to be passed while accessing the URL.
trouble_alert	boolean	Configuration to create an incident during a TROUBLE alert.
critical_alert	boolean	Configuration to create an incident during a CRITICAL alert.
manual_resolve	boolean	Configuration to resolve the incidents manually when the monitor changes to UP status.
close_status	string	Configuration settings to resolve or close incidents automatically in ConnectWise, when the monitor status changes to UP.
alert_tags_id	array	Tag id’s to be associated with the integration.

Retrieve ConnectWise

GET /integration/connectwise/{service_id}

Request Example

$ curl https://www.site24x7.com/api/integration/connectwise/12977000000074123 \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": {
        "url": "https://api-staging.connectwisedev.com/v2019_4",
        "name": "Test ConnectWise",
        "private_key": "KaxKPKiP88i6rmAb",
        "public_key": "Fkb7dlqwhQGIxcc5",
        "company_id": "GreenInc",
        "selection_type": 2,
        "monitors":["113770000023231032","113770000023231043"]
        "send_custom_parameters": true,
        "custom_parameters": "City=Chennai \n Source={name=Phone}",
        "critical_alert": true,
        "service_status": 0,
        "service_id": "12977000000074123",
        "company": "zylker_c",
        "manual_resolve": false,
        "trouble_alert": true,
        "close_status":"Resolved",
        "alert_tags_id": ["113770000023231001"]
  }
}

Retrieve configuration of a ConnectWise.

oauthscope : Site24x7.Admin.Read

Path Parameters

Param	Type	Description
service_id	string	Mandatory Unique ID generated by the server. This can be used as an identifier.

Response Attributes

Attribute	Type	Description
service_id	string	Unique ID generated by the server. This can be used as an identifier.
service_status	int	Integration Status
name	string	Display name for the ConnectWise Integration.
url	string	URL to be invoked for action execution.
company	string	Company for Authentication.
public_key	string	Public Key for Authentication.
private_key	string	Private Key for Authentication.
company_id	string	Tickets to your ConnectWise account will be assigned to this Company ID.
selection_type	int	Resource Type associated with this integration.
monitors	array	Monitors associated with the integration.
send_custom_parameters	boolean	Configuration to send custom parameters while executing the action.
custom_parameters	string	Custom parameters to be passed while accessing the URL.
trouble_alert	boolean	Configuration to create an incident during a TROUBLE alert.
critical_alert	boolean	Configuration to create an incident during a CRITICAL alert.
manual_resolve	boolean	Configuration to resolve the incidents manually when the monitor changes to UP status.
close_status	string	Configuration settings to resolve or close incidents automatically in ConnectWise, when the monitor status changes to UP.
alert_tags_id	array	Tag id’s to be associated with the integration.

Update ConnectWise

PUT /integration/connectwise/{service_id}

Request Example

$ curl https://www.site24x7.com/api/integration/connectwise/12977000000074123 \
    -X PUT \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \
    -d '{
      "name": "Test ConnectWise",
      "url": "https://api-staging.connectwisedev.com/v2019_4",
      "selection_type":0,
      "company": "zylker_c",
      "public_key": "KaxKPKiP88i6rmAb",
      "send_custom_parameters": true,
      "custom_parameters": "City=Chennai \n Source={name=Phone}"
      "private_key": "Fkb7dlqwhQGIxcc5",
      "company_id": "BigInc",
      "critical_alert": true,
      "trouble_alert":true,
      "manual_resolve":false,
      "close_status":"Resolved",
      "alert_tags_id": ["113770000023231001", "113770000023231002"]
}'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": {
        "url": "https://api-staging.connectwisedev.com/v2019_4",
        "name": "Test ConnectWise",
        "private_key": "Fkb7dlqwhQGIxcc5",
        "public_key": "KaxKPKiP88i6rmAb",
        "company_id": "BigInc",
        "selection_type": 0,
        "critical_alert": true,
        "send_custom_parameters": true,
        "custom_parameters": "City=Chennai \n Source={name=Phone}",
        "service_status": 0,
        "service_id": "12977000000074123",
        "company": "zylker_c",
        "manual_resolve": false,
        "trouble_alert": true,
        "close_status":"Resolved",
        "alert_tags_id": ["113770000023231001", "113770000023231002"]
  }
}

Update an existing ConnectWise.

oauthscope : Site24x7.Admin.Update

Path Parameters

Param	Type	Description
service_id	string	Mandatory Unique ID generated by the server. This can be used as an identifier.

Request Parameters

Param	Type	Description
name	string	Mandatory Display name for the ConnectWise Integration.
url	string	Mandatory URL to be invoked for action execution.
selection_type	int	Mandatory Resource Type associated with this integration. Monitor Group is not supported.
company	string	Mandatory Company for Authentication.
public_key	string	Mandatory Public Key for Authentication.
private_key	string	Mandatory Private Key for Authentication.
send_custom_parameters	boolean	Configuration to send custom parameters while executing the action.
custom_parameters	string	Mandatory, if send_custom_parameters is set as true. Custom parameters to be passed while accessing the URL.
company_id	string	Mandatory Tickets to your ConnectWise account will be assigned to this Company ID.
trouble_alert	boolean	Configuration to create an incident during a TROUBLE alert.
critical_alert	boolean	Configuration to create an incident during a CRITICAL alert.
manual_resolve	boolean	Configuration to resolve the incidents manually when the monitor changes to UP status.
close_status	string	Mandatory, if manual_resolve is set as false. Provide the configuration settings to resolve or close incidents automatically in Connectwise, when the monitor status changes to UP.
alert_tags_id	array	Tag id’s to be associated with the integration.

Response Attributes

Attribute	Type	Description
service_id	string	Unique ID generated by the server. This can be used as an identifier.
service_status	int	Integration Status
name	string	Display name for the ConnectWise Integration.
url	string	URL to be invoked for action execution.
selection_type	int	Resource Type associated with this integration.
company	string	Company for Authentication.
public_key	string	Public Key for Authentication.
private_key	string	Private Key for Authentication.
company_id	string	Tickets to your ConnectWise account will be assigned to this Company ID.
send_custom_parameters	boolean	Configuration to send custom parameters while executing the action.
custom_parameters	string	Custom parameters to be passed while accessing the URL.
trouble_alert	boolean	Configuration to create an incident during a TROUBLE alert.
critical_alert	boolean	Configuration to create an incident during a CRITICAL alert.
manual_resolve	boolean	Configuration to resolve the incidents manually when the monitor changes to UP status.
close_status	string	Configuration settings to resolve or close incidents automatically in ConnectWise, when the monitor status changes to UP.
alert_tags_id	array	Tag id’s to be associated with the integration.

Create Stride Integration

POST /integration/stride

Request Example

$ curl https://www.site24x7.com/api/integration/stride \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \
    -d '{
      "name": "Site24x7-Stride Integration",
      "url": "https://api.atlassian.com/site/1aa8sd54-f801-440a-a8f7-5bec2s3dc43b/conversation/3c079e3-cfba-40f4-bb36-9284c115s8d3/message",
      "access_token":"8Gu7xjh3gF1qj76sasv",
      "selection_type":2,
      "title":"$MONITOR_NAME is $STATUS",
      "monitors":["113770000023231032","113770000023231043"]
}'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": {
    "service_id": "113770000023231022",
    "service_status ": 0,
    "name": "Site24x7-Stride Integration",
    "url": "https://api.atlassian.com/site/1aa8sd54-f801-440a-a8f7-5bec2s3dc43b/conversation/3c079e3-cfba-40f4-bb36-9284c115s8d3/message",
    "access_token":"8Gu7xjh3gF1qj76sasv",
    "selection_type":2,
    "monitors":["113770000023231032","113770000023231043"],
    "title":"$MONITOR_NAME is $STATUS"
  }
}

Create a new Stride integration.

oauthscope : Site24x7.Admin.Create

Request Parameters

Param	Type	Description
name	string	Mandatory Display name for the integration.
url	string	Mandatory Stride Conversation URL to which the message will be posted.
access_token	string	Mandatory Stride access token.
title	string	Mandatory Title of the incident.
selection_type	int	Mandatory Resource Type associated with this integration. Monitor Group is not supported.
monitors	array	Monitors associated with the integration

Response Attributes

Attribute	Type	Description
service_id	string	Unique ID generated by the server. This can be used as an identifier.
service_status	int	Actual operational status of the integration. Integration Status
name	string	Display name for the integration.
access_token	string	Stride access token.
url	string	Stride Conversation URL to which the message will be posted.
title	string	Title of the incident.
selection_type	int	Resource Type associated with this integration.
monitors	array	Monitors associated with the integration.

Retrieve Stride

GET /integration/stride/{service_id}

Request Example

$ curl https://www.site24x7.com/api/stride/113770000023231022 \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": {
    "service_id": "113770000023231022",
    "service_status ": 0,
    "name": "Site24x7-Stride Integration",
    "url": "https://api.atlassian.com/site/1aa8sd54-f801-440a-a8f7-5bec2s3dc43b/conversation/3c079e3-cfba-40f4-bb36-9284c115s8d3/message",
    "access_token":"8Gu7xjh3gF1qj76sasv",
    "selection_type":2,
    "monitors":["113770000023231032","113770000023231043"],
    "title":"$MONITOR_NAME is $STATUS"
  }
}

Retrieve configuration details of your Stride integration.

oauthscope : Site24x7.Admin.Read

Path Parameters

Param	Type	Description
service_id	string	Mandatory Unique ID generated by the server. This can be used as an identifier.

Response Attributes

Attribute	Type	Description
service_id	string	Unique ID generated by the server. This can be used as an identifier.
service_status	int	Actual operational status of the integration. Integration Status
name	string	Display name for the integration.
access_token	string	Stride access token.
url	string	Stride Conversation URL to which the message will be posted.
title	string	Title of the incident.
selection_type	int	Resource Type associated with this integration.
monitors	array	Monitors associated with the integration.

Update your existing Stride configuration.

PUT /integration/stride/{service_id}

Request Example

$ curl https://www.site24x7.com/api/integration/stride/113770000023231022 \
    -X PUT \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \
    -d '{
      "name": "Stride Integration - Site24x7",
      "url": "https://api.atlassian.com/site/1aa8sd54-f801-440a-a8f7-5bec2s3dc43b/conversation/3c079e3-cfba-40f4-bb36-9284c115s8d3/message",
    "access_token":"8Gu7xjh3gF1qj76sasv",
      "selection_type":0,
      "title":"$MONITOR_NAME is $STATUS"
}'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": {
    "service_id": "113770000023231022",
    "service_status ": 0,
    "name": "Stride Integration - Site24x7",
    "url": "https://api.atlassian.com/site/1aa8sd54-f801-440a-a8f7-5bec2s3dc43b/conversation/3c079e3-cfba-40f4-bb36-9284c115s8d3/message",
    "access_token":"8Gu7xjh3gF1qj76sasv",
    "selection_type":0,
    "title":"$MONITOR_NAME is $STATUS"
  }
}

Update an existing Stride.

oauthscope : Site24x7.Admin.Update

Path Parameters

Param	Type	Description
service_id	string	Mandatory Unique ID generated by the server. This can be used as an identifier.

Request Parameters

Param	Type	Description
name	string	Mandatory Display name for the integration.
url	string	Mandatory Stride Conversation URL to which the message will be posted.
access_token	string	Mandatory Stride access token.
title	string	Mandatory Title of the incident.
selection_type	int	Mandatory Resource Type associated with this integration. Monitor Group is not supported.
monitors	array	Monitors associated with the integration

Response Attributes

Attribute	Type	Description
service_id	string	Unique ID generated by the server. This can be used as an identifier.
service_status	int	Actual operational status of the integration. Integration Status
name	string	Display name for the integration.
access_token	string	Stride access token.
url	string	Stride Conversation URL to which the message will be posted.
title	string	Title of the incident.
selection_type	int	Resource Type associated with this integration.
monitors	array	Monitors associated with the integration.

Create EventBridge

POST /integration/event_bridge

Request Example

$ curl https://www.site24x7.com/api/integration/event_bridge \
    -X POST \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \
    -d '{
        "event_sources": [
            {
                "region": "us-east-1"
            }
        ],
        "amazon_monitor":"10729000000399005",
        "name": "Site24x7-Eventbridge Integration",
        "selection_type":0,
        "region_type":0,
        "trouble_alert":false,
        "critical_alert":false,
        "alert_tags_id": ["113770000023231001"]
}'

Response Example

HTTP/1.1 201 Created
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "success",
    "data": {
        "amazon_monitor": "10729000000399005",
        "event_sources": [
            {
                "event_bus_arn": "arn:aws:events:us-east-1:063251190422:event-bus/aws.partner/site24x7.com/063251190422/aws.site24x7.1.055729684E9",
                "event_source_arn": "arn:aws:events:us-east-1::event-source/aws.partner/site24x7.com/063251190422/aws.site24x7.1.055729684E9",
                "created_time": "1591188120139",
                "name": "aws.site24x7.10557296849",
                "region": "us-east-1",
                "event_source_state": "PENDING"
            }
        ],
        "name": "Site24x7-Eventbridge Integration",
        "selection_type": 0,
        "cus_account": "184302343112",
        "critical_alert": false,
        "service_status": 0,
        "service_id": "10729000000636001",
        "type": 19,
        "trouble_alert": false,
        "region_type": 0,
        "alert_tags_id": ["113770000023231001"]
    }
}

Create a new EventBridge integration.

oauthscope : Site24x7.Admin.Create

Request Parameters

Param	Type	Description
name	string	Mandatory Display name for the integration.
amazon_monitor	string	Mandatory Monitor ID of the valid amazon account that is integrated with Site24x7.
selection_type	int	Mandatory Resource Type associated with this integration. Monitor Groupis not supported.
trouble_alert	boolean	Configuration to create an event during a TROUBLE alert.
critical_alert	boolean	Configuration to create an event during a CRITICAL alert.
monitors	array	Monitors associated with the integration.
event_sources	json array	Mandatory List of event sources. JSON Format:{region:“$region”}
region	string	Mandatory AWS region code.
region_type	int	Mandatory AWS Account Region Type.
alert_tags_id	array	Tag id’s to be associated with the integration.

Response Attributes

Attribute	Type	Description
service_id	string	Unique ID generated by the server. This can be used as an identifier.
service_status	int	Integration Status
amazon_monitor	string	Monitor ID of the valid amazon account that is integrated with Site24x7.
selection_type	int	Resource Type associated with this integration.
name	string	Display name for the integration.
trouble_alert	boolean	Configuration to create an event during a TROUBLE alert.
critical_alert	boolean	Configuration to create an event during a CRITICAL alert.
monitors	array	Monitors associated with the integration.
region_type	int	AWS Account Region Type.
event_sources	json array	List of event sources.
region	string	AWS region code.
event_sources	json array	List of event sources. JSON Format: {name: “$event_source_name”, region:“$region”, event_source_arn:“$event_source_arn”, event_bus_arn:“$event_bus_arn”,created_time:“$created_time”,event_source_state:“$event_source_state”}
event_source_name	string	Name of the event source created.
event_source_arn	string	ARN of the created event source.
event_bus_arn	string	ARN of the created event bus.
created_time	string	Created time of the event source.
event_source_state	string	State of the event source.
alert_tags_id	array	Tag id’s to be associated with the integration.

Retrieve EventBridge

GET /integration/event_bridge/{service_id}

Request Example

$ curl https://www.site24x7.com/api/integration/event_bridge/10729000000636001 \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "success",
    "data": {
        "amazon_monitor": "10729000000399005",
        "event_sources": [
            {
                "event_bus_arn": "arn:aws:events:us-east-1:063251190422:event-bus/aws.partner/site24x7.com/063251190422/aws.site24x7.1.055729684E9",
                "event_source_arn": "arn:aws:events:us-east-1::event-source/aws.partner/site24x7.com/063251190422/aws.site24x7.1.055729684E9",
                "created_time": "1591188120139",
                "name": "aws.site24x7.10557296849",
                "region": "us-east-1",
                "event_source_state": "PENDING"
            }
        ],
        "name": "Site24x7-Eventbridge Integration",
        "selection_type": 0,
        "cus_account": "184302343112",
        "critical_alert": false,
        "service_status": 0,
        "service_id": "10729000000636001",
        "type": 19,
        "trouble_alert": false,
        "region_type": 0,
        "alert_tags_id": ["113770000023231001"]
    }
}

Retrieve configuration of a EventBridge.

oauthscope : Site24x7.Admin.Read

Path Parameters

Param	Type	Description
service_id	string	Mandatory Unique ID generated by the server. This can be used as an identifier.

Response Attributes

Attribute	Type	Description
service_id	string	Unique ID generated by the server. This can be used as an identifier.
service_status	int	Integration Status
amazon_monitor	string	Monitor ID of the valid amazon account that is integrated with Site24x7.
selection_type	int	Resource Type associated with this integration.
name	string	Display name for the integration.
trouble_alert	boolean	Configuration to create an event during a TROUBLE alert.
critical_alert	boolean	Configuration to create an event during a CRITICAL alert.
monitors	array	Monitors associated with the integration.
region_type	int	AWS Account Region Type.
event_sources	json array	List of event sources.
region	string	AWS region code.
event_sources	json array	List of event sources. JSON Format: {name: “$event_source_name”, region:“$region”, event_source_arn:“$event_source_arn”, event_bus_arn:“$event_bus_arn”,created_time:“$created_time”,event_source_state:“$event_source_state”}
event_source_name	string	Name of the event source created.
event_source_arn	string	ARN of the created event source.
event_bus_arn	string	ARN of the created event bus.
created_time	string	Created time of the event source.
event_source_state	string	State of the event source.
alert_tags_id	array	Tag id’s to be associated with the integration.

Update EventBridge

PUT /integration/event_bridge/{service_id}

Request Example

$ curl https://www.site24x7.com/api/integration/event_bridge/10729000000636001 \
    -X PUT \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \
    -d '{
        "name": "Site24x7-Eventbridge Integration",
        "amazon_monitor":"10729000000399005",
        "selection_type": 0,
        "critical_alert": false,
        "trouble_alert": false,
        "region_type": 0,
        "alert_tags_id": ["113770000023231001", "113770000023231002"]
    }'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": {
        "amazon_monitor": "10729000000399005",
        "event_sources": [
            {
                "event_bus_arn": "arn:aws:events:us-east-1:063251190422:event-bus/aws.partner/site24x7.com/063251190422/aws.site24x7.1.055729684E9",
                "event_source_arn": "arn:aws:events:us-east-1::event-source/aws.partner/site24x7.com/063251190422/aws.site24x7.1.055729684E9",
                "created_time": "1591188120139",
                "name": "aws.site24x7.10557296849",
                "region": "us-east-1",
                "event_source_state": "PENDING"
            }
        ],
        "name": "Site24x7-Eventbridge Integration",
        "selection_type": 0,
        "cus_account": "184302343112",
        "critical_alert": false,
        "service_status": 0,
        "service_id": "10729000000636001",
        "type": 19,
        "trouble_alert": false,
        "region_type": 0,
        "alert_tags_id": ["113770000023231001", "113770000023231002"]
    }
}

Update an existing EventBridge.

oauthscope : Site24x7.Admin.Update

Path Parameters

Param	Type	Description
service_id	string	Mandatory Unique ID generated by the server. This can be used as an identifier.

Request Parameters

Param	Type	Description
name	string	Mandatory Display name for the integration.
selection_type	int	Mandatory Resource Type associated with this integration. Monitor Groupis not supported.
amazon_monitor	string	Mandatory Monitor ID of the valid amazon account that is integrated with Site24x7.
trouble_alert	boolean	Configuration to create an event during a TROUBLE alert.
critical_alert	boolean	Configuration to create an event during a CRITICAL alert.
monitors	array	Monitors associated with the integration.
region_type	int	Mandatory AWS Account Region Type.
alert_tags_id	array	Tag id’s to be associated with the integration.

Response Attributes

Attribute	Type	Description
service_id	string	Unique ID generated by the server. This can be used as an identifier.
service_status	int	Integration Status
amazon_monitor	string	Monitor ID of the valid amazon account that is integrated with Site24x7.
selection_type	int	Resource Type associated with this integration.
name	string	Display name for the integration.
trouble_alert	boolean	Configuration to create an event during a TROUBLE alert.
critical_alert	boolean	Configuration to create an event during a CRITICAL alert.
monitors	array	Monitors associated with the integration.
event_sources	json array	List of event sources.
region	string	AWS region code.
event_sources	json array	List of event sources. JSON Format: {name: “$event_source_name”, region:“$region”, event_source_arn:“$event_source_arn”, event_bus_arn:“$event_bus_arn”,created_time:“$created_time”,event_source_state:“$event_source_state”}
event_source_name	string	Name of the event source created.
event_source_arn	string	ARN of the created event source.
event_bus_arn	string	ARN of the created event bus.
created_time	string	Created time of the event source.
event_source_state	string	State of the event source.
region_type	int	AWS Account Region Type.
alert_tags_id	array	Tag id’s to be associated with the integration.

Create Telegram

POST /integration/telegram

Request Example

$ curl https://www.site24x7.com/api/integration/telegram \
    -X POST \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \
    -d '{
    "alert_tags_id": ["1163770000023231001", "1163770000023231002"],
    "channel_url": "https://web.telegram.org/z/#-87656875",
    "name": "Site24x7-Telegram Integration",
    "selection_type": 0,
    "title": "$MONITORNAME is $STATUS",
    "token": "5334957868:ARTVWHmnzFiWfmzab-u-Ytrqs68dzom-TI8"
}'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8

{"code":0,
"message":"success",
"data":{"down_alert":true,
"title":"$MONITORNAME is $STATUS",
"alert_tags_id":["1163770000023231001", "1163770000023231002"],
"type":21,
"token":"hPBY0MC5r7BpYO0NxLy/Dn482Dzhh3vX98NO8URlxVIcuRh3SG6JUets1jcHNrKC",
"channel_url":"https://web.telegram.org/z/#-87656875",
"selection_type":0,
"trouble_alert":false,
"critical_alert":false,
"service_id":"27062000000229001",
"name":"Site24x7-Telegram Integration",
"service_status":0}
}

Create a new Telegram integration.

oauthscope : Site24x7.Admin.Create

Request Parameters

Param	Type	Description
name	string	Mandatory Display name for the integration.
title	string	Mandatory Title of the incident.
channel_url	string	Mandatory Web URL of your telegram channel to which the message will be posted.
token	string	Mandatory Bot token created by botfather.
selection_type	int	Mandatory Resource Type associated with this integration. Monitor Group is not supported.
monitors	array	Monitors associated with the integration
alert_tags_id	array	Tag id’s to be associated with the integration.

Response Attributes

Attribute	Type	Description
service_id	string	Unique ID generated by the server. This can be used as an identifier.
service_status	int	Integration Status
name	string	Display name for the integration.
channel_url	string	Web URL of your telegram channel to which the message will be posted.
token	string	Bot token created by botfather.
title	string	Title of the incident.
selection_type	int	Resource Type associated to this integration.
monitors	array	Monitors associated with the integration.
alert_tags_id	array	Tag id’s to be associated with the integration.

Retrieve Telegram

GET /integration/telegram/{service_id}

Request Example

$ curl https://www.site24x7.com/api/integration/telegram/1163770000023231022 \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code":0,
"message":"success",
"data":{
    "selection_type":0,
    "service_id":"27062000000229007",
    "service_status":0,
    "name":"Site24x7-Telegram Integration",
    "type":21,
    "title":"$MONITORNAME is $STATUS",
    "alert_tags_id":["1163770000023231001", "1163770000023231002"],
    "token":"5334957868:ARTVWHmnzFiWfmzab-u-Ytrqs68dzom-TI8",
    "channel_url":"https://web.telegram.org/z/#-87656875"
    }
}

Retrieve configuration of a Telegram.

oauthscope : Site24x7.Admin.Read

Path Parameters

Param	Type	Description
service_id	string	Mandatory Unique ID generated by the server. This can be used as an identifier.

Response Attributes

Attribute	Type	Description
service_id	string	Unique ID generated by the server. This can be used as an identifier.
service_status	int	Integration Status
name	string	Display name for the integration.
channel_url	string	Web URL of your telegram channel to which the message will be posted.
token	string	Bot token created by botfather.
title	string	Title of the incident.
selection_type	int	Resource Type associated with this integration.
monitors	array	Monitors associated with the integration.
alert_tags_id	array	Tag id’s to be associated with the integration.

Update Telegram

PUT /integration/telegram/{service_id}

Request Example

$ curl https://www.site24x7.com/api/integration/telegram/1163770000023231022 \
    -X PUT \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \
    -d '{
    "alert_tags_id": ["1163770000023231001", "1163770000023231002"],
    "channel_url": "https://web.telegram.org/z/#-87656875",
    "name": "Site24x7-Telegram Integration",
    "selection_type":2,
    "monitors":["1163770000023231032","1163770000023231043"],
    "title": "$MONITORNAME is $STATUS",
    "token": "5334957868:ARTVWHmnzFiWfmzab-u-Ytrqs68dzom-TI8",
    "alert_tags_id": ["1163770000023231001", "1163770000023231002"]
}'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{"code":0,
"message":"success",
"data":{
    "down_alert":true,
"title":"$MONITORNAME is $STATUS",
"alert_tags_id":["1163770000023231001", "1163770000023231002"],
"type":21,
"token":"hPBY0MC5r7BpYO0NxLy/Dn482Dzhh3vX98NO8URlxVIcuRh3SG6JUets1jcHNrKC",
"channel_url":"https://web.telegram.org/z/#-87656875",
"selection_type":0,
"trouble_alert":false,
"critical_alert":false,
"service_id":"27062000000229001",
"name":"Site24x7-Telegram Integration",
"selection_type":2,
"monitors":["1163770000023231032","1163770000023231043"],
"alert_tags_id": ["1163770000023231001", "1163770000023231002"]
}
}

Update an existing Telegram.

oauthscope : Site24x7.Admin.Update

Path Parameters

Param	Type	Description
service_id	string	Mandatory Unique ID generated by the server. This can be used as an identifier.

Request Parameters

Param	Type	Description
name	string	Mandatory Display name for the integration.
title	string	Mandatory Title of the incident.
channel_url	string	Mandatory Web URL of your telegram channel to which the message will be posted.
token	string	Mandatory Bot token created by botfather.
selection_type	int	Mandatory Resource Type associated with this integration. Monitor Group is not supported.
monitors	array	Monitors associated with the integration
alert_tags_id	array	Tag id’s to be associated with the integration.

Response Attributes

Attribute	Type	Description
service_id	string	Unique ID generated by the server. This can be used as an identifier.
service_status	int	Integration Status
name	string	Display name for the integration.
channel_url	string	Web URL of your telegram channel to which the message will be posted.
token	string	Bot token created by botfather.
title	string	Title of the incident.
selection_type	int	Resource Type associated to this integration.
monitors	array	Monitors associated with the integration.
alert_tags_id	array	Tag id’s to be associated with the integration.

Create Freshservice

POST /integration/fresh_service

Request Example

$ curl https://www.site24x7.com/api/integration/fresh_service \
    -X POST \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \
    -d '{
    "alert_tags_id": ["1163770000023231001", "1163770000023231002"],
    "domain_name": "example.freshservice.com",
    "api_key": "QCKDemcOQ45Q0D8dZ3"
    "name": "Site24x7-Freshservice Integration",
    "selection_type": 0,
    "subject": "$MONITORNAME is $STATUS"
}'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8

{"code": 0,
"message": "success",
"data": {"selection_type": 0,
"domain_name": "example.freshservice.com",
"api_key": "QCKDemcOQ45Q0D8dZ3",
"subject": "$MONITORNAME is $STATUS",
"service_id": "29634000000291013",
"name": "Site24x7-Freshservice Integration",
"service_status": 0,
"alert_tags_id": ["1163770000023231001", "1163770000023231002"],
"type": 22,
"requester_id": "27001727396"}
}

Create a new Freshservice integration.

oauthscope : Site24x7.Admin.Create

Request Parameters

Param	Type	Description
name	string	Mandatory Display name for the integration.
title	string	Mandatory Title of the incident.
domain_name	string	Mandatory Domain name of your Freshservice URL
api_key	string	Mandatory API key generated on Freshservice account.
selection_type	int	Mandatory Resource type associated with this integration. Monitor Group is not supported.
monitors	array	Monitors associated with the integration
alert_tags_id	array	Tag id’s to be associated with the integration.

Response Attributes

Attribute	Type	Description
service_id	string	Unique ID generated by the server. This can be used as an identifier.
service_status	int	Integration Status
name	string	Display name for the integration.
domain_name	string	Domain name of your Freshservice URL
api_key	string	API key generated on Freshservice account.
requester_id	string	Unique ID generated by Freshservice. This can be used as an identifier.
title	string	Title of the incident.
selection_type	int	Resource Type associated to this integration.
monitors	array	Monitors associated with the integration.
alert_tags_id	array	Tag id’s to be associated with the integration.

Retrieve Freshservice

GET /integration/fresh_service/{service_id}

Request Example

$ curl https://www.site24x7.com/api/integration/fresh_service/1163770000023231022 \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "success",
    "data": {
        "selection_type": 0,
        "domain_name": "example.freshservice.com",
        "api_key": "QCKDemcOQ45Q0D8dZ3",
        "subject": "$MONITORNAME is $STATUS",
        "service_id": "29634000000291017",
        "send_incident_parameters": true,
        "service_status": 0,
        "name": "Site24x7-Freshservice Integration",
        "type": 22,
        "alert_tags_id": []
    }
}

Retrieve configuration of a Freshservice.

oauthscope : Site24x7.Admin.Read

Path Parameters

Param	Type	Description
service_id	string	Mandatory Unique ID generated by the server. This can be used as an identifier.

Response Attributes

Attribute	Type	Description
service_id	string	Unique ID generated by the server. This can be used as an identifier.
service_status	int	Integration Status
name	string	Display name for the integration.
domain_name	string	Domain name of your Freshservice URL
api_key	string	API key generated on Freshservice account.
title	string	Title of the incident.
selection_type	int	Resource Type associated with this integration.
monitors	array	Monitors associated with the integration.
alert_tags_id	array	Tag id’s to be associated with the integration.

Update Freshservice

PUT /integration/fresh_service/{service_id}

Request Example

$ curl https://www.site24x7.com/api/integration/fresh_service/1163770000023231022 \
    -X PUT \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \
    -d '{
    "alert_tags_id": ["1163770000023231001", "1163770000023231002"],
    "domain_name": "example.freshservice.com",
    "api_key":"QCKDemcOQ45Q0D8dZ3"
    "name": "Site24x7-Freshservice Integration",
    "selection_type":2,
    "monitors":["1163770000023231032","1163770000023231043"],
    "subject": "$MONITORNAME is $STATUS",
    "token": "5334957868:ARTVWHmnzFiWfmzab-u-Ytrqs68dzom-TI8",
    "alert_tags_id": ["1163770000023231001", "1163770000023231002"]
}'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{"code":0,
"message":"success",
"data":{
    "down_alert":true,
"title":"$MONITORNAME is $STATUS",
"alert_tags_id":["1163770000023231001", "1163770000023231002"],
"type":21,
"api_key":"QCKDemcOQ45Q0D8dZ3",
"domain_name":"example.freshservice.com",
"selection_type":0,
"trouble_alert":false,
"critical_alert":false,
"service_id":"27062000000229001",
"name":"Site24x7-Freshservice Integration",
"selection_type":2,
"monitors":["1163770000023231032","1163770000023231043"],
"alert_tags_id": ["1163770000023231001", "1163770000023231002"]
}
}

Update an existing Freshservice.

oauthscope : Site24x7.Admin.Update

Path Parameters

Param	Type	Description
service_id	string	Mandatory Unique ID generated by the server. This can be used as an identifier.

Request Parameters

Param	Type	Description
name	string	Mandatory Display name for the integration.
subject	string	Mandatory Title of the incident.
domain_name	string	Mandatory Domain name of your Freshservice URL
api_key	string	Mandatory API key generated on Freshservice account.
selection_type	int	Mandatory Resource Type associated with this integration. Monitor Group is not supported.
monitors	array	Monitors associated with the integration
alert_tags_id	array	Tag id’s to be associated with the integration.

Response Attributes

Attribute	Type	Description
service_id	string	Unique ID generated by the server. This can be used as an identifier.
service_status	int	Integration Status
name	string	Display name for the integration.
domain_name	string	Domain name of your Freshservice URL
api_key	string	API key generated on Freshservice account.
subject	string	Title of the incident.
selection_type	int	Resource Type associated to this integration.
monitors	array	Monitors associated with the integration.
alert_tags_id	array	Tag id’s to be associated with the integration.

Delete Integration

DELETE /integration/thirdparty_service/{service_id}

Request Example

$ curl https://www.site24x7.com/api/integration/thirdparty_service/113770000023231022 \
    -X DELETE \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

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

Delete an existing integration.

oauthscope : Site24x7.Admin.Delete

Path Parameters

Param	Type	Description
service_id	string	Mandatory Unique ID generated by the server. This can be used as an identifier.

Activate Integration

PUT /integration/thirdparty_service/activate/{service_id}

Request Example

$ curl https://www.site24x7.com/api/integration/thirdparty_service/activate/113770000023231022 \
    -X PUT \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

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

Activate an existing integration.

oauthscope : Site24x7.Admin.Update

Path Parameters

Param	Type	Description
service_id	string	Mandatory Unique ID generated by the server. This can be used as an identifier.

Suspend Integration

PUT /integration/thirdparty_service/suspend/{service_id}

Request Example

$ curl https://www.site24x7.com/api/integration/thirdparty_service/suspend/113770000023231022 \
    -X PUT \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

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

Suspend an existing integration.

oauthscope : Site24x7.Admin.Update

Path Parameters

Param	Type	Description
service_id	string	Mandatory Unique ID generated by the server. This can be used as an identifier.

List Integrations

GET /third_party_services

Request Example

$ curl https://www.site24x7.com/api/third_party_services \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": [
      {
      "name": "Site24x7-PagerDuty Integration",
      "service_key": "f12345678d987654321045690cc1043ag",
      "selection_type": 0,
      "service_status": 0,
      "service_id": "113770000023231022",
      "sender_name": "Site24x7",
      "title": "$MONITORNAME is $STATUS",
      "trouble_alert": true,
      "type" : 1
    },
    {..},
    {..}
  ]
}

List of all Integrations.

oauthscope : Site24x7.Admin.Read

Response Attributes

Attribute	Type	Description
service_id	string	Unique ID generated by the server. This can be used as an identifier.
service_status	int	Integration Status
service_key	string	Unique integration key provided by the pagerduty to post incidents.
name	string	Display name for the integration.
sender_name	string	Name of the service who posted the incident.
title	string	Title of the incident.
selection_type	int	Resource Type associated with this integration.
trouble_alert	boolean	Configuration to create incident or not when there is a trouble alert.
type	int	Integration type

Tags

Create tags to organize, manage, and discover monitors easily.

Create Tags

POST /tags

Request Example

$ curl https://www.site24x7.com/api/tags \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \
    -d '{ 
    "tag_name": "Database",
    "tag_value": "MySQL",
    "tag_color": "#AAB3D4"
}'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": {
    "tag_id":"113770000041271035",
    "tag_type":1,
    "tag_name":"Database",
    "tag_value":"MySQL",
    "tag_color":"#AAB3D4"
  }
}

Create a new Tag.

oauthscope : Site24x7.Admin.Create

Request Parameters

Param	Type	Description
tag_name	string	Mandatory Display Name for the Tag.
tag_value	string	Value for the Tag.
tag_type	int	Type of the tag. 1 - User Defined Tag. 2 - System Generated AWS Tag
tag_color	string	Color code for the Tag.

Response Attributes

Attribute	Type	Description
tag_id	string	Unique ID generated by the server. This can be used as an identifier.
tag_name	string	Display Name for the Tag.
tag_value	string	Value for the Tag.
tag_type	int	Type of the tag. 1 is User Defined Tag. 2 is AWS System Generated Tag
tag_color	string	Color code for the Tag.

Retrieve Tag

GET /tags/{tag_id}

Request Example

$ curl https://www.site24x7.com/api/tags/113770000041271035 \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": {
    "tag_id": "113770000041271035",
    "tag_type":1,
    "tag_name":"Database",
    "tag_value":"MySQL",
    "tag_color":"#AAB3D4"
  }
}

Retrieve details for an existing tag.

oauthscope : Site24x7.Admin.Read

Path Parameters

Param	Type	Description
tag_id	string	Mandatory Unique ID generated by the server. This can be used as an identifier.

Response Attributes

Attribute	Type	Description
tag_id	string	Unique ID generated by the server. This can be used as an identifier.
tag_name	string	Display Name for the Tag.
tag_value	string	Value for the Tag.
tag_type	int	Type of the tag. 1 is User Defined Tag. 2 is AWS System Generated Tag
tag_color	string	Color code for the Tag.

Update Tag

PUT /tags/{tag_id}

Request Example

$ curl https://www.site24x7.com/api/tags/113770000041271035 \
    -X PUT \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \
    -d '{
        "tag_name": "Database_Tags",
        "tag_value": "MySQL",
        "tag_color": "#4895A8"
      }'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": {
    "tag_id": "113770000041271035",
    "tag_type":1,
    "tag_name":"Database_Tags",
    "tag_value":"MySQL",
    "tag_color":"#4895A8"
  }
}

Update an existing Tag.

oauthscope : Site24x7.Admin.Update

Path Parameters

Param	Type	Description
tag_id	string	Mandatory Unique ID generated by the server. This can be used as an identifier.

Request Parameters

Param	Type	Description
tag_name	string	Mandatory Display Name for the Tag.
tag_value	string	Value for the Tag.
tag_type	int	Type of the tag. 1 is User Defined Tag. 2 is AWS System Generated Tag
tag_color	string	Color code for the Tag.

Response Attributes

Attribute	Type	Description
tag_id	string	Unique ID generated by the server. This can be used as an identifier.
tag_name	string	Display Name for the Tag.
tag_value	string	Value for the Tag.
tag_type	int	Type of the tag. 1 is User Defined Tag. 2 is AWS System Generated Tag
tag_color	string	Color code for the Tag.

Delete Tag

DELETE /tags/{tag_id}

Request Example

$ curl https://www.site24x7.com/api/tags/113770000041271035 \
    -X DELETE \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

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

Delete an existing Tag.

oauthscope : Site24x7.Admin.Delete

Path Parameters

Param	Type	Description
tag_id	string	Mandatory Unique ID generated by the server. This can be used as an identifier.

List of all Tags

GET /tags

Request Example

$ curl https://www.site24x7.com/api/tags \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": [{
    "tag_id": "113770000041271035",
    "tag_type":1,
    "tag_name":"Database_Tags",
    "tag_value":"MySQL",
    "tag_color":"#4895A8"
  }]
}

List of all Tags.

oauthscope : Site24x7.Admin.Read

Response Attributes

Attribute	Type	Description
tag_id	string	Unique ID generated by the server. This can be used as an identifier.
tag_name	string	Display Name for the Tag.
tag_value	string	Value for the Tag.
tag_type	int	Type of the tag. 1 is User Defined Tag. 2 is AWS System Generated Tag
tag_color	string	Color code for the Tag.

Retrieve Monitor IDs Associated with the Tag

GET /tags/{tag_id}/monitors

Request Example

$ curl https://www.site24x7.com/api/tags/113770000041271035/monitors \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": {
    "id": "113770000041271035",
    "name":"Database",
    "value":"MySQL",
    "color":"#AAB3D4",
    "monitors":["113770000041271075","113770000041271078"]
  }
}

Retrieve monitors associated with an existing tag.

oauthscope : Site24x7.Admin.Read

Path Parameters

Param	Type	Description
tag_id	string	Mandatory Unique ID generated by the server. This can be used as an identifier.

Response Attributes

Attribute	Type	Description
monitors	array	List of monitor IDs associated with the tag.
id	string	Unique ID generated by the server for tags.
name	string	Display name for the tag.
value	string	Value of the tag.
color	string	Color code for the tag.

Configuration Rules

Configuration Rules helps you to automate the configuration settings of resources under monitoring.

Retrieve Configuration Rule

GET /rules/{rule_id}

Request Example

$ curl https://www.site24x7.com/api/rules/128867000008168001 \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
[
  {
    "rule_type_name": "USER_RULE",
    "config": {
      "rule_action": {
        "poll_interval": 5,
        "user_group": [
          "128867000000025003"
        ],
        "threshold_profile": "128867000008895003",
        "it_automation": [
          {
            "action_id": "128867000003558001",
            "alert_type": 0
          }
        ],
        "notification_profile": "128867000008895007",
        "monitor_group": [
          "128867000008895009"
        ],
        "third_party": [
          "128867000008895011"
        ],
        "location_profile": "128867000000592001"
      },
      "rule_action_data": {
        "user_group": {
            "replace": true
        }
      },
      "rule_criteria": {
        "conditions": [
          {
            "condition": "is",
            "values": [
              "URL"
            ],
            "criteria_id": 1,
            "attribute": "monitor_type"
          },
          {
            "condition": "is",
            "values": [
              ".eu"
            ],
            "criteria_id": 2,
            "attribute": "website"
          }
        ],
        "operator": "AND"
      }
    },
    "rule_type": 0,
    "rule_id": "128867000008168001",
    "priority": 1,
    "rule_name": "Website Rule - Europe",
    "description": "",
    "rule_monitor_type": "URL",
    "stop_executing_other_rules": true
  }
]

Retrieve details for an existing Configuration Rule.

oauthscope : Site24x7.Admin.Read

Path Parameters

Param	Type	Description
rule_id	string	Mandatory Unique ID generated by the server for the Configuration Rule.

Response Attributes

Attribute	Type	Description
rule_id	string	Unique ID generated by the server for the Configuration Rule.
rule_name	string	Display name of the Configuration Rule.
rule_type_name	string	USER_RULE/DEFAULT_RULE values denote whether the Configuration Rule is created by the user or is a system generated one.
rule_type	int	Integer denoting the type of the Configuration Rule.
priority	int	Priority of the Configuration Rule.
description	string	Description of the Configuration Rule.
rule_monitor_type	string	Monitor type of the Configuration Rule.
stop_executing_other_rules	boolean	Boolean to stop execution of Configuration Rules with less priority.
config	json	Rule Config JSON Format: {“rule_action”:{“poll_interval”:$poll_interval,“user_group”:[“$user_group_id”],“threshold_profile”:“$threshold_profile_id”,“it_automation”:[{“action_id”:“$action_id”,“alert_type”:$alert_type}],“notification_profile”:“$nofication_profile_id”,“monitor_group”:[“$monitor_group_id”],“third_party”:[“$third_party_id”],“location_profile”:“$location_profile_id”,“browser_type”:$browser_type,“http_configuration”: {“http_method”: $http_method, “ssl_protocol”: $ssl_protocol, “user_agent”: $user_agent, “custom_headers”: $custom_headers, “http_protocol”: $http_protocol, “up_status_codes”: $up_status_codes}},“rule_action_data”:{“user_group”:{“replace”:true},“monitor_group”:{“replace”:true},“tag”:{“replace”:true},“third_party”:{“replace”:true}},“rule_criteria”:{“conditions”:[{“condition”:“$rule_condition”,“values”:[“$criteria_values”],“criteria_id”:$criteria_id,“attribute”:“$criteria_attribute”}],“operator”:“$rule_operator”}

Delete Configuration Rule

DELETE /rules/{rule_id}

Request Example

$ curl https://www.site24x7.com/api/rules/128867000008168001 \
    -X DELETE \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

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

Delete an existing Configuration Rule.

oauthscope : Site24x7.Admin.Delete

Path Parameters

Param	Type	Description
rule_id	string	Mandatory Unique ID generated by the server for the Configuration Rule.

Run Configuration Rule

PUT /rules/run_rule/{rule_id}

Request Example

$ curl https://www.site24x7.com/api/rules/run_rule/128867000008168001 \
    -X PUT \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8

{
  "code": 0,
  "message": "success",
  "data": {
    "success": true,
    "message": "rule.scheduled.successfully"
  }
}

Run an existing Configuration Rule.

oauthscope : Site24x7.Admin.Update

Path Parameters

Param	Type	Description
rule_id	string	Mandatory Unique ID generated by the server for the Configuration Rule.

List Configuration Rules

GET /rules

Request Example

$ curl https://www.site24x7.com/api/rules \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
[
  {
    "rule_id": "128867000008168001",
    "rule_type_name": "USER_RULE",
    "rule_type": 0,
    "priority": 1,
    "rule_name": "Website Rule - Europe",
    "description": "",
    "rule_monitor_type": "URL",
    "stop_executing_other_rules": true,
    "config": {
      "rule_action": {
        "poll_interval": 5,
        "user_group": [
          "128867000000025003"
        ],
        "threshold_profile": "128867000008895003",
        "it_automation": [
          {
            "action_id": "128867000003558001",
            "alert_type": 0
          }
        ],
        "notification_profile": "128867000008895007",
        "monitor_group": [
          "128867000008895009"
        ],
        "third_party": [
          "128867000008895011"
        ],
        "location_profile": "128867000000592001"
      },
      "rule_action_data": {
        "user_group": {
            "replace": true
        }
      },
      "rule_criteria": {
        "conditions": [
          {
            "condition": "is",
            "values": [
              "URL"
            ],
            "criteria_id": 1,
            "attribute": "monitor_type"
          },
          {
            "condition": "is",
            "values": [
              ".eu"
            ],
            "criteria_id": 2,
            "attribute": "website"
          }
        ],
        "operator": "AND"
      }
    }
  }
]

List of all Configuration Rules.

oauthscope : Site24x7.Admin.Read

Response Attributes

Attribute	Type	Description
rule_id	string	Unique ID generated by the server for the Configuration Rule.
rule_name	string	Display name of the Configuration Rule.
rule_type_name	string	USER_RULE/DEFAULT_RULE values denote whether the Configuration Rule is created by the user or is a system generated one.
rule_type	int	Integer denoting the type of the Configuration Rule.
priority	int	Priority of the Configuration Rule.
description	string	Description of the Configuration Rule.
rule_monitor_type	string	Monitor type of the Configuration Rule.
stop_executing_other_rules	boolean	Boolean to stop execution of Configuration Rules with less priority.
config	json	Rule Config JSON Format: {“rule_action”:{“poll_interval”:$poll_interval,“user_group”:[“$user_group_id”],“threshold_profile”:“$threshold_profile_id”,“it_automation”:[{“action_id”:“$action_id”,“alert_type”:$alert_type}],“notification_profile”:“$nofication_profile_id”,“monitor_group”:[“$monitor_group_id”],“third_party”:[“$third_party_id”],“location_profile”:“$location_profile_id”,“browser_type”:$browser_type,“http_configuration”: {“http_method”: $http_method, “ssl_protocol”: $ssl_protocol, “user_agent”: $user_agent, “custom_headers”: $custom_headers, “http_protocol”: $http_protocol, “up_status_codes”: $up_status_codes}},“rule_action_data”:{“user_group”:{“replace”:true},“monitor_group”:{“replace”:false},“tag”:{“replace”:true},“third_party”:{“replace”:true}},“rule_criteria”:{“conditions”:[{“condition”:“$rule_condition”,“values”:[“$criteria_values”],“criteria_id”:$criteria_id,“attribute”:“$criteria_attribute”}],“operator”:“$rule_operator”}}

Bulk Action

Bulk Action helps you identify and select multiple monitors and assign them to a particular Admin action.

Configure Bulk Action

PUT /monitors/bulk_action

Request Example

$ curl https://www.site24x7.com/api/monitors/bulk_action\
    -X PUT \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \
    -d '{
        "bulk_action_type": 0,
        "threshold_profile_id": "3642900000000265",
        "type":"URL"
        "monitors":["113770000000025041", "113770000000025043"]
    }'

Response Example

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

Configure and execute a bulk action.

oauthscope : Site24x7.Admin.Update

Request Parameters

Param	Type	Description
bulk_action_type	int	Mandatory Bulk action type to be performed.
operation_type	int	Operation to be performed Supported only if the bulk_action_type chosen is 3,5,16 or 19.
threshold_profile_id	string	Mandatory, if the bulk_action_type chosen is 0. Threshold profile id to be associated with the monitor
type	string	Mandatory, if the bulk_action_type chosen is 0,1,4 or 24 Monitor type to be updated.
monitors	array	Mandatory List of monitors to be updated.
location_profile_id	string	Mandatory, if the bulk_action_type chosen is 1. Location Profile id to be associated with the monitor.
notification_profile_id	string	Mandatory, if the bulk_action_type chosen is 2. Notification Profile id to be associated with the monitor.
apm_agent_config_profile_id	string	Mandatory, if the bulk_action_type chosen is 24. APM agent configuration profile id to be associated with the monitor.
user_groups	array	Mandatory, if the bulk_action_type chosen is 3. User groups to be updated.
poll_interval	string	Mandatory, if the bulk_action_type chosen is 4. Poll Interval to be set.
logneeded	boolean	Mandatory, if the bulk_action_type chosen is 11. Update logneeded as either true or false based on your logging needs.
alert_required	boolean	Mandatory, if the bulk_action_type chosen is 22. Set alert_required as true to enable alerts.
waittime	string	Mandatory, if the bulk_action_type chosen is 23. Modify waittime if alert_required is true.
monitor_groups	array	Mandatory, if the bulk_action_type chosen is 16. Monitor group id’s to be associated.
tag_ids	array	Mandatory, if the bulk_action_type chosen is 19. Tag id’s to be associated with the monitor.
resource_type	int	Mandatory, if the bulk_action_type chosen is 19. Set resource_type as 1 for user_defined tags.
suppress_alert	boolean	Mandatory,if the bulk_action_type chosen is 26. Set suppress_alert as true to suppress alerts.
auto_discover	boolean	Mandatory,if the bulk_action_type chosen is 27. Set auto_discover as true to enable auto discovery.
statsd_enabled	int	Mandatory,if the bulk_action_type chosen is 28. Set statsd_enabled as 1 to enable statsd metrics collection in server agent.

Bulk Action Operation

Default operation that will be performed.

Action	Bulk Action Type	Default operation
Modify User Alert Groups	3	1
Modify IT Automations	5	1
Modify Monitor Group(s)	16	0
Modify Tags	19	1

Bulk Action Details

Action	Bulk Action Type	Param
Modify Threshold Profile	0	threshold_profile_id, type, monitors.
Modify Location Profile	1	location_profile_id, type, monitors(Only location based monitors).
Modify Notification Profile	2	notification_profile_id, monitors(Except Real User Monitor).
Modify User Alert Groups	3	user_groups, monitors(Except Real User Monitor).
Modify Check Frequency	4	type, monitors,poll_interval.
Modify IT Automations	5	action_ids, monitors(Except Real User Monitor).
Upgrade Server Monitor Agents	9	monitors(Only Server Monitor).
Modify Server Syslog/Event Log Preference	11	logneeded, monitors(Only Server Monitor).
Modify Plugin to enable alert when data is not received	22	alert_required, monitors.
Modify Plugin waittime to alert if alert is enabled	23	waittime.
Modify APM Agent Configuration Profile	24	apm_agent_config_profile_id, type, monitors(Only APM Insight Application).
Re-Register Plugins across servers	25	monitors(Only Server Monitor).
Delete Monitors	8	monitors(Except Real User Monitor).
Suspend Monitors	7	monitors(Except Real User Monitor).
Activate Monitors	6	monitors(Except Real User Monitor).
Modify Monitor Group(s)	16	associated_monitor_groups, monitors.
Modify Tags	19	tag_ids, resource_type, monitors(Except Real User Monitor).
Suppress Container Alerts	26	suppress_alert,monitors(Only Container Monitors).
Auto Discover Containers	27	auto_discover,monitors(Only Docker monitors with Agent version above 17.5.7).
Enable Statsd Metrics	28	statsd_enabled,monitors(Only Linux server monitors with Agent version above 17.7.0).

Bulk Action Status

GET /monitors/bulk_action/status

Request Example

$ curl https://www.site24x7.com/api/monitors/bulk_action/status\
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "success",
    "data": {
         "name": "Activate Monitors",
        "start_time": "2020-12-23T13:45:05-0800",
        "user_name": "example@abc.com",
        "type": "6",
        "status": 1,
        "success_count": 2,
        "failed_count": 0
        "inprogress_count": 0
        "total_count": 2,
        "failed_monitors": [],
        "end_time": "2020-12-23T13:45:06-0800"
    }
}

Retrieve status of the bulk action task triggered. This is only applicable for Activate, Suspend and Delete Monitors bulk action types.

oauthscope : Site24x7.Admin.Read

Response Attributes

Attribute	Type	Description
name	string	Name of the Bulk Action Type. Can be of the type in Activate, or Suspend or Delete Monitors.
start_time	string	Start time of bulk action task in ISO format.
end_time	string	End time of bulk action task in ISO format.
user_name	string	Email Id of user who triggered bulk action task.
type	string	Number constant of bulk action types type triggered.
status	int	Status of bulk action task.
success_count	int	Count of monitors for which bulk action task has completed successfully.
failure_count	int	Count of monitors for which bulk action task has failed.
inprogress_count	int	Count of monitors for which bulk action task is yet to be completed.
total_count	int	Total count of monitors
failed_monitors	array	List of monitor ID’s for which bulk action task has failed.
message	string	Description of task status.
stop_allowed	boolean	True when the user is allowed to stop the running bulk action.

Schedule Maintenances

Schedule a maintenance window to collaborate effectively within the IT team. It prevents redundant alerts from being triggered.

Create Maintenance

POST /maintenance

Request Example

$ curl https://www.site24x7.com/api/maintenance \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \
    -d '{
        "maintenance_type": 3,
        "selection_type": 2,
        "start_time": "19:08",
        "end_time": "20:08",
        "display_name": "Weekly maintenance",
        "description": "Maintenance Description",
        "monitors": [
          "113770000039133011"
        ],
        "start_date": "2016-10-03",
        "end_date": "2016-10-03",
        "perform_monitoring":true
    }'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": {
    "maintenance_id": "113770000041409009",
    "display_name": "Once maintenance",
    "description": "Maintenance Description",
    "maintenance_type": 3,
    "maintenance_status": "V",
    "start_time": "19:08",
    "end_time": "20:08",
    "start_date": "2016-10-03",
    "end_date": "2016-10-03",
    "monitors": [
      "113770000039133011"
    ],
    "selection_type": 2,
    "maintenance_start_time": "2016-10-03T19:09:17+0530",
    "zuid" : "65478659",
    "perform_monitoring":true
  }
}

Scheduled a new maintenance window.

oauthscope : Site24x7.Operations.Create

Request Parameters

Param	Type	Description
display_name	string	Mandatory Display name for the maintenance.
maintenance_type	int	Mandatory Configuration for Once/Daily/Weekly/Monthly/Yearly maintenance.
start_date	string	Mandatory, if the maintenance_type chosen is Once Maintenance start date. Format - yyyy-mm-dd.
start_time	string	Mandatory Maintenance start time. Format - hh:mm
end_date	string	Mandatory, if the maintenance_type chosen is Once. Maintenance end date. Format - yyyy-mm-dd.
end_time	string	Mandatory Maintenance end time. Format - hh:mm
monthly_start_date	int	Mandatory, if the maintenance_type chosen is Monthly(By Date). Date on which the maintenance must recur.
start_week	int	Mandatory, if the maintenance_type chosen is Monthly(By Day). The week of the month on which the maintenance must recur.
start_day	int	Mandatory, if the maintenance_type chosen is Weekly or Monthly(By Day). The day on which the maintenance must recur.
duration	int	Mandatory, if the maintenance_type chosen is Monthly(By Date) or Monthly(By Day) or Weekly(By Day). The maximum maintenance duration should be up to 1400 minutes. Format - in minutes
end_day	int	Mandatory, if the maintenance_type chosen is Weekly. The day on which the maintenance must end.
week_days	array	Optional, if the maintenance_type chosen is Weekly(By Day). The Days of the week on which the maintenance must recur.
execute_every	int	Optional, if the maintenance_type chosen is Weekly. Specify the interval at which weekly maintenance should recur. Ranges from 1 to 4. Example for BI-Weekly you can pass 2. Default value is 1.
start_after	int	Optional, if the maintenance_type chosen is Monthly(By Day). Specify the number of days after which the maintenance should begin every month. Ranges from 1 to 15. Default value is 0.
timezone	string	Time zone for your scheduled maintenance. Default value is your account timezone.
maintenance_start_on	string	Optional, if maintenance_type is Daily/Weekly/Monthly/Yearly. The date on which the maintenance should start. Default value is current date of the maintenance timezone. Format - yyyy-mm-dd.
maintenance_end_type	int	Optional, if maintenance_type is Daily/Weekly/Monthly/Yearly. Specify the end type of the maintenance. Default value is 0.
maintenance_end_after_times	int	Optional, if maintenance_end_type is 1. Specify the number execution times after which the maintenance should end.
maintenance_end_on	string	Optional, if maintenance_end_type is 2. Specify the end date on which the maintenance should end. Format - yyyy-mm-dd.
selection_type	int	Mandatory Specify the resource type associated with the scheduled maintenance. All Monitors resource segmentation not supported.
monitors	array	Mandatory, if selection_type chosen is Monitors. Monitors that need to be associated with the maintenance window.
monitor_groups	array	Mandatory, if selection_type chosen is Monitor Groups. Monitor Groups that need to be associated with the maintenance window.
tags	array	Mandatory, if selection_type chosen is Tags. Tags that should be associated with the maintenance window.
subgroup_monitors	boolean	Optional, if selection_type is Monitor Groups. Enable this option to include subgroups of the selected Monitor Groups. Otherwise, only the selected Group(s) will be considered. Default value is true
description	string	Description for the maintenance.
perform_monitoring	boolean	Enable this to perform uptime monitoring of the resource during the maintenance window.

Response Attributes

Attribute	Type	Description
maintenance_id	string	Unique ID generated by the server. This can be used as an identifier.
display_name	string	Display name for the maintenance.
description	string	Description for the maintenance.
maintenance_type	int	Configuration for Once/Daily/Weekly/Monthly only maintenance.
maintenance_status	string	Status of the maintenance.
start_date	string	Maintenance start date. Format - yyyy-mm-dd
start_time	string	Maintenance start time. Format - hh:mm
end_date	string	Maintenance end date. Format - yyyy-mm-dd
end_time	string	Maintenance end time. Format - hh:mm
monthly_start_date	int	Date on which the maintenance must recur.
start_week	int	The week of the month on which the maintenance must recur.
duration	int	The maximum maintenance duration should be less than 1440 minutes. Format - in minutes
start_day	int	Weekly Maintenance start day.
end_day	int	Weekly Maintenance end day.
maintenance_start_time	string	Time when maintenance was Created/Last Updated (in ISO date & time format).
week_days	array	The Days of the week on which the maintenance must recur.
execute_every	int	The interval at which weekly maintenance should recur.
start_after	int	The number of days after which the maintenance should begin every month.
timezone	string	Time zone for your scheduled maintenance.
maintenance_start_on	string	The date on which the maintenance should start. Default value is current date of the maintenance timezone. Format - yyyy-mm-dd.
maintenance_end_type	int	The end type of the maintenance.
maintenance_end_after_times	int	The number execution times after which the maintenance should end.
maintenance_end_on	string	The end date on which the maintenance should end. Format - yyyy-mm-dd.
selection_type	int	Resource type associated to this maintenance. All Monitors are not supported.
monitors	array	Monitors to be associated to this maintenance.
monitor_groups	array	Monitor Groups to be associated to this maintenance.
tags	array	Tags to be associated with this maintenance.
subgroup_monitors	boolean	Optional, if selection_type is Monitor Groups. Enable this option to include subgroups of the selected Monitor Groups. Otherwise, only the selected Group(s) will be considered. Default value is true
zuid	String	Unique ID of the user who created maintenance.Use users list API to find out zuid of the user.
perform_monitoring	boolean	Enable this to perform uptime monitoring of the resource during the maintenance window.

Retrieve Maintenance

GET /maintenance/{maintenance_id}

Request Example

$ curl https://www.site24x7.com/api/maintenance/113770000041409009 \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
 "code": 0,
  "message": "success",
  "data": {
    "maintenance_id": "113770000041409009",
    "display_name": "Weekly by days",
    "description": "BI-WEEKLY",
    "maintenance_type": 8,
    "maintenance_status": "V",
    "timezone": "IST",
    "week_days": [
        3,
        5
    ],
    "start_time": "14:26",
    "duration": 30,
    "execute_every": 2,
    "maintenance_start_on": "2022-08-03",
    "maintenance_end_type": 0,
    "selection_type": 2,
    "monitors": [
        "113770000039133011"
    ],
    "maintenance_start_time": "2022-08-03T15:22:10+0530",
    "zuid": "65478659",
    "pre_action_id": "",
    "post_action_id": "",
    "system_generated": false,
    "perform_monitoring": true
  }
}

Retrieve configuration of a Scheduled Maintenance.

oauthscope : Site24x7.Operations.Read

Path Parameters

Param	Type	Description
maintenance_id	string	Mandatory Unique ID generated by the server. This can be used as an identifier.

Response Attributes

Attribute	Type	Description
maintenance_id	string	Unique ID generated by the server. This can be used as an identifier.
display_name	string	Display name for the maintenance.
description	string	Description for the maintenance.
maintenance_type	int	Configuration for Once/Daily/Weekly/Monthly only maintenance.
maintenance_status	string	Status of the maintenance.
start_date	string	Maintenance start date. Format - yyyy-mm-dd
start_time	string	Maintenance start time. Format - hh:mm
end_date	string	Maintenance end date. Format - yyyy-mm-dd
end_time	string	Maintenance end time. Format - hh:mm
monthly_start_date	int	Date on which the maintenance must recur.
start_week	int	The week of the month on which the maintenance must recur.
duration	int	The maximum maintenance duration should be less than 1440 minutes. Format - in minutes
start_day	int	Weekly Maintenance start day.
end_day	int	Weekly Maintenance end day.
maintenance_start_time	string	Time when maintenance was Created/Last Updated (in ISO date & time format).
week_days	array	The Days of the week on which the maintenance must recur.
execute_every	int	The interval at which weekly maintenance should recur.
start_after	int	The number of days after which the maintenance should begin every month.
timezone	string	Time zone for your scheduled maintenance.
maintenance_start_on	string	The date on which the maintenance should start. Default value is current date of the maintenance timezone. Format - yyyy-mm-dd.
maintenance_end_type	int	The end type of the maintenance.
maintenance_end_after_times	int	The number execution times after which the maintenance should end.
maintenance_end_on	string	The end date on which the maintenance should end. Format - yyyy-mm-dd.
selection_type	int	Resource type associated to this maintenance. All Monitors are not supported.
monitors	array	Monitors to be associated to this maintenance.
monitor_groups	array	Monitor Groups to be associated to this maintenance.
tags	array	Tags to be associated with this maintenance.
subgroup_monitors	boolean	Optional, if selection_type is Monitor Groups. Enable this option to include subgroups of the selected Monitor Groups. Otherwise, only the selected Group(s) will be considered. Default value is true
zuid	String	Unique ID of the user who created maintenance.Use users list API to find out zuid of the user.
perform_monitoring	boolean	Enable this to perform uptime monitoring of the resource during the maintenance window.

Update Maintenance

PUT /maintenance/{maintenance_id}

Request Example

$ curl https://www.site24x7.com/api/maintenance/113770000041409009 \
    -X PUT \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \
    -d '{
        "maintenance_type": 3,
        "selection_type": 2,
        "start_time": "19:08",
        "end_time": "20:08",
        "display_name": "Weekly maintenance",
        "description": "Maintenance Description",
        "monitors": [
          "113770000039133011"
        ],
        "start_date": "2016-10-03",
        "end_date": "2016-10-03",
        "perform_monitoring":true
    }'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": {
    "maintenance_id": "113770000041409009",
    "display_name": "Weekly maintenance",
    "description": "Maintenance Description",
    "maintenance_type": 3,
    "maintenance_status": "V",
    "start_time": "19:08",
    "end_time": "20:08",
    "start_date": "2016-10-03",
    "end_date": "2016-10-03",
    "monitors": [
      "113770000039133011"
    ],
    "selection_type": 2,
    "maintenance_start_time": "2016-10-03T19:09:17+0530",
    "zuid" : "65478659",
    "perform_monitoring":true
  }
}

Update an existing Scheduled Maintenance.

oauthscope : Site24x7.Operations.Update

Path Parameters

Param	Type	Description
maintenance_id	string	Mandatory Unique ID generated by the server. This can be used as an identifier.

Request Parameters

Param	Type	Description
display_name	string	Mandatory Display name for the maintenance.
maintenance_type	int	Mandatory Configuration for Once/Daily/Weekly/Monthly only maintenance.
start_date	string	Mandatory, if the maintenance_type chosen is Once Maintenance start date. Format - yyyy-mm-dd.
start_time	string	Mandatory Maintenance start time. Format - hh:mm
end_date	string	Mandatory, if the maintenance_type chosen is Once. Maintenance end date. Format - yyyy-mm-dd.
end_time	string	Mandatory Maintenance end time. Format - hh:mm
monthly_start_date	int	Mandatory, if the maintenance_type chosen is Monthly(By Date). Date on which the maintenance must recur.
start_week	int	Mandatory, if the maintenance_type chosen is Monthly(By Day). The week of the month on which the maintenance must recur.
duration	int	Mandatory, if the maintenance_type chosen is Monthly(By Date) or Monthly(By Day). The maximum maintenance duration should be less than 1440 minutes. Format - in minutes
start_day	int	Mandatory, if the maintenance_type chosen is Weekly or Monthly(By Day). The day on which the maintenance must recur.
end_day	int	Mandatory, if the maintenance_type chosen is Weekly. The day on which the maintenance must end.
selection_type	int	Mandatory Specify the resource type associated with the scheduled maintenance. All Monitors resource segmentation not supported.
monitors	array	Mandatory, if selection_type chosen is Monitors. Monitors that need to be associated with the maintenance window.
monitor_groups	array	Mandatory, if selection_type chosen is Monitor Groups. Monitor Groups that need to be associated with the maintenance window.
tags	array	Mandatory, if selection_type chosen is Tags. Tags that should be associated with the maintenance window.
subgroup_monitors	boolean	Optional, if selection_type is Monitor Groups. Enable this option to include subgroups of the selected Monitor Groups. Otherwise, only the selected Group(s) will be considered. Default value is true
description	string	Description for the maintenance.
perform_monitoring	boolean	Enable this to perform uptime monitoring of the resource during the maintenance window.

Response Attributes

Attribute	Type	Description
maintenance_id	string	Unique ID generated by the server. This can be used as an identifier.
display_name	string	Display name for the maintenance.
description	string	Description for the maintenance.
maintenance_type	int	Configuration for Once/Daily/Weekly/Monthly only maintenance.
maintenance_status	string	Status of the maintenance.
start_date	string	Maintenance start date. Format - yyyy-mm-dd
start_time	string	Maintenance start time. Format - hh:mm
end_date	string	Maintenance end date. Format - yyyy-mm-dd
end_time	string	Maintenance end time. Format - hh:mm
monthly_start_date	int	Date on which the maintenance must recur.
start_week	int	The week of the month on which the maintenance must recur.
duration	int	The maximum maintenance duration should be less than 1440 minutes. Format - in minutes
start_day	int	Weekly Maintenance start day.
end_day	int	Weekly Maintenance end day.
maintenance_start_time	string	Time when maintenance was Created/Last Updated (in ISO date & time format).
week_days	array	The Days of the week on which the maintenance must recur.
execute_every	int	The interval at which weekly maintenance should recur.
start_after	int	The number of days after which the maintenance should begin every month.
timezone	string	Time zone for your scheduled maintenance.
maintenance_start_on	string	The date on which the maintenance should start. Default value is current date of the maintenance timezone. Format - yyyy-mm-dd.
maintenance_end_type	int	The end type of the maintenance.
maintenance_end_after_times	int	The number execution times after which the maintenance should end.
maintenance_end_on	string	The end date on which the maintenance should end. Format - yyyy-mm-dd.
selection_type	int	Resource type associated to this maintenance. All Monitors are not supported.
monitors	array	Monitors to be associated to this maintenance.
monitor_groups	array	Monitor Groups to be associated to this maintenance.
tags	array	Tags to be associated with this maintenance.
subgroup_monitors	boolean	Optional, if selection_type is Monitor Groups. Enable this option to include subgroups of the selected Monitor Groups. Otherwise, only the selected Group(s) will be considered. Default value is true
zuid	String	Unique ID of the user who created maintenance.Use users list API to find out zuid of the user.
perform_monitoring	boolean	Enable this to perform uptime monitoring of the resource during the maintenance window.

Delete Maintenance

DELETE /maintenance/{maintenance_id}

Request Example

$ curl https://www.site24x7.com/api/maintenance/113770000041409009 \
    -X DELETE \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

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

Delete an existing Scheduled Maintenance.

oauthscope : Site24x7.Operations.Delete

Path Parameters

Param	Type	Description
maintenance_id	string	Mandatory Unique ID generated by the server. This can be used as an identifier.

List Maintenance

GET /maintenance

Request Example

$ curl https://www.site24x7.com/api/maintenance \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": [
    {
        "maintenance_id": "113770000041409009",
        "display_name": "Weekly by days",
        "description": "BI-WEEKLY",
        "maintenance_type": 8,
        "maintenance_status": "V",
        "timezone": "IST",
        "week_days": [
            3,
            5
        ],
        "start_time": "14:26",
        "duration": 30,
        "execute_every": 2,
        "maintenance_start_on": "2022-08-03",
        "maintenance_end_type": 0,
        "selection_type": 2,
        "monitors": [
            "113770000039133011"
        ],
        "maintenance_start_time": "2022-08-03T15:22:10+0530",
        "zuid": "65478659",
        "pre_action_id": "",
        "post_action_id": "",
        "system_generated": false,
        "perform_monitoring": true
    },
    {
        "maintenance_id": "113770000041409010",
        "display_name": "Monthly By day",
        "description": "Patch Tuesday",
        "maintenance_type": 6,
        "maintenance_status": "V",
        "timezone": "IST",
        "start_week": 2,
        "start_day": 2,
        "start_after": 2,
        "start_time": "12:30",
        "duration": 30,
        "maintenance_start_on": "2022-08-03",
        "maintenance_end_type": 0,
        "selection_type": 2,
        "monitors": [
            "113770000039133011"
        ],
        "maintenance_start_time": "2022-08-03T15:22:10+0530",
        "zuid": "65478659",
        "pre_action_id": "",
        "post_action_id": "",
        "system_generated": false,
        "perform_monitoring": true
    },
    {
        "maintenance_id": "113770000041409012",
        "display_name": "Yearly",
        "description": "Christmas",
        "maintenance_type": 9,
        "maintenance_status": "V",
        "timezone": "IST",
        "yearly_start_month": 12,
        "monthly_start_date": 25,
        "start_time": "00:00",
        "yearly_end_month": 12,
        "monthly_end_date": 30,
        "end_time": "23:59",
        "maintenance_start_on": "2022-08-03",
        "maintenance_end_type": 0,
        "selection_type": 2,
        "monitors": [
            "113770000039133011"
        ],
        "maintenance_start_time": "2022-08-03T15:22:10+0530",
        "zuid": "65478659",
        "pre_action_id": "",
        "post_action_id": "",
        "system_generated": false,
        "perform_monitoring": true
    }
  ]
}

List of all Scheduled Maintenance.

oauthscope : Site24x7.Operations.Read

Response Attributes

Attribute	Type	Description
maintenance_id	string	Unique ID generated by the server. This can be used as an identifier.
display_name	string	Display name for the maintenance.
description	string	Description for the maintenance.
maintenance_type	int	Configuration for Once/Daily/Weekly/Monthly only maintenance.
maintenance_status	string	Status of the maintenance.
start_date	string	Maintenance start date. Format - yyyy-mm-dd
start_time	string	Maintenance start time. Format - hh:mm
end_date	string	Maintenance end date. Format - yyyy-mm-dd
end_time	string	Maintenance end time. Format - hh:mm
monthly_start_date	int	Date on which the maintenance must recur.
start_week	int	The week of the month on which the maintenance must recur.
duration	int	The maximum maintenance duration should be less than 1440 minutes. Format - in minutes
start_day	int	Weekly Maintenance start day.
end_day	int	Weekly Maintenance end day.
maintenance_start_time	string	Time when maintenance was Created/Last Updated (in ISO date & time format).
week_days	array	The Days of the week on which the maintenance must recur.
execute_every	int	The interval at which weekly maintenance should recur.
start_after	int	The number of days after which the maintenance should begin every month.
timezone	string	Time zone for your scheduled maintenance.
maintenance_start_on	string	The date on which the maintenance should start. Default value is current date of the maintenance timezone. Format - yyyy-mm-dd.
maintenance_end_type	int	The end type of the maintenance.
maintenance_end_after_times	int	The number execution times after which the maintenance should end.
maintenance_end_on	string	The end date on which the maintenance should end. Format - yyyy-mm-dd.
selection_type	int	Resource type associated to this maintenance. All Monitors are not supported.
monitors	array	Monitors to be associated to this maintenance.
monitor_groups	array	Monitor Groups to be associated to this maintenance.
tags	array	Tags to be associated with this maintenance.
subgroup_monitors	boolean	Optional, if selection_type is Monitor Groups. Enable this option to include subgroups of the selected Monitor Groups. Otherwise, only the selected Group(s) will be considered. Default value is true
zuid	String	Unique ID of the user who created maintenance.Use users list API to find out zuid of the user.
perform_monitoring	boolean	Enable this to perform uptime monitoring of the resource during the maintenance window.

Start Ad hoc Maintenance By Id

POST /start_maintenance

Request Example

$ curl https://www.site24x7.com/api/start_maintenance \
    -X POST \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \
    -d '{
        "selection_type": 2,
        "monitors": [
          "113770000039133011"
        ],
        "perform_monitoring":true
    }'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": {
    "maintenance_id": "113770000041409009",
    "display_name": "Ad-Hoc Maintenance",
    "maintenance_type": 3,
    "maintenance_status": "V",
    "start_time": "19:08",
    "start_date": "2016-10-03",
    "monitors": [
      "113770000039133011"
    ],
    "selection_type": 2,
    "maintenance_start_time": "2016-10-03T19:09:17+0530",
    "zuid" : "65478659",
    "perform_monitoring":true
  }
}

Schedule a new maintenance immediately without any end time using monitor ids or monitor group ids.

oauthscope : Site24x7.Operations.Create

Request Parameters

Param	Type	Description
selection_type	int	Mandatory Specify the resource type associated with the scheduled maintenance. All Monitors resource segmentation not supported.
monitors	array	Mandatory, if selection_type chosen is Monitors. Monitors that need to be associated with the maintenance window.
monitor_groups	array	Mandatory, if selection_type chosen is Monitor Groups. Monitor Groups that need to be associated with the maintenance window.
tags	array	Mandatory, if selection_type chosen is Tags. Tags that should be associated with the maintenance window.
subgroup_monitors	boolean	Optional, if selection_type is Monitor Groups. Enable this option to include subgroups of the selected Monitor Groups. Otherwise, only the selected Group(s) will be considered. Default value is true
perform_monitoring	boolean	Enable this to perform uptime monitoring of the resource during the maintenance.
duration	int	If specified, the maintenance will end after the specified time (in minutes).

Response Attributes

Attribute	Type	Description
maintenance_id	string	Unique ID generated by the server. This can be used as an identifier.
display_name	string	Display name for the maintenance.
description	string	Description for the maintenance.
maintenance_type	int	Configuration for Once/Daily/Weekly/Monthly only maintenance.
maintenance_status	string	Status of the maintenance.
start_date	string	Maintenance start date. Format - yyyy-mm-dd
start_time	string	Maintenance start time. Format - hh:mm
end_date	string	Maintenance end date. Format - yyyy-mm-dd
end_time	string	Maintenance end time. Format - hh:mm
monthly_start_date	int	Date on which the maintenance must recur.
start_week	int	The week of the month on which the maintenance must recur.
duration	int	The maximum maintenance duration should be less than 1440 minutes. Format - in minutes
start_day	int	Weekly Maintenance start day.
end_day	int	Weekly Maintenance end day.
maintenance_start_time	string	The time at which the maintenance was created or last updated(in ISO date & time format).
timezone	string	Time zone for your scheduled maintenance.
selection_type	int	Resource type associated to this maintenance. All Monitors are not supported.
monitors	array	Monitors that are associated with a maintenance.
monitor_groups	array	Monitor Groups that are associated with a maintenance.
tags	array	Tags that are associated with the maintenance.
subgroup_monitors	boolean	Optional, if selection_type is Monitor Groups. Enable this option to include subgroups of the selected Monitor Groups. Otherwise, only the selected Group(s) will be considered. Default value is true
zuid	String	Unique ID of the user who created maintenance.Use users list API to find out zuid of the user.
perform_monitoring	boolean	Enable this to perform uptime monitoring of the resource during the maintenance.

Start Ad hoc Maintenance By Name

POST /start_maintenance/name

Request Example

$ curl https://www.site24x7.com/api/start_maintenance/name \
    -X POST \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \
    -d '{
        "selection_type": 2,
        "monitor_names": [
          "AlfaRomeo"
        ],
        "perform_monitoring":true
    }'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": {
    "maintenance_id": "113770000041409009",
    "display_name": "Ad-Hoc Maintenance",
    "maintenance_type": 3,
    "maintenance_status": "V",
    "start_time": "19:08",
    "start_date": "2016-10-03",
    "monitors": [
      "113770000039133011"
    ],
    "selection_type": 2,
    "maintenance_start_time": "2016-10-03T19:09:17+0530",
    "zuid" : "65478659",
    "timezone": "IST",
    "perform_monitoring":true
  }
}

Schedule a new maintenance immediately without any end time using monitor names or monitor group names.

oauthscope : Site24x7.Operations.Create

Request Parameters

Param	Type	Description
selection_type	int	Mandatory Specify the resource type associated with the scheduled maintenance. All Monitors resource segmentation not supported.
monitor_names	array	Mandatory, if selection_type chosen is Monitors. Monitors that need to be associated with the maintenance window.
monitor_group_names	array	Mandatory, if selection_type chosen is Monitor Groups. Monitor Groups that need to be associated with the maintenance window.
tag_name_values	array	Mandatory, if selection_type chosen is Tags. Tag Name Value Pair that should be associated with the maintenance window.
subgroup_monitors	boolean	Optional, if selection_type is Monitor Groups. Enable this option to include subgroups of the selected Monitor Groups. Otherwise, only the selected Group(s) will be considered. Default value is true
perform_monitoring	boolean	Enable this to perform uptime monitoring of the resource during the maintenance.
duration	int	If specified, the maintenance will end after the specified time (in minutes).

Response Attributes

Attribute	Type	Description
maintenance_id	string	Unique ID generated by the server. This can be used as an identifier.
display_name	string	Display name for the maintenance.
description	string	Description for the maintenance.
maintenance_type	int	Configuration for Once/Daily/Weekly/Monthly only maintenance.
maintenance_status	string	Status of the maintenance.
start_date	string	Maintenance start date. Format - yyyy-mm-dd
start_time	string	Maintenance start time. Format - hh:mm
end_date	string	Maintenance end date. Format - yyyy-mm-dd
end_time	string	Maintenance end time. Format - hh:mm
monthly_start_date	int	Date on which the maintenance must recur.
start_week	int	The week of the month on which the maintenance must recur.
duration	int	The maximum maintenance duration should be less than 1440 minutes. Format - in minutes
start_day	int	Weekly Maintenance start day.
end_day	int	Weekly Maintenance end day.
maintenance_start_time	string	The time at which the maintenance was created or last updated(in ISO date & time format).
timezone	string	Time zone for your scheduled maintenance.
selection_type	int	Resource type associated to this maintenance. All Monitors are not supported.
monitors	array	Monitors that are associated with a maintenance.
monitor_groups	array	Monitor Groups that are associated with a maintenance.
tags	array	Tags that are associated with the maintenance.
subgroup_monitors	boolean	Optional, if selection_type is Monitor Groups. Enable this option to include subgroups of the selected Monitor Groups. Otherwise, only the selected Group(s) will be considered. Default value is true
zuid	String	Unique ID of the user who created maintenance.Use users list API to find out zuid of the user.
perform_monitoring	boolean	Enable this to perform uptime monitoring of the resource during the maintenance.

End Resource Maintenance By Id

PUT /end_maintenance

Request Example

$ curl https://www.site24x7.com/api/end_maintenance \
    -X PUT \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \
    -d '{
        "maintenance_id":"13770000041409009",
        "monitors": [
          "113770000039133011"
        ],
        "monitor_groups": [
          "113770000039135019"
        ],
        "tags": [
          "113770000039135099"
        ]
    }'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": {
        "maintenance_id":"13770000041409009",
        "monitors": [
          "113770000039133011"
        ],
        "monitor_groups": [
          "113770000039135019"
        ],
        "tags": [
          "113770000039135099"
        ],
        "resource_id": "1000000464047"
  }
}

Snooze monitors currently under maintenance without affecting the overall maintenance configuration. You can choose to stop monitor maintenance based on maintenance window, list of Monitor IDs, or Monitor Group IDs.

oauthscope : Site24x7.Operations.Update

Request Parameters

Param	Type	Description
maintenance_id	string	Unique ID generated by the server. This is the identifier for the maintenance window.
monitors	array	Monitors that are associated with a maintenance window.
monitor_groups	array	Monitor Groups that are associated with a maintenance window.
tags	array	Tags that are associated with the maintenance window.

Response Attributes

Attribute	Type	Description
resource_id	string	Unique ID generated by the server. This is the identifier for the maintenance window.
monitors	array	Monitors that are associated with a maintenance.
monitor_groups	array	Monitor Groups that are associated with a maintenance.
tags	array	Tags that are associated with the maintenance.

End Resource Maintenance By Name

PUT /end_maintenance/name

Request Example

$ curl https://www.site24x7.com/api/end_maintenance/name \
    -X PUT \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \
    -d '{
        "monitor_names": [
          "AlfaRomeo"
        ],
        "monitor_group_names": [
          "API - Group 1"
        ],
        "tag_name_values": [
          "tag name:tag value"
        ]
    }'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": {
        "monitor_names": [
          "AlfaRomeo"
        ],
        "monitor_group_names": [
          "API - Group 1"
        ],
        "tag_name_values": [
          "tag name:tag value"
        ],
        "resource_id": "1000000000011"
  }
}

Snooze monitors currently under maintenance without affecting the overall maintenance configuration. You can choose to stop monitor maintenance based on list of Monitor Names, or Monitor Group Names.

oauthscope : Site24x7.Operations.Update

Request Parameters

Param	Type	Description
monitor_names	array	Monitors that are associated with a maintenance window.
monitor_group_names	array	Monitor Groups that are associated with a maintenance window.
tag_name_values	array	Tag Name Value that are associated with the maintenance window.

Response Attributes

Attribute	Type	Description
resource_id	string	Unique ID generated by the server. This is the identifier for the maintenance window.
monitors	array	Monitors that are associated with a maintenance.
monitor_groups	array	Monitor Groups that are associated with a maintenance.
Tags	array	Tags that are associated with the maintenance.

Business Hours

Define business hours so that you can segment data in reports and SLAs by time period that is most critical to your business.

Create Business Hour

POST /business_hours

Request Example

$ curl https://www.site24x7.com/api/business_hours \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \
    -d '{
      "time_config": [
        {
          "day": 2,
          "start_time": "09:00",
          "end_time": "17:00"
        },
        {
          "day": 3,
          "start_time": "09:00",
          "end_time": "17:00"
        },
        {
          "day": 4,
          "start_time": "09:00",
          "end_time": "17:00"
        },
        {
          "day": 5,
          "start_time": "09:00",
          "end_time": "17:00"
        },
        {
          "day": 6,
          "start_time": "09:00",
          "end_time": "17:00"
        }
      ],
      "display_name": "General Shift",
      "description": "General shift 5 days a week 9 AM to 5 PM"
    }'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": {
    "business_hours_id": "113770000041403039",
    "display_name": "General Shift",
    "time_config": [
      {
        "day": 2,
        "end_time": "17:00",
        "start_time": "09:00"
      },
      {
        "day": 3,
        "end_time": "17:00",
        "start_time": "09:00"
      },
      {
        "day": 4,
        "end_time": "17:00",
        "start_time": "09:00"
      },
      {
        "day": 5,
        "end_time": "17:00",
        "start_time": "09:00"
      },
      {
        "day": 6,
        "end_time": "17:00",
        "start_time": "09:00"
      }
    ],
    "description": "General shift 5 days a week 9 AM to 5 PM"
  }
}

Create a new Business Hour

oauthscope : Site24x7.Admin.Create

Request Parameters

Param	Type	Description
display_name	string	Mandatory Display name for the Business Hour.
time_config	json	Mandatory Business hour timing configurations. JSON Format : {day: $day_constants, start_time: “hh:mm”, end_time: “hh:mm”}
description	string	Description for the Business Hour

Response Attributes

Attribute	Type	Description
business_hours_id	string	Unique ID generated by the server. This can be used as an identifier.
display_name	string	Display name for the Business Hour.
time_config	json	Business hour timing configurations. JSON Format : {day: $day_constants, start_time: “hh:mm”, end_time: “hh:mm”}
description	string	Description for the Business Hour.

Retrieve Business Hour

GET /business_hours/{business_hours_id}

Request Example

$ curl https://www.site24x7.com/api/business_hours/113770000041403039 \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": {
    "business_hours_id": "113770000041403039",
    "display_name": "General Shift",
    "time_config": [
      {
        "day": 2,
        "end_time": "17:00",
        "start_time": "09:00"
      },
      {
        "day": 3,
        "end_time": "17:00",
        "start_time": "09:00"
      },
      {
        "day": 4,
        "end_time": "17:00",
        "start_time": "09:00"
      },
      {
        "day": 5,
        "end_time": "17:00",
        "start_time": "09:00"
      },
      {
        "day": 6,
        "end_time": "17:00",
        "start_time": "09:00"
      }
    ],
    "description": "General shift 5 days a week 9 AM to 5 PM"
  }
}

Retrieve configuration of a Business Hour.

oauthscope : Site24x7.Admin.Read

Path Parameters

Param	Type	Description
business_hours_id	string	Mandatory Unique ID generated by the server. This can be used as an identifier.

Response Attributes

Attribute	Type	Description
business_hours_id	string	Unique ID generated by the server. This can be used as an identifier.
display_name	string	Display name for the Business Hour.
time_config	json	Business hour timing configurations. JSON Format : {day: $day_constants, start_time: “hh:mm”, end_time: “hh:mm”}
description	string	Description for the Business Hour.

Update Business Hour

PUT /business_hours/{business_hours_id}

Request Example

$ curl https://www.site24x7.com/api/business_hours/113770000041403039 \
    -X PUT \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \
    -d '{
      "time_config": [
        {
          "day": 2,
          "start_time": "09:00",
          "end_time": "17:00"
        },
        {
          "day": 3,
          "start_time": "09:00",
          "end_time": "17:00"
        },
        {
          "day": 4,
          "start_time": "09:00",
          "end_time": "17:00"
        },
        {
          "day": 5,
          "start_time": "09:00",
          "end_time": "17:00"
        },
        {
          "day": 6,
          "start_time": "09:00",
          "end_time": "17:00"
        }
      ],
      "display_name": "General Shift",
      "description": "General shift 5 days a week 9 AM to 5 PM"
    }'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": {
    "business_hours_id": "113770000041403039",
    "display_name": "General Shift",
    "time_config": [
      {
        "day": 2,
        "end_time": "17:00",
        "start_time": "09:00"
      },
      {
        "day": 3,
        "end_time": "17:00",
        "start_time": "09:00"
      },
      {
        "day": 4,
        "end_time": "17:00",
        "start_time": "09:00"
      },
      {
        "day": 5,
        "end_time": "17:00",
        "start_time": "09:00"
      },
      {
        "day": 6,
        "end_time": "17:00",
        "start_time": "09:00"
      }
    ],
    "description": "General shift 5 days a week 9 AM to 5 PM"
  }
}

Update an existing Business Hour.

oauthscope : Site24x7.Admin.Update

Path Parameters

Param	Type	Description
business_hours_id	string	Mandatory Unique ID generated by the server. This can be used as an identifier.

Request Parameters

Param	Type	Description
display_name	string	Mandatory Display name for the Business Hour.
time_config	json	Mandatory Business hour timing configurations. JSON Format : {day: $day_constants, start_time: “hh:mm”, end_time: “hh:mm”}
description	string	Description for the Business Hour

Response Attributes

Attribute	Type	Description
business_hours_id	string	Unique ID generated by the server. This can be used as an identifier.
display_name	string	Display name for the Business Hour.
time_config	json	Business hour timing configurations. JSON Format : {day: $day_constants, start_time: “hh:mm”, end_time: “hh:mm”}
description	string	Description for the Business Hour.

Delete Business Hour

DELETE /business_hours/{business_hours_id}

Request Example

$ curl https://www.site24x7.com/api/business_hours/113770000041403039 \
    -X DELETE \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

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

Delete an existing Business Hour.

oauthscope : Site24x7.Admin.Delete

Path Parameters

Param	Type	Description
business_hours_id	string	Mandatory Unique ID generated by the server. This can be used as an identifier.

List Business Hours

GET /business_hours

Request Example

$ curl https://www.site24x7.com/api/business_hours \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": [
      {
        "business_hours_id": "113770000041403039",
        "display_name": "General Shift",
        "time_config": [
          {
            "day": 2,
            "end_time": "17:00",
            "start_time": "09:00"
          },
          {
            "day": 3,
            "end_time": "17:00",
            "start_time": "09:00"
          },
          {
            "day": 4,
            "end_time": "17:00",
            "start_time": "09:00"
          },
          {
            "day": 5,
            "end_time": "17:00",
            "start_time": "09:00"
          },
          {
            "day": 6,
            "end_time": "17:00",
            "start_time": "09:00"
          }
        ],
        "description": "General shift 5 days a week 9 AM to 5 PM"
    },
    {..},
    {..}
  ]
}

List of all Business Hours.

oauthscope : Site24x7.Admin.Read

Response Attributes

Attribute	Type	Description
business_hours_id	string	Unique ID generated by the server. This can be used as an identifier.
display_name	string	Display name for the Business Hour.
time_config	json	Business hour timing configurations. JSON Format : {day: $day_constants, start_time: “hh:mm”, end_time: “hh:mm”}
description	string	Description for the Business Hour.

Schedule Reports

Schedule performance and availability reports to users and customers in the format and time they prefer.

Schedule a Report

POST /scheduled_reports

Request Example

$ curl https://www.site24x7.com/api/scheduled_reports \
    -X POST \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \
    -d '{
      "selection_type": 2,
      "scheduled_day": 2,
      "scheduled_time": 22,
      "report_type": 11,
      "report_format": 3,
      "report_frequency": 2,
      "display_name": "Availability Summary Report",
      "monitors": [
        "113770000039133011",
        "113770000039079003"
      ],
      "business_hours_id": "113770000020402013",
      "report_criteria":{"criteria":0,"operator":1,"target_value":70},
      "user_groups": [
        "113770000000025015"
      ]
    }'

Response Example

HTTP/1.1 201 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": {
    "report_id": "113770000041403041",
    "display_name": "Availability Summary Report",
    "report_frequency": 2,
    "scheduled_time": 22,
    "scheduled_day": 2,
    "report_type": 11,
    "report_format": 3,
    "selection_type": 2,
    "monitors": [
      "113770000039133011",
      "113770000039079003"
    ],
    "report_criteria":{"criteria":0,"operator":1,"target_value":70},
    "user_groups": [
      "113770000000025015"
    ],
    "schedule_execution_time": "Every Tuesday at 22:00 Hrs",
    "schedule_status": 0,
    "business_hours_id": "113770000020402013"
  }
}

Schedule a report to be received on a specific day and time.

oauthscope : Site24x7.Reports.Create

Request Parameters

Param	Type	Description
display_name	string	Mandatory Display name for the Report.
report_type	int	Mandatory Type of report to be Scheduled. Health Trend Report is not supported.
selection_type	int	Mandatory Resource type associated to this Scheduled Report.
report_format	int	Mandatory Format of the report to be scheduled. Only CSV format is supported for Availability Trend, Server Inventory, Monitor Status, and Hadoop Inventory Reports Only PDF format is supported for Executive Summary SLA Report.
report_frequency	int	Mandatory Frequency for the scheduled report Daily / Weekly / Monthly.
scheduled_day	int	Mandatory, if the chosen report_frequency is Weekly. Day on which you wish to receive Weekly reports.
scheduled_time	int	Mandatory. Time at which you wish to recieve report. Format - hh
scheduled_date	string	Mandatory, if the chosen report_frequency is Monthly. Date on which you wish to receive Monthly reports. Format - dd
scheduled_month	int	Mandatory, if the chosen report_frequency is Quarterly. Specifies the Business Quarter Months in which report has to be sent. Example: On passing scheduled_month as 2, the report will be scheduled at the specified date and hour of February, May, August, and November months.
monitor_groups	array	Mandatory, if the chosen selection_type is Monitor Groups. Monitor Groups to be associated to this scheduled report.
monitor_group_id	long	Mandatory, if the report_type chosen is Executive Summary SLA Report. Monitor Group to be associated to this Executive Summary SLA Report.
subgroup_monitors	boolean	Optional, if the chosen selection_type is Monitor Groups. Enable this option to include subgroups of the selected Monitor Groups. Otherwise, only the selected Group(s) will be considered. Default value is true
monitors	array	Mandatory, if the chosen selection_type is Monitors. Monitors to be associated to this scheduled report. Not supported for Busy Hours Report and Top N Reports.
monitor_id	string	Mandatory, if the report_type chosen is Busy Hours Report. Monitor to be associated to this Busy Hours Report.
monitor_type	string	Mandatory, if the report_type chosen is Top N & Bottom N Report or the selection_type is Monitor Type for other supported report types. Type of the monitor.
logtypes	array	Mandatory, if the report_type chosen is Applogs Report. LogTypes to be associated to this scheduled report.
attribute_name	string	Mandatory, if the report_type chosen is Top N & Bottom N Report.Top N & Button Attributes Reports can be scheduled based on the attribute_name if the report_type is Performance and selection_type is Monitors(for one monitor). Performance Attributes (or) You can schedule reports on the attribute_name if the report_type is Availability Summary and the selection_type is Monitors. This is applicable only if a Metrics monitor is selected.
attribute_names	array	Mandatory for Plugin monitors, if the report_type chosen is Performance Report and the selection_type is Monitors or Monitor Type.
plugin_id	long	Mandatory, if the selection_type is Monitor Type and the selected monitor type is Plugin.
user_groups	array	Mandatory. Recipient of the scheduled reports.
business_hours_id	string	The predefined business hours during which critical outage details reports are generated.
report_criteria	json	Criteria to set threshold limits for component values exceeding which a report has to be scheduled. JSON Format: {“criteria”:$criteria_constant,“operator”:$operator_constant,“target_value”:$target_value}. Only Summary report and Availability summary report are supported.
report_periods	array	Mandatory, if the report_type chosen is Availability Trend Report. Select report time period constants. Constants to be associated to this Availability Trend Report (A maximum of 5 report period constants can be choosen).
report_period_id	int	Mandatory, if the report_type chosen is Executive Summary SLA Report. Select a report time period constants. Constants to be associated to this Executive Summary SLA Report .
aws_monitor_type	string	Mandatory if the chosen report type is AWS Inventory Report. ID of the AWS service for which you want to receive the report.
best_response_time	int	Optional, use if report type is Executive Summary SLA Report. Provide the best in class response time value to be compared in the Executive Summary SLA report.
meta_info	boolean	Optional, use if report type is Availability Trend Report. Any Monitor Groups information, which the resource is associated to, will be shared in the report.
metrics	int	Optional, use if report type is Step Summary Report. Metrics If the frequency is set to Daily you can get an overall data.For the other frequencies you will get either an overall data or data for each day.
sla_required	boolean	Optional, use if report type is Availability Trend Report. SLA Availability data will also be included in the shared report for the selected Reporting Period.
days_to_expiry	int	Optional, use if report type is SSL Domain Expiry Report. Use this field to filter your monitors based on days left for expiry. Use -1 if you want to choose all the SSL/Domain Expiry monitors.
report_resource_type	string	Mandatory for the report types mentioned here.

Report Resource Type

Report Type	report_resource_type
Server Inventory Report	SERVER
Monitor Status Report	SERVER
Hadoop Inventory Report	HADOOP
Processes Report	ProcessDetails
Disk Partition Report	DiskDetails
Network Adapter Report	NetworkDetails
Services Report	WindowsServices

Response Attributes

Attribute	Type	Description
report_id	string	Unique ID generated by the server. This can be used as an identifier.
display_name	string	Display name for the Report.
report_type	int	Type of report to be Scheduled. Health Trend Report is not supported.
selection_type	int	Resource type associated to this Scheduled Report.
report_format	int	Format of the report to be scheduled.
report_frequency	int	Frequency for the scheduled report Daily / Weekly / Monthly.
scheduled_day	int	Day on which you wish to receive Weekly reports.
scheduled_time	int	Time at which you wish to recieve report. Format - hh
scheduled_date	string	Date on which you wish to receive Monthly reports. Format - dd
scheduled_month	int	Business Quarter Months in which report will be sent.
monitor_groups	array	Monitor Groups to be associated to this scheduled report.
subgroup_monitors	boolean	Optional, , if the chosen selection_type is Monitor Groups. Enable this option to include subgroups of the selected Monitor Groups. Otherwise, only the selected Group(s) will be considered. Default value is true
monitors	array	Monitors to be associated to this scheduled report. Not supported for Busy Hours Report and Top N Reports.
monitor_id	string	Monitor to be associated to this Busy Hours Report.
monitor_type	string	Type of the monitor.
logtypes	array	LogTypes to be associated to this scheduled report. Supported only for Applogs Report.
attribute_name	string	Top N & Buttom Attributes or Performance Attributes or Metrics child id based on the report_type.
attribute_names	array	Plugin Attributes.
plugin_id	long	Plugin Template.
user_groups	array	Recipient of the scheduled reports.
business_hours_id	string	The predefined business hours during which critical outage details reports are generated.
report_criteria	json	Criteria to set threshold limits for component values exceeding which a report has to be scheduled. JSON Format: {“criteria”:$criteria_constant,“operator”:$operator_constant,“target_value”:$target_value}. Only Summary report and Availability summary report are supported.
schedule_execution_time	string	Scheduled report execution time
report_periods	array	Report Periods to be associated to the Availability Trend Report
aws_monitor_type	string	ID of the AWS service for which you receive the report.
metrics	int	Metrics associated if the report type is Step Summary Report. Provides either an overall data or a data that is grouped by day.
meta_info	boolean	Optional, use if report type is Availability Trend Report. Any Monitor Groups information, which the resource is associated to, will be shared in the report.
sla_required	boolean	Optional, use if report type is Availability Trend Report. SLA Availability data will also be included in the shared report for the selected Reporting Period.
days_to_expiry	int	Optional, use if report type is SSL Domain Expiry Report. Use this field to filter your monitors based on days left for expiry. Use -1 if you want to choose all the SSL/Domain Expiry monitors.

Get Scheduled Report

GET /scheduled_reports/{report_id}

Request Example

$ curl https://www.site24x7.com/api/scheduled_reports/113770000041403041 \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": {
    "report_id": "113770000041403041",
    "display_name": "Availability Summary Report",
    "report_frequency": 2,
    "scheduled_time": 22,
    "scheduled_day": 2,
    "report_type": 11,
    "report_format": 3,
    "selection_type": 2,
    "monitors": [
      "113770000039133011",
      "113770000039079003"
    ],
    "user_groups": [
      "113770000000025015"
    ],
    "schedule_execution_time": "Every Tuesday at 22:00 Hrs",
    "schedule_status": 0,
    "business_hours_id": "113770000020402013"
  }
}

Retrieve the configuration of a Scheduled Report.

oauthscope : Site24x7.Reports.Read

Path Parameters

Param	Type	Description
report_id	string	Mandatory Unique ID generated by the server. This can be used as an identifier.

Response Attributes

Attribute	Type	Description
report_id	string	Unique ID generated by the server. This can be used as an identifier.
display_name	string	Display name for the Report.
report_type	int	Type of report to be Scheduled. Health Trend Report is not supported.
selection_type	int	Resource type associated to this Scheduled Report.
report_format	int	Format of the report to be scheduled.
report_frequency	int	Frequency for the scheduled report Daily / Weekly / Monthly.
scheduled_day	int	Day on which you wish to receive Weekly reports.
scheduled_time	int	Time at which you wish to recieve report. Format - hh
scheduled_date	string	Date on which you wish to receive Monthly reports. Format - dd
scheduled_month	int	Business Quarter Months in which report will be sent.
monitor_groups	array	Monitor Groups to be associated to this scheduled report.
subgroup_monitors	boolean	Optional, , if the chosen selection_type is Monitor Groups. Enable this option to include subgroups of the selected Monitor Groups. Otherwise, only the selected Group(s) will be considered. Default value is true
monitors	array	Monitors to be associated to this scheduled report. Not supported for Busy Hours Report and Top N Reports.
monitor_id	string	Monitor to be associated to this Busy Hours Report.
monitor_type	string	Type of the monitor.
logtypes	array	LogTypes to be associated to this scheduled report. Supported only for Applogs Report.
attribute_name	string	Top N & Buttom Attributes or Performance Attributes or Metrics child id based on the report_type.
attribute_names	array	Plugin Attributes.
plugin_id	long	Plugin Template.
user_groups	array	Recipient of the scheduled reports.
business_hours_id	string	The predefined business hours during which critical outage details reports are generated.
schedule_execution_time	string	Scheduled report execution time
report_criteria	json	Criteria to set threshold limits for component values exceeding which a report has to be scheduled. JSON Format: {“criteria”:$criteria_constant,“operator”:$operator_constant,“target_value”:$target_value}. Only Summary report and Availability summary report are supported.
report_periods	array	Report Periods to be associated to the Availability Trend Report
aws_monitor_type	string	ID of the AWS service for which you receive the report.
meta_info	boolean	Optional, use if report type is Availability Trend Report. Any Monitor Groups information, which the resource is associated to, will be shared in the report.
sla_required	boolean	Optional, use if report type is Availability Trend Report. SLA Availability data will also be included in the shared report for the selected Reporting Period.
days_to_expiry	int	Optional, use if report type is SSL Domain Expiry Report. Use this field to filter your monitors based on days left for expiry. Use -1 if you want to choose all the SSL/Domain Expiry monitors.
report_resource_type	string	Optional, except for the report types mentioned here

Update Scheduled Report

PUT /scheduled_reports/{report_id}

Request Example

$ curl https://www.site24x7.com/api/scheduled_reports/113770000041403041 \
    -X PUT \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \
    -d '{
      "selection_type": 2,
      "scheduled_day": 2,
      "scheduled_time": 22,
      "report_type": 11,
      "report_format": 3,
      "report_frequency": 2,
      "display_name": "Availability Summary Report",
      "monitors": [
        "113770000039133011",
        "113770000039079003"
      ],
      "business_hours_id": "113770000020402013",
      "report_criteria":{"criteria":0,"operator":1,"target_value":70},
      "user_groups": [
        "113770000000025015"
      ]
    }'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": {
    "report_id": "113770000041403041",
    "display_name": "Availability Summary Report",
    "report_frequency": 2,
    "scheduled_time": 22,
    "scheduled_day": 2,
    "report_type": 11,
    "report_format": 3,
    "selection_type": 2,
    "monitors": [
      "113770000039133011",
      "113770000039079003"
    ],
    "report_criteria":{"criteria":0,"operator":1,"target_value":70},
    "user_groups": [
      "113770000000025015"
    ],
    "schedule_execution_time": "Every Tuesday at 22:00 Hrs",
    "schedule_status": 0,
    "business_hours_id": "113770000020402013"
  }
}

Update the configuration of an existing Scheduled Report.

oauthscope : Site24x7.Reports.Update

Path Parameters

Param	Type	Description
report_id	string	Mandatory Unique ID generated by the server. This can be used as an identifier.

Request Parameters

Param	Type	Description
display_name	string	Mandatory Display name for the Report.
report_type	int	Mandatory Type of report to be Scheduled. Health Trend Report is not supported.
selection_type	int	Mandatory Resource type associated to this Scheduled Report.
report_format	int	Mandatory Format of the report to be scheduled.
report_frequency	int	Mandatory Frequency for the scheduled report Daily / Weekly / Monthly.
scheduled_day	int	Mandatory, if the chosen report_frequency is Weekly. Day on which you wish to receive Weekly reports.
scheduled_time	int	Mandatory. Time at which you wish to recieve report. Format - hh
scheduled_date	string	Mandatory, if the chosen report_frequency is Monthly. Date on which you wish to receive Monthly reports. Format - dd
scheduled_month	int	Mandatory, if the chosen report_frequency is Quarterly. Specifies the Business Quarter Months in which report has to be sent. Example: On passing scheduled_month as 2, the report will be scheduled at the specified date and hour of February, May, August, and November months.
monitor_groups	array	Mandatory, if the chosen selection_type is Monitor Groups. Monitor Groups to be associated to this scheduled report.
subgroup_monitors	boolean	Optional, , if the chosen selection_type is Monitor Groups. Enable this option to include subgroups of the selected Monitor Groups. Otherwise, only the selected Group(s) will be considered. Default value is true
monitors	array	Mandatory, if the chosen selection_type is Monitors. Monitors to be associated to this scheduled report. Not supported for Busy Hours Report and Top N Reports.
monitor_id	string	Mandatory, if the report_type chosen is Busy Hours Report. Monitor to be associated to this Busy Hours Report.
monitor_type	string	Mandatory, if the report_type chosen is Top N & Bottom N Report or the selection_type is Monitor Type for other supported report types. Type of the monitor.
logtypes	array	Mandatory, if the report_type chosen is Applogs Report. LogTypes to be associated to this scheduled report.
attribute_name	string	Mandatory, if the report_type chosen is Top N & Bottom N Report.Top N & Button Attributes Reports can be scheduled based on the attribute_name if the report_type is Performance and selection_type is Monitors(for one monitor). Performance Attributes (or) You can schedule reports on the attribute_name if the report_type is Availability Summary and the selection_type is Monitors. This is applicable only if a Metrics monitor is selected.
attribute_names	array	Mandatory for Plugin monitors, if the report_type chosen is Performance Report and the selection_type is Monitors or Monitor Type.
plugin_id	long	Mandatory, if the selection_type is Monitor Type and the selected monitor type is Plugin.
user_groups	array	Mandatory. Recipient of the scheduled reports.
business_hours_id	string	The predefined business hours during which critical outage details reports are generated.
report_criteria	json	Criteria to set threshold limits for component values exceeding which a report has to be scheduled. JSON Format: {“criteria”:$criteria_constant,“operator”:$operator_constant,“target_value”:$target_value}. Only Summary report and Availability summary report are supported.
report_periods	array	Report Periods to be associated to the Availability Trend Report
aws_monitor_type	string	Mandatory if the chosen report type is AWS Inventory Report. ID of the AWS service for which you want to receive the report.
meta_info	boolean	Optional, use if report type is Availability Trend Report. Any Monitor Groups information, which the resource is associated to, will be shared in the report.
sla_required	boolean	Optional, use if report type is Availability Trend Report. SLA Availability data will also be included in the shared report for the selected Reporting Period.
days_to_expiry	int	Optional, use if report type is SSL Domain Expiry Report. Use this field to filter your monitors based on days left for expiry. Use -1 if you want to choose all the SSL/Domain Expiry monitors.
report_resource_type	string	Mandatory for the report types mentioned here.

Response Attributes

Attribute	Type	Description
report_id	string	Unique ID generated by the server. This can be used as an identifier.
display_name	string	Display name for the Report.
report_type	int	Type of report to be Scheduled. Health Trend Report is not supported.
selection_type	int	Resource type associated to this Scheduled Report.
report_format	int	Format of the report to be scheduled.
report_frequency	int	Frequency for the scheduled report Daily / Weekly / Monthly.
scheduled_day	int	Day on which you wish to receive Weekly reports.
scheduled_time	int	Time at which you wish to recieve report. Format - hh
scheduled_date	string	Date on which you wish to receive Monthly reports. Format - dd
scheduled_month	int	Business Quarter Months in which report will be sent.
monitor_groups	array	Monitor Groups to be associated to this scheduled report.
subgroup_monitors	boolean	Optional, if the chosen selection_type is Monitor Groups. Enable this option to include subgroups of the selected Monitor Groups. Otherwise, only the selected Group(s) will be considered. Default value is true
monitors	array	Monitors to be associated to this scheduled report. Not supported for Busy Hours Report and Top N Reports.
monitor_id	string	Monitor to be associated to this Busy Hours Report.
monitor_type	string	Type of the monitor.
logtypes	array	LogTypes to be associated to this scheduled report. Supported only for Applogs Report.
attribute_name	string	Top N & Buttom N Attributes or Performance Attributes or Metrics child id based on the report_type.
attribute_names	array	Plugin Attributes.
plugin_id	long	Plugin Template.
user_groups	array	Recipient of the scheduled reports.
business_hours_id	string	The predefined business hours during which critical outage details reports are generated.
report_criteria	json	Criteria to set threshold limits for component values exceeding which a report has to be scheduled. JSON Format: {“criteria”:$criteria_constant,“operator”:$operator_constant,“target_value”:$target_value}. Only Summary report and Availability summary report are supported.
schedule_execution_time	string	Scheduled report execution time
report_periods	array	Report Periods to be associated to the Availability Trend Report
aws_monitor_type	string	ID of the AWS service for which you receive the report.
meta_info	boolean	Optional, use if report type is Availability Trend Report. Any Monitor Groups information, which the resource is associated to, will be shared in the report.
sla_required	boolean	Optional, use if report type is Availability Trend Report. SLA Availability data will also be included in the shared report for the selected Reporting Period.
days_to_expiry	int	Optional, use if report type is SSL Domain Expiry Report. Use this field to filter your monitors based on days left for expiry. Use -1 if you want to choose all the SSL/Domain Expiry monitors.

Delete Scheduled Report

DELETE /scheduled_reports/{report_id}

Request Example

$ curl https://www.site24x7.com/api/scheduled_reports/113770000041403041 \
    -X DELETE \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

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

Delete the existing Scheduled Report.

oauthscope : Site24x7.Reports.Delete

Path Parameters

Param	Type	Description
report_id	string	Mandatory Unique ID generated by the server. This can be used as an identifier.

List Scheduled Reports

GET /scheduled_reports

Request Example

$ curl https://www.site24x7.com/api/scheduled_reports \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": [
    {
      "report_id": "113770000041403041",
      "display_name": "Availability Summary Report",
      "report_frequency": 2,
      "scheduled_time": 22,
      "scheduled_day": 2,
      "report_type": 11,
      "report_format": 3,
      "selection_type": 2,
      "monitors": [
        "113770000039133011",
        "113770000039079003"
      ],
      "user_groups": [
        "113770000000025015"
      ],
      "schedule_execution_time": "Every Tuesday at 22:00 Hrs",
      "schedule_status": 0,
      "business_hours_id": "113770000020402013"
    },
    {..},
    {..}
  ]
}

List of all Scheduled Reports.

oauthscope : Site24x7.Reports.Read

Response Attributes

Attribute	Type	Description
report_id	string	Unique ID generated by the server. This can be used as an identifier.
display_name	string	Display name for the Report.
report_type	int	Type of report to be Scheduled. Health Trend Report is not supported.
selection_type	int	Resource type associated to this Scheduled Report.
report_format	int	Format of the report to be scheduled.
report_frequency	int	Frequency for the scheduled report Daily / Weekly / Monthly.
scheduled_day	int	Day on which you wish to receive Weekly reports.
scheduled_time	int	Time at which you wish to recieve report. Format - hh
scheduled_date	string	Date on which you wish to receive Monthly reports. Format - dd
scheduled_month	int	Business Quarter Months in which report will be sent.
monitor_groups	array	Monitor Groups to be associated to this scheduled report.
subgroup_monitors	boolean	Optional, , if the chosen selection_type is Monitor Groups. Enable this option to include subgroups of the selected Monitor Groups. Otherwise, only the selected Group(s) will be considered. Default value is true
monitors	array	Monitors to be associated to this scheduled report. Not supported for Busy Hours Report and Top N Reports.
monitor_id	string	Monitor to be associated to this Busy Hours Report.
monitor_type	string	Type of the monitor.
logtypes	array	LogTypes to be associated to this scheduled report. Supported only for Applogs Report.
attribute_name	string	Top N & Buttom N Attributes or Performance Attributes or Metrics child id based on the report_type.
attribute_names	array	Plugin Attributes.
plugin_id	long	Plugin Template.
user_groups	array	Recipient of the scheduled reports.
business_hours_id	string	The predefined business hours during which critical outage details reports are generated.
report_criteria	json	Criteria to set threshold limits for component values exceeding which a report has to be scheduled. JSON Format: {“criteria”:$criteria_constant,“operator”:$operator_constant,“target_value”:$target_value}. Only Summary report and Availability summary report are supported.
schedule_execution_time	string	Scheduled report execution time
report_periods	array	Report Periods to be associated to the Availability Trend Report
aws_monitor_type	string	ID of the AWS service for which you receive the report.
meta_info	boolean	Optional, use if report type is Availability Trend Report. Any Monitor Groups information, which the resource is associated to, will be shared in the report.
sla_required	boolean	Optional, use if report type is Availability Trend Report. SLA Availability data will also be included in the shared report for the selected Reporting Period.
days_to_expiry	int	Optional, use if report type is SSL Domain Expiry Report. Use this field to filter your monitors based on days left for expiry. Use -1 if you want to choose all the SSL/Domain Expiry monitors.
report_resource_type	string	Optional, except for the report types mentioned here

Milestone Markers

Milestone marker helps you to record your significant events like build deployments, product updates, feature enhancements and infrastructure upgrades.

List all Milestone Markers

GET /api/milestone

Request Example

$ curl "https://www.site24x7.com/api/milestone?page=4" \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response

{
    "code": 0,
    "message": "success",
    "data": {
        "milestone_list": [
            {
                "monitor_id": "15698000017614001",
                "marker_time": "2017-06-23T02:06:00+0530",
                "label": "Build version 9.35",
                "display_name": "Java Sample App",
                "message": "A simple java app",
                "milestone_type": 1
            },
            {
                "monitor_id": "15698000067539089",
                "marker_time": "2017-05-30T15:38:00+0530",
                "label": "1",
                "display_name": "test",
                "message": "Test Group",
                "milestone_type": 2
            },
            {
                "monitor_id": "15698000067539089",
                "marker_time": "2017-05-30T17:40:00+0530",
                "label": "12",
                "display_name": "TestAPP",
                "message": "",
                "milestone_type": 1
            }
        ],
        "total_count": 32
    }
}

API to list all milestone markers created.

oauthscope : Site24x7.Admin.Read

Query Parameters

Param	Type	Description
page	int	Mandatory Page number of the entire list of milestones.

Response Attributes

Attribute	Type	Description
monitor_id	string	Monitor ID or Group ID.
marker_time	string	Timestamp of milestone creation.
label	string	Milestone label.
display_name	string	Display name of the milestone.
message	string	Milestone description.
milestone_type	int	Milestone marker level.

Add a Milestone Marker

POST /api/milestone

Request Example

$ curl "https://www.site24x7.com/api/milestone" \
    -X POST \
    -H "Accept: application/json; version=2.0" \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \
    -d {
         "marker_time": "2016-06-28T11:00:00+0530",
         "label": "testing",
         "monitor_id": "15698000017614001",
         "message": "Milestone No.1"
        }

Response

{
  "code": 0,
  "message": "success"
}

API to add a new milestone with a json object as payload.

oauthscope : Site24x7.Admin.Create

Request Parameters

Param	Type	Description
marker_time	string	Timestamp of milestone creation.
label	string	Milestone label.
monitor_id	string	Monitor ID or Group ID.
message	string	Milestone description.

Update Milestone Marker

PUT /api/milestone

Request Example

$ curl https://www.site24x7.com/api/milestone \
    -X PUT \
    -H "Accept: application/json; version=2.0" \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \
    -d {
         "marker_time": "2016-06-28T11:00:00+0530",
         "new_marker_time" : "2016-06-28T12:00:00+0530",
         "label": "testing-updated",
         "monitor_id": "15698000017614001",
         "message": "Milestone message changed"
        }

Response

{
  "code": 0,
  "message": "success"
}

API to update an existing milestone with a json object as payload.

oauthscope : Site24x7.Admin.Update

Request Parameters

Param	Type	Description
marker_time	string	Timestamp of milestone creation.
new_marker_time	string	Timestamp of milestone updation.
label	string	Milestone label.
monitor_id	string	Monitor ID or Group ID.
message	string	Milestone description.

Delete a Milestone Marker

DELETE /api/milestone?marker_time={marker_time}&monitor_id={monitor_id}

Request Example

$ curl https://www.site24x7.com/api/milestone?marker_time=2016-06-28+11:27&monitor_id=15698000017614001 \
    -X DELETE \
    -H "Accept: application/json; version=2.0" \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response

{
  "code": 0,
  "message": "success"
}

API to delete an existing milestone marker.

oauthscope : Site24x7.Admin.Delete

Query Parameters

Param	Type	Description
marker_time	string	Timestamp of milestone creation.
monitor_id	string	Monitor ID or Group ID.

SLA Settings

Set goals for your IT Team by setting SLAs per monitor so that your customers are happy.

Create SLA

POST /sla_settings

Request Example

$ curl https://www.site24x7.com/api/sla_settings \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \
    -d '{
      "type": 1,
      "sla_targets": [
        {
          "target_name": "Success",
          "target_color": "#33CC00",
          "target_condition": 0,
          "target_value": 99
        },
        {
          "target_name": "Poor",
          "target_color": "#0045cc",
          "target_condition": 3,
          "target_value": 90
        },
        {
          "target_name": "Medium",
          "target_color": "#33CC00",
          "target_condition": 4,
          "target_value": 90
        }
      ],
      "slo_availability": {
        "availability": 99,
        "condition": 0,
        "weightage": 50
      },
      "slo_responsetime": {
        "responsetime": 100,
        "time_available": 99,
        "condition": 3,
        "weightage": 50
      },
      "display_name": "Monitors Availability",
      "description": "99.9% Availability SLA.",
      "selection_type":2,
      "monitors": [
        "113770000039133011",
        "113770000008080001"
      ],
      "business_hours_id": "113770000010999123"
    }'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": {
    "sla_id": "113770000041403051",
    "display_name": "Monitors Availability",
    "type": 1,
    "description": "99.9% Availability SLA.",
    "business_hours_id": "113770000010999123",
    "sla_targets": [
      {
        "target_id": "113770000041403065",
        "target_name": "Success",
        "target_color": "#33CC00",
        "target_condition": 0,
        "target_value": 99
      },
      {
        "target_id": "113770000041403067",
        "target_name": "Poor",
        "target_color": "#0045cc",
        "target_condition": 3,
        "target_value": 90
      },
      {
        "target_id": "113770000041403069",
        "target_name": "Medium",
        "target_color": "#33CC00",
        "target_condition": 4,
        "target_value": 90
      }
    ],
    "slo_availability": {
      "availability": 99,
      "condition": 0,
      "weightage": 50
    },
    "slo_responsetime": {
      "responsetime": 100,
      "time_available": 99,
      "condition": 3,
      "weightage": 50
    },
    "selection_type":2,
    "monitors": [
      "113770000008080001",
      "113770000039133011"
    ]
  }
}

Create a SLA report.

oauthscope : Site24x7.Admin.Create

Request Parameters

Param	Type	Description
display_name	string	Mandatory Display name for the SLA.
type	int	Mandatory Type of SLA (Availability / Response time/ Composite)
sla_targets	JSON array	Mandatory Targets to be achieved for this SLA. Format: [{target_name: “$name_of_the_target”, target_color:“$hexcode”, target_condition:$sla_target_constants, target_value:$target_value}]
selection_type	int	Mandatory Specify the resource type for which the SLA Report has to be generated. You can either associate “multiple monitors” or “all monitors in a group” with your SLA Report. All Monitors resource segmentation is not supported.
monitors	array	Mandatory, if selection_type chosen is Monitor IDs. Select Monitor IDs to be associated with your SLA Report.
monitor_groups	array	Mandatory, if selection_type chosen is Monitor Groups. Select Monitor Groups to associate all the related monitors in that group to SLA report.
slo_availability	json	Optional, if the chosen SLA type is composite. SLA target to be achieved for monitor availability. JSON Format: {availability: $availability_value, condition:$sla_target_constants, weightage: $weightage_in_percentage}
slo_responsetime	json	Optional, if the chosen SLA type is composite. SLA target to be achieved for monitor responsetime. JSON Format: {responsetime:$responsetime_value, time_available:$time_available, condition:$sla_target_constants, weightage: $weightage_in_percentage}
description	string	Description for the SLA
business_hours_id	string	The predefined business hours during which critical outage details reports are generated.

Response Attributes

Attribute	Type	Description
sla_id	string	Unique ID generated by the server. This can be used as an identifier.
display_name	string	Display name for the SLA.
type	int	Type of SLA (Availability / Response time/ Composite)
sla_targets	JSON array	Targets to be achieved for this SLA. Format: [{target_name: “$name_of_the_target”, target_color:“$hexcode”, target_condition:$sla_target_constants, target_value:$target_value}]
target_id	string	Unique ID for each target generated by the server.
selection_type	int	Resource type associated to this SLA Report. All Monitors are not supported.
monitors	array	Monitor IDs to be associated to the SLA report.
monitor_groups	array	Monitor Groups to be associated to this SLA report.
slo_availability	json	SLA target to be achieved for monitor availability. JSON Format: {availability: $availability_value, condition:$sla_target_constants, weightage: $weightage_in_percentage}
slo_responsetime	json	SLA target to be achieved for monitor responsetime. JSON Format: {responsetime:$responsetime_value, time_available:$time_available, condition:$sla_target_constants, weightage: $weightage_in_percentage}
description	string	Description for the SLA
business_hours_id	string	The predefined business hours during which critical outage details reports are generated.

Get SLA Report

GET /sla_settings/{sla_id}

Request Example

$ curl https://www.site24x7.com/api/sla_settings/113770000041403051 \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": {
    "sla_id": "113770000041403051",
    "display_name": "Monitors Availability",
    "type": 1,
    "description": "99.9% Availability SLA.",
    "business_hours_id": "113770000010999123",
    "sla_targets": [
      {
        "target_id": "113770000041403065",
        "target_name": "Success",
        "target_color": "#33CC00",
        "target_condition": 0,
        "target_value": 99
      },
      {
        "target_id": "113770000041403067",
        "target_name": "Poor",
        "target_color": "#0045cc",
        "target_condition": 3,
        "target_value": 90
      },
      {
        "target_id": "113770000041403069",
        "target_name": "Medium",
        "target_color": "#33CC00",
        "target_condition": 4,
        "target_value": 90
      }
    ],
    "slo_availability": {
      "availability": 99,
      "condition": 0,
      "weightage": 50
    },
    "slo_responsetime": {
      "responsetime": 100,
      "time_available": 99,
      "condition": 3,
      "weightage": 50
    },
    "selection_type":2,
    "monitors": [
      "113770000008080001",
      "113770000039133011"
    ]
  }
}

Retrieve the configuration of a SLA Report.

oauthscope : Site24x7.Admin.Read

Path Parameters

Param	Type	Description
sla_id	string	Mandatory Unique ID generated by the server. This can be used as an identifier.

Response Attributes

Attribute	Type	Description
sla_id	string	Unique ID generated by the server. This can be used as an identifier.
display_name	string	Display name for the SLA.
type	int	Type of SLA (Availability / Response time/ Composite)
sla_targets	JSON array	Targets to be achieved for this SLA. Format: [{target_name: “$name_of_the_target”, target_color:“$hexcode”, target_condition:$sla_target_constants, target_value:$target_value}]
target_id	string	Unique ID for each target generated by the server.
selection_type	int	Resource type associated to this SLA Report. All Monitors are not supported.
monitors	array	Monitor IDs to be associated to the SLA report.
monitor_groups	array	Monitor Groups to be associated to this SLA report.
slo_availability	json	SLA target to be achieved for monitor availability. JSON Format: {availability: $availability_value, condition:$sla_target_constants, weightage: $weightage_in_percentage}
slo_responsetime	json	SLA target to be achieved for monitor responsetime. JSON Format: {responsetime:$responsetime_value, time_available:$time_available, condition:$sla_target_constants, weightage: $weightage_in_percentage}
description	string	Description for the SLA
business_hours_id	string	The predefined business hours during which critical outage details reports are generated.

Update SLA Report

PUT /sla_settings/{sla_id}

Request Example

$ curl https://www.site24x7.com/api/sla_settings/113770000041403051 \
    -X PUT \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \
    -d '{
      "type": 1,
      "sla_targets": [
        {
          "target_name": "Success",
          "target_color": "#33CC00",
          "target_condition": 0,
          "target_value": 99
        },
        {
          "target_name": "Poor",
          "target_color": "#0045cc",
          "target_condition": 3,
          "target_value": 90
        },
        {
          "target_name": "Medium",
          "target_color": "#33CC00",
          "target_condition": 4,
          "target_value": 90
        }
      ],
      "slo_availability": {
        "availability": 99,
        "condition": 0,
        "weightage": 50
      },
      "slo_responsetime": {
        "responsetime": 100,
        "time_available": 99,
        "condition": 3,
        "weightage": 50
      },
      "display_name": "Monitors Availability",
      "description": "99.9% Availability SLA.",
      "selection_type":2,
      "monitors": [
        "113770000039133011",
        "113770000008080001"
      ],
      "business_hours_id": "113770000010999123"
    }'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": {
    "sla_id": "113770000041403051",
    "display_name": "Monitors Availability",
    "type": 1,
    "description": "99.9% Availability SLA.",
    "business_hours_id": "113770000010999123",
    "sla_targets": [
      {
        "target_id": "113770000041403065",
        "target_name": "Success",
        "target_color": "#33CC00",
        "target_condition": 0,
        "target_value": 99
      },
      {
        "target_id": "113770000041403067",
        "target_name": "Poor",
        "target_color": "#0045cc",
        "target_condition": 3,
        "target_value": 90
      },
      {
        "target_id": "113770000041403069",
        "target_name": "Medium",
        "target_color": "#33CC00",
        "target_condition": 4,
        "target_value": 90
      }
    ],
    "slo_availability": {
      "availability": 99,
      "condition": 0,
      "weightage": 50
    },
    "slo_responsetime": {
      "responsetime": 100,
      "time_available": 99,
      "condition": 3,
      "weightage": 50
    },
    "selection_type":2,
    "monitors": [
      "113770000008080001",
      "113770000039133011"
    ]
  }
}

Update the configuration of an existing SLA Report.

oauthscope : Site24x7.Admin.Update

Path Parameters

Param	Type	Description
sla_id	string	Mandatory Unique ID generated by the server. This can be used as an identifier.

Request Parameters

Param	Type	Description
display_name	string	Mandatory Display name for the SLA.
type	int	Mandatory Type of SLA (Availability / Response time/ Composite)
sla_targets	JSON array	Mandatory Targets to be achieved for this SLA. Format: [{target_name: “$name_of_the_target”, target_color:“$hexcode”, target_condition:$sla_target_constants, target_value:$target_value}]
selection_type	int	Mandatory Specify the resource type for which the SLA Report has to be generated. You can either associate “multiple monitors” or “all monitors in a group” with your SLA Report. All Monitors resource segmentation is not supported.
monitors	array	Mandatory, if selection_type chosen is Monitor IDs. Select Monitor IDs to be associated with your SLA Report.
monitor_groups	array	Mandatory, if selection_type chosen is Monitor Groups. Select Monitor Groups to associate all the related monitors in that group to SLA report.
slo_availability	json	Optional, if the chosen SLA type is composite. SLA target to be achieved for monitor availability. JSON Format: {availability: $availability_value, condition:$sla_target_constants, weightage: $weightage_in_percentage}
slo_responsetime	json	Optional, if the chosen SLA type is composite. SLA target to be achieved for monitor responsetime. JSON Format: {responsetime:$responsetime_value, time_available:$time_available, condition:$sla_target_constants, weightage: $weightage_in_percentage}
description	string	Description for the SLA
business_hours_id	string	The predefined business hours during which critical outage details reports are generated.

Response Attributes

Attribute	Type	Description
sla_id	string	Unique ID generated by the server. This can be used as an identifier.
display_name	string	Display name for the SLA.
type	int	Type of SLA (Availability / Response time/ Composite)
sla_targets	JSON array	Targets to be achieved for this SLA. Format: [{target_name: “$name_of_the_target”, target_color:“$hexcode”, target_condition:$sla_target_constants, target_value:$target_value}]
target_id	string	Unique ID for each target generated by the server.
selection_type	int	Resource type associated to this SLA Report. All Monitors are not supported.
monitors	array	Monitor IDs to be associated to the SLA report.
monitor_groups	array	Monitor Groups to be associated to this SLA report.
slo_availability	json	SLA target to be achieved for monitor availability. JSON Format: {availability: $availability_value, condition:$sla_target_constants, weightage: $weightage_in_percentage}
slo_responsetime	json	SLA target to be achieved for monitor responsetime. JSON Format: {responsetime:$responsetime_value, time_available:$time_available, condition:$sla_target_constants, weightage: $weightage_in_percentage}
description	string	Description for the SLA
business_hours_id	string	The predefined business hours during which critical outage details reports are generated.

Delete SLA Report

DELETE /sla_settings/{sla_id}

Request Example

$ curl https://www.site24x7.com/api/sla_settings/113770000041403051 \
    -X DELETE \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

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

Delete the existing SLA Report.

oauthscope : Site24x7.Admin.Delete

Path Parameters

Param	Type	Description
sla_id	string	Mandatory Unique ID generated by the server. This can be used as an identifier.

List SLA Reports

GET /sla_settings

Request Example

$ curl https://www.site24x7.com/api/sla_settings \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": [
    {
      "sla_id": "113770000041403051",
      "display_name": "Monitors Availability",
      "type": 1,
      "description": "99.9% Availability SLA.",
      "business_hours_id": "113770000010999123",
      "sla_targets": [
        {
          "target_id": "113770000041403065",
          "target_name": "Success",
          "target_color": "#33CC00",
          "target_condition": 0,
          "target_value": 99
        },
        {
          "target_id": "113770000041403067",
          "target_name": "Poor",
          "target_color": "#0045cc",
          "target_condition": 3,
          "target_value": 90
        },
        {
          "target_id": "113770000041403069",
          "target_name": "Medium",
          "target_color": "#33CC00",
          "target_condition": 4,
          "target_value": 90
        }
      ],
      "slo_availability": {
        "availability": 99,
        "condition": 0,
        "weightage": 50
      },
      "slo_responsetime": {
        "responsetime": 100,
        "time_available": 99,
        "condition": 3,
        "weightage": 50
      },
      "selection_type":2,
      "monitors": [
        "113770000008080001",
        "113770000039133011"
      ]
    },
    {..},
    {..}
  ]
}

List of all SLA Reports.

oauthscope : Site24x7.Admin.Read

Response Attributes

Attribute	Type	Description
sla_id	string	Unique ID generated by the server. This can be used as an identifier.
display_name	string	Display name for the SLA.
type	int	Type of SLA (Availability / Response time/ Composite)
sla_targets	JSON array	Targets to be achieved for this SLA. Format: [{target_name: “$name_of_the_target”, target_color:“$hexcode”, target_condition:$sla_target_constants, target_value:$target_value}]
target_id	string	Unique ID for each target generated by the server.
selection_type	int	Resource type associated to this SLA Report. All Monitors are not supported.
monitors	array	Monitor IDs to be associated to the SLA report.
monitor_groups	array	Monitor Groups to be associated to this SLA report.
slo_availability	json	SLA target to be achieved for monitor availability. JSON Format: {availability: $availability_value, condition:$sla_target_constants, weightage: $weightage_in_percentage}
slo_responsetime	json	SLA target to be achieved for monitor responsetime. JSON Format: {responsetime:$responsetime_value, time_available:$time_available, condition:$sla_target_constants, weightage: $weightage_in_percentage}
description	string	Description for the SLA
business_hours_id	string	The predefined business hours during which critical outage details reports are generated.

Status Pages

Publish the current status of your services to your customers and end users. This will help reduce calls to the help desk. Additionally build customer confidence in the long term.

Create a Status Page

POST /status_dashboards

Request Example

$ curl https://www.site24x7.com/api/status_dashboards \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \
    -d '{
      "layout_type": 2,
      "selection_type": 0,
      "show_transaction_time": true,
      "show_maintenance": true,
      "show_history": true,
      "show_current_status": true,
      "show_performance": true,
      "display_name": "Service Status Dashboard",
      "description": "Displays the current status of the service.",
      "footer": "2016 All rights Reserved.",
      "domain_name": "www.mydomain.com",
      "domain_path": "myservice",
      "incident_history" : true,
      "powered_by" : true
    }'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": {
    "status_viewid": "113770000041403071",
    "display_name": "Service Status Dashboard",
    "description": "Displays the current status of the service.",
    "footer": "2016 All rights Reserved.",
    "show_transaction_time": true,
    "show_noc_comments": false,
    "layout_type": 2,
    "report_period": -1,
    "monitor_groups": "0",
    "show_maintenance": true,
    "show_performance": true,
    "show_history": true,
    "show_current_status": true,
    "permalink": "https://www.site24x7.com/dv.do?id=X9qsSr8BqYvWS151245wHS54QNkmW4H9sBMEu12IB5NLEQEb2gaS4iBmWtXe5UTMF%2Bldffvi%2BgwjCjh%2FmYgZ%0ATna8OfxrFgRmvUpIiz1Q%2FsniX8hng5U%3D",
    "embed_code": "https://www.site24x7.com/dv.do?id=X9qsSfgu124r8BqYvWS15HS54QNkmW4H9sBMEu12IB5NLEQEb2gaS4iBmWtXe5UTMF%2Blvi%2BgwjCjh%2FmYgZ%0ATrag4una8OfxrFgRmvUpIiz1Q%2FsniX8hng5U%3D",
    "selection_type": 0,
    "custom_domain": "http://www.mydomain.com/ns/myservice",
    "domain_name": "www.mydomain.com",
    "domain_path": "myservice",
    "domain_verification": {
            "key":"6079158eebfa7f5818291020151b9517e62a" 
        },
    "incident_history" : true,
    "powered_by" : true
  }
}

Create a new Status Page.

oauthscope : Site24x7.Reports.Create

Request Parameters

Param	Type	Description
display_name	string	Mandatory Display Name for the Status Dashboard.
selection_type	int	Mandatory Resource type associated to this Status Page.
monitor_groups	array	Mandatory, if the chosen selection_type is Monitor Groups. Monitor Groups to be associated to this Status Page.
monitors	array	Mandatory, if the chosen selection_type is Monitors. Monitors to be associated to this Status Page.
layout_type	int	Mandatory Expected value is 2
show_transaction_time	boolean	Mandatory Enable to show total transaction time for web transaction monitors.
description	string	Description for the Status Dashboard.
footer	string	Footer text for the Status Dashboard.
show_maintenance	boolean	Enable to show Scheduled Maintenance in Status Dashboard.
show_history	booelan	Enable to show Availability history over the period of 3 months.
show_performance	boolean	Enable to show performance of the monitors in Status Dashboard.
domain_name	string	Domain name over which the Status Dashboard can be accessible.
domain_path	string	URL path in the specified domain for accessing Status Dashboard.
incident_history	boolean	To show or hide the Incident History section in Status Page.
powered_by	boolean	To show or hide ‘Site24x7 Powered By’ section in Status Page.

Response Attributes

Attribute	Type	Description
status_viewid	string	Unique ID generated by the server. This can be used as an identifier.
display_name	string	Display Name for the Status Dashboard.
selection_type	int	Resource type associated to this Status Page.
monitor_groups	array	Monitor Groups to be associated to this Status Page.
monitors	array	Monitors to be associated to this Status Page.
layout_type	int	Layout type - 2
show_transaction_time	boolean	Enable to show total transaction time for web transaction monitors.
description	string	Description for the Status Dashboard.
footer	string	Footer text for the Status Dashboard.
show_maintenance	boolean	Enable to show Scheduled Maintenance in Status Dashboard.
show_history	booelan	Enable to show Availability history over the period of 3 months.
show_performance	boolean	Enable to show performance of the monitors in Status Dashboard.
domain_name	string	Domain name over which the Status Dashboard can be accessible.
domain_path	string	URL path in the specified domain for accessing Status Dashboard.
domain_verification	json	Obtain domain verification details, such as DNS TXT verification key and verification status.
key	string	This unique alphanumeric key must be entered in your custom domain host’s DNS TXT records to verify your domain ownership successfully.
status	boolean	Domain verification status.
permalink	string	Link to access the status page
custom_domain	string	Custom Domain
embed_code	string	iframe code snippet to embed within the body tag of your HTML document.
incident_history	boolean	To show or hide the Incident History section in Status Page.
powered_by	boolean	To show or hide ‘Site24x7 Powered By’ section in Status Page.

Retrieve a Status Page

GET /status_dashboards/{status_viewid}

Request Example

$ curl https://www.site24x7.com/api/status_dashboards/113770000041403071 \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": {
    "status_viewid": "113770000041403071",
    "display_name": "Service Status Dashboard",
    "description": "Displays the current status of the service.",
    "footer": "2016 All rights Reserved.",
    "show_transaction_time": true,
    "show_noc_comments": false,
    "layout_type": 2,
    "report_period": -1,
    "monitor_groups": "0",
    "show_maintenance": true,
    "show_performance": true,
    "show_history": true,
    "show_current_status": true,
    "permalink": "https://www.site24x7.com/dv.do?id=X9qsSr8BqYvWS151245wHS54QNkmW4H9sBMEu12IB5NLEQEb2gaS4iBmWtXe5UTMF%2Bldffvi%2BgwjCjh%2FmYgZ%0ATna8OfxrFgRmvUpIiz1Q%2FsniX8hng5U%3D",
    "embed_code": "https://www.site24x7.com/dv.do?id=X9qsSfgu124r8BqYvWS15HS54QNkmW4H9sBMEu12IB5NLEQEb2gaS4iBmWtXe5UTMF%2Blvi%2BgwjCjh%2FmYgZ%0ATrag4una8OfxrFgRmvUpIiz1Q%2FsniX8hng5U%3D",
    "selection_type": 0,
    "custom_domain": "http://www.mydomain.com/ns/myservice",
    "domain_name": "www.mydomain.com",
    "domain_path": "myservice",
    "domain_verification": {
            "key":"6079158eebfa7f5818291020151b9517e62a",
            "status":true
        },
    "incident_history" : true,
    "powered_by" : true
  }
}

Retrieve the configuration of the Status Page.

oauthscope : Site24x7.Reports.Read

Path Parameters

Param	Type	Description
status_viewid	string	Unique ID generated by the server. This can be used as an identifier.

Response Attributes

Attribute	Type	Description
status_viewid	string	Unique ID generated by the server. This can be used as an identifier.
display_name	string	Display Name for the Status Dashboard.
selection_type	int	Resource type associated to this Status Page.
monitor_groups	array	Monitor Groups to be associated to this Status Page.
monitors	array	Monitors to be associated to this Status Page.
layout_type	int	Layout type - 2
show_transaction_time	boolean	Enable to show total transaction time for web transaction monitors.
description	string	Description for the Status Dashboard.
footer	string	Footer text for the Status Dashboard.
show_maintenance	boolean	Enable to show Scheduled Maintenance in Status Dashboard.
show_history	booelan	Enable to show Availability history over the period of 3 months.
show_performance	boolean	Enable to show performance of the monitors in Status Dashboard.
domain_name	string	Domain name over which the Status Dashboard can be accessible.
domain_path	string	URL path in the specified domain for accessing Status Dashboard.
domain_verification	json	Obtain domain verification details, such as DNS TXT verification key and verification status.
key	string	This unique alphanumeric key must be entered in your custom domain host’s DNS TXT records to verify your domain ownership successfully.
status	boolean	Domain verification status.
permalink	string	Link to access the status page
custom_domain	string	Custom Domain
embed_code	string	iframe code snippet to embed within the body tag of your HTML document.
incident_history	boolean	To show or hide the Incident History section in Status Page.
powered_by	boolean	To show or hide ‘Site24x7 Powered By’ section in Status Page.

Update a Status Page

PUT /status_dashboards/{status_viewid}

Request Example

$ curl https://www.site24x7.com/api/status_dashboards/113770000041403071 \
    -X PUT \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \
    -d '{
      "layout_type": 2,
      "selection_type": 0,
      "show_transaction_time": true,
      "show_maintenance": true,
      "show_history": true,
      "show_current_status": true,
      "show_performance": true,
      "display_name": "Service Status Dashboard",
      "description": "Displays the current status of the service.",
      "footer": "2016 All rights Reserved.",
      "domain_name": "www.mydomain.com",
      "domain_path": "myservice",
      "incident_history" : true,
      "powered_by" : true
    }'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": {
    "status_viewid": "113770000041403071",
    "display_name": "Service Status Dashboard",
    "description": "Displays the current status of the service.",
    "footer": "2016 All rights Reserved.",
    "show_transaction_time": true,
    "show_noc_comments": false,
    "layout_type": 2,
    "report_period": -1,
    "monitor_groups": "0",
    "show_maintenance": true,
    "show_performance": true,
    "show_history": true,
    "show_current_status": true,
    "permalink": "https://www.site24x7.com/dv.do?id=X9qsSr8BqYvWS151245wHS54QNkmW4H9sBMEu12IB5NLEQEb2gaS4iBmWtXe5UTMF%2Bldffvi%2BgwjCjh%2FmYgZ%0ATna8OfxrFgRmvUpIiz1Q%2FsniX8hng5U%3D",
    "embed_code": "https://www.site24x7.com/dv.do?id=X9qsSfgu124r8BqYvWS15HS54QNkmW4H9sBMEu12IB5NLEQEb2gaS4iBmWtXe5UTMF%2Blvi%2BgwjCjh%2FmYgZ%0ATrag4una8OfxrFgRmvUpIiz1Q%2FsniX8hng5U%3D",
    "selection_type": 0,
    "custom_domain": "http://www.mydomain.com/ns/myservice",
    "domain_name": "www.mydomain.com",
    "domain_path": "myservice",
    "domain_verification": {
            "key":"6079158eebfa7f5818291020151b9517e62a",
            "status":false
        },
    "incident_history" : true,
    "powered_by" : true
  }
}

Update the configuration of an existing Status Page.

oauthscope : Site24x7.Reports.Update

Path Parameters

Param	Type	Description
status_viewid	string	Unique ID generated by the server. This can be used as an identifier.

Request Parameters

Param	Type	Description
display_name	string	Mandatory Display Name for the Status Dashboard.
selection_type	int	Mandatory Resource type associated to this Status Page.
monitor_groups	array	Mandatory, if the chosen selection_type is Monitor Groups. Monitor Groups to be associated to this Status Page.
monitors	array	Mandatory, if the chosen selection_type is Monitors. Monitors to be associated to this Status Page.
layout_type	int	Mandatory Expected value is 2
show_transaction_time	boolean	Mandatory Enable to show total transaction time for web transaction monitors.
description	string	Description for the Status Dashboard.
footer	string	Footer text for the Status Dashboard.
show_maintenance	boolean	Enable to show Scheduled Maintenance in Status Dashboard.
show_history	booelan	Enable to show Availability history over the period of 3 months.
show_performance	boolean	Enable to show performance of the monitors in Status Dashboard.
domain_name	string	Domain name over which the Status Dashboard can be accessible.
domain_path	string	URL path in the specified domain for accessing Status Dashboard.
incident_history	boolean	To show or hide the Incident History section in Status Page.
powered_by	boolean	To show or hide ‘Site24x7 Powered By’ section in Status Page.

Response Attributes

Attribute	Type	Description
status_viewid	string	Unique ID generated by the server. This can be used as an identifier.
display_name	string	Display Name for the Status Dashboard.
selection_type	int	Resource type associated to this Status Page.
monitor_groups	array	Monitor Groups to be associated to this Status Page.
monitors	array	Monitors to be associated to this Status Page.
layout_type	int	Layout type - 2
show_transaction_time	boolean	Enable to show total transaction time for web transaction monitors.
description	string	Description for the Status Dashboard.
footer	string	Footer text for the Status Dashboard.
show_maintenance	boolean	Enable to show Scheduled Maintenance in Status Dashboard.
show_history	booelan	Enable to show Availability history over the period of 3 months.
show_performance	boolean	Enable to show performance of the monitors in Status Dashboard.
domain_name	string	Domain name over which the Status Dashboard can be accessible.
domain_path	string	URL path in the specified domain for accessing Status Dashboard.
domain_verification	json	Obtain domain verification details, such as DNS TXT verification key and verification status.
key	string	This unique alphanumeric key must be entered in your custom domain host’s DNS TXT records to verify your domain ownership successfully.
status	boolean	Domain verification status.
permalink	string	Link to access the status page
custom_domain	string	Custom Domain
embed_code	string	iframe code snippet to embed within the body tag of your HTML document.
incident_history	boolean	To show or hide the Incident History section in Status Page.
powered_by	boolean	To show or hide ‘Site24x7 Powered By’ section in Status Page.

Delete a Status Page

DELETE /status_dashboards/{status_viewid}

Request Example

$ curl https://www.site24x7.com/api/status_dashboards/113770000041403071 \
    -X DELETE \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

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

Delete an existing Status Page.

oauthscope : Site24x7.Reports.Delete

Path Parameters

Param	Type	Description
status_viewid	string	Unique ID generated by the server. This can be used as an identifier.

List of Status Pages

GET /status_dashboards

Request Example

$ curl https://www.site24x7.com/api/status_dashboards \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": [
    {
      "status_viewid": "113770000041403071",
      "display_name": "Service Status Dashboard",
      "description": "Displays the current status of the service.",
      "footer": "2016 All rights Reserved.",
      "show_transaction_time": true,
      "show_noc_comments": false,
      "layout_type": 2,
      "report_period": -1,
      "monitor_groups": "0",
      "show_maintenance": true,
      "show_performance": true,
      "show_history": true,
      "show_current_status": true,
      "permalink": "https://www.site24x7.com/dv.do?id=X9qsSr8BqYvWS151245wHS54QNkmW4H9sBMEu12IB5NLEQEb2gaS4iBmWtXe5UTMF%2Bldffvi%2BgwjCjh%2FmYgZ%0ATna8OfxrFgRmvUpIiz1Q%2FsniX8hng5U%3D",
      "embed_code": "https://www.site24x7.com/dv.do?id=X9qsSfgu124r8BqYvWS15HS54QNkmW4H9sBMEu12IB5NLEQEb2gaS4iBmWtXe5UTMF%2Blvi%2BgwjCjh%2FmYgZ%0ATrag4una8OfxrFgRmvUpIiz1Q%2FsniX8hng5U%3D",
      "selection_type": 0,
      "custom_domain": "http://www.mydomain.com/ns/myservice",
      "domain_name": "www.mydomain.com",
      "domain_path": "myservice",
      "domain_verification": {
            "key":"6079158eebfa7f5818291020151b9517e62a",
            "status":true
      },
      "incident_history" : true,
      "powered_by" : true
    },
    {..},
    {..}
  ]
}

List of all Status Pages

oauthscope : Site24x7.Reports.Read

Response Attributes

Attribute	Type	Description
status_viewid	string	Unique ID generated by the server. This can be used as an identifier.
display_name	string	Display Name for the Status Dashboard.
selection_type	int	Resource type associated to this Status Page.
monitor_groups	array	Monitor Groups to be associated to this Status Page.
monitors	array	Monitors to be associated to this Status Page.
layout_type	int	Layout type - 2
show_transaction_time	boolean	Enable to show total transaction time for web transaction monitors.
description	string	Description for the Status Dashboard.
footer	string	Footer text for the Status Dashboard.
show_maintenance	boolean	Enable to show Scheduled Maintenance in Status Dashboard.
show_history	booelan	Enable to show Availability history over the period of 3 months.
show_performance	boolean	Enable to show performance of the monitors in Status Dashboard.
domain_name	string	Domain name over which the Status Dashboard can be accessible.
domain_path	string	URL path in the specified domain for accessing Status Dashboard.
domain_verification	json	Obtain domain verification details, such as DNS TXT verification key and verification status.
key	string	This unique alphanumeric key must be entered in your custom domain host’s DNS TXT records to verify your domain ownership successfully.
status	boolean	Domain verification status.
permalink	string	Link to access the status page
custom_domain	string	Custom Domain
embed_code	string	iframe code snippet to embed within the body tag of your HTML document.
incident_history	boolean	To show or hide the Incident History section in Status Page.
powered_by	boolean	To show or hide ‘Site24x7 Powered By’ section in Status Page.

Create an Announcement

POST /announcement/{status_viewid}

Request Example

$ curl https://www.site24x7.com/api/announcement/113770000041953001 \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \
    -d '{ 
            "description": "Description Text", 
            "heading": "Heading Text", 
            "expiry_time": "5", 
            "time": "2017-07-28T09:00:00+0530"
        }'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": {
    "id": "1509439440000",
    "description": "Description Text",
    "heading": "Heading Text",
    "time": "2017-07-28T09:00:00+0530",
    "show_on_top": true,
    "expiry_time": "5"
  }
}

Create a new announcement to display in the status dashboard.

oauthscope : Site24x7.Operations.Create

Path Parameters

Param	Type	Description
status_viewid	string	Mandatory Unique ID of the status dashboard.

Request Parameters

Param	Type	Description
heading	string	Mandatory Heading of the announcement.
description	string	Mandatory Description of the announcement.
expiry_time	int	Mandatory Expiry duration of the announcement in hours.
time	string	Time of the announcement. Current time will be set if no value passed.

Response Attributes

Attribute	Type	Description
id	string	Server generated ID to uniquely identify the announcement.
heading	string	Heading of the announcement.
description	string	Description of the announcement.
expiry_time	int	Expiry duration of the announcement in hours.
time	string	Time of the announcement.
show_on_top	boolean	Attribute to show a particular announcement on top of the status dashboard.

Retrieve Announcements Using Auth-token

GET /announcement/{status_viewid}

Request Example

$ curl https://www.site24x7.com/api/announcement/174961000190262079 \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": {
    "announcements": [
      {
        "expiry_time": "5",
        "description": "Description Text",
        "time": "2017-07-28T09:00:00+0530",
        "heading": "Heading Text",
        "show_on_top": true,
        "id": "1509439440000"
      },
      {
        "description": "Description of the Announcement",
        "time": "2017-07-28T10:36:00+0530",
        "heading": "Heading of the Announcement",
        "id": "1509439440000"
      }
    ]
  }
}

Retrieve all the announcements for a particular status dashboard using auth-token.

oauthscope : Site24x7.Operations.Read

Path Parameters

Param	Type	Description
status_viewid	string	Mandatory Unique ID of the status dashboard.

Response Attributes

Attribute	Type	Description
announcements	array	List of announcements for the particular status dashboard.
id	string	Server generated ID to uniquely identify the announcement.
heading	string	Heading of the announcement.
description	string	Description of the announcement.
expiry_time	int	Expiry duration of the announcement in hours.
time	string	Date of the announcement.
show_on_top	boolean	Attribute to show a particular announcement on top of the status dashboard.

Retrieve Announcements Using Public View ID

GET /announcement?id={public_viewid}

Request Example

$ curl "https://www.site24x7.com/api/announcement?id=X9qsSr8BqYsv1xFJLXp54mZu6x%2BqO2f7HWQE16Gd4tX2gaS4iBmWtXe5UTMF%2Blvi%2BgwjCjh%2FmYgZ%0ATna8OfxrFgRmvUpIiz1Q%2FsniX8hng5U%3D" \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Accept: application/json; version=2.0"

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": {
    "announcements": [
      {
        "expiry_time": "5",
        "description": "Description Text",
        "time": "2017-07-28T09:00:00+0530",
        "heading": "Heading Text",
        "show_on_top": true,
        "id": "1509439440000"
      },
      {
        "description": "Description of the Announcement",
        "time": "2017-07-28T10:36:00+0530",
        "heading": "Heading of the Announcement",
        "id": "1509439440000"
      }
    ]
  }
}

Retrieve all the announcements for a particular status dashboard using public view id of the status dashboard.

Path Parameters

Param	Type	Description
public_viewid	string	Mandatory Public view ID of the status dashboard.

Response Attributes

Attribute	Type	Description
announcements	array	List of announcements for the particular status dashboard.
id	string	Server generated ID to uniquely identify the announcement.
heading	string	Heading of the announcement.
description	string	Description of the announcement.
expiry_time	int	Expiry duration of the announcement in hours.
time	string	Date of the announcement.
show_on_top	boolean	Attribute to show a particular announcement on top of the status dashboard.

Update an Announcement

PUT /announcement/{status_viewid}/{announcement_id}

Request Example

$ curl https://www.site24x7.com/api/announcement/174961000190262079/1505915340000 \
    -X PUT \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \
    -d '{ 
            "description": "Description Text", 
            "heading": "Heading Text", 
            "expiry_time": "5", 
            "time": "2017-07-28T09:00:00+0530"
        }'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": {
    "id": "1505915340000",
    "description": "Description Text",
    "heading": "Heading Text",
    "time": "2017-07-28T09:00:00+0530",
    "show_on_top": true,
    "expiry_time": "5"
  }
}

Update an existing announcement in a particular status dashboard.

oauthscope : Site24x7.Operations.Update

Path Parameters

Param	Type	Description
status_viewid	string	Mandatory Unique ID of the status dashboard.
announcement_id	string	Mandatory Unique ID of the announcement.

Request Parameters

Param	Type	Description
heading	string	Mandatory Heading of the announcement.
description	string	Mandatory Description of the announcement.
expiry_time	int	Mandatory Expiry duration of the announcement in hours.
time	string	Mandatory Time of the announcement. Current time will be set if no value passed.

Response Attributes

Attribute	Type	Description
id	string	Server generated ID to uniquely identify the announcement.
heading	string	Heading of the announcement.
description	string	Description of the announcement.
expiry_time	int	Expiry duration of the announcement in hours.
time	string	Time of the announcement.
show_on_top	boolean	Attribute to show a particular announcement on top of the status dashboard.

Delete an Announcement

DELETE /announcement/{status_viewid}/{announcement_id}

Request Example

$ curl https://www.site24x7.com/api/announcement/174961000190262079/1505915340000 \
    -X DELETE \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

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

Delete an existing announcement in a particular status dashboard.

oauthscope : Site24x7.Operations.Delete

Path Parameters

Param	Type	Description
status_viewid	string	Mandatory Unique ID of the status dashboard.
announcement_id	string	Mandatory Server generated ID to uniquely identify the announcement.

Response Attributes

Attribute	Type	Description
resource_id	string	ID of the deleted announcement.
resource_name	string	Type of the resource being deleted.

Operations Dashboards

Get an at-a-glance status of all applications and servers monitored. Simple embed options make it really useful for a NOC.

Create Operations Dashboard

POST /dashboard_views

Request Example

$ curl https://www.site24x7.com/api/dashboard_views \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \
    -d '{
      "display_name": "NOC Plasma Dashboard",
      "layout_type": 1,
      "visited_user": true,
      "monitor_groups": "113770000026704011",
      "selection_type": "1"
    }'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": {
    "dashboard_viewid": "113770000041403073",
    "display_name": "NOC Plasma Dashboard",
    "layout_type": 1,
    "visited_user": true,
    "social_status": true,
    "monitor_groups": "113770000026704011",
    "permalink": "https://www.site24x7.com/dv.do?id=X9qsSr8BqYvWS151245wHS54QNkmW4H9sBMEu12IB5NLEQEb2gaS4iBmWtXe5UTMF%2Bldffvi%2BgwjCjh%2FmYgZ%0ATna8OfxrFgRmvUpIiz1Q%2FsniX8hng5U%3D",
    "embed_code": "https://www.site24x7.com/dv.do?id=X9qsSfgu124r8BqYvWS15HS54QNkmW4H9sBMEu12IB5NLEQEb2gaS4iBmWtXe5UTMF%2Blvi%2BgwjCjh%2FmYgZ%0ATrag4una8OfxrFgRmvUpIiz1Q%2FsniX8hng5U%3D",
    "selection_type": 1
  }
}

Create a new Operations Dashboard

oauthscope : Site24x7.Reports.Create

Request Parameters

Param	Type	Description
display_name	string	Mandatory Display name for the Operations Dashboard.
layout_type	int	Mandatory Layout to be used for the Operations Dashboard. Layout 1 - 1 and Layout 2 - 2
selection_type	int	Mandatory Resource type associated to this Operations Dashboard.
monitors	array	Mandatory, if the chosen selection_type is Monitors. Monitors to be associated to this Operations Dashboard.
monitor_groups	string	Mandatory, if the chosen selection_type is Monitor Groups. Monitor Group to be associated to this Status Page.
subgroup_monitors	boolean	Optional, if the chosen selection_type Monitor Groups. Otherwise, only the selected Group(s) will be considered. Default value is true
visited_user	boolean	Show operators who visited during outage.

Response Attributes

Attribute	Type	Description
dashboard_viewid	string	Unique ID generated by the server. This can be used as an identifier.
display_name	string	Display name for the Operations Dashboard.
layout_type	int	Layout to be used for the Operations Dashboard. Layout 1 - 1 and Layout 2 - 2
selection_type	int	Resource type associated to this Operations Dashboard.
monitors	array	Monitors associated with this Operations Dashboard.
monitor_groups	string	Monitor Group associated with this Status Page.
subgroup_monitors	boolean	Optional, if the chosen selection_type is Monitor Groups. Enable this option to include subgroups of the selected Monitor Groups. Otherwise, only the selected Group(s) will be considered. Default value is true
visited_user	boolean	Show operators who visited during outage.
permalink	string	Link to access the status page
embed_code	string	iframe code snippet to embed within the body tag of your HTML document.

Retrieve Operations Dashboard

GET /dashboard_views/{dashboard_viewid}

Request Example

$ curl https://www.site24x7.com/api/dashboard_views/113770000041403073 \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": {
    "dashboard_viewid": "113770000041403073",
    "display_name": "NOC Plasma Dashboard",
    "layout_type": 1,
    "visited_user": true,
    "social_status": true,
    "monitor_groups": "113770000026704011",
    "permalink": "https://www.site24x7.com/dv.do?id=X9qsSr8BqYvWS151245wHS54QNkmW4H9sBMEu12IB5NLEQEb2gaS4iBmWtXe5UTMF%2Bldffvi%2BgwjCjh%2FmYgZ%0ATna8OfxrFgRmvUpIiz1Q%2FsniX8hng5U%3D",
    "embed_code": "https://www.site24x7.com/dv.do?id=X9qsSfgu124r8BqYvWS15HS54QNkmW4H9sBMEu12IB5NLEQEb2gaS4iBmWtXe5UTMF%2Blvi%2BgwjCjh%2FmYgZ%0ATrag4una8OfxrFgRmvUpIiz1Q%2FsniX8hng5U%3D",
    "selection_type": 1
  }
}

Retrieve the configuration of the Operations Dashboard.

oauthscope : Site24x7.Reports.Read

Path Parameters

Param	Type	Description
dashboard_viewid	string	Mandatory Unique ID generated by the server. This can be used as an identifier.

Response Attributes

Attribute	Type	Description
dashboard_viewid	string	Unique ID generated by the server. This can be used as an identifier.
display_name	string	Display name for the Operations Dashboard.
layout_type	int	Layout to be used for the Operations Dashboard. Layout 1 - 1 and Layout 2 - 2
selection_type	int	Resource type associated to this Operations Dashboard.
monitors	array	Monitors associated with this Operations Dashboard.
monitor_groups	string	Monitor Group associated with this Status Page.
subgroup_monitors	boolean	Optional, if the chosen selection_type is Monitor Groups. Enable this option to include subgroups of the selected Monitor Groups. Otherwise, only the selected Group(s) will be considered. Default value is true
visited_user	boolean	Show operators who visited during outage.
permalink	string	Link to access the status page
embed_code	string	iframe code snippet to embed within the body tag of your HTML document.

Update Operations Dashboard

PUT /dashboard_views/{dashboard_viewid}

Request Example

$ curl https://www.site24x7.com/api/dashboard_views/113770000041403073 \
    -X PUT \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \
    -d '{
      "display_name": "NOC Plasma Dashboard",
      "layout_type": 1,
      "visited_user": true,
      "monitor_groups": "113770000026704011",
      "selection_type": "1"
    }'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": {
    "dashboard_viewid": "113770000041403073",
    "display_name": "NOC Plasma Dashboard",
    "layout_type": 1,
    "visited_user": true,
    "social_status": true,
    "monitor_groups": "113770000026704011",
    "permalink": "https://www.site24x7.com/dv.do?id=X9qsSr8BqYvWS151245wHS54QNkmW4H9sBMEu12IB5NLEQEb2gaS4iBmWtXe5UTMF%2Bldffvi%2BgwjCjh%2FmYgZ%0ATna8OfxrFgRmvUpIiz1Q%2FsniX8hng5U%3D",
    "embed_code": "https://www.site24x7.com/dv.do?id=X9qsSfgu124r8BqYvWS15HS54QNkmW4H9sBMEu12IB5NLEQEb2gaS4iBmWtXe5UTMF%2Blvi%2BgwjCjh%2FmYgZ%0ATrag4una8OfxrFgRmvUpIiz1Q%2FsniX8hng5U%3D",
    "selection_type": 1
  }
}

Update the configuration of an existing Operations Dashboard.

oauthscope : Site24x7.Reports.Update

Path Parameters

Param	Type	Description
dashboard_viewid	string	Mandatory Unique ID generated by the server. This can be used as an identifier.

Request Parameters

Param	Type	Description
display_name	string	Mandatory Display name for the Operations Dashboard.
layout_type	int	Mandatory Layout to be used for the Operations Dashboard. Layout 1 - 1 and Layout 2 - 2
selection_type	int	Mandatory Resource type associated to this Operations Dashboard. All Monitors - 0, Monitor Groups - 1 and Monitors - 2
monitors	array	Mandatory, if the chosen selection_type is Monitors. Monitors to be associated to this Operations Dashboard.
monitor_groups	string	Mandatory, if the chosen selection_type is Monitor Groups. Monitor Group to be associated to this Status Page.
subgroup_monitors	boolean	Optional, if the chosen selection_type is Monitor Groups. Enable this option to include subgroups of the selected Monitor Groups. Otherwise, only the selected Group(s) will be considered. Default value is true
visited_user	boolean	Show operators who visited during outage.

Response Attributes

Attribute	Type	Description
dashboard_viewid	string	Unique ID generated by the server. This can be used as an identifier.
display_name	string	Display name for the Operations Dashboard.
layout_type	int	Layout to be used for the Operations Dashboard. Layout 1 - 1 and Layout 2 - 2
selection_type	int	Resource type associated to this Operations Dashboard.
monitors	array	Monitors associated with this Operations Dashboard.
monitor_groups	string	Monitor Group associated with this Status Page.
subgroup_monitors	boolean	Optional, if the chosen selection_type is Monitor Groups. Enable this option to include subgroups of the selected Monitor Groups. Otherwise, only the selected Group(s) will be considered. Default value is true
visited_user	boolean	Show operators who visited during outage.
permalink	string	Link to access the status page
embed_code	string	iframe code snippet to embed within the body tag of your HTML document.

Delete Operations Dashboard

DELETE /dashboard_views/{dashboard_viewid}

Request Example

$ curl https://www.site24x7.com/api/dashboard_views/113770000041403073 \
    -X DELETE \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

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

Delete the existing Operations Dashboard.

oauthscope : Site24x7.Reports.Delete

Path Parameters

Param	Type	Description
dashboard_viewid	string	Mandatory Unique ID generated by the server. This can be used as an identifier.

List Operations Dashboards

GET /dashboard_views

Request Example

$ curl https://www.site24x7.com/api/dashboard_views \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": [
    {
      "dashboard_viewid": "113770000041403073",
      "display_name": "NOC Plasma Dashboard",
      "layout_type": 1,
      "visited_user": true,
      "social_status": true,
      "monitor_groups": "113770000026704011",
      "permalink": "https://www.site24x7.com/dv.do?id=X9qsSr8BqYvWS151245wHS54QNkmW4H9sBMEu12IB5NLEQEb2gaS4iBmWtXe5UTMF%2Bldffvi%2BgwjCjh%2FmYgZ%0ATna8OfxrFgRmvUpIiz1Q%2FsniX8hng5U%3D",
      "embed_code": "https://www.site24x7.com/dv.do?id=X9qsSfgu124r8BqYvWS15HS54QNkmW4H9sBMEu12IB5NLEQEb2gaS4iBmWtXe5UTMF%2Blvi%2BgwjCjh%2FmYgZ%0ATrag4una8OfxrFgRmvUpIiz1Q%2FsniX8hng5U%3D",
      "selection_type": 1
    },
    {..},
    {..}
  ]
}

List of all Operations Dashboards.

oauthscope : Site24x7.Reports.Read

Response Attributes

Attribute	Type	Description
dashboard_viewid	string	Unique ID generated by the server. This can be used as an identifier.
display_name	string	Display name for the Operations Dashboard.
layout_type	int	Layout to be used for the Operations Dashboard. Layout 1 - 1 and Layout 2 - 2
selection_type	int	Resource type associated to this Operations Dashboard.
monitors	array	Monitors associated with this Operations Dashboard.
monitor_groups	string	Monitor Group associated with this Status Page.
subgroup_monitors	boolean	Optional, if the chosen selection_type is Monitor Groups. Enable this option to include subgroups of the selected Monitor Groups. Otherwise, only the selected Group(s) will be considered. Default value is true
visited_user	boolean	Show operators who visited during outage.
permalink	string	Link to access the status page
embed_code	string	iframe code snippet to embed within the body tag of your HTML document.

Uptime Buttons

Embed an Uptime Button on your site and show uptime metrics to your visitors.

Create Uptime Button

POST /uptime_buttons

Request Example

$ curl https://www.site24x7.com/api/uptime_buttons \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \
    -d '{
      "button_type": "3",
      "uptime_value": 98,
      "time_period": 2,
      "picked_color": "#5745bf",
      "monitor_id": "113770000039133011"
    }'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": {
    "time_period": 2,
    "monitor_id": "113770000039133011",
    "button_type": "3",
    "uptime_value": 98,
    "picked_color": "#5745bf",
    "uptime_embed_code": "<a href=\"https://ext1.site24x7.com/login/status.do?execute=StatusReport&p=gdgBs1VFyAyN6rgGxfd1ePVP8lcJDY7nb2N23577aspjZlLaGy9g0cyoHQrbzzO%2BQ%3D%3D&u=true&period=2\" style=\"color:#FFFFFF;text-decoration:none;cursor:pointer;\"><span style=\"background-color: rgb(255, 255, 255);border: 1px solid #5745bf;color: rgb(0, 0, 0);float: left;font-family: Verdana,Arial;font-size: 9px; font-weight: normal;line-height: 16px; margin: 0; padding: 0; text-align: center;text-indent: 0;width: 120px;\"><b style=\"background-color:#5745bf;color: rgb(255, 255, 255);float: left;height: 20px;width: 100%;\"><span style=\"height: 22px;line-height: 22px;\">Uptime </span><script type=\"text/javascript\" src=\"https://www.site24x7.com/website-uptime.html?v=gdgBs1VFyAyBh4cPYPyaFNncJ59dBuQH\"></script></b><br><span>Monitored by Site24x7</span></span></a>"
  }
}

Create a new Monitor Group.

oauthscope : Site24x7.Reports.Create

Request Parameters

Param	Type	Description
monitor_id	string	Mandatory Unique ID generated by the server. This can be used as an identifier.
time_period	string	Mandatory Time period for which uptime metrics is displayed.
button_type	string	Mandatory Type of button to be generated. Button 1 - 1, Button 2 - 2 and Button 3 - 3
uptime_value	int	Configuration to show minimum uptime percentage
picked_color	string	Hexcode for button color

Response Attributes

Attribute	Type	Description
monitor_id	string	Unique ID of the monitor. Use retrieve monitor API to get the details of this monitor.
time_period	string	Time period for which uptime metrics is displayed.
button_type	string	Type of button to be generated. Button 1 - 1, Button 2 - 2 and Button 3 - 3
uptime_value	int	Configuration to show minimum uptime percentage
picked_color	string	Hexcode for button color
uptime_embed_code	string	Button code to embed in your web page.

Retrieve Uptime Button

GET /uptime_buttons/{monitor_id}

Request Example

$ curl https://www.site24x7.com/api/uptime_buttons/113770000039133011 \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": {
    "time_period": 2,
    "monitor_id": "113770000039133011",
    "button_type": "3",
    "uptime_value": 98,
    "picked_color": "#5745bf",
    "uptime_embed_code": "<a href=\"https://ext1.site24x7.com/login/status.do?execute=StatusReport&p=gdgBs1VFyAyN6rgGxfd1ePVP8lcJDY7nb2N23577aspjZlLaGy9g0cyoHQrbzzO%2BQ%3D%3D&u=true&period=2\" style=\"color:#FFFFFF;text-decoration:none;cursor:pointer;\"><span style=\"background-color: rgb(255, 255, 255);border: 1px solid #5745bf;color: rgb(0, 0, 0);float: left;font-family: Verdana,Arial;font-size: 9px; font-weight: normal;line-height: 16px; margin: 0; padding: 0; text-align: center;text-indent: 0;width: 120px;\"><b style=\"background-color:#5745bf;color: rgb(255, 255, 255);float: left;height: 20px;width: 100%;\"><span style=\"height: 22px;line-height: 22px;\">Uptime </span><script type=\"text/javascript\" src=\"https://www.site24x7.com/website-uptime.html?v=gdgBs1VFyAyBh4cPYPyaFNncJ59dBuQH\"></script></b><br><span>Monitored by Site24x7</span></span></a>"
  }
}

Retrieve the configuration of the Uptime Button.

oauthscope : Site24x7.Reports.Read

Path Parameters

Param	Type	Description
monitor_id	string	Mandatory Unique ID generated by the server. This can be used as an identifier.

Response Attributes

Attribute	Type	Description
monitor_id	string	Unique ID of the monitor. Use retrieve monitor API to get the details of this monitor.
time_period	string	Time period for which uptime metrics is displayed.
button_type	string	Type of button to be generated. Button 1 - 1, Button 2 - 2 and Button 3 - 3
uptime_value	int	Configuration to show minimum uptime percentage
picked_color	string	Hexcode for button color
uptime_embed_code	string	Button code to embed in your web page.

Update Uptime Button

PUT /uptime_buttons/{monitor_id}

Request Example

$ curl https://www.site24x7.com/api/uptime_buttons/113770000039133011 \
    -X PUT \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \
    -d '{
      "button_type": "3",
      "uptime_value": 98,
      "time_period": 2,
      "picked_color": "#5745bf",
      "monitor_id": "113770000039133011"
    }'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": {
    "time_period": 2,
    "monitor_id": "113770000039133011",
    "button_type": "3",
    "uptime_value": 98,
    "picked_color": "#5745bf",
    "uptime_embed_code": "<a href=\"https://ext1.site24x7.com/login/status.do?execute=StatusReport&p=gdgBs1VFyAyN6rgGxfd1ePVP8lcJDY7nb2N23577aspjZlLaGy9g0cyoHQrbzzO%2BQ%3D%3D&u=true&period=2\" style=\"color:#FFFFFF;text-decoration:none;cursor:pointer;\"><span style=\"background-color: rgb(255, 255, 255);border: 1px solid #5745bf;color: rgb(0, 0, 0);float: left;font-family: Verdana,Arial;font-size: 9px; font-weight: normal;line-height: 16px; margin: 0; padding: 0; text-align: center;text-indent: 0;width: 120px;\"><b style=\"background-color:#5745bf;color: rgb(255, 255, 255);float: left;height: 20px;width: 100%;\"><span style=\"height: 22px;line-height: 22px;\">Uptime </span><script type=\"text/javascript\" src=\"https://www.site24x7.com/website-uptime.html?v=gdgBs1VFyAyBh4cPYPyaFNncJ59dBuQH\"></script></b><br><span>Monitored by Site24x7</span></span></a>"
  }
}

Update the configuration of the uptime button for a monitor.

oauthscope : Site24x7.Reports.Update

Path Parameters

Param	Type	Description
monitor_id	string	Mandatory Unique ID generated by the server. This can be used as an identifier.

Request Parameters

Param	Type	Description
monitor_id	string	Mandatory Unique ID generated by the server. This can be used as an identifier.
time_period	string	Mandatory Time period for which uptime metrics is displayed.
button_type	string	Mandatory Type of button to be generated. Button 1 - 1, Button 2 - 2 and Button 3 - 3
uptime_value	int	Configuration to show minimum uptime percentage
picked_color	string	Hexcode for button color

Response Attributes

Attribute	Type	Description
monitor_id	string	Unique ID of the monitor. Use retrieve monitor API to get the details of this monitor.
time_period	string	Time period for which uptime metrics is displayed.
button_type	string	Type of button to be generated. Button 1 - 1, Button 2 - 2 and Button 3 - 3
uptime_value	int	Configuration to show minimum uptime percentage
picked_color	string	Hexcode for button color
uptime_embed_code	string	Button code to embed in your web page.

Delete Uptime Button

DELETE /uptime_buttons/{monitor_id}

Request Example

$ curl https://www.site24x7.com/api/uptime_buttons/113770000039133011 \
    -X DELETE \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

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

}

Delete the uptime button for a monitor.

oauthscope : Site24x7.Reports.Delete

Path Parameters

Param	Type	Description
monitor_id	string	Mandatory Unique ID generated by the server. This can be used as an identifier.

List Uptime Buttons

GET /uptime_buttons

Request Example

$ curl https://www.site24x7.com/api/uptime_buttons \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": [
    {
      "time_period": 2,
      "monitor_id": "113770000039133011",
      "button_type": "3",
      "uptime_value": 98,
      "picked_color": "#5745bf",
      "uptime_embed_code": "<a href=\"https://ext1.site24x7.com/login/status.do?execute=StatusReport&p=gdgBs1VFyAyN6rgGxfd1ePVP8lcJDY7nb2N23577aspjZlLaGy9g0cyoHQrbzzO%2BQ%3D%3D&u=true&period=2\" style=\"color:#FFFFFF;text-decoration:none;cursor:pointer;\"><span style=\"background-color: rgb(255, 255, 255);border: 1px solid #5745bf;color: rgb(0, 0, 0);float: left;font-family: Verdana,Arial;font-size: 9px; font-weight: normal;line-height: 16px; margin: 0; padding: 0; text-align: center;text-indent: 0;width: 120px;\"><b style=\"background-color:#5745bf;color: rgb(255, 255, 255);float: left;height: 20px;width: 100%;\"><span style=\"height: 22px;line-height: 22px;\">Uptime </span><script type=\"text/javascript\" src=\"https://www.site24x7.com/website-uptime.html?v=gdgBs1VFyAyBh4cPYPyaFNncJ59dBuQH\"></script></b><br><span>Monitored by Site24x7</span></span></a>"
    }
  ]
}

List of all Uptime Buttons.

oauthscope : Site24x7.Reports.Read

Response Attributes

Attribute	Type	Description
monitor_id	string	Unique ID of the monitor. Use retrieve monitor API to get the details of this monitor.
time_period	string	Time period for which uptime metrics is displayed.
button_type	string	Type of button to be generated. Button 1 - 1, Button 2 - 2 and Button 3 - 3
uptime_value	int	Configuration to show minimum uptime percentage
picked_color	string	Hexcode for button color
uptime_embed_code	string	Button code to embed in your web page.

Subscriptions

Get the complete overview of your subscription plan. Retrieve details like pack name, monitor count, add-on count, alert credits, billing details, and more. To learn more about what resources fall under basic and advanced monitors, see monitor type categorization.

GET /subscriptions

Request Example

$ curl https://www.site24x7.com/api/subscriptions \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{
  "code": 0,
  "message": "success",
  "data": {
    "pack_details": {
      "package_name": "Premier Plan",
      "default": {
        "free_alert_credits": 500,
        "advanced_monitor_count": 25,
        "all_monitor_count": 300,
        "rum_page_views": "5000000"
      },
      "addons": [
        {
          "addon_count": 1,
          "addon_label": "Additional 5 Advanced Monitors Add-On"
        }
      ],
      "package_id": 6
    },
    "is_paid_user": true,
    "usage_details": {
      "total_monitors": {
        "used": 157,
        "allowed": 305
      },
      "advanced_monitors": {
        "used_internet_services": 26,
        "used_apm": 1,
        "used_server": 0,
        "used": 27,
        "allowed": 30
      },
      "rum_details": {
        "page_views_used": "0",
        "page_views_limit": "5000000"
      },
      "basic_monitors": {
        "used_internet_services": 74,
        "used_server": 56,
        "used": 130,
        "allowed": 275
      },
      "alert_credits": {
        "remaining_alert_credits": 500
      },
      "basic_additional_checks": 250000,
      "basic_additional_checks_used": 21693,
      "advanced_additional_checks": 10000,
      "advanced_additional_checks_used": 0
    },
    "enabled_products":{
        "apm": false, 
        "website": true, 
        "network": false, 
        "server": false, 
        "aws": false
    },
    "billing_details": {
      "next_payment_date": "2018-01-01T19:00:00-1100",
      "payment_type": "Purchase Order",
      "modify_card_details":false,
      "allow_renew_subscription":false,
      "is_onetime_purchase_eligible":true,
      "hourly_pricing": {
          "is_enabled" : true
      },
      "billing_contacts": [
        {
          "email_id": "mark@example.com",
          "display_name": "Mark"
        },
        {
          "email_id": "james@example.com",
          "display_name": "James"
        }
      ]
    }
  }
}

Retrieve details about your subscription plan.

oauthscope : Site24x7.Account.Read

Response Attributes

Attribute	Type	Description
package_name	string	Current subscription plan name.
free_alert_credits	int	Total Voice/SMS alert credits available in your current subscription plan.
advanced_monitor_count	int	Total number of advanced monitors that you are entitled to use under your current subscription plan.
all_monitor_count	int	Total number of basic and advanced monitors that you are entitled to use under the subscription plan.
rum_page_views	string	Total RUM page views available in your current subscription plan.
addons	JSON array	Additional units of basic monitors, advanced monitors, RUM page views, and Mobile APMs purchased.
total_monitors	json	Total number of monitors and purchased add-ons that you’ve exhausted from your available monitor count.
advanced_monitors	json	Contains the total number of advanced Web & Internet Service monitors, APM and advanced Server monitors used and allowed.
rum_details	json	Contains the number of RUM page views used and allowed.
basic_monitors	json	Contains the total number of basic Web & Internet Service monitors, basic Server monitors and Apps used and allowed.
alert_credits	json	Consolidated number of free and purchased alert credits remaining in the account.
billing_details	json	Contains the billing details, including next payment date, payment type,hourly_pricing and billing contacts.
basic_additional_checks	int	Total number of basic additional checks that you are entitled to use under the subscription plan.
basic_additional_checks_used	int	Total number of basic additional checks you’ve used in your current subscription plan.
advanced_additional_checks	int	Total number of advanced additional checks that you are entitled to use under the subscription plan.
advanced_additional_checks_used	int	Total number of advanced additional checks you’ve used in your current subscription plan.

Anomaly

Obtain the summary of all the anomalous events that were detected in your Site24x7 account.

Anomaly Dashboard

GET /reports/anomaly?period={report_period_constants}&monitor_type={monitor_type}

Request Example

$ curl "https://www.site24x7.com/api/reports/anomaly?period=3&monitor_type=URL" \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \

Response Example

{
    "code": 0,
    "message": "success",
    "data": {
        "anomaly_summary": {
            "monitors": [
                {
                    "display_name": "sample anomaly",
                    "monitor_id": "113770000055242275",
                    "anomaly_info": {
                        "anomaly_count": 1,
                        "severity": "Likely"
                    }
                },
                {
                    "display_name": "siteAuto",
                    "monitor_id": "113770000086987003",
                    "anomaly_info": {
                        "anomaly_count": 1,
                        "severity": "Likely"
                    }
                },
                {
                    "display_name": "test",
                    "monitor_id": "113770000086963193",
                    "anomaly_info": {
                        "anomaly_count": 1,
                        "severity": "Info"
                    }
                }
            ],
            "monitor_groups": [
                {
                    "group_id": "113770000092710062",
                    "display_name": "anomaly_group",
                    "severity": "Info",
                    "anomaly_count": 1
                },
                {
                    "group_id": "113770000016978007",
                    "display_name": "All Url monitors",
                    "severity": "Info",
                    "anomaly_count": 1
                },
                {
                    "group_id": "113770000086381139",
                    "display_name": "monitor group",
                    "severity": "Info",
                    "anomaly_count": 1
                },
                {
                    "group_id": "113770000055242217",
                    "display_name": "URL monitors",
                    "severity": "Likely",
                    "anomaly_count": 1
                }
            ]
        },
        "monthly_anomaly_data": [],
        "info": {
            "end_time": "2018-12-18T19:41:29-1100",
            "formatted_start_time": "December 18, 2018 12:00 AM SST",
            "period_name": "Today",
            "formatted_end_time": "December 18, 2018 7:41 PM SST",
            "generated_time": "2018-12-18T19:41:30-1100",
            "start_time": "2018-12-18T00:00:00-1100",
            "timezone": "US/Samoa",
            "period": 3,
            "formatted_generated_time": "December 18, 2018 7:41 PM SST"
        }
    }
}

Get the overall summary of anomalous events in your Site24x7 account.

oauthscope : Site24x7.Reports.Read

Query Parameters

Param	Type	Description
period	int	Mandatory Anomaly Dashboard will render data based on this predefined interval.
monitor_type	string	Type of monitor.

Response Attributes

Attribute	Type	Description
anomaly_summary	json	Consists of the summary of anomalous events that were detected in each monitor and monitor groups.
monitors	json array	Consists of anomalous details of your individual monitors.
display_name	string	Display Name of the monitor.
monitor_id	long	Unique ID of the monitor
anomaly_info	json	Details of the number of anomalies with the highest severity-level. JSON format:{anomaly_count: $anomaly_count,severity: $severity}
monitor_groups	json array	Consists of anomalous details of your monitor groups.
group_id	long	Unique ID of the monitor group. You can find group_id using the Monitor Group list API.
display_name	string	Display name of the monitor group.
severity	string	Highest severity level that affected a particular monitor group.
anomaly_count	int	The total number of anomalies with the highest severity-levels that were detected in a particular monitor group.

JSON format

Attribute	Type	Description
anomaly_count	int	The total number of anomalies with the highest severity-levels that were detected for a particular monitor.
severity	string	Highest severity level that affected a particular monitor.

Cloud Anomaly Dashboard

GET /reports/anomaly/cloud/{parent_id}?period={report_period_constants}

Request Example

$ curl "https://www.site24x7.com/api/reports/anomaly/cloud/{parent_id}?period=3" \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \

Response Example

{
    "code": 0,
    "message": "success",
    "data": {
        "anomaly_summary": {
            "monitors": [
                {
                    "display_name": "sample anomaly",
                    "monitor_id": "113770000055242275",
                    "anomaly_info": {
                        "anomaly_count": 1,
                        "severity": "Likely"
                    }
                },
                {
                    "display_name": "siteAuto",
                    "monitor_id": "113770000086987003",
                    "anomaly_info": {
                        "anomaly_count": 1,
                        "severity": "Likely"
                    }
                },
                {
                    "display_name": "test",
                    "monitor_id": "113770000086963193",
                    "anomaly_info": {
                        "anomaly_count": 1,
                        "severity": "Info"
                    }
                }
            ],
            "monitor_groups": [
                {
                    "group_id": "113770000092710062",
                    "display_name": "anomaly_group",
                    "severity": "Info",
                    "anomaly_count": 1
                },
                {
                    "group_id": "113770000016978007",
                    "display_name": "All Url monitors",
                    "severity": "Info",
                    "anomaly_count": 1
                },
                {
                    "group_id": "113770000086381139",
                    "display_name": "Server monitors",
                    "severity": "Info",
                    "anomaly_count": 1
                },
                {
                    "group_id": "113770000055242217",
                    "display_name": "All dns monitors",
                    "severity": "Likely",
                    "anomaly_count": 1
                }
            ]
        },
        "monthly_anomaly_data": [],
        "info": {
            "end_time": "2018-12-18T19:41:29-1100",
            "formatted_start_time": "December 18, 2018 12:00 AM SST",
            "period_name": "Today",
            "formatted_end_time": "December 18, 2018 7:41 PM SST",
            "generated_time": "2018-12-18T19:41:30-1100",
            "start_time": "2018-12-18T00:00:00-1100",
            "timezone": "US/Samoa",
            "period": 3,
            "formatted_generated_time": "December 18, 2018 7:41 PM SST"
        }
    }
}

Get the overall summary of anomalous events in your Amazon account.

oauthscope : Site24x7.Reports.Read

Query Parameters

Param	Type	Description
period	int	Mandatory Anomaly Dashboard will render data based on this predefined interval.
parent_id	long	Mandatory Anomaly Dashboard will render data based on Amazon monitor id.

Response Attributes

Attribute	Type	Description
anomaly_summary	json	Consists of the summary of anomalous events that were detected in each monitor and monitor groups.
monitors	json array	Consists of anomalous details of your individual monitors.
display_name	string	Display Name of the monitor.
monitor_id	long	Unique ID of the monitor
anomaly_info	json	Details of the number of anomalies with the highest severity-level. JSON format:{anomaly_count: $anomaly_count,severity: $severity}
monitor_groups	json array	Consists of anomalous details of your monitor groups.
group_id	long	Unique ID of the monitor group. You can find group_id using the Monitor Group list API.
display_name	string	Display name of the monitor group.
severity	string	Highest severity level that affected a particular monitor group.
anomaly_count	int	The total number of anomalies with the highest severity-levels that were detected in a particular monitor group.

JSON format

Attribute	Type	Description
anomaly_count	int	The total number of anomalies with the highest severity-levels that were detected for a particular monitor.
severity	string	Highest severity level that affected a particular monitor.

Anomaly Report by Monitor

GET /reports/anomaly/monitors/type?monitor_id={monitor_id}&period={report_period_constants}&severity={anomaly_severity_types}

Request Example

$ curl "https://www.site24x7.com/api/reports/anomaly/monitors/type?monitor_id=113770000055242275&period=3&severity=CONFIRMED,LIKELY" \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{
    "code": 0,
    "message": "success",
    "data": {
        "anomaly_chart_data": [
            [
                "2018-12-18T00:00:00-1100",
                3
            ]
        ],
        "anomaly_table_data": [
            {
                "anomaly_data": {
                    "occurred_time": "1545201434604",
                    "severity": "Info",
                    "monitor_type": "DNS",
                    "time": "18 December, 2018 07:37:14 PM",
                    "monitor_id": "113770000055242275",
                    "comment": [
                        {
                            "location_id": 39,
                            "location_name": "Brussels",
                            "location_comments": [
                                {
                                    "attribute_name": "RESPONSETIME",
                                    "formatted_attribute": "Response Time",
                                    "anomaly_comment": "The <b>Response Time</b> has surged to <b>10.5 ms</b> in Brussels. This has                                                         resulted in a <b>1.4</b> times increase in Response Time from the baseline                                                      average 95th percentile value. The baseline value <b>7.75 ms</b> is also                                                        calculated for the same period between 7:00 PM to 8:00 PM over the past four                                                        weeks from Brussels.",
                                    "present_value": 10,
                                    "base_value": 7,
                                    "attribute_unit": "ms"
                                }
                            ]
                        }
                    ]
                },
                "display_name": "sample anomaly"
            },
            {
                "anomaly_data": {
                    "occurred_time": "1545187481270",
                    "severity": "Likely",
                    "monitor_type": "DNS",
                    "time": "18 December, 2018 03:44:41 PM",
                    "monitor_id": "113770000055242275",
                    "comment": [
                        {
                            "location_id": 16,
                            "location_name": "Rio de Janeiro",
                            "location_comments": [
                                {
                                    "attribute_name": "RESPONSETIME",
                                    "formatted_attribute": "Response Time",
                                    "anomaly_comment": "The <b>Response Time</b> has surged to <b>1,273 ms</b> in Rio de Janeiro. This                                                      has resulted in a <b>6.3</b> times increase in Response Time from the baseline                                                      average 95th percentile value. The baseline value <b>202.03 ms</b> is also                                                      calculated for the same period between 3:00 PM to 4:00 PM over the past four                                                        weeks from Rio de Janeiro.",
                                    "present_value": 1273,
                                    "base_value": 202,
                                    "attribute_unit": "ms"
                                }
                            ]
                        }
                    ]
                },
                "display_name": "sample anomaly"
            }
        ]
    }
}

Get Anomaly Report of a particular monitor.

oauthscope : Site24x7.Reports.Read

Query Parameters

Param	Type	Description
monitor_id	long	Mandatory Unique ID of the monitor
period	int	Mandatory Anomaly report is generated within this predefined interval.
severity	array	Mandatory Anomaly report is generated for any of these severities.

Response Attributes

Attribute	Type	Description
anomaly_table_data	json array	Details of individual anomalies that affected a particular monitor.
display_name	string	Display name of the monitor.
anomaly_data	json	Details of a detected anomaly event. JSON format:{occurred_time: $occurred_time, severity: $severity, monitor_type: $monitor_type, time: $time, monitor_id: $monitor_id, comment: $comment}
anomaly_chart_data	json array	Consists of array of all anomalies in the selected period and severity.

JSON format

Attribute	Type	Description
occurred_time	long	Time at which anomaly event occurred (in milliseconds).
time	string	Formatted time at which anomaly event occurred.
severity	string	Severity of the anomaly event when it occurred.
monitor_type	string	Type of monitor for which the anomaly event occurred.
monitor_id	long	Unique ID of the monitor
comment	json array	Description of a detected anomaly event.
location_id	int	location ID where the anomaly event was spotted.
location_name	string	Name of the location where the anomaly event was spotted.
location_comments	json array	Description of anomaly events that occurred for multiple attributes from a particular location. Anomaly Comment JSON format:[{attribute_name: $attribute_name, formatted_attribute: $formatted_attribute,anomaly_comment: $anomaly_comment, present_value: $present_value, base_value: $base_value, attribute_unit: $attribute_unit}]

Anomaly Comment JSON format

Attribute	Type	Description
attribute_name	string	Name of the attribute, which has anomaly.
formatted_attribute	string	Formatted name of the attribute, which has an anomaly.
anomaly_comment	string	Detailed description of the detected anomaly event.
present_value	double	Anomalous value that was spotted for a particular attribute.
base_value	double	Current base value of a particular attribute.
attribute_unit	string	Unit of a particular attribute.

Anomaly Report by Monitor Group

GET /reports/anomaly/monitor_groups?group_id={group_id}&period={report_period_constants}&severity={anomaly_severity_types}

Request Example

$ curl "https://www.site24x7.com/api/reports/anomaly/monitor_groups?group_id=113770000069421063&period=3&severity=CONFIRMED,LIKELY" \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{
    "code": 0,
    "message": "success",
    "data": {
        "anomaly_chart_data": [
            [
                {
                    "display_name": "sample anomaly",
                    "data": [
                        {
                            "date": "2018-12-18T00:00:00-1100",
                            "count": 1
                        }
                    ]
                }
            ]
        ],
        "anomaly_table_data": [
            {
                "anomaly_data": {
                    "occurred_time": "1545184399291",
                    "severity": "Likely",
                    "monitor_type": "URL",
                    "time": "18 December, 2018 02:53:19 PM",
                    "monitor_id": "113770000055242275",
                    "comment": [
                        {
                            "location_id": 32,
                            "location_name": "Phoenix",
                            "location_comments": [
                                {
                                    "attribute_name": "RESPONSETIME",
                                    "formatted_attribute": "Response Time",
                                    "anomaly_comment": "The <b>Response Time</b> has surged to <b>2,009.36 ms</b> in Phoenix. This has                                                      resulted in a <b>1.9</b> times increase in Response Time from the baseline                                                      average 95th percentile value. The baseline value <b>1,068.68 ms</b> is also                                                        calculated for the same period between 2:00 PM to 3:00 PM over the past four                                                        weeks from Phoenix.",
                                    "present_value": 2009,
                                    "base_value": 1068,
                                    "attribute_unit": "ms"
                                }
                            ]
                        }
                    ]
                },
                "display_name": "sample anomaly"
            }
        ]
    }
}

Get Anomaly Report of a particular monitor group.

oauthscope : Site24x7.Reports.Read

Query Parameters

Param	Type	Description
group_id	long	Mandatory Unique ID of the monitor group. You can find group_id using the Monitor Group list API.
period	int	Mandatory Anomaly report is generated within this predefined interval.
severity	array	Mandatory Anomaly report is generated for any of these severities.

Response Attributes

Attribute	Type	Description
anomaly_table_data	json array	Details of individual anomalies that occurred for a particular monitor.
display_name	string	Display name of the monitor.
anomaly_data	json	Details of a detected anomaly event. JSON format:{occurred_time: $occurred_time, severity: $severity, monitor_type: $monitor_type, time: $time, monitor_id: $monitor_id, comment: $comment}
anomaly_chart_data	json array	Consists of array of all anomalies in the selected period and severity.

JSON format

Attribute	Type	Description
occurred_time	long	Time at which anomaly event occurred (in milliseconds).
time	string	Formatted time at which anomaly event occurred.
severity	string	Severity of the anomaly event that was detected.
monitor_type	string	Type of the monitor for which the anomaly event was detected.
monitor_id	long	Unique ID of the monitor
comment	json array	Description of the detected anomaly event.
location_id	int	location ID where the anomalous event was detected.
location_name	string	Name of the location where the anomalous event was detected.
location_comments	json array	Description of anomalous events that occurred for multiple attributes from a particular location. Anomaly Comment JSON format:[{attribute_name: $attribute_name, formatted_attribute: $formatted_attribute,anomaly_comment: $anomaly_comment, present_value: $present_value, base_value: $base_value, attribute_unit: $attribute_unit}]

Anomaly Comment JSON format

Attribute	Type	Description
attribute_name	string	Name of the attribute, which has an anomaly.
formatted_attribute	string	Name of the attribute, which has an anomaly.
anomaly_comment	string	The detailed description of the detected anomaly event.
present_value	double	Anomalous value that was spotted for a particular attribute.
base_value	double	Current base value of a particular attribute.
attribute_unit	string	Unit of a particular attribute.

Anomaly Settings Form

Retrieve Anomaly Settings

GET /anomaly_settings

Request Example

$ curl https://www.site24x7.com/api/anomaly_settings \
    -H "Accept: application/json" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "success",
    "data": [
        {
         "enable_scoring": false,
         "attribute_group_id": "168853000013422001",
         "l1": 40,
         "l2": 65,
         "l3": 85,
         "attribute_group_name": "All Attributes"
        }
  ]
}

Retrieve Anomaly Settings details

oauthscope : Site24x7.Admin.Read

Response Attributes

Attribute	Type	Description
l1	double	Level 1 (Info) severity deviation % Info severity stands for minimum deviation. By default, the minimum deviation threshold for Info severity is 20%.
l2	double	Level 2 (Likely) severity deviation % Likely severity stands for medium deviation. By default, the minimum deviation threshold for Likely severity is 50%.
l3	double	Level 3 (Confirmed) severity deviation % Confirmed severity stands for high deviation. By default, the minimum deviation threshold for Confirmed severity is 80%.p
enable_scoring	boolean	Enable Anomaly Scoring Method This may cause certain anomalies to change the severity appropriately with respect to other alerts in your environment.
attribute_group_id	string	UniqueID generated by the server for Anomaly Settings.

Update Anomaly Settings

PUT /anomaly_settings/{attribute_group_id}

Request Example

$ curl https://www.site24x7.com/api/anomaly_settings \
    -X PUT \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Accept: application/json" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \
    -d '{
         "l1": 40,
         "l2": 65,
         "l3": 85,
         "enable_scoring": true,
         }'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
     "code": 0,
     "message": "success",
     "data": {
        "enable_scoring": true,
        "attribute_group_id": "168853000013422001",
        "l1": 40,
        "l2": 65,
        "l3": 85,
        "attribute_group_name": "All Attributes"
     }
}

Update existing Anomaly Settings

oauthscope : Site24x7.Admin.Update

Path Parameters

Param	Type	Description
attribute_group_id	string	Mandatory UniqueID generated by the server for Anomaly Settings.

Request Attributes

Attribute	Type	Description
l1	double	Level 1 (Info) severity deviation % Info severity stands for minimum deviation. By default, the minimum deviation threshold for Info severity is 20%.
l2	double	Level 2 (Likely) severity deviation % Likely severity stands for medium deviation. By default, the minimum deviation threshold for Likely severity is 50%.
l3	double	Level 3 (Confirmed) severity deviation % Confirmed severity stands for high deviation. By default, the minimum deviation threshold for Confirmed severity is 80%.p
enable_scoring	boolean	Enable Anomaly Scoring Method This may cause certain anomalies to change the severity appropriately with respect to other alerts in your environment.

Response Attributes

Attribute	Type	Description
l1	double	Level 1 (Info) severity deviation % Info severity stands for minimum deviation. By default, the minimum deviation threshold for Info severity is 20%.
l2	double	Level 2 (Likely) severity deviation % Likely severity stands for medium deviation. By default, the minimum deviation threshold for Likely severity is 50%.
l3	double	Level 3 (Confirmed) severity deviation % Confirmed severity stands for high deviation. By default, the minimum deviation threshold for Confirmed severity is 80%.p
enable_scoring	boolean	Enable Anomaly Scoring Method This may cause certain anomalies to change the severity appropriately with respect to other alerts in your environment.
attribute_group_id	string	UniqueID generated by the server for Anomaly Settings.

APM Insight Applications

Application’s performance monitoring is done using APM Insight. These api’s help in fetching details / performing actions related to applications being monitored.

List all APM Applications

GET /apminsight/app/{time_window}

Request Example

$ curl https://www.site24x7.com/api/apminsight/app/H \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response

{
  "code": 0,
  "message": "success",
  "data": [
    {
      "response_time_data": {
        "response_time": 5112.5,
        "min_response_time": 0,
        "max_response_time": 630196,
        "total_response_time": 0,
        "request_count": 66533,
        "error_count": 0,
        "throughput": 1108.88,
        "cpu_time": 0
      },
      "exception_info": {
        "warning_count": 0,
        "fatal_count": 0
      },
      "application_info": {
        "instance_ids": [
          "101071000000034035"
      ],
        "host_count": 1,
        "application_name": "Site24x7",
        "hosts": {
          "192.168.xxx.xxx": [
            "101071000000034035"
            ]
          },
        "application_id": "101071000000034001",
        "rum_info": {
          "rumAppId": "15698000010568013",
          "rumAppKey": "61cc526aa43df99a460d1e7bce9e635d",
          "rumAppName": "BookingApp"
        },
        "instances": {
          "101071000000034035": {
            "port": 8080,
            "host": "192.168.xxx.xxx",
            "instance_name": "192.168.xxx.xxx:8080",
            "application_name": "Site24x7",
            "application_id": "101071000000034001",
            "instance_id": "101071000000034035",
            "ins_type": "JAVA",
            "agent_version": 1.7
          }
        },
        "instance_count": 1
      },
      "availability_health_info": {
        "availability": "AVAILABLE",
        "availability_url": "/home/reportsinfo.do?execute=getDetailsPageReport&period=3&reporttype=LocationDownReport&urlid=101071000000034001",
        "has_health_attribute": false,
        "health": "",
        "health_url": "",
        "managed_state": true,
        "under_maintenance": false,
        "last_communication_time": 0
      },
      "apdex_data": {
        "apdex": 0.875,
        "satisfied": 83.6,
        "tolerating": 7.7,
        "frustrated": 8.7,
        "satisfied_count": 55622,
        "tolerating_count": 5123,
        "frustrated_count": 5788
      },
      "cpu_time": 98.8,
      "show_instance_port_number": true
    }
  ]
}

API to list all the APM applications being monitored. ‘Time window’ is a mandatory field. You can get the list of all applications in the last 1 hour, last 3 hour, last 1 day and so on.

oauthscope : Site24x7.Reports.Read

Path Parameters

Param	Type	Description
time_window	string	Mandatory Time window for which the applications have to be listed. Time window

Response Attributes

Attribute	Type	Description
response_time_data	json	Response time metrics. JSON Format:{response_time: $response_time, min_response_time: $min_response_time, max_response_time: $max_response_time, total_response_time: $total_response_time, request_count: $request_count, error_count: $error_count, throughput: $throughput, cpu_time: $cpu_time}
exception_info	json	Exception Information. JSON Format: {warning_count:$warning_count, fatal_count:$fatal_count}
application_info	json	Application Information. JSON Format: {instance_ids: $instance_ids, host_count: $host_count, application_name: “$application_name”, hosts: $hosts, application_id: “$application_id”, rum_info: “$rum_info”}
instances	json	Instance metrics JSON Format: {port: $port, host: “$host”, instance_name: “$instance_name”, application_name: “$application_name”, application_id: “$application_id”, instance_id: “$instance_id”, ins_type: “$ins_type”, agent_version: “$agent_version”, instance_count: “$instance_count”}
availability_health_info	json	Availability Information. JSON Format:{availability: “$availability”, availability_url: “$availability_url”, has_health_attribute: “$has_health_attribute”, health: “$health”, health_url: “$health_url”, managed_state: “$managed_state”, under_maintenance: “$under_maintenance”, last_communication_time: “$last_communication_time”}
apdex_data	json	Apdex metrics. JSON Format: {apdex:$apdex, satisfied:$satisfied, tolerating:$tolerating, frustrated:$frustrated, satisfied_count:$satisfied_count, tolerating_count:$tolerating_count, frustrated_count:$frustrated_count}
cpu_time	int	Average time spent by the application in the CPU.
show_instance_port_number	boolean	Returns true if displaying instance port number is enabled.

JSON Format

Attribute	Type	Description
response_time	long	Response time.
min_response_time	long	Minimum response time.
max_response_time	long	Maximum response time.
total_response_time	long	Total Response time of application.
request_count	int	Total no. of requests.
error_count	int	Total no. of errors.
throughput	long	Through put of application.
cpu_time	int	Average time spent by the application in the CPU.
warning_count	int	No of warnings encountered.
fatal_count	int	No of fatal exceptions encountered.
instance_ids	String Array	IDs of all instances of the application.
host_count	int	No. of hosts.
application_name	string	Name of the application.
host	string	Host address of particular instance.
application_id	string	Application id.
rum_info	json	RUM Information JSON Format: {rumAppId:$“rumAppId”, rumAppKey:$“rumAppKey”, rumAppName:“$rumAppName”}
port	int	Port number of instance.
host	string	Host address of particular instance
instance_name	string	Name of the instance
ins_type	string	Type of agent used for particular instance like (JAVA,PHP,RUBY,.NET).
agent_version	string	Agent version.
instance_count	int	No. of instances associated with particular application.
avalability	int	Avalability score
availability_url	string	Avalability report url
has_health_attribute	boolean	True if health attribute is present
health	int	Health score
health_url	string	Health report url
managed_state	boolean	True if managed by the user
under_maintenance	boolean	True if under maintenance
last_communication_time	long	Last known communication time of the monitor
apdex	double	Apdex score of application.
satisfied	double	Percentage of satisfied users with respect to total no. of requests.
tolerating	double	Percentage of tolerating users with respect to total no. of requests.
frustrated	double	Percentage of frustrated users with respect to total no. of requests.
satisfied_count	long	No. of satisfied users.
tolerating_count	long	No. of tolerating users.
frustrated_count	long	No. of frustrated users.

Single Application details

GET /apminsight/app/{application_id}/{time_window}

Request Example

$ curl https://www.site24x7.com/api/apminsight/app/101071000000034001/H \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response

{
  "code": 0,
  "message": "success",
  "data": {
  "response_time_data": {
    "response_time": 4543.7,
      "min_response_time": 0,
      "max_response_time": 509503,
      "total_response_time": 0,
      "request_count": 68678,
      "error_count": 0,
      "throughput": 1144.63,
      "cpu_time": 0
    },
    "exception_info": {
      "warning_count": 0,
      "fatal_count": 0
    },
    "application_info": {
      "instance_ids": [
        "101071000000034035",
        "101071000000034025"
      ],
      "host_count": 2,
      "application_name": "Site24x7",
      "hosts": {
        "192.168.xxx.xxx": [
          "101071000000034035"
        ],
        "192.168.xxx.xxx": [
          "101071000000034025"
        ]
      },
      "application_id": "101071000000034001",
      "rum_info": {},
      "instances": {
        "101071000000034035": {
          "port": 8080,
          "host": "192.168.xxx.xxx",
          "instance_name": "192.168.xxx.xxx:8080",
          "application_name": "Site24x7",
          "application_id": "101071000000034001",
          "instance_id": "101071000000034035",
          "ins_type": "JAVA",
          "agent_version": 1.7
        },
        "101071000000034025": {
          "port": 8080,
          "host": "192.168.xxx.xxx",
          "instance_name": "192.168.xxx.xxx:8080",
          "application_name": "Site24x7",
          "application_id": "101071000000034001",
          "instance_id": "101071000000034025",
          "ins_type": "JAVA",
          "agent_version": 1.7
        }
      },
      "instance_count": 2
    },
    "availability_health_info": {
      "availability": "AVAILABLE",
      "availability_url": "/home/reportsinfo.do?execute=getDetailsPageReport&period=3&reporttype=LocationDownReport&urlid=101071000000034001",
      "has_health_attribute": false,
      "health": "",
      "health_url": "",
      "managed_state": true,
      "under_maintenance": false,
      "last_communication_time": 0
    },
    "apdex_data": {
      "apdex": 0.883,
      "satisfied": 84.7,
      "tolerating": 7.4,
      "frustrated": 8,
      "satisfied_count": 58170
      "tolerating_count": 5082
      "frustrated_count": 5494
    },
    "cpu_time": 0,
    "show_instance_port_number": true
  }
}

API to get the details of a particular application. The ‘time window’ and ‘application id’ are mandatory fields. Application-id is required to identify the particular application and time window is to know the exact time period for which the details are sought for.

oauthscope : Site24x7.Reports.Read

Path Parameters

Param	Type	Description
time_window	string	Mandatory Time window for which the applications have to be listed. Time window
application_id	string	Mandatory Application Id of APM application

Response Attributes

Attribute	Type	Description
response_time_data	json	Response time metrics. JSON Format:{response_time: $response_time, min_response_time: $min_response_time, max_response_time: $max_response_time, total_response_time: total_response_time, request_count: $request_count, error_count: $error_count, throughput: $throughput, cpu_time: $cpu_time}
exception_info	json	Exception Information. JSON Format: {warning_count:$warning_count, fatal_count:$fatal_count}
application_info	json	Application Information. JSON Format: {instance_ids: $instance_ids, host_count: $host_count, application_name: “$application_name”, hosts: $hosts, application_id: “$application_id”, rum_info: “$rum_info”}
instances	json	Instance metrics JSON Format: {port: $port, host: “$host”, instance_name: “$instance_name”, application_name: “$application_name”, application_id:“$application_id”, instance_id: “$instance_d”, ins_type:“$ins_type”, agent_version: “$agent_version”, instance_count: “$instance_count”}
availability_health_info	json	Availability Information. JSON Format:{availability: “$availability”, availability_url: “$availability_url”, has_health_attribute: “$has_health_attribute”, health: “$health”, health_url: “$health_url”, managed_state: “$managed_state”, under_maintenance: “$under_maintenance”, last_communication_time: “$last_communication_time”}
apdex_data	json	Apdex metrics. JSON Format: {apdex:$apdex, satisfied:$satisfied, tolerating:$tolerating, frustrated:$frustrated, satisfied_count:$satisfied_count, tolerating_count:$tolerating_count, frustrated_count:$frustrated_count}
cpu_time	int	Average time spent by the application in the CPU.
show_instance_port_number	boolean	Returns true if displaying instance port number is enabled.

JSON Format

Attribute	Type	Description
response_time	long	Response time.
min_response_time	long	Minimum response time.
max_response_time	long	Maximum response time.
total_response_time	long	Total Response time of application.
request_count	int	Total no. of requests.
error_count	int	Total no. of errors.
throughput	long	Through put of application.
cpu_time	int	Average time spent by the application in the CPU.
warning_count	int	No of warnings encountered.
fatal_count	int	No of fatal exceptions encountered.
instance_ids	String Array	IDs of all instances of the application.
host_count	int	No. of hosts.
application_name	string	Name of the application.
host	string	Host address of particular instance.
application_id	string	Application id.
rum_info	json	RUM Information JSON Format: {rumAppId:“$rumAppId”, rumAppKey:“$rumAppKey”, rumAppName:“$rumAppName”}
port	int	Port number of instance.
host	string	Host address of particular instance
instance_name	string	Name of the instance
ins_type	string	Type of agent used for particular instance like (JAVA,PHP,RUBY,.NET).
agent_version	string	Agent version.
instance_count	int	No. of instances associated with particular application.
avalability	int	Avalability score
availability_url	string	Avalability report url
has_health_attribute	boolean	True if health attribute is present
health	int	Health score
health_url	string	Health report url
managed_state	boolean	True if managed by the user
under_maintenance	boolean	True if under maintenance
last_communication_time	long	Last known communication time of the monitor
apdex	double	Apdex score of application.
satisfied	double	Percentage of satisfied users with respect to total no. of requests.
tolerating	double	Percentage of tolerating users with respect to total no. of requests.
frustrated	double	Percentage of frustrated users with respect to total no. of requests.
satisfied_count	long	No. of satisfied users.
tolerating_count	long	No. of tolerating users.
frustrated_count	long	No. of frustrated users.

Manage Application

POST /api/apminsight/app/{application_id}/manage

Request Example

$ curl https://www.site24x7.com/api/apminsight/app/15698000009961011/manage
 \
    -X POST
    -H "Accept: application/json; version=2.0" \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response

{
   "code": 0,
   "message": "success"
}

API to manage an application that is already in suspended state.Application-id is mandatory and is required to identify the particular application.

oauthscope : Site24x7.Admin.Create

Path Parameters

Param	Type	Description
application_id	string	Mandatory Application Id of APM application

Unmanage Application

POST /api/apminsight/app/{application_id}/unmanage

Request Example

$ curl https://www.site24x7.com/api/apminsight/app/15698000009961011/unmanage
 \
    -X POST
    -H "Accept: application/json; version=2.0" \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response

{
   "code": 0,
   "message": "success"
}

API to unmanage an application that is in active state.application_id is mandatory and is required to identify the particular application.

oauthscope : Site24x7.Admin.Create

Path Parameters

Param	Type	Description
application_id	string	Mandatory Application Id of APM application

Delete Application

DELETE /api/apminsight/app/{application_id}

Request Example

$ curl https://www.site24x7.com/api/apminsight/app/15698000009961011
 \
    -X DELETE
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response

{
   "code": 0,
   "message": "success"
}

API to delete an application. application_id is mandatory and is required to identify the particular application.

oauthscope : Site24x7.Admin.Delete

Path Parameters

Param	Type	Description
application_id	string	Mandatory Application Id of APM application

APM Insight Instances

These api’s help in fetching details / performing actions related to instances being monitored.
In Java, each JVM is an instance. In DotNet, each app in IIS server is an instance. In Ruby, each Rails server is an instance. In PHP, each php server is an instance.

List all APM instances

GET /apminsight/ins/{time_window}

Request Example

$ curl https://www.site24x7.com/api/apminsight/ins/H \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response

{
  "code": 0,
  "message": "success",
  "data": [
    {
      "response_time_data": {
        "response_time": 30.7,
        "min_response_time": 0,
        "max_response_time": 26087,
        "total_response_time": 0,
        "request_count": 106915,
        "error_count": 0,
        "throughput": 1781.92,
        "cpu_time": 5.5
       },
      "exception_info": {
            "warning_count": 0,
            "fatal_count": 0
      },
      "instance_info": {
        "port": 8080,
        "host": "192.168.xxx.xxx",
        "instance_name": "192.168.xxx.xxx:8080",
        "application_name": "plus.site24x7",
        "application_id": "101071000000059001",
        "instance_id": "101071000000059011",
        "ins_type": "JAVA",
        "agent_version": 1.8
      },
      "availability_health_info": {
        "availability": "AVAILABLE",
        "availability_url": "/home/reportsinfo.do?execute=getDetailsPageReport&period=3&reporttype=LocationDownReport&urlid=101071000000059011",
        "has_health_attribute": false,
        "health": "",
        "health_url": "",
        "managed_state": true,
        "under_maintenance": false,
        "last_communication_time": 1440480146375
      },
      "app_config":{  
        "is_cloud_app":false,
        "autoScale":false
         },
      "apdex_data": {
        "apdex": 0.996,
        "satisfied": 99.3,
        "tolerating": 0.6,
        "frustrated": 0.1,
        "satisfied_count": 106167,
        "tolerating_count": 641,
        "frustrated_count": 107
      },
      "cpu_time": 5.5,
      "show_instance_port_number": true
    }
  ]
}

API to list all the APM instances being monitored. ‘Time window’ is a mandatory field. You can get the list of all instances in the last 1 hour, last 3 hour, last 1 day and so on.

oauthscope : Site24x7.Reports.Read

Path Parameters

Param	Type	Description
time_window	string	Mandatory Time window for which the instances have to be listed. Time window

Response Attributes

Attribute	Type	Description
response_time_data	json	Response time metrics. JSON Format: {response_time: $response_time, min_response_time: $min_response_time, max_response_time:$max_response_time, total_response_time: $total_response_time, request_count: $request_count, error_count: $error_count, throughput: $throughput, cpu_time: $cpu_time}
exception_info	json	Exception Information. JSON Format: {warning_count: $warning_count, fatal_count:$fatal_count}
instance_info	json	Instance metrics JSON Format: {port: $port, host: “$host” , instance_name: “$instance_name”, application_name: “$application_name”, application_id: “$application_id”, instance_id: “$instance_id”, ins_type: “$ins_type”, agent_version: “$agent_version”, instance_count: “$instance_count”}
availability_health_info	json	Availability Information. JSON Format:{availability: “$availability”, availability_url: “$availability_url”, has_health_attribute: “$has_health_attribute”, health:“$health”, health_url: “$health_url”, managed_state: “$managed_state”, under_maintenance: “$under_maintenance”, last_communication_time: “$last_communication_time”}
app_config	json	Application Configuration. JSON Format: {is_cloud_app:$is_cloud_app, autoScale:$autoScale}
apdex_data	json	Apdex metrics. JSON Format: {apdex:$apdex, satisfied:$satisfied, tolerating:$tolerating, frustrated:$frustrated, satisfied_count:$satisfied_count, tolerating_count:$tolerating_count, frustrated_count:$frustrated_count}
cpu_time	int	Average time spent by the application in the CPU.
show_instance_port_number	boolean	Returns true if displaying instance port number is enabled.

JSON Format

Attribute	Type	Description
response_time	long	Response time.
min_response_time	long	Minimum response time.
max_response_time	long	Maximum response time.
total_response_time	long	Total Response time of application.
request_count	int	Total no. of requests.
error_count	int	Total no. of errors.
throughput	long	Through put of application.
cpu_time	int	Average time spent by the application in the CPU.
warning_count	int	No of warnings encountered.
fatal_count	int	No of fatal exceptions encountered.
port	int	Port number of instance.
host	string	Host address of particular instance
instance_name	string	Name of the instance
application_name	string	Name of the application.
application_id	string	Application id.
ins_type	string	Type of agent used for particular instance like (JAVA,PHP,RUBY,.NET).
agent_version	string	Agent version.
instance_count	int	No. of instances associated with particular application.
avalability	int	Avalability score.
availability_url	string	Avalability report url.
has_health_attribute	boolean	True if health attribute is present.
health	int	Health score.
health_url	string	Health report url.
managed_state	boolean	True if managed by the user.
under_maintenance	boolean	True if under maintenance.
last_communication_time	long	Last known communication time of the monitor.
is_cloud_app	boolean	True if instance is hosted in a cloud environment(AWS,Azure,etc).
autoScale	boolean	True if Autoscaling is enabled.
apdex	double	Apdex score of application.
satisfied	double	Percentage of satisfied users with respect to total no. of requests.
tolerating	double	Percentage of tolerating users with respect to total no. of requests.
frustrated	double	Percentage of frustrated users with respect to total no. of requests.
satisfied_count	long	No. of satisfied users.
tolerating_count	long	No. of tolerating users.
frustrated_count	long	No. of frustrated users.

Agent version details

GET /api/apminsight/ins/agent_info

Request Example

$ curl https://www.site24x7.com/api/apminsight/ins/agent_info \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response

{
  "code": 0,
  "message": "success",
  "data": [
    {
      "last_communication_time": "1575636292594",
      "availability": "NOTAVAILABLE",
      "agent_upgrade_status": "New agent version 4.6 is available.",
      "instance_info": {
        "agent_version": 4.5,
        "instance_id": "101071000000059011",
        "instance_name": "192.168.xxx.xxx:8080",
        "application_name": "plus.site24x7",
        "cloud_type": "Docker",
        "port": 8080,
        "is_cloud_ins": true,
        "host": "192.168.xxx.xxx",
        "ins_type": "JAVA",
        "application_id": "101071000000059001",
        "host_id": "0",
        "host_license": false
      },
      "status_reason": "Agent is not communicating with Site24x7 server.",
      "status": 0
    },
    {..},
    {..}
  ]
}

API to list all the APM instances and their corresponding agent version.

oauthscope : Site24x7.Reports.Read

Response Attributes

Attribute	Type	Description
last_communication_time	long	Last known communication time of the monitor.
availability	string	Availability status.
agent_upgrade_status	string	Monitor’s agent upgrade information.
instance_info	json	Instance metrics JSON Format: {agent_version: “$agent_version”, instance_id: “$instance_id”, instance_name: “$instance_name”, application_name: “$application_name”, cloud_type: “$cloud_type”, port: $port, is_cloud_ins: “is_cloud_ins”, host: “$host”, ins_type: “$ins_type”, application_id: “$application_id”, host_id: “$host_id”, host_license: “$host_license”}
status_reason	string	Availability reason.
status	int	Availability score.

JSON Format

Attribute	Type	Description
agent_version	string	Agent version.
instance_id	long	Instance id.
instance_name	string	Name of the instance
application_name	string	Name of the application.
cloud_type	string	Name of the cloud environment.
port	int	Port number of instance.
is_cloud_ins	boolean	True if instance is hosted in a cloud environment(AWS,Azure,etc).
host	string	Host address of a particular instance.
ins_type	string	Type of APM Insight agent (Java,Php,Ruby,.NET,Node.js) used for a particular instance.
application_id	string	Application id.
host_id	long	Host id.
host_license	boolean	True if host based license is applied for this instance.

Single Instance Details

GET /apminsight/ins/{instance_id}/{time_window}

Request Example

$ curl https://www.site24x7.com/api/apminsight/ins/101071000000034035/H \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "response_time_data": {
      "response_time": 7996.4,
      "min_response_time": 0,
      "max_response_time": 504237,
      "total_response_time": 0,
      "request_count": 19111,
      "error_count": 0,
      "throughput": 318.52,
      "cpu_time": 0
    },
    "exception_info": {
      "warning_count": 0,
      "fatal_count": 0
    },
    "instance_info": {
      "port": 8080,
      "host": "192.168.xxx.xxx",
      "instance_name": "192.168.xxx.xxx:8080",
      "application_name": "Site24x7",
      "application_id": "101071000000034001",
      "instance_id": "101071000000034035",
      "ins_type": "JAVA",
      "agent_version": 1.7
      },
    "application_info": {
      "instance_ids": [
        "101071000000034035"
      ],
      "host_count": 4,
      "application_name": "Site24x7",
      "hosts": {
        "192.168.xxx.xxx": [
          "101071000000034035"
        ]
      },
      "application_id": "101071000000034001",
      "rum_info": {},
      "instances": {
        "101071000000034035": {
          "port": 8080,
          "host": "192.168.xxx.xxx",
          "instance_name": "192.168.xxx.xxx:8080",
          "application_name": "Site24x7",
          "application_id": "101071000000034001",
          "instance_id": "101071000000034035",
          "ins_type": "JAVA",
          "agent_version": 1.7
        }
      ,
      "instance_count": 1
    },
    "availability_health_info": {
      "availability": "AVAILABLE",
      "availability_url": "/home/reportsinfo.do?execute=getDetailsPageReport&period=3&reporttype=LocationDownReport&urlid=101071000000034035",
      "has_health_attribute": false,
      "health": "",
      "health_url": "",
      "managed_state": true,
      "under_maintenance": false,
      "last_communication_time": 1440480435156
    },
    "app_config":{  
      "is_cloud_app":false,
      "autoScale":false
    },
    "apdex_data": {
      "apdex": 0.843,
      "satisfied": 81.3,
      "tolerating": 6,
      "frustrated": 12.7,
      "satisfied_count": 15537,
      "tolerating_count": 1147,
      "frustrated_count": 2427
    },
    "cpu_time": 0,
    "show_instance_port_number": true,
    "alert_message": "The deployed agent version at this instance is 1.0, <a href=\"https://staticdownloads.site24x7.com/apminsight/agents/agent_php.zip\">Download</a> latest version 1.1,      Follow this <a href=\"https://support.site24x7.com/portal/helpcenter/articles/upgrading-from-php-agent-1-0-to-php-agent-1-1\" target=\"_blank\">upgrading steps</a>."
  }
}

API to get the details of a particular instance. The ‘time window’ and ‘instance id’ are mandatory fields. Instance-id is required to identify the particular instance and time window is to know the exact time period for which the details are sought for.

oauthscope : Site24x7.Reports.Read

Path Parameters

Param	Type	Description
time_window	string	Mandatory Time window for which the instances have to be listed. Time window
instance_id	string	Mandatory Instance id of APM application

Response Attributes

Attribute	Type	Description
response_time_data	json	Response time metrics. JSON Format: {response_time: $response_time, min_response_time: $min_response_time, max_response_time: $max_response_time, total_response_time: $total_response_time, request_count: $request_count, error_count: $error_count, throughput: $throughput, cpu_time: $cpu_time}
exception_info	json	Exception Information. JSON Format: {warning_count:$warning_count, fatal_count:$fatal_count}
application_info	json	Application Information. JSON Format: {instance_ids: $instance_ids, host_count: $host_count, application_name: “$application_name”, hosts:$hosts, application_id: “$application_id”, rum_info: “$rum_info”}
instance_info	json	Instance metrics JSON Format: {port:$port, host:“$host”, instance_name: “$instance_name”, application_name: “$application_name”, application_id: “$application_id”, instance_id: “$instance_id”, ins_type: “$ins_type”, agent_version: “$agent_version”}
availability_health_info	json	Availability Information. JSON Format:{availability: “$availability”, availability_url: “$availability_url”, has_health_attribute: “$has_health_attribute”, health: “$health”, health_url: “$health_url”, managed_state: “$managed_state”, under_maintenance: “$under_maintenance”, last_communication_time: “$last_communication_time”}
app_config	json	Application Configuration. JSON Format: {is_cloud_app:$is_cloud_app, autoScale:$autoScale}
apdex_data	json	Apdex metrics. JSON Format: {apdex:$apdex, satisfied:$satisfied, tolerating:$tolerating, frustrated:$frustrated, satisfied_count:$satisfied_count, tolerating_count:$tolerating_count, frustrated_count:$frustrated_count}
cpu_time	int	Average time spent by the application in the CPU.
show_instance_port_number	boolean	Returns true if displaying instance port number is enabled.
alert_message	string	Alert Message

JSON Format

Attribute	Type	Description
response_time	long	Response time.
min_response_time	long	Minimum response time.
max_response_time	long	Maximum response time.
total_response_time	long	Total Response time of application.
request_count	int	Total no. of requests.
error_count	int	Total no. of errors.
throughput	long	Through put of application.
cpu_time	int	Average time spent by the application in the CPU.
warning_count	int	No of warnings encountered.
fatal_count	int	No of fatal exceptions encountered.
instance_ids	String Array	IDs of all instances of the application.
host_count	int	No. of hosts.
application_name	string	Name of the application.
host	string	Host address of particular instance.
application_id	string	Application id.
rum_info	json	RUM Information JSON Format: {rumAppId:$“rumAppId”, rumAppKey:$“rumAppKey”, rumAppName:“$rumAppName”}
port	int	Port number of instance.
host	string	Host address of particular instance
instance_name	string	Name of the instance
ins_type	string	Type of agent used for particular instance like (JAVA,PHP,RUBY,.NET).
agent_version	string	Agent version.
avalability	int	Avalability score
availability_url	string	Avalability report url
has_health_attribute	boolean	True if health attribute is present
health	int	Health score
health_url	string	Health report url
managed_state	boolean	True if managed by the user
under_maintenance	boolean	True if under maintenance
last_communication_time	long	Last known communication time of the monitor
is_cloud_app	boolean	True if instance is hosted in a cloud environment(AWS,Azure,etc).
autoScale	boolean	True if Autoscaling is enabled.
apdex	double	Apdex score of application.
satisfied	double	Percentage of satisfied users with respect to total no. of requests.
tolerating	double	Percentage of tolerating users with respect to total no. of requests.
frustrated	double	Percentage of frustrated users with respect to total no. of requests.
satisfied_count	long	No. of satisfied users.
tolerating_count	long	No. of tolerating users.
frustrated_count	long	No. of frustrated users.

Manage Instance

POST /api/apminsight/ins/{instance_id}/manage

Request Example

$ curl https://www.site24x7.com/api/apminsight/ins/15698000009961011/manage
 \
    -X POST
    -H "Accept: application/json; version=2.0" \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response

{
   "code": 0,
   "message": "success"
}

API to manage an instance that is already in suspended state. instance_id is a mandatory field and it is the corresponding instance-id of the instance.

oauthscope : Site24x7.Admin.Create

Path Parameters

Param	Type	Description
instance_id	string	Mandatory Instance id of APM application

Unmanage Instance

POST /api/apminsight/ins/{instance_id}/unmanage

Request Example

$ curl https://www.site24x7.com/api/apminsight/ins/15698000009961011/unmanage
 \
    -X POST
    -H "Accept: application/json; version=2.0" \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response

{
   "code": 0,
   "message": "success"
}

API to unmanage an instance that is in active state.instance_id is a mandatory field and it is the corresponding instance-id of the instance.

oauthscope : Site24x7.Admin.Create

Path Parameters

Param	Type	Description
instance_id	string	Mandatory Instance id of APM application

Delete Instance

DELETE /api/apminsight/ins/{instance_id}

Request Example

$ curl https://www.site24x7.com/api/apminsight/ins/15698000009961011
 \
    -X DELETE
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response

{
   "code": 0,
   "message": "success"
}

API to delete an instance. Scope and scopeid are mandatory fields.instance_id is a mandatory field and it is the corresponding instance-id of the instance.

oauthscope : Site24x7.Admin.Delete

Path Parameters

Param	Type	Description
instance_id	string	Mandatory Instance id of APM application

APM Insight Metrics

Gather in-depth performance related metrics of all applications that are monitored by APM Insight.

List all web transactions

GET /apminsight/{resource_type}/{resource_id}/txn/list/{limit}/{attribute_type}/{time_window}

Request Example

$ curl https://www.site24x7.com/api/apminsight/ins/101071000000034025/txn/list/3/apdex/H
 \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response

{
  "code": 0,
  "message": "success",
  "data": [
    {
      "value": 0,
      "info": {
        "transaction_id": "3763",
        "application_id": "101071000000034001",
        "transaction_name": "serverstatus",
        "txn_type": "HTTP"
      }
    },
    {..}
  ]
}

Lists all the web transactions in the application / instance based on a particular attribute type. The attribute types can be any one of apdex, average response time, throughput, errors or total response time.

oauthscope : Site24x7.Reports.Read

Path Parameters

Param	Type	Description
time_window	string	Mandatory Time window for which the applications have to be listed. Time window
resource_type	string	Mandatory Type of resources. Resource type
resource_id	string	Mandatory Selected resource type id. If scope is application then application_id. If scope is instance then instance_id.
limit	int	Mandatory Number of transactions to be displayed.
attribute_type	string	Mandatory Type of attribute. Based on selected attribute sorted web transaction will be lisited. Attribute type

Response Attributes

Attribute	Type	Description
transaction_id	string	Transaction ID
application_id	string	Application ID
transaction_name	string	Transaction Name
txn_type	string	Type of transaction

Single transaction details

GET /apminsight/{resource_type}/{resource_id}/{txn_type}/{txn_id}/{time_window}

Request Example

$ curl https://www.site24x7.com/api/apminsight/ins/15698000009961011/txn/30420/H
 \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "response_time_data": {
      "response_time": 621.6,
      "min_response_time": 8,
      "max_response_time": 15834,
      "total_response_time": 0,
      "request_count": 3958,
      "error_count": 0,
      "throughput": 65.97,
      "cpu_time": 98.8
    },
    "exception_info": {
        "warning_count": 0,
        "fatal_count": 0
    },
    "transaction_info": {
      "transaction_id": "30420",
      "application_id": "101071000000232001",
      "transaction_name": "arh/data",
      "txn_type": "HTTP"
    },
    "apdex_data": {
      "apdex": 0.805,
      "satisfied": 67.3,
      "tolerating": 26.4,
      "frustrated": 6.3,
      "satisfied_count": 2664,
      "tolerating_count": 1045,
      "frustrated_count": 249
    },
    "cpu_time": 98.8
  }
}

To fetch details of a particular transaction in an application / instance based on the selected attribute type. The attribute type should be ‘txn’ to fetch web transaction details.

oauthscope : Site24x7.Reports.Read

Path Parameters

Param	Type	Description
time_window	string	Mandatory Time window for which the applications have to be listed. Time window
resource_type	string	Mandatory Type of resources. Resource type
resource_id	string	Mandatory Selected resource type id. If scope is application then application_id. If scope is instance then instance_id..
txn_type	string	Mandatory Type of attribute. Based on selected attribute particular transaction information will be listed.Attribute Type.
txn_id	long	Mandatory TransactionId from info details of the transaction List.

Response Attributes

Attribute	Type	Description
response_time_data	json	Response time metrics. JSON Format: {response_time: $response_time, min_response_time: $min_response_time, max_response_time: $max_response_time, total_response_time: $total_response_time, request_count: $request_count, error_count: $error_count, throughput: $throughput, cpu_time: $cpu_time}
exception_info	json	Exception Information. JSON Format: {warning_count:$warning_count, fatal_count:$fatal_count}
transaction_info	json	Transaction Information JSON Format: {transaction_id: “$transaction_id”, application_id: “$application_id”, transaction_name: “$transaction_name”, txn_type: “txn_type”}
apdex_data	json	Apdex metrics. JSON Format: {apdex:$apdex, satisfied:$satisfied, tolerating:$tolerating, frustrated:$frustrated, satisfied_count:$satisfied_count, tolerating_count:$tolerating_count, frustrated_count:$frustrated_count}
cpu_time	int	Average time spent by the application in the CPU.

JSON Format

Attribute	Type	Description
response_time	long	Response time.
min_response_time	long	Minimum response time.
max_response_time	long	Maximum response time.
total_response_time	long	Total Response time of application.
request_count	int	Total no. of requests.
error_count	int	Total no. of errors.
throughput	long	Through put of application.
cpu_time	int	Average time spent by the application in the CPU.
warning_count	int	No of warnings encountered.
fatal_count	int	No of fatal exceptions encountered.
transaction_id	string	Transaction ID
application_id	string	Application ID
transaction_name	string	Transaction Name
txn_type	string	Type of transaction
apdex	double	Apdex score of application.
satisfied	double	Percentage of satisfied users with respect to total no. of requests.
tolerating	double	Percentage of tolerating users with respect to total no. of requests.
frustrated	double	Percentage of frustrated users with respect to total no. of requests.
satisfied_count	long	No. of satisfied users.
tolerating_count	long	No. of tolerating users.
frustrated_count	long	No. of frustrated users.

List all database operations

GET /apminsight/{resource_type}/{resource_id}/db/list/{limit}/{attribute_type}/{time_window}

Request Example

$ curl https://www.site24x7.com/api/apminsight/ins/101071000000034025/db/list/2/avgrt/H
 \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response

{
  "code": 0,
  "message": "success",
  "data": [
    {
      "value": 21.16,
      "info": {
        "db_name": "",
        "operation_name": "UPDATE",
        "table_name": "jvminfo",
        "application_id": "101071000000232001",
        "user_name": "",
        "operation_id": "18423"
      }
    },
    {..}    
  ]
}

oauthscope : Site24x7.Reports.Read

Lists all the database operations in the application / instance based on a particular attribute type. The attribute types can be any one of average response time, throughput, errors or total response time.

Path Parameters

Param	Type	Description
time_window	string	Mandatory Time window for which the applications have to be listed. Time window
resource_type	string	Mandatory Type of resources. Resource type
resource_id	string	Mandatory Selected resource type id. If scope if app then application_id. If scope is instance then instance_id.
limit	int	Mandatory Number of transaction to be displayed.
attribute_type	string	Mandatory Type of attribute. Based on selected attribute sorted database transaction will be listed. Attribute type

Response Attributes

Attribute	Type	Description
db_name	string	Name of the Database.
operation_name	string	Operation name.
table_name	string	Name of the table.
application_id	string	Application ID
user_name	string	User name
operation_id	long	Operation ID

Single Database Operations

GET /apminsight/{resource_type}/{resource_id}/db/{operation_id}/{time_window}

Request Example

$ curl https://www.site24x7.com/api/apminsight/app/15698000017614001/db/13059/H
 \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response

{
    "code": 0,
    "message": "success",
    "data": {
        "response_time_data": {
            "min_response_time": 0,
            "max_response_time": 1461,
            "total_response_time": 0,
            "response_time": 168.6,
            "throughput": 163.88,
            "error_count": 0,
            "request_count": 9833,
            "cpu_time": 0
        },
        "db_operation_info": {
            "operation_name": "INSERT",
            "db_name": "",
            "user_name": "",
            "operation_id": "13059",
            "table_name": "person",
            "application_id": "15698000017614001"
        }
    }
}

To fetch details of a particular database operation in an application / instance based on the selected database transaction id.

oauthscope : Site24x7.Reports.Read

Path Parameters

Param	Type	Description
time_window	string	Mandatory Time window for which the applications have to be listed. Time window
resource_type	string	Mandatory Type of resources. Resource type
resource_id	string	Mandatory Selected resource type id. If scope if app then application_id. If scope is instance then instance_id.
operation_id	string	Mandatory Database Operation ID from info details of the transaction List.

Response Attributes

Attribute	Type	Description
response_time_data	json	Response time metrics. JSON Format: {response_time: $response_time, min_response_time: $min_response_time, max_response_time: $max_response_time, total_response_time: total_response_time, request_count: $request_count, error_count: $error_count, throughput: $throughput, cpu_time: $cpu_time}
db_operation_info	json	Database Operation metrics. JSON Format: {operation_name: “$operation_name”, db_name: “$db_name”, user_name: “$user_name”, operation_id: “$operation_id”, table_name: “$table_name”, application_id: “$application_id” }

JSON Format

Attribute	Type	Description
min_response_time	long	Minimum response time.
max_response_time	long	Maximum response time.
total_response_time	long	Total Response time of application.
response_time	long	Response time.
throughput	long	Through put of application
error_count	int	Total no. of errors.
request_count	int	Total no. of requests.
cpu_time	int	Average time spent by the application in the CPU.
operation_name	string	Operation Name
db_name	string	Name of the Database
user_name	string	User name
operation_id	long	Operation ID
table_name	string	Name of the Table
application_id	string	Applcation ID

List all Background transactions

GET /apminsight/{resource_type}/{resource_id}/bgtxn/list/{limit}/{attribute_type}/{time_window}

Request Example

$ curl https://www.site24x7.com/api/apminsight/ins/15698000009961011/bgtxn/list/2/avgrt/H
 \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response

{
  "code": 0,
  "message": "success",
  "data": [
    {
      "value": 197.44,
      "info": {
        "transaction_id": "15527",
        "application_id": "15698000009961001",
        "transaction_name": "system.data.sqlclient.sqlcommand.executereader",
        "txn_type": "BGT"
      }
    }
  ]
}

Lists all the background transactions in the application / instance based on a particular attribute type. The attribute type can be any one of average response time, throughput, errors or total response time.

oauthscope : Site24x7.Reports.Read

Path Parameters

Param	Type	Description
time_window	string	Mandatory Time window for which the applications have to be listed. Time window
resource_type	string	Mandatory Type of resources. Resource type
resource_id	string	Mandatory Selected resource type id. If scope is application then application_id. If scope is instance then instance_id.
limit	int	Mandatory Number of transactions to be displayed.
attribute_type	string	Mandatory Type of Attribute. Based on selected attribute sorted Background transaction will be listed. Attribute Type

Response Attributes

Attribute	Type	Description
transaction_id	string	Transaction ID
application_id	string	Application ID
transaction_name	string	Transaction Name
txn_type	string	Type of transaction

Single Background transaction details

GET /apminsight/{resource_type}/{resource_id}/bgtxn/{txn_id}/{time_window}

Request Example

$ curl https://www.site24x7.com/api/apminsight/ins/15698000009961011/bgtxn/30420/H
 \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "response_time_data": {
      "response_time": 621.6,
      "min_response_time": 8,
      "max_response_time": 15834,
      "total_response_time": 0,
      "request_count": 3958,
      "error_count": 0,
      "throughput": 65.97,
      "cpu_time": 98.8
     },
    "exception_info": {
        "warning_count": 0,
        "fatal_count": 0
    },
    "transaction_info": {
      "transaction_id": "30420",
      "application_id": "101071000000232001",
      "transaction_name": "arh/data",
      "txn_type": "HTTP"
    }
  }
}

To fetch details of a particular background transaction in an application / instance based on the selected attribute type. The attribute type should be ‘bgtxn’ to fetch background transaction details.

oauthscope : Site24x7.Reports.Read

Path Parameters

Param	Type	Description
tw	string	Mandatory Time window for which the applications have to be listed. Time window
resource_type	string	Mandatory Type of resources. Resource type
resource_id	string	Mandatory Selected resource type id. If scope is application then application_id. If scope is instance then instance_id..
txn_id	long	Mandatory TransactionId from info details of the transaction List.

Response Attributes

Attribute	Type	Description
response_time_data	json	Response time metrics. JSON Format: {response_time: $response_time, min_response_time: $min_response_time, max_response_time: $max_response_time ,total_response_time: $total_response_time, request_count: $request_count, error_count: $error_count, throughput:$throughput, cpu_time: $cpu_time}
exception_info	json	Exception Information. JSON Format: {warning_count:$warning_count, fatal_count:$fatal_count}
transaction_info	json	Transaction Information JSON Format: {transaction_id:“$transaction_id”, application_id:“$application_id”, transaction_name:“$transaction_name”,txn_type:“txn_type”}

JSON Format

Attribute	Type	Description
response_time	long	Response time.
min_response_time	long	Minimum response time.
max_response_time	long	Maximum response time.
total_response_time	long	Total Response time of application.
request_count	int	Total no. of requests.
error_count	int	Total no. of errors.
throughput	long	Through put of application.
cpu_time	int	Average time spent by the application in the CPU.
warning_count	int	No of warnings encountered.
fatal_count	int	No of fatal exceptions encountered.
transaction_id	string	Transaction ID
application_id	string	Application ID
transaction_name	string	Transaction Name
txn_type	string	Type of transaction

List all Errors

GET /apminsight/{resource_type}/{resource_id}/error/list/{limit}/{time_window}

Request Example

$ curl https://www.site24x7.com/api/apminsight/ins/15698000009961011/error/list/5/H
 \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response

{
  "code": 0,
  "message": "success",
  "data": [
    [
      {
        "transaction_id": "30420",
        "application_id": "101071000000232001",
        "transaction_name": "arh/data",
        "txn_type": "HTTP"
      },
      "1440510139251",
      "44655814331556",
      "101071000000232009",
      7406,
      0,
      715
    ],
    [..]
  ]
}

To list all the error in the application / instance in the specified time window.

oauthscope : Site24x7.Reports.Read

Path Parameters

Param	Type	Description
time_window	string	Mandatory Time window for which the applications have to be listed. Time window
resource_type	string	Mandatory Type of resources. Resource type
resource_id	string	Mandatory Selected resource type id. If scope is application then application_id. If scope is instance then instance_id.
limit	int	Mandatory Number of transactions to be displayed.

Response Attributes

Attribute	Type	Description
transaction_id	string	Transaction ID
application_id	string	Application ID
transaction_name	string	Transaction Name
txn_type	string	Type of transaction

APM Insight Traces

To fetch details about the traces of methods in the application’s transactions.

List all traces

GET /apminsight/{resource_type}/{resource_id}/tr/list/{limit}/{attr_trc_constant}/{thresholdLevel}/{time_window}

Request Example

$ curl https://www.site24x7.com/api/apminsight/ins/15698000009961011/tr/list/H 
 \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response

{
  "code": 0,
  "message": "success",
  "data": [
    [
      {
        "transaction_id": "30420",
        "application_id": "101071000000232001",
        "transaction_name": "arh/data",
        "txn_type": "HTTP"
      },
      "1440510139251",
      "44655814331556",
      "101071000000232009",
      7406,
      0,
      715
    ],
    [..]
  ]
}

Lists all the traces in the application / instance, that exceed the threshold set and based on a particular attribute type. The attribute type can be any one of response time, CPU time, SQL time, exception count or external call count.

oauthscope : Site24x7.Reports.Read

Path Parameters

Param	Type	Description
time_window	string	Mandatory Time window for which the applications have to be listed. Time window
resource_type	string	Mandatory Type of resources. Resource type
resource_id	string	Mandatory Selected resource type id. If scope is application then application_id. If scope is instance then instance_id.
limit	int	Mandatory Number of transactions to be displayed.
thresholdLevel	int	Mandatory Threshold Level for selected Attribute type.For Response Time,CPU Time,SQL Time it will be in milliseconds for other it will be as count.
attr_trc_constant	string	Mandatory Trace Attribute Constants.Trace Attributes

Response Attributes

Attribute	Type	Description
transaction_id	string	Transaction ID
application_id	string	Application ID
transaction_name	string	Transaction Name
txn_type	string	Type of transaction

Single trace details

GET /apminsight/{resource_type}/{resource_id}/tr/{trId}

Request Example

$ curl https://www.site24x7.com/api/apminsight/ins/1000000129025/tr/45143182873588
 \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response

{  
   "code":0,
   "message":"success",
   "data":{  
      "trace_details":{  
         "reason":8,
         "cpu_time":-1,
         "response_code":200,
         "trace_info":"46433372988092",
         "response_bytes":"",
         "external_count":4,
         "memory_allocated":"",
         "instance_id":"15698000033242001",
         "is_error":0,
         "response_time":25272,
         "collection_time":"1497850740297",
         "exception_count":0,
         "sql_time":0
      },
      "trace_data":{  
         "sqls":[],
         "trace":[  
            {  
               "parent":"0",
               "component":"",
               "total":"25272",
               "metric":"Total Calls: 4 Remote call(s) + 7 Method call(s) ",
               "level":"0",
               "exclusive":"0",
               "id":"1",
               "time":"1497850740297"
            },
            {..}
         ],
         "additional_metrics":{  
            "thread_id":"888",
            "thread_name":"TicketId_166928665",
            "ext_components":{  
               "WEBREQUEST":"2",
               "WCF":"2"
            }
         },
         "slowest_components_graph":{  
            "0":{  
               "spilitupgraph":{  
                  "95_percentile":[  
                     25256.0
                  ],
                  "average":[  
                     8424.0
                  ],
                  "chart_data":[  
                     [  
                        "System.Net.HttpWebRequest.GetResponse() [http://localhost:2146/MovieService/BookingService.svc]",
                        25256.0
                     ],
                     [  
                        "System.Net.HttpWebRequest.GetResponse() [http://localhost:2146/MovieService/MovieService.svc]",
                        15.0
                     ],
                     [  
                        "others",
                        1.0
                     ]
                  ],
                  "min":[  
                     1.0
                  ],
                  "max":[  
                     25256.0
                  ]
               }
            },
            "legends":[  
               "Splitup"
            ],
            "units":[  
               ""
            ]
         },
         "ext_components":{  
            "0":{  
               "spilitupgraph":{  
                  "95_percentile":[  
                     2.0
                  ],
                  "average":[  
                     2.0
                  ],
                  "chart_data":[  
                     [  
                        "WEBREQUEST",
                        2.0
                     ],
                     [  
                        "WCF",
                        2.0
                     ]
                  ],
                  "min":[  
                     2.0
                  ],
                  "max":[  
                     2.0
                  ]
               }
            },
            "legends":[  
               "Splitup"
            ],
            "units":[  
               ""
            ]
         },
         "components_breakup":[  
            {  
               "component":"WEBREQUEST",
               "exclusive":"25271"
            }
         ],
         "slowest_components":[  
            {  
               "metric":"System.Net.HttpWebRequest.GetResponse() [http://localhost:2146/MovieService/BookingService.svc]",
               "count":"1",
               "exclusive":"25256"
            },
            {..},
            {..}
         ],
         "remote_calls":{  
            "WEBREQUEST":[  
               {  
                  "name":"System.Net.HttpWebRequest.GetResponse() [http://localhost:2146/MovieService/BookingService.svc]",
                  "value":"1"
               },
               {..}               
            ]
         },
         "exceptions":[]
      },
      "instance_info":{  
         "agent_version":3.3,
         "instance_id":"15698000033242001",
         "instance_name":"site24x7-w7-64:80",
         "application_name":"TicketBooking",
         "port":80,
         "host":"site24x7-w7-64",
         "ins_type":"DOTNET",
         "application_id":"15698000028007017"
      },
      "transaction_info":{  
         "transaction_id":"33360",
         "txn_type":"HTTP",
         "transaction_name":"ticketweb/movie/bookticket",
         "application_id":"15698000028007017"
      }
   }
}

To fetch details of a particular trace in an application / instance, whose trace-id is set as attribute.

oauthscope : Site24x7.Reports.Read

Path Parameters

Param	Type	Description
resource_type	string	Mandatory Type of resources. Resource type
resource_id	string	Mandatory Selected resource type id. If scope is application then application_id. If scope is instance then instance_id.
trId	int	Mandatory traceId from info details of the trace list.

Response Attributes

Attribute	Type	Description
trace_details	json	Trace Details. JSON Format: {reason:$reason, cpu_time: $cpu_time, response_code: $response_code, trace_info: $trace_info, response_bytes: $response_bytes ,external_count: $external_count, memory_allocated: $memory_allocated, instance_id: “$instance_id”, is_error: $is_error, response_time: $response_time, collection_time: $collection_time, exception_count: $exception_count, sql_time: $sql_time}
trace_data	json	Trace metrics. JSON Format: {sqls:$sqls, trace:$trace, additional_metrics:$additional_metrics, slowest_components_graph: $slowest_components_graph, components_breakup: $components_breakup, slowest_components: $slowest_components, remote_calls: $remote_calls}
instanceInfo	json	Instance metrics JSON Format: {agent_version: “$agent_version”, instance_id: “$instance_id”, instance_name: “$instance_name”, application_name: “$application_name”, port: $port, host: “$host”, ins_type: “$ins_type”, application_id: “$application_id”}
transaction_info	json	Transaction Information JSON Format: {transaction_id: “$transaction_id”, txn_type: “txn_type”, transaction_name: “$transaction_name”, application_id: “$application_id”}

JSON Format

Attribute	Type	Description
reason	int	Reason code for trace.
cpu_time	long	Average time spent by the application in the CPU
response_code	int	HTTP Response code
trace_info	long	Trace Information - ID
response_bytes	long	No. of bytes sent in the response.
external_count	int	No. of external calls.
memory_allocated	long	Memory allocated for the request execution.
instance_id	string	Instance Id
is_error	boolean	Error trace or not
response_time	long	Response Time
collection_time	long	Data Collection time
exception_count	int	Total no. of Exceptions
sql_time	long	Time taken by sql operations
parent	string	ID of the parent
component	string	Transaction component type
total	string	Total time
metric	string	Metrics of the transaction
level	string	component’s level in the hierarchy.
exclusive	string	metric specific time.
id	string	Metric id.
time	string	timestamp for the metric since startup.
thread_id	long	Thread ID
thread_name	string	Name of the Thread
components_break_up	json Array	Individual components metrics.
slowest_components	json Array	Slowest components splitup.
agent_version	string	Agent version.
instanceid	long	Instance Id
instance_name	string	Name of the instance
application_name	string	Name of the application.
port	int	Port number of instance.
host	string	Host address of particular instance
ins_type	string	Type of agent used for particular instance like (JAVA,PHP,RUBY,.NET).
application_id	string	Application id.
transaction_id	string	Transaction ID
txn_type	string	Type of transaction
transaction_name	string	Transaction Name

Delete single trace

DELETE /api/apminsight/{resource_type}/{resource_id}/tr/{instance_id}_{txn_id}_{collection_time}

Request Example

$ curl https://www.site24x7.com/api/apminsight/ins/15698000009961011/tr/1400200006003_508_1569500208890
 \
    -X DELETE
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response

{
   "code": 0,
   "message": "success"
}

To delete the single trace in an application / instance, whose trace-id is set as attribute.

oauthscope : Site24x7.Admin.Delete

Path Parameters

Param	Type	Description
resource_type	string	Mandatory Type of resources. Resource type
resource_id	string	Mandatory Selected resource type id. If scope is application then application_id. If scope is instance then instance_id.
instance_id	int	Mandatory Instance Id. Use all instances API to get the instance id of the monitor.
txn_id	int	Mandatory Transaction Id. Use all traces API to get the transaction id of the transaction.
collection_time	long	Mandatory Collection time of the trace. Use single trace details API to get the collection time of the trace.

Delete all traces

DELETE /api/apminsight/app/{application_id}/tr

Request Example

$ curl https://www.site24x7.com/api/apminsight/app/101071000000034001/tr
 \
    -X DELETE
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response

{
   "code": 0,
   "message": "success"
}

To delete all the traces in the application, whose application-id is set as attribute.

oauthscope : Site24x7.Admin.Delete

Path Parameters

Param	Type	Description
application_id	string	Mandatory Application Id of APM application

APM Insight Reports

Reporting APIs to get all graph data for various metrics and attributes in APM Insight, that can be used to build custom reports of user’s choice.

Application / Instance graph data

GET /apminsight/{resource_type}/{resource_id}/graph/{attribute_type}/{time_window}

Request Example

$ curl https://www.site24x7.com/api/apminsight/ins/101071000000034035/graph/apdex/H \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "0": {
      "apdexgraph": {
        "95_percentile": [
          1
        ],
        "min": [
          1
        ],
        "max": [
          1
        ],
        "average": [
          1
        ],
        "chart_data": [
          [
            "2016-02-14T19:45:00+0530",
            ""
          ],
          [
            "2016-02-14T21:30:00+0530",
            1
          ]
        ]
      }
    },
    "legends": [
        "Server"
    ],
    "units": [
      ""
    ]
  }
}

To fetch the graph data for application / instance for the specified attribute types. The attribute types can be any one of apdex, response time & throughput, components, response time by components, throughput or average response time.

oauthscope : Site24x7.Reports.Read

Path Parameters

Param	Type	Description
time_window	string	Mandatory Time window for which the applications have to be listed. Time window
resource_type	string	Mandatory Type of resources. Resource type
resource_id	string	Mandatory Selected resource type id. If scope is application then application_id. If scope is instance then instance_id.
attribute_type	string	Mandatory Attribute for graphs.Graph attribute

Response Attributes

Attribute	Type	Description
apdexgraph	json	Object containing apdex graph details. JSON Format: {95_percentile: $95_percentile, chart_data: $chart_data, legends: $legends, units: $units}

JSON Format

Attribute	Type	Description
95_percentile	Integer Array	95th percentile value
chart_data	String Array	Data for plotting chart
legends	String Array	Legends for graph
units	String Array	Units

Web Transaction graph

GET /apminsight/{resource_type}/{resource_id}/{txn_type}/{txn_id}/graph/{graph_constant}/{time_window}

Request Example

$ curl https://www.site24x7.com/api/apminsight/ins/15698000009961011/txn/30420/graph/rtandthroughput/H
 \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "0": {
      "avgresponsetimethroughputgraph": {
        "95_percentile": [
          122,
          0.07
        ],
        "min": [
          122,
          0.07
        ],
        "max": [
          122,
          0.07
        ],
        "average": [
          122,
          0.07
        ],
        "chart_data": [
          [
            "2016-02-14T20:00:00+0530",
            "",
            ""
          ],
          [
            "2016-02-14T22:15:00+0530",
            122,
            0.07
          ]
        ]
      }
    },
    "legends": [
      "Avg. Response Time",
      "Throughput"
    ],
    "units": [
      "ms",
      "rpm"
    ]
  }
}

To fetch the graph data of a particular web transaction in an application / instance for the specified graph constants.

oauthscope : Site24x7.Reports.Read

Path Parameters

Param	Type	Description
time_window	string	Mandatory Time window for which the applications have to be listed. Time window
resource_type	string	Mandatory Type of resources. Resource type
resource_id	string	Mandatory Selected resource type id. If scope is application then application_id. If scope is instance then instance_id.
txn_type	string	Mandatory Type of attribute. Based on selected attribute particular transaction information will be listed.Attribute Type.
txn_id	long	Mandatory TransactionId from info details of the transaction List.
graph_constant	string	Mandatory Graph Constants.Graph Constants.

Response Attributes

Attribute	Type	Description
avgresponsetimethroughputgraph	json	Object containing responsetime/throughput graph details. JSON Format: {95_percentile: $95_percentile, chart_data: $chart_data, legends: $legends, units: $units}

JSON Format

Attribute	Type	Description
95_percentile	Integer Array	95th percentile value
chart_data	String Array	Data for plotting chart
legends	String Array	Legends for graph
units	String Array	Units

Database Operation Graph

GET /apminsight/{resource_type}/{resource_id}/db/graph/{graph_constant}/{time_window}

Request Example

$ curl https://www.site24x7.com/api/apminsight/ins/15698000009961011/db/graph/avgrt/H
 \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "0": {
      "responsetimegraph": {
        "95_percentile": [
          7
        ],
        "min": [
          1
        ],
        "max": [
          7
        ],
        "average": [
          4
        ],
        "chart_data": [
          [
            "2016-02-15T19:07:00+0530",
            ""
          ],
          [
            "2016-02-15T19:36:00+0530",
            1
          ]
        ]
      }
    },
    "legends": [
      "select"
    ],
    "units": [
      "ms"
    ]
  }
}

To fetch the graph data of a particular database operation in an application / instance for the specified graph constants. The graph constants are response time, throughput, response time & throughput.

oauthscope : Site24x7.Reports.Read

Path Parameters

Param	Type	Description
time_window	string	Mandatory Time window for which the applications have to be listed. Time window
resource_type	string	Mandatory Type of resources. Resource type
resource_id	string	Mandatory Selected resource type id. If scope is application then application_id. If scope is instance then instance_id.
graph_constant	string	Mandatory Database Operation Graph Constants.Graph Constants.

Response Attributes

Attribute	Type	Description
responsetimegraph	json	Object containing responsetime graph details. JSON Format: {95_percentile: $95_percentile, chart_data: $chart_data, legends:$legends, units: $units}

JSON Format

Attribute	Type	Description
95_percentile	Integer Array	95th percentile value
chart_data	String Array	Data for plotting chart
legends	String Array	Legends for graph
units	String Array	Units

APM Insight JVM / IIS metrics

APIs to get detailed metric related to JVM instances and IIS servers.

JVM Summary

GET /apminsight/{resource_type}/{resource_id}/jvm/summary/{time_window}

Request Example

$ curl https://www.site24x7.com/api/apminsight/ins/15698000009961011/jvm/summary/H 
 \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "non_heap_details": [
      48,
      12,
      11,
      2048,
      138,
      80,
      0,
      0,
      0,
      0,
      0,
      0
    ],
    "jvm_metrics": {
      "runtimetotalmemory": 271,
      "classesloaded": 10427,scopeId
      "classesunloaded": 121,
      "cpuutil": 0.12,
      "jittime": 29,
      "runtimefreememory": 111
    },
    "heap_details": [
      151,
      86,
      43,
      8,
      8,
      4,
      341,
      177,
      111
    ],
    "graphs": {
      "heap_memory": {
        "0": {
          "memorygraph": {
            "95_percentile": [
              73,
              9,
              112
            ],
            "min": [
              24,
              2,
              109
            ],
            "max": [
              73,
              9,
              112
            ],
            "average": [
              42.6,
              4.53,
              110.73
            ],
            "chart_data": [
              [
                "2016-02-14T20:30:00+0530",
                "",
                "",
                ""
              ],
              [
                "2016-02-14T21:30:00+0530",
                45,
                9,
                109
              ],
            ]
          }
        },
        "legends": [
          "Eden Space",
          "Survivor Space",
          "Tenured Gen"
        ],
        "units": [
          "MB"
        ]
      },
      "classes_info": {
        "0": {
          "collectioncountgraph": {
            "95_percentile": [
              10439,
              121
            ],
            "min": [
              10420,
              121
            ],
            "max": [
              10439,
              121
            ],
            "average": [
              10426.87,
              121
            ],
            "chart_data": [
              [
                "2016-02-14T20:30:00+0530",
                "",
                ""
              ],
              [
                "2016-02-14T21:30:00+0530",
                10420,
                121
              ]
            ]
          }
        },
        "legends": [
          "Loaded",
          "Unloaded"
        ],
        "units": [
          ""
        ]
      },
      "jit_time": {
        "0": {
          "timespentgraph": {
            "95_percentile": [
              131
            ],
            "min": [
              0
            ],
            "max": [
              131
            ],
            "average": [
              27.7
            ],
            "chart_data": [
              [
                "2016-02-14T20:30:00+0530",
                ""
              ],
              [
                "2016-02-14T21:30:00+0530",
                10
              ]
            ]
          }
        },
        "legends": [],
        "units": [
          "ms"
        ]
      },
      "cpu_util_graph_data": {
        "0": {
          "usagegraph": {
            "95_percentile": [
              0.29
            ],
            "min": [
              0.08
            ],
            "max": [
              0.29
            ],
            "average": [
              0.13
            ],
            "chart_data": [
              [
                "2016-02-14T20:30:00+0530",
                ""
              ],
              [
                "2016-02-14T21:30:00+0530",
                0.2
              ]
            ]
          }
        },
        "legends": [],
        "units": [
          "%"
        ]
      },
      "non_heap_Memory": {
        "0": {
          "memorygraph": {
            "95_percentile": [
              12,
              80,
              0,
              0
            ],
            "min": [
              10,
              80,
              0,
              0
            ],
            "max": [
              12,
              80,
              0,
              0
            ],
            "average": [
              11.2,
              80,
              0,
              0
            ],
            "chart_data": [
              [
                "2016-02-14T20:30:00+0530",
                "",
                "",
                "",
                ""
              ],
              [
                "2016-02-14T21:30:00+0530",
                10,
                80,
                0,
                0
              ]
            ]
          }
        },
        "legends": [
          "Code Cache",
          "Perm Gen",
          "Perm Gen [shared-ro]",
          "Perm Gen [shared-rw]"
        ],
        "units": [
          "MB"
        ]
      },
      "run_time_memory_info": {
        "0": {
          "memorygraph": {
            "95_percentile": [
              160
            ],
            "min": [
              111
            ],
            "max": [
              160
            ],
            "average": [
              135.5
            ],
            "chart_data": [
              [
                "FREE",
                111
              ],
              [
                "USED",
                160
              ]
            ]
          }
        },
        "legends": [],
        "units": [
          "MB"
        ]
      }
    }
  }
}

To fetch the summary details of the particular JVM in an application / instance whose application-id or instance-id is passed as argument.

oauthscope : Site24x7.Reports.Read

Path Parameters

Param	Type	Description
time_window	string	Mandatory Time window for which the applications have to be listed. Time window
resource_type	string	Mandatory Type of resources. Resource type
resource_id	string	Mandatory Selected resource type id. If scope is application then application_id. If scope is instance then instance_id.

Response Attributes

Attribute	Type	Description
non_heap_details	Integer Array	JVM Non-heap memory usage metrics.
jvm_metrics	json	JVM metrics. JSON Format:{runtimetotalmemory: $runtimetotalmemory, classesloaded: $classesloaded, classesunloaded:$classesunloaded, cpuutil: $cpuutil, jittime:$jittime, runtimefreememory: $runtimefreememory}
heap_details	Integer Array	JVM Heap memory usage metrics
graphs	json	Graph data. JSON Format:{heap_memory: $heap_memory, classes_info: $classes_info, jit_time:$jit_time, cpu_util_graph_data: $cpu_util_graph_data, non_heap_Memory: $non_heap_Memory, run_time_memory_info: $run_time_memory_info$}

JSON Format

Attribute	Type	Description
runtimetotalmemory	long	JVM Run-time Total Memory
classesloaded	long	Number of classes that are currently loaded in the JVM.
classesunloaded	long	Number of classes that are unloaded in the JVM.
cpuutil	int	JVM CPU Utilisation.
jittime	long	JIT compilation’s time.
runtimefreememory	long	JVM Run-time free memory.
heap_memory	json	Heap-memory graph data. JSON Format:{95_percentile: $95_percentile, min: $min, max: $max, average: $average, chart_data: $chart_data, legends: $legends, units: $units}
classes_info	json	Classes information graph data. JSON Format:{95_percentile: $95_percentile, min: $min, max: $max, average: $average, chart_data: $chart_data, legends: $legends, units: $units}
jit_time	json	JIIT time graph data. JSON Format:{95_percentile: $95_percentile, min: $min, max: $max, average: $average, chart_data: $chart_data, legends: $legends, units: $units}
cpu_util_graph_data	json	CPU utilization graph data. JSON Format:{95_percentile: $95_percentile, min: $min, max: $max, average: $average, chart_data: $chart_data, legends: $legends, units: $units}
non_heap_Memory	json	Non-heap memory graph data. JSON Format:{95_percentile: $95_percentile, min: $min, max: $max, average: $average, chart_data: $chart_data, legends: $legends, units: $units}
run_time_memory_info	json	Run-time memory graph data. JSON Format:{95_percentile: $95_percentile, min: $min, max: $max, average: $average, chart_data: $chart_data, legends: $legends, units: $units}

JVM garbage collector

GET /apminsight/{resource_type}/{resource_id}/jvm/gc/{time_window}

Request Example

$ curl https://www.site24x7.com/api/apminsight/ins/15698000009961011/jvm/gc/H 
 \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response

{
  "code": 0,
  "message": "success",
  "data": [
    {
      "data": [
        "PS Scavenge",
        123,
        2409,
        95,
        2219
      ],
      "graphs": {
        "total_collections_count_and_time": {
          "0": {
            "timespentcollectioncountgraph": {
              "95_percentile": [
                3950,
                151
              ],
              "min": [
                960,
                38
              ],
              "max": [
                4038,
                155
              ],
              "average": [
                2219.18,
                94.33
              ],
              "chart_data": [
                [
                  "2016-02-14T20:30:00+0530",
                  "",
                  ""
                ],
                [
                  "2016-02-14T21:30:00+0530",
                  3229,
                  119
                ]
              ]
            }
          },
          "legends": [
            "Time Spent",
            "Count"
          ],
          "units": [
            "ms",
            ""
          ]
        },
        "current_collections_count_and_time": {
          "0": {
            "timespentcollectioncountgraph": {
              "95_percentile": [
                137,
                6
              ],
              "min": [
                0,
                0
              ],
              "max": [
                157,
                8
              ],
              "average": [
                47.24,
                2.41
              ],
              "chart_data": [
                [
                  "2016-02-14T20:30:00+0530",
                  "",
                  ""
                ],
                [
                  "2016-02-14T21:30:00+0530",
                  65,
                  1
                ]
              ]
            }
          },
          "legends": [
            "Time Spent",
            "Count"
          ],
          "units": [
            "ms",
            ""
          ]
        }
      }
    },
    {..}
  ]
}

To fetch details of various garbage collectors in the JVM being monitored.

oauthscope : Site24x7.Reports.Read

Path Parameters

Param	Type	Description
time_window	string	Mandatory Time window for which the applications have to be listed. Time window
resource_type	string	Mandatory Type of resources. Resource type
resource_id	string	Mandatory Selected resource type id. If scope is application then application_id. If scope is instance then instance_id.

Response Attributes

Attribute	Type	Description
data	json Array	Major and Minor Garbage collector details.
graphs	jsonobject	Graph metrics. JSON Format:{total_collections_count_and_time: $total_collections_count_and_time, current_collections_count_and_time: $current_collections_count_and_time}

JSON Format

Attribute	Type	Description
total_collections_count_and_time	json	Total collection count graph data. JSON Format:{95_percentile: $95_percentile, min: $min, max: $max, average: $average, chart_data: $chart_data, legends: $legends, units: $units}
current_collections_count_and_time	json	Current collection count graph data. JSON Format:{95_percentile: $95_percentile, min: $min, max: $max, average: $average, chart_data: $chart_data, legends: $legends, units: $units}

JVM thread

GET /apminsight/{resource_type}/{resource_id}/jvm/threads/{time_window}

Request Example

$ curl https://www.site24x7.com/api/apminsight/ins/15698000009961011/jvm/threads/H 

 \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "dead_locked_threads": [],
    "graphs": {
      "live_and_deamon_threads": {
        "0": {
          "collectioncountgraph": {
            "95_percentile": [
              67,
              56,
              90,
              3
            ],
            "min": [
              56,
              47,
              90,
              2
            ],
            "max": [
              67,
              56,
              90,
              3
            ],
            "average": [
              57.87,
              48.6,
              90,
              2.53
            ],
            "chart_data": [
              [
                "2016-02-14T20:30:00+0530",
                "",
                "",
                "",
                ""
              ],
              [
                "2016-02-14T21:30:00+0530",
                67,
                56,
                90,
                2
              ]
          }
        },
        "legends": [
          "Live Threads",
          "Daemon Threads",
          "Peak Threads",
          "Sleeping Threads"
        ],
        "units": [
          ""
        ]
      },
      "cpu_and_user_time": {
        "0": {
          "timespentgraph": {
            "95_percentile": [
              173,
              145
            ],
            "min": [
              46,
              39
            ],
            "max": [
              173,
              145
            ],
            "average": [
              75.4,
              63.4
            ],
            "chart_data": [
              [
                "2016-02-14T20:30:00+0530",
                "",
                ""
              ],
              [
                "2016-02-14T21:30:00+0530",
                122,
                110
              ]
            ]
          }
        },
        "legends": [
          "CPU Time",
          "User Time"
        ],
        "units": [
          "ms"
        ]
      }
    }
  }
}

To fetch details of various thread in the JVM being monitored.

oauthscope : Site24x7.Reports.Read

Path Parameters

Param	Type	Description
time_window	string	Mandatory Time window for which the applications have to be listed. Time window
resource_type	string	Mandatory Type of resources. Resource type
resource_id	string	Mandatory Selected resource type id. If scope is application then application_id. If scope is instance then instance_id.

Response Attributes

Attribute	Type	Description
dead_locked_threads	String Array	Deadlocked thread’s details
graphs	jsonobject	Graph metrics. JSON Format:{live_and_deamon_threads: $live_and_deamon_threads, cpu_and_user_time: $cpu_and_user_time}

JSON Format

Attribute	Type	Description
live_and_deamon_threads	json	Total collection count graph data. JSON Format:{95_percentile: $95_percentile, min: $min, max: $max, average: $average, chart_data: $chart_data, legends: $legends, units: $units}
cpu_and_user_time	json	Current collection count graph data. JSON Format:{95_percentile: $95_percentile, min: $min, max: $max, average: $average, chart_data: $chart_data, legends: $legends, units: $units}

JVM configuration

GET /apminsight/{resource_type}/{resource_id}/jvm/config

Request Example

$ curl https://www.site24x7.com/api/apminsight/ins/15698000009961011/jvm/config 

 \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response

{
  "code": 0,
  "message": "success",
  "data": [
    {
      "boot_classpath": [
        "/usr/lib/jvm/java-1.6.0-openjdk-1.6.0.0.x86_64/jre/lib/resources.jar",
        "/usr/lib/jvm/java-1.6.0-openjdk-1.6.0.0.x86_64/jre/lib/rt.jar",
        "/usr/lib/jvm/java-1.6.0-openjdk-1.6.0.0.x86_64/jre/lib/sunrsasign.jar",
        "/usr/lib/jvm/java-1.6.0-openjdk-1.6.0.0.x86_64/jre/lib/jsse.jar",
        "/usr/lib/jvm/java-1.6.0-openjdk-1.6.0.0.x86_64/jre/lib/jce.jar",
        "/usr/lib/jvm/java-1.6.0-openjdk-1.6.0.0.x86_64/jre/lib/charsets.jar",
        "/usr/lib/jvm/java-1.6.0-openjdk-1.6.0.0.x86_64/jre/lib/netx.jar",
        "/usr/lib/jvm/java-1.6.0-openjdk-1.6.0.0.x86_64/jre/lib/plugin.jar",
        "/usr/lib/jvm/java-1.6.0-openjdk-1.6.0.0.x86_64/jre/lib/rhino.jar",
        "/usr/lib/jvm/java-1.6.0-openjdk-1.6.0.0.x86_64/jre/lib/modules/jdk.boot.jar",
        "/usr/lib/jvm/java-1.6.0-openjdk-1.6.0.0.x86_64/jre/classes",
        "/home/test/apminsight-aws-app/apminsight/apminsight-javaagent.jar"
      ],
      "java_arguments": [
        "-Djava.util.logging.config.file=\\/home\\/test\\/apminsight-aws-app\\/apache-tomcat-7.0.50\\/conf\\/logging.properties",
        "-Djava.util.logging.manager=org.apache.juli.ClassLoaderLogManager",
        "-javaagent:\\/home\\/test\\/apminsight-aws-app\\/apminsight\\/apminsight-javaagent.jar",
        "-Djava.endorsed.dirs=\\/home\\/test\\/apminsight-aws-app\\/apache-tomcat-7.0.50\\/endorsed",
        "-Dcatalina.base=\\/home\\/test\\/apminsight-aws-app\\/apache-tomcat-7.0.50",
        "-Dcatalina.home=\\/home\\/test\\/apminsight-aws-app\\/apache-tomcat-7.0.50",
        "-Djava.io.tmpdir=\\/home\\/test\\/apminsight-aws-app\\/apache-tomcat-7.0.50\\/temp"
      ],
      "classpath": [
        "/home/test/apminsight-aws-app/apache-tomcat-7.0.50/bin/bootstrap.jar",
        "/home/test/apminsight-aws-app/apache-tomcat-7.0.50/bin/tomcat-juli.jar",
        "/home/test/apminsight-aws-app/apminsight/apminsight-javaagent.jar"
      ],
      "jvm_config_info": {
        "OSArch": "amd64",
        "JavaHome": "/usr/lib/jvm/java-1.6.0-openjdk-1.6.0.0.x86_64/jre",
        "Classpath": "/home/test/apminsight-aws-app/apache-tomcat-7.0.50/bin/bootstrap.jar:/home/test/apminsight-aws-app/apache-tomcat-7.0.50/bin/tomcat-juli.jar:/home/test/apminsight-aws-app/apminsight/apminsight-javaagent.jar",
        "JavaVersion": "1.6.0_22",
        "JavaArguments": "[\"-Djava.util.logging.config.file=\\/home\\/test\\/apminsight-aws-app\\/apache-tomcat-7.0.50\\/conf\\/logging.properties\",\"-Djava.util.logging.manager=org.apache.juli.ClassLoaderLogManager\",\"-javaagent:\\/home\\/test\\/apminsight-aws-app\\/apminsight\\/apminsight-javaagent.jar\",\"-Djava.endorsed.dirs=\\/home\\/test\\/apminsight-aws-app\\/apache-tomcat-7.0.50\\/endorsed\",\"-Dcatalina.base=\\/home\\/test\\/apminsight-aws-app\\/apache-tomcat-7.0.50\",\"-Dcatalina.home=\\/home\\/test\\/apminsight-aws-app\\/apache-tomcat-7.0.50\",\"-Djava.io.tmpdir=\\/home\\/test\\/apminsight-aws-app\\/apache-tomcat-7.0.50\\/temp\"]",
        "ClassVersion": "50.0",
        "OSVersion": "2.6.38.6-26.rc1.fc15.x86_64",
        "JavaVendor": "Sun Microsystems Inc.",
        "JVMName": "OpenJDK 64-Bit Server VM",
        "OS": "Linux",
        "ApplicationStarttime": "1460952901417",
        "HeapMaximum": "958",
        "JvmPID": "15887",
        "AgentInstallPath": "/home/test/apminsight-aws-app/apminsight",
        "BootClasspath": "/usr/lib/jvm/java-1.6.0-openjdk-1.6.0.0.x86_64/jre/lib/resources.jar:/usr/lib/jvm/java-1.6.0-openjdk-1.6.0.0.x86_64/jre/lib/rt.jar:/usr/lib/jvm/java-1.6.0-openjdk-1.6.0.0.x86_64/jre/lib/sunrsasign.jar:/usr/lib/jvm/java-1.6.0-openjdk-1.6.0.0.x86_64/jre/lib/jsse.jar:/usr/lib/jvm/java-1.6.0-openjdk-1.6.0.0.x86_64/jre/lib/jce.jar:/usr/lib/jvm/java-1.6.0-openjdk-1.6.0.0.x86_64/jre/lib/charsets.jar:/usr/lib/jvm/java-1.6.0-openjdk-1.6.0.0.x86_64/jre/lib/netx.jar:/usr/lib/jvm/java-1.6.0-openjdk-1.6.0.0.x86_64/jre/lib/plugin.jar:/usr/lib/jvm/java-1.6.0-openjdk-1.6.0.0.x86_64/jre/lib/rhino.jar:/usr/lib/jvm/java-1.6.0-openjdk-1.6.0.0.x86_64/jre/lib/modules/jdk.boot.jar:/usr/lib/jvm/java-1.6.0-openjdk-1.6.0.0.x86_64/jre/classes:/home/test/apminsight-aws-app/apminsight/apminsight-javaagent.jar",
        "JVMVersion": "20.0-b11",
        "NonHeapInitial": "23",
        "HeapInitial": "61",
        "NonHeapMaximum": "214",
        "LibraryPath": "/usr/lib/jvm/java-1.6.0-openjdk-1.6.0.0.x86_64/jre/lib/amd64/server:/usr/lib/jvm/java-1.6.0-openjdk-1.6.0.0.x86_64/jre/lib/amd64:/usr/lib/jvm/java-1.6.0-openjdk-1.6.0.0.x86_64/jre/../lib/amd64:/usr/java/packages/lib/amd64:/usr/lib64:/lib64:/lib:/usr/lib"
      },
      "jvmInfoValues": {
        "vmUptime": 375609533,
        "availProcessors": 1,
        "totalClasses": 4875,
        "totalThreads": 36999,
        "uptimeDuration": "4 Days: 8 Hours 20 Minutes 9 Seconds "
      }
    }
  ]
}

To fetch details of all the configuration metrics in the JVM being monitored.

oauthscope : Site24x7.Reports.Read

Path Parameters

Param	Type	Description
resource_type	string	Mandatory Type of resources. Resource type
resource_id	string	Mandatory Selected resource type id. If scope is application then application_id. If scope is instance then instance_id.

Response Attributes

Attribute	Type	Description
boot_classpath	string	List of files in JVM’s Boot Classpath.
java_arguments	string	Arguments passed for JVM startup
Classpath		List of files in JVM’s Classpath.
jvm_config_info	json	JVM Configuration Information. JSON Format:{OSArch: “$OSArch”, JavaHome: “$JavaHome”, JavaVersion: “$JavaVersion”, ClassVersion: “$ClassVersion”, OSVersion: “$OSVersion”, JavaVendor: “$JavaVendor”, JVMName: “$JVMName”,OS: “$OS”, ApplicationStarttime: “$ApplicationStarttime”, HeapMaximum: “$HeapMaximum”, JvmPID: “$JvmPID”, AgentInstallPath: “$AgentInstallPath”, JVMVersion: “$JVMVersion”, NonHeapInitial: “$NonHeapInitial”, HeapInitial: “$HeapInitial”, NonHeapMaximum: “$NonHeapMaximum”,LibraryPath: “$LibraryPath”}
jvmInfoValues	json	JVM Information values. JSON Format:{vmUptime:$vmUptime, availProcessors:$availProcessors, totalClasses: $totalClasses, totalThreads: “$totalThreads”, uptimeDuration: $“uptimeDuration”}

JSON Format

Attribute	Type	Description
OSArch	string	OS Architecture.
JavaHome	string	Java Home Directory
JavaVersion	string	Java version.
ClassVersion	string	Class version
OSVersion	string	OS version.
JavaVendor	string	Java vendor name
JVMName	string	JVM Name
OS	string	Operating System Name
ApplicationStarttime	string	JVM Start time
HeapMaximum	string	Maximum memory available for heap memory pool.
JvmPID	string	JVM Process ID
AgentInstallPath	string	Installation path of the JAVA Agent.
JVMVersion	string	JVM version
NonHeapInitial	string	Initial memory allocated for Non-heap memory pool.
HeapInitial	string	Initial memory allocated for heap memory pool.
NonHeapMaximum	string	Maximum memory available for Non-heap memory pool.
LibraryPath	string	List of files in JVM’s Librarypath.
vmUptime	long	Uptime of the JVM.
availProcessors	int	No. of available processors.
totalClasses	long	currently loaded classes.
totalThreads	long	no.ofthreads created since JVM startup.
uptimeDuration	string	Uptime in terms of Days/Hours/Seconds.

IIS application details

GET /apminsight/{resource_type}/{resource_id}/iis/details/{time_window}

Request Example

$ curl https://www.site24x7.com/api/apminsight/ins/15698000009999011/iis/details/SD/15.02.2016 

 \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "sessiondata": {
      "activeSessionsAvg": 0,
      "sqlConnectionAvg": 0,
      "stateConnectionAvg": 0
    },
    "status_message": "Currently IIS Monitor is Down.",
    "networkstatistics": {
      "0": {
        "networkstatisticsgraph": {
          "95_percentile": [
            36.96,
            2.39
          ],
          "min": [
            12.63,
            1.36
          ],
          "max": [
            37.07,
            2.41
          ],
          "average": [
            32.82,
            2.268
          ],
          "chart_data": [
            [
              "2016-02-15T07:00:00+0530",
              12.63,
              1.36
            ],
            [
              "2016-02-15T08:00:00+0530",
              30.56,
              2.23
            ],
            [
              "2016-02-15T18:00:00+0530",
              37.07,
              2.39
            ]
          ]
        }
      },
      "legends": [
        "Bytes Sent/sec",
        "Bytes Received/sec"
      ],
      "units": [
        "sec"
      ],
      "avgdata": {
        "sentAvg": 2.939,
        "recvdAvg": 0.203
      },
      "serviceUptime": 0
    },
    "appresponsedata": {
      "0": {
        "appresponsedatagraph": {
          "95_percentile": [
            14935.98,
            46256.56,
            0
          ],
          "min": [
            529.35,
            1591.28,
            0
          ],
          "max": [
            16462.77,
            51016.99,
            0
          ],
          "average": [
            8250,
            25500,
            0
          ],
          "chart_data": [
            [
              "2016-02-15T07:00:00+0530",
              529.35,
              1591.28,
              0
            ],
            [
              "2016-02-15T08:00:00+0530",
              1557.96,
              4709.18,
              0
            ],
            [
              "2016-02-15T18:00:00+0530",
              16462.77,
              51016.99,
              0
            ]
          ]
        }
      },
      "legends": [
        "Request Bytes In",
        "Request Bytes Out",
        "Requests Failed"
      ],
      "units": [
        "KB/Sec"
      ],
      "avgdata": {
        "bytesInAvg": 738.981,
        "bytesOutAvg": 2282.949,
        "failedRequestAvg": 0
      }
    },
    "apppoolData": {
      "processIOThreadData": {
        "0": {
          "processIOThreadDatagraph": {
            "95_percentile": [
              5.42,
              7.54,
              44
            ],
            "min": [
              0,
              4.94,
              40
            ],
            "max": [
              7.92,
              7.67,
              44
            ],
            "average": [
              3.99,
              7.14,
              42.4
            ],
            "chart_data": [
              [
                "2016-02-15T07:00:00+0530",
                3.5,
                4.94,
                42
              ],
              [
                "2016-02-15T08:00:00+0530",
                7.92,
                7.32,
                41
              ]
            ]
          }
        },
        "legends": [
          "% Processor Time",
          "IO Data Operations/sec",
          "Thread Count"
        ],
        "units": [
          "%",
          "sec",
          ""
        ],
        "avgdata": {
          "processorTimeAvg": 0.357,
          "ioDataAvg": 0.638,
          "threadCountAvg": 3.798
        }
      },
      "privateBytesWorkingSet": {
        "0": {
          "privateBytesWorkingSetgraph": {
            "95_percentile": [
              107,
              143
            ],
            "min": [
              75,
              111
            ],
            "max": [
              120,
              155
            ],
            "average": [
              90.2,
              126
            ],
            "chart_data": [
              [
                "2016-02-15T07:00:00+0530",
                75,
                111
              ],
              [
                "2016-02-15T08:00:00+0530",
                81,
                116
              ]
            ]
          }
        },
        "legends": [
          "Private Bytes",
          "Working Set"
        ],
        "units": [
          "MB"
        ],
        "avgdata": {
          "privateBytesDataAvg": 8,
          "workingSetAvg": 11
        }
      },
      "clrData": {
        "0": {
          "clrDatagraph": {
            "95_percentile": [
              40,
              13,
              0.82
            ],
            "min": [
              32,
              10,
              0.16
            ],
            "max": [
              40,
              13,
              3.78
            ],
            "average": [
              39.3,
              12.2,
              0.76
            ],
            "chart_data": [
              [
                "2016-02-15T07:00:00+0530",
                32,
                10,
                3.78
              ],
              [
                "2016-02-15T08:00:00+0530",
                39,
                12,
                0.32
              ]
            ]
          }
        },
        "legends": [
          "Bytes in Loader Heap",
          "# Bytes in all Heaps",
          "% Time in GC"
        ],
        "units": [
          "MB",
          "MB",
          "%"
        ],
        "avgdata": {
          "loaderHeapBytesAvg": 3,
          "totalHeapBytesAvg": 1,
          "gcTimeAvg": 0.068
        }
      },
      "heapData": {
        "0": {
          "heapDatagraph": {
            "95_percentile": [
              13,
              2,
              11,
              0
            ],
            "min": [
              10,
              1,
              0,
              0
            ],
            "max": [
              15,
              2,
              11,
              0
            ],
            "average": [
              11.7,
              1.42,
              9.75,
              0
            ],
            "chart_data": [
              [
                "2016-02-15T07:00:00+0530",
                15,
                1,
                9,
                0
              ],
              [
                "2016-02-15T08:00:00+0530",
                12,
                1,
                10,
                0
              ]
            ]
          }
        },
        "legends": [
          "Gen 0 heap size",
          "Gen 1 heap size",
          "Gen 2 heap size",
          "Large Object Heap size"
        ],
        "units": [
          "MB"
        ],
        "avgdata": {
          "heap0Avg": 1,
          "heap1Avg": 0,
          "heap2Avg": 0,
          "heapLargeAvg": 0
        }
      }
    },
    "cachedata": {
      "0": {
        "cachedatagraph": {
          "95_percentile": [
            47.82,
            0,
            0,
            0
          ],
          "min": [
            43.25,
            0,
            0,
            0
          ],
          "max": [
            48,
            0,
            0,
            0
          ],
          "average": [
            46.2,
            0,
            0,
            0
          ],
          "chart_data": [
            [
              "2016-02-15T07:00:00+0530",
              43.67,
              0,
              0,
              0
            ],
            [
              "2016-02-15T08:00:00+0530",
              43.25,
              0,
              0,
              0
            ],
            [
              "2016-02-15T18:00:00+0530",
              48,
              0,
              0,
              0
            ]
          ]
        }
      },
      "legends": [
        "Cache % Machine Memory Limit Used",
        "Cache API Hit Ratio",
        "Output Cache Hit Ratio",
        "Cache API Turnover Rate"
      ],
      "units": [
        "%",
        "%",
        "%",
        "sec"
      ],
      "avgdata": {
        "memAvg": 4.133,
        "apiHitAvg": 0,
        "cacheHitAvg": 0,
        "turnOverAvg": 0
      }
    }
  }
}

To fetch details of all the applications in the IIS server.

oauthscope : Site24x7.Reports.Read

Path Parameters

Param	Type	Description
time_window	string	Mandatory Time window for which the applications have to be listed. Time window
resource_type	string	Mandatory Type of resources. Resource type
resource_id	string	Mandatory Selected resource type id. If scope is application then application_id. If scope is instance then instance_id.

Response Attributes

Attribute	Type	Description
sessiondata	json	Session data metrics. JSON Format:{activeSessionsAvg:$activeSessionsAvg, sqlConnectionAvg:$sqlConnectionAvg, stateConnectionAvg:$stateConnectionAvg}
status_message	string	Status message.
networkstatistics	json	Network statistics JSON Format:{95_percentile: $95_percentile, min: $min, max: $max, average: $average, chart_data: $chart_data, legends: $legends, units: $units}
appresponsedata	json	Application response metrics JSON Format:{95_percentile: $95_percentile, min: $min, max: $max, average: $average, chart_data: $chart_data, legends: $legends, units: $units}
apppoolData	json	Application pool metrics. JSON Format:{95_percentile: $95_percentile, min: $min, max: $max, average: $average, chart_data: $chart_data, legends: $legends, units: $units}
privateBytesWorkingSet	json	Private Bytes set Metrics. JSON Format:{95_percentile: $95_percentile, min: $min, max: $max, average: $average, chart_data: $chart_data, legends: $legends, units: $units}
clrData	json	Clrdata Metrics. JSON Format:{95_percentile: $95_percentile, min: $min, max: $max, average: $average, chart_data: $chart_data, legends: $legends, units: $units}
heapData	json	Heap data metrics JSON Format:{95_percentile: $95_percentile, min: $min, max: $max, average: $average, chart_data: $chart_data, legends: $legends, units: $units}
cachedata	json	Cached data metrics JSON Format:{95_percentile: $95_percentile, min: $min, max: $max, average: $average, chart_data: $chart_data, legends: $legends, units: $units}

JSON Format

Attribute	Type	Description
activeSessionsAvg	int	Average No of active (in-proc) sessions.
sqlConnectionAvg	int	Average number of (out-of-proc) sessions, that uses SQL Server for storing sessions.
stateConnectionAvg	int	Average number of (out-of-proc) sessions, that uses ASP.NET State Service for storing sessions.
95_percentile	IntegervArray	95th percentile value.
chart_data	String Array	Data for plotting chart.
legends	String Array	Legends for graph.
units	String Array	Units.

APM Insight Agent Configurations

Create agent configuration profile

POST /apminsight/agent_config_profile

Request Example

$ curl https://www.site24x7.com/api/apminsight/agent_config_profile
 \
    -X POST \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"
    -d '{
        "profile_name": "Configuration Profile - Java",
        "agent_type": "JAVA",
        "is_default": false,
        "agent_config": {
          "transaction.trace.enabled": true,
          "transaction.trace.sql.parametrize": true,
          "autoupgrade.enabled": false,
          "transaction.trace.sql.stacktrace.threshold": 3,
          "transaction.tracking.request.interval": 1,
          "transaction.trace.threshold": 2,
          "sql.capture.enabled": true,
          "show.instance.port.number": true,
          "apdex.threshold": 0.5,
       }
       }'

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "agent_type": "JAVA",
    "agent_config": {
      "transaction.trace.enabled": true,
      "transaction.trace.sql.parametrize": true,
      "autoupgrade.enabled": false,
      "transaction.trace.sql.stacktrace.threshold": 3,
      "transaction.tracking.request.interval": 1,
      "last.modified.time": "1563790347139",
      "transaction.trace.threshold": 2,
      "sql.capture.enabled": true,
      "show.instance.port.number": true,
      "apdex.threshold": 0.5
    },
    "profile_name": "Configuration Profile - Java",
    "profile_id": "1000000009001",
    "is_default": false
  }
}

To create an agent configuration profile.

oauthscope : Site24x7.Admin.Create

Request Parameters

Param	Type	Description
profile_name	string	Mandatory Name to be associated with the profile.
is_default	boolean	Mandatory True if this profile has to be the default configuration for the agent type
agent_type	string	Mandatory Type of the APM Insight agent
transaction.trace.enabled	boolean	Mandatory True if traces for transactions are required.
transaction.trace.sql.parametrize	boolean	Mandatory True if SQL obfuscation is required.
autoupgrade.enabled	boolean	Mandatory True if agent auto upgrading is required.
transaction.trace.sql.stacktrace.threshold	int	Mandatory Slow SQL query threshold.
transaction.tracking.request.interval	int	Mandatory Web transaction’s sampling factor.
last.modified.time	long	Mandatory Last updated time of the profile in millis.
transaction.trace.threshold	int	Mandatory Tracing threshold.
sql.capture.enabled	boolean	Mandatory True if SQL capturing is required.
show.instance.port.number	boolean	Mandatory True if displaying instance port number is required.
apdex.threshold	int	Mandatory Apdex Threshold.

Response Attributes

Attribute	Type	Description
transaction.trace.enabled	boolean	Returns true if tracing is enabled.
transaction.trace.sql.parametrize	boolean	Returns true if SQL obfuscation is enabled.
autoupgrade.enabled	boolean	Returns true if agent auto upgrading is enabled.
transaction.trace.sql.stacktrace.threshold	int	Slow SQL query threshold.
transaction.tracking.request.interval	int	Web transaction’s sampling factor.
last.modified.time	long	Last updated time of the profile in millis.
transaction.trace.threshold	int	Tracing threshold.
sql.capture.enabled	boolean	Returns true if SQL capturing is enabled.
show.instance.port.number	boolean	Returns true if displaying instance port number is enabled.
apdex.threshold	int	Apdex Threshold.
profile_name	string	Name associated with the profile.
profile_id	int	Id associated with the profile.
is_default	boolean	True if this profile is the default configuration for the agent type.
agent_type	string	Type of the APM Insight agent.

Update agent configuration profile

PUT /apminsight/agent_config_profile/{profile_id}

Request Example

$ curl https://www.site24x7.com/api/apminsight/agent_config_profile/1000000009001
 \
    -X PUT \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"
    -d '{
        "profile_name": "Java profile",
        "agent_type": "JAVA",
        "is_default": false,
        "agent_config": {
          "transaction.trace.enabled": true,
          "transaction.trace.sql.parametrize": true,
          "autoupgrade.enabled": false,
          "transaction.trace.sql.stacktrace.threshold": 3,
          "transaction.tracking.request.interval": 1,
          "transaction.trace.threshold": 2,
          "sql.capture.enabled": true,
          "show.instance.port.number": true,
          "apdex.threshold": 0.5,
       }
       }'

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "agent_type": "JAVA",
    "agent_config": {
      "transaction.trace.enabled": true,
      "transaction.trace.sql.parametrize": true,
      "autoupgrade.enabled": false,
      "transaction.trace.sql.stacktrace.threshold": 3,
      "transaction.tracking.request.interval": 1,
      "last.modified.time": "1563790347139",
      "transaction.trace.threshold": 2,
      "sql.capture.enabled": true,
      "show.instance.port.number": true,
      "apdex.threshold": 0.5
    },
    "profile_name": "Java profile",
    "profile_id": "1000000009001",
    "is_default": false
  }
}

To update an existing agent configuration profile whose profile id is passed as argument.

oauthscope : Site24x7.Admin.Update

Request Parameters

Param	Type	Description
profile_name	string	Name to be associated with the profile.
is_default	boolean	True if this profile has to be the default configuration for the agent type.
agent_type	string	Type of the APM Insight agent.
transaction.trace.enabled	boolean	Mandatory True if traces for transactions are required.
transaction.trace.sql.parametrize	boolean	Mandatory True if SQL obfuscation is required.
autoupgrade.enabled	boolean	Mandatory True if agent auto upgrading is required.
transaction.trace.sql.stacktrace.threshold	int	Mandatory Slow SQL query threshold.
transaction.tracking.request.interval	int	Mandatory Web transaction’s sampling factor.
last.modified.time	long	Mandatory Last updated time of the profile in millis.
transaction.trace.threshold	int	Mandatory Tracing threshold.
sql.capture.enabled	boolean	Mandatory True if SQL capturing is required.
show.instance.port.number	boolean	Mandatory True if displaying instance port number is required.
apdex.threshold	int	Apdex Threshold.

Response Attributes

Attribute	Type	Description
transaction.trace.enabled	boolean	Returns true if tracing is enabled.
transaction.trace.sql.parametrize	boolean	Returns true if SQL obfuscation is enabled.
autoupgrade.enabled	boolean	Returns true if agent auto upgrading is enabled.
transaction.trace.sql.stacktrace.threshold	int	Slow SQL query threshold.
transaction.tracking.request.interval	int	Web transaction’s sampling factor.
last.modified.time	long	Last updated time of the profile in millis.
transaction.trace.threshold	int	Tracing threshold.
sql.capture.enabled	boolean	Returns true if SQL capturing is enabled.
show.instance.port.number	boolean	Returns true if displaying instance port number is enabled.
apdex.threshold	int	Apdex Threshold.
profile_name	string	Name associated with the profile.
profile_id	int	Id associated with the profile.
is_default	boolean	True if this profile is the default configuration for the agent type.
agent_type	string	Type of the APM Insight agent.

Get default agent configuration profile

GET /apminsight/default_agent_config_profile/{agent_type}

Request Example

$ curl https://www.site24x7.com/api/apminsight/default_agent_config_profile/JAVA
 \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "agent_type": "JAVA",
    "agent_config": {
      "transaction.trace.enabled": true,
      "transaction.trace.sql.parametrize": true,
      "autoupgrade.enabled": false,
      "transaction.trace.sql.stacktrace.threshold": 3,
      "transaction.tracking.request.interval": 5,
      "last.modified.time": "1563790588827",
      "transaction.trace.threshold": 2,
      "sql.capture.enabled": true,
      "show.instance.port.number": true,
      "apdex.threshold": 0.5
    },
    "profile_name": "Default profile-JAVA",
    "profile_id": "1000000009003",
    "is_default": true
  }
}

To fetch the default configuration profile for the agent whose agent type is passed as argument.

oauthscope : Site24x7.Admin.Read

Path Parameters

Param	Type	Description
agent_type	string	Mandatory Type of the APM Insight agent.

Response Attributes

Attribute	Type	Description
transaction.trace.enabled	boolean	Returns true if tracing is enabled.
transaction.trace.sql.parametrize	boolean	Returns true if SQL obfuscation is enabled.
autoupgrade.enabled	boolean	Returns true if agent auto upgrading is enabled.
transaction.trace.sql.stacktrace.threshold	int	Slow SQL query threshold.
transaction.tracking.request.interval	int	Web transaction’s sampling factor.
last.modified.time	long	Last updated time of the profile in millis.
transaction.trace.threshold	int	Tracing threshold.
sql.capture.enabled	boolean	Returns true if SQL capturing is enabled.
show.instance.port.number	boolean	Returns true if displaying instance port number is enabled.
apdex.threshold	int	Apdex Threshold.
profile_id	int	Id associated with the profile.
is_default	boolean	True if this profile is the default configuration for the agent type.
agent_type	string	Type of the APM Insight agent.

Get all APM agent configuration profiles

GET /apminsight/agent_config_profiles

Request Example

$ curl https://www.site24x7.com/api/apminsight/agent_config_profiles
 \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response

{
    "code": 0,
    "message": "success",
    "data": [
      {
          "agent_type": "JAVA",
          "agent_config": {
            "transaction.trace.enabled": true,
            "transaction.trace.sql.parametrize": true,
            "autoupgrade.enabled": false,
            "transaction.trace.sql.stacktrace.threshold": 3,
            "transaction.tracking.request.interval": 1,
            "last.modified.time": "1563788274258",
            "transaction.trace.threshold": 2,
            "sql.capture.enabled": true,
            "show.instance.port.number": true,
            "apdex.threshold": 0.5
          },
          "profile_name": "Default profile-JAVA",
          "profile_id": "1000000004001",
          "is_default": true
      },
      {..},
      {..},
      {..}
  ]
}

To fetch all configuration profiles of all APM Insight agents.

oauthscope : Site24x7.Admin.Read

Response Attributes

Attribute	Type	Description
transaction.trace.enabled	boolean	Returns true if tracing is enabled.
transaction.trace.sql.parametrize	boolean	Returns true if SQL obfuscation is enabled.
autoupgrade.enabled	boolean	Returns true if agent auto upgrading is enabled.
transaction.trace.sql.stacktrace.threshold	int	Slow SQL query threshold.
transaction.tracking.request.interval	int	Web transaction’s sampling factor.
last.modified.time	long	Last updated time of the profile in millis.
transaction.trace.threshold	int	Tracing threshold.
sql.capture.enabled	boolean	Returns true if SQL capturing is enabled.
show.instance.port.number	boolean	Returns true if displaying instance port number is enabled.
apdex.threshold	int	Apdex Threshold.
profile_id	int	Id associated with the profile.
is_default	boolean	True if this profile is the default configuration for the agent type.
agent_type	string	Type of the APM Insight agent.

Get all APM agent configuration profiles for agent type

GET /apminsight/agent_config_profiles/{agent_type}

Request Example

$ curl https://www.site24x7.com/api/apminsight/agent_config_profiles/JAVA
 \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response

{
    "code": 0,
    "message": "success",
    "data": [
      {
          "agent_type": "JAVA",
          "agent_config": {
            "transaction.trace.enabled": true,
            "transaction.trace.sql.parametrize": true,
            "autoupgrade.enabled": false,
            "transaction.trace.sql.stacktrace.threshold": 3,
            "transaction.tracking.request.interval": 1,
            "last.modified.time": "1563788274258",
            "transaction.trace.threshold": 2,
            "sql.capture.enabled": true,
            "show.instance.port.number": true,
            "apdex.threshold": 0.5
          },
          "profile_name": "Default profile-JAVA",
          "profile_id": "1000000004001",
          "is_default": true
      },
      {..},
      {..},
      {..}
  ]
}

To fetch all configuration profiles whose agent type is passed as argument.

oauthscope : Site24x7.Admin.Read

Path Parameters

Param	Type	Description
agent_type	string	Mandatory Type of the APM Insight agent.

Response Attributes

Attribute	Type	Description
transaction.trace.enabled	boolean	Returns true if tracing is enabled.
transaction.trace.sql.parametrize	boolean	Returns true if SQL obfuscation is enabled.
autoupgrade.enabled	boolean	Returns true if agent auto upgrading is enabled.
transaction.trace.sql.stacktrace.threshold	int	Slow SQL query threshold.
transaction.tracking.request.interval	int	Web transaction’s sampling factor.
last.modified.time	long	Last updated time of the profile in millis.
transaction.trace.threshold	int	Tracing threshold.
sql.capture.enabled	boolean	Returns true if SQL capturing is enabled.
show.instance.port.number	boolean	Returns true if displaying instance port number is enabled.
apdex.threshold	int	Apdex Threshold.
profile_id	int	Id associated with the profile.
is_default	boolean	True if this profile is the default configuration for the agent type.
agent_type	string	Type of the APM Insight agent.

Delete configuration profile

DELETE /apminsight/agent_config_profile/{profile_id}

Request Example

$ curl https://www.site24x7.com/api/apminsight/agent_config_profile/1000000009001
 \
    -X DELETE \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "name": "Configuration Profile - Java",
    "id": "1000000009001"
  }
}

To delete the agent configuration profile whose profile id is passed as argument.

oauthscope : Site24x7.Admin.Delete

Path Parameters

Param	Type	Description
profile_id	int	Mandatory Profile id associated with the configuration profile

Response Attributes

Attribute	Type	Description
name	string	Name of the deleted configuration profile
id	int	Profile id of the deleted configuration profile

RUM Applications

APIs to get details of all Real User Monitoring (RUM) applications.

List all RUM applications

GET /rum/web/view/userapps/{time_window}

Request Example

$ curl https://www.site24x7.com/api/rum/web/view/userapps/H \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "app_list": [
      {
        "uniq_users": "134",
        "app_info": {
              "apdex_threshold": "2000",
              "application_name": "rumApplication",
              "beacon_type": "0",
              "locations": "",
              "state": "0",
              "type": "web",
              "application_key": "a21c2s7fd2h5671ceb4ddda2b26dcb3s",
              "application_id": "1000000013001",
              "rum_config": "{"resources_config":[{"sub_type":"first","name":"firstPartyResources","domains":["www.site24x7.com","localhost:8080"],"type":"domain"}],"cx_ajax_enabled":false,"excluded_domains":["google.com","site24x7.com"],"ajax_enabled":true,"excluded_useragents":["Mozilla\/5.0 (Linux; Android 7.0; SM-G892A Build\/NRD90M; wv) ,AppleWebKit\/537.36 (KHTML, like Gecko) Version\/4.0 ,Chrome\/60.0.3112.107 Mobile Safari\/537.36"]}",
              "license_key": "ab_a2a5aa6ss501939c63c5219ssse3e7b5"
            },
        "app_data": {
          "error_count": "268",
          "frustrated_users": "0",
          "total_count": "134",
          "page_rendering_time": 13693,
          "first_byte_time": 6203,
          "document_rendering_time": 134,
          "frontend_time": 26322,
          "redirection_time": 9770,
          "document_processing_time": 6737,
          "document_download_time": 5892,
          "tolerated_users": "62",
          "satisfied_users": "72",
          "dns_time": 12937,
          "backend_time": 6505,
          "network_time": 26145,
          "total_response_time": 58972,
          "connection_time": 3438
        },
        "last_archieved_time": "1461221024892",
        "new_users": "0"
        "returning_users": "1"
        "sessions_count": "1"
      }
    ],
    "last_archieved_time": "1548137880088",
    "pageviews_limit": "5000000",
    "page_views": "4936",
    "rumsites_limit": "5"
  }
}

API to list all the RUM applications being monitored. ‘Time window’ is a mandatory field. You can get the list of all applications in the last 1 hour, last 3 hour, last 1 day and so on.

oauthscope : Site24x7.Reports.Read

Path Parameters

Param	Type	Description
time_window	string	Mandatory Time window for which the applications have to be listed. Time window

Response Attributes

Attribute	Type	Description
app_list	json Array	List of RUM Applications.
uniq_users	int	Distinct individuals visiting per month.
app_info	json	Application Information. JSON Format: {apdex_threshold: “$apdex_threshold”, application_name: “$application_name”, application_key: “$application_key”, state: “$state”, application_id: “$application_id”, license_key: “$license_key”, type:“$type”}
app_data	json	Application metrics. JSON Format: {error_count: “$error_count”, frustrated_users:“$frustrated_users”, total_count:“$total_count”, page_rendering_time: $page_rendering_time, first_byte_time: $first_byte_time, document_rendering_time: $document_rendering_time, frontend_time: $frontend_time, redirection_time: $redirection_time, document_processing_time: $document_processing_time, document_download_time: $document_download_time, tolerated_users: “$tolerated_users”, satisfied_users: “$satisfied_users”, dns_time: $dns_time, backend_time: backend_time, network_time: $network_time, total_response_time: $total_response_time, connection_time: $connection_time}
last_archieved_time	string	Most recent data collection time.
new_users	string	New users for the application.
returning_users	string	Returning users for the application.
sessions_count	string	Total sessions for the application.
pageviews_limit	string	Total number of page views per license.
page_views	string	Total number of page views consumed.
rumsites_limit	string	Maximum number of RUM applications permitted in user’s subscription.

JSON Format

Attribute	Type	Description
apdex_threshold	string	Apdex score. For details visit Apdex.
application_name	string	Application name.
application_key	string	Application key.
state	string	Active/Suspended status.
application_id	string	Application id.
license_key	string	License key of APM.
type	string	Type of application(web/android/ios)
error_count	string	Total number of JavaScript errors.
frustrated_users	string	Frustrated users.
total_count	string	Number of times users have visited the page.
page_rendering_time	int	Page rendering time of application.
first_byte_time	int	First byte time of application.
document_rendering_time	int	Document rendering time of application.
frontend_time	int	Front end time of application.
redirection_time	int	Redirection time of application.
document_processing_time	int	Document processing time of application.
document_download_time	int	Document loading time of application.
tolerated_users	string	Tolerating users.
satisfied_users	string	Satisfied users.
dns_time	int	Domain Name Server(DNS) time of application.
backend_time	int	Back End time of application.
network_time	int	Network time of application
total_response_time	int	Total Response time of application.
connection_time	int	Connection time of application.

Single RUM application details

GET /rum/web/view/{application_id}/{time_window}

Request Example

$ curl https://www.site24x7.com/api/rum/web/view/1000000005003/H \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "ajax_page_views": "1706"
    "uniq_users": "47",
    "app_info": {
      "apdex_threshold": "450",
      "application_name": "rum-sim",
      "application_key": "653ddf79144744612a2c80f44e04ca8b",
      "state": "0",
      "application_id": "1000000005003",
      "license_key": "621fa3538e196c7d0113db74af2a253e22a33bd9",
      "type": "web"
    },
    "app_data": {
      "error_count": "94",
      "frustrated_users": "0",
      "total_count": "47",
      "page_rendering_time": 4487,
      "first_byte_time": 2014,
      "document_rendering_time": 47,
      "frontend_time": 8623,
      "redirection_time": 3762,
      "document_processing_time": 1960,
      "document_download_time": 2176,
      "tolerated_users": "17",
      "satisfied_users": "30",
      "dns_time": 4354,
      "backend_time": 2356,
      "network_time": 9317,
      "total_response_time": 20296,
      "connection_time": 1201,
      "min_rt":100,
      "max_rt":5240
    },
    "last_archieved_time": "1461217776876",
    "page_views": "1062336",
    "page_views_limit": "20000000"
  }
}

API to get the details of a particular RUM application. The ‘time window’ and ‘application id’ are mandatory fields. Application-id is required to identify the particular application and time window is to know the exact time period for which the details are sought for.

oauthscope : Site24x7.Reports.Read

Path Parameters

Param	Type	Description
time_window	string	Mandatory Time window for which the applications have to be listed. Time window
application_id	string	Mandatory Application id of RUM application.

Response Attributes

Attribute	Type	Description
ajax_page_views	string	Ajax pageviews of the application.
uniq_users	int	Distinct individuals visiting per month.
app_info	json	Application Information. JSON Format: {apdex_threshold: “$apdex_threshold”, application_name: “$application_name”, application_key: “$application_key”, state: “$state”, application_id: “$application_id”, license_key: “$license_key”, type: “$type”}
app_data	json	Application metrics. JSON Format: {error_count: “$error_count”, frustrated_users: “$frustrated_users”, total_count: “$total_count”, page_rendering_time: $page_rendering_time, first_byte_time: $first_byte_time, document_rendering_time: $document_rendering_time, frontend_time: $frontend_time, redirection_time: $redirection_time, document_processing_time: document_processing_time, document_download_time: $document_download_time, tolerated_users: “$tolerated_users”, satisfied_users: “$satisfied_users”, dns_time: $dns_time, backend_time: $backend_time, network_time:$network_time, total_response_time: $total_response_time ,connection_time: $connection_time,min_rt: $min_rt,max_rt:$max_rt}
last_archieved_time	string	Most recent data collection time.
page_views	string	Pageviews of the application.
page_views_limit	string	licensed pageviews of the user.

JSON Format

Attribute	Type	Description
apdex_threshold	int	Apdex score. For details visit Apdex.
application_name	string	Application name.
application_key	string	Application key.
state	string	Active/Suspended status.
application_id	string	Application id.
license_key	string	License key of APM.
type	string	Type of application(web/android/ios)
error_count	string	Total number of JavaScript errors.
frustrated_users	string	Frustrated users.
total_count	string	Number of times users have visited the page.
page_rendering_time	int	Page rendering time of application.
first_byte_time	int	First byte time of application.
document_rendering_time	int	Document rendering time of application.
frontend_time	int	Front end time of application.
redirection_time	int	Redirection time of application.
document_processing_time	int	Document processing time of application.
document_download_time	int	Document loading time of application.
tolerated_users	string	Tolerating users.
satisfied_users	string	Satisfied users.
dns_time	int	Domain Name Server(DNS) time of application.
backend_time	int	Back End time of application.
network_time	int	Network time of application
total_response_time	int	Total Response time of application.
connection_time	int	Connection time of application.
min_rt	int	Minimum response time of application.
max_rt	int	Maximum response time of application.

RUM Application Metrics

Gather in-depth performance related metrics of all applications that are monitored by RUM.

Geographic details of RUM application

GET /rum/web/view/{application_id}/geographic/{attribute}/{limit}/{time_window}

Request Example

$ curl https://www.site24x7.com/api/rum/web/view/1000000005003/geographic/apdex/3/H \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "map_data": {
      "data": [
        {
          "link": "j-changeMap-EU",
          "id": "142",
          "tooltext": "<span id='rum-loc-tooltip' style='font-size:12px;font-weight: bold;margin-bottom:200px!important'>Germany</span>{br}<hr class='mrgtop5 mrgbot5'><span style='font-weight: bold;'>Apdex :</span> 0.86{br}<span style='font-weight: bold;'>Avg.Resp.Time :</span> 4362 ms{br}<span style='font-weight: bold;'>Pageviews : </span>100{br}<span style='font-weight: bold;'>Throughput : </span>1.69 cpm{br}<span style='font-weight: bold;'>Errors : </span>115",
          "value": 0.98
        },
        {
          "id": "120",
          "tooltext": "<span id='rum-loc-tooltip' style='font-size:12px;font-weight: bold;margin-bottom:200px!important'>Sri Lanka</span>{br}<hr class='mrgtop5 mrgbot5'><span style='font-weight: bold;'>Apdex :</span> 0.67{br}<span style='font-weight: bold;'>Avg.Resp.Time :</span> 4824 ms{br}<span style='font-weight: bold;'>Pageviews : </span>3{br}<span style='font-weight: bold;'>Throughput : </span>0.05 cpm{br}<span style='font-weight: bold;'>Errors : </span>0",
          "value": 0.83
        },
        {..}
      ]
    },
    "app_info": {
      "apdex_threshold": "5000",
      "application_name": "BookingApp",
      "application_id": "15698000010568013",
      "application_key": "61cc526aa43df99a460d1e7bce9e635d",
      "state": "0",
      "type": "web",
      "license_key": "edd30a0099ba623763b7893aafb88c7f"
    },
    "rt_list": [
      {
        "apdex": 0.5,
        "total_count": 1,
        "name": "Kenya\t",
        "average_response_time": 17538,
        "throughput": 0.02,
        "total_response_time": 17538
      },
      {..}
    ]
  }
}

API to fetch the geographic location details of the RUM application whose application-id is passed as request parameter. Time window and limit of the number of locations are also mandatory parameters.

oauthscope : Site24x7.Reports.Read

Path Parameters

Param	Type	Description
time_window	string	Mandatory Time window for which the applications have to be listed. Time window
application_id	string	Mandatory Application id of RUM application.
attribute	string	Mandatory Attribute to be plotted in Map.
limit	string	Number of locations requested. Could be from 0 to 99. 0 gives all locations.

Response Attributes

Attribute	Type	Description
map_data	json	Map Data. JSON Format: {data: $data}
app_info	json	Application Information. JSON Format: apdex_threshold: “$apdex_threshold”, application_name: “$application_name”, application_id: “$application_id”, application_key: “$application_key”, state:“$state”, type:“$type”, license_key: “$license_key” }
rt_list	json Array	Response time data of locations.

JSON Format

Attribute	Type	Description
data	Integer Array	Geographic data
apdex_threshold	string	Threshold value set for apdex.
application_name	string	Application name.
application_id	string	Application id.
application_key	string	Application key.
state	string	Active/Suspended status.
license_key	string	License key of APM.

Transaction details of RUM application

GET /rum/web/view/{application_id}/wt/list/avgRT/{time_window}

Request Example

$ curl https://www.site24x7.com/api/rum/web/view/1000000005003/wt/list/avgRT/H \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "wt_list": [
      {
        "total_count": 34,
        "name": "home/Welcome.do",
        "total_response_time": 15415,
        "throughput": 0.58,
        "average_response_time": 453.38
      },
      {
        "total_count": 34,
        "name": "app/apm",
        "total_response_time": 14945,
        "throughput": 0.58,
        "average_response_time": 439.56
      },
      {..}
    ]
  }
}

API to fetch the web transaction details of a particular application whose application-id is passed as request parameter.

oauthscope : Site24x7.Reports.Read

Path Parameters

Param	Type	Description
time_window	string	Mandatory Time window for which the applications have to be listed. Time window
application_id	string	Mandatory Application id of RUM application.

Response Attributes

Attribute	Type	Description
total_count	int	Total No. of Transactions
name	string	Transaction Name.
total_response_time	long	Total response time of the web transaction.
throughput	int	Throughput of the transaction.
average_response_time	long	Average response time of the web transaction.

Browser details of RUM application

GET /rum/web/view/{application_id}/browser/{time_window}

Request Example

$ curl https://www.site24x7.com/api/rum/web/view/1000000005003/browser/H \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "browsers_list": [
      {
        "total_count": "24",
        "name": "FireFox",
        "total_response_time": 11273,
        "throughput": 0.41,
        "average_response_time": 469.71,
        "version": "All"
      },
      {
        "total_count": "17",
        "name": "MSIE",
        "total_response_time": 7737,
        "throughput": 0.29,
        "average_response_time": 455.12,
        "version": "All"
      },
      {..}
    ],
    "app_info": {
      "apdex_threshold": "2000",
      "application_name": "rumApplication",
      "beacon_type": "0",
      "locations": "",
      "state": "0",
      "type": "web",
      "application_key": "a21c2s7fd2h5671ceb4ddda2b26dcb3s",
      "application_id": "1000000013001",
      "rum_config": "{"resources_config":[{"sub_type":"first","name":"firstPartyResources","domains":["www.site24x7.com","localhost:8080"],"type":"domain"}],"cx_ajax_enabled":false,"excluded_domains":["google.com","site24x7.com"],"ajax_enabled":true,"excluded_useragents":["Mozilla\/5.0 (Linux; Android 7.0; SM-G892A Build\/NRD90M; wv) AppleWebKit\/537.36 (KHTML, like Gecko) Version\/4.0 Chrome\/60.0.3112.107 Mobile Safari\/537.36"]}",
      "license_key": "ab_a2a5aa680501939c63c52s94e1essss5"
    },
    "count_graph": {
      "0": {
        "collectioncountgraph": {
          "average": [
            16.2,
            3.22,
            0.37,
            0.72,
            0.15
          ],
          "chart_data": [
            [
              "2019-01-23T16:54:37+0530",
              "",
              "",
              "",
              "",
              ""
            ],
            [
              "2019-01-23T16:55:37+0530",
              13,
              3,
              "",
              "",
              ""
            ],
            [
              "2019-01-23T16:56:37+0530",
              16,
              6,
              "",
              "",
              ""
            ],
            [
              "2019-01-23T16:57:37+0530",
              17,
              6,
              "",
              "",
              ""
            ],
            [
              "2019-01-23T16:58:37+0530",
              20,
              1,
              "",
              4,
              ""
            ],
            [...]
          ],
          "min": [
            6,
            0,
            0,
            0,
            0
          ],
          "max": [
            26,
            8,
            4,
            4,
            2
          ],
          "percentile_95": [
            24,
            6,
            2,
            3,
            1
          ]
        }
      },
      "legends": [
        "Chrome",
        "Firefox",
        "Opera",
        "Edge",
        "Others"
      ],
      "keys": [
        "Chrome",
        "Firefox",
        "Opera",
        "Edge",
        "Others"
      ],
      "units": [
        ""
      ]
    },
    "rt_graph": {
      "0": {
        "responsetimegraph": {
          "average": [
            6767.22,
            5876.13,
            4058.42,
            2300.98,
            1172.62
          ],
          "chart_data": [
            [
              "2019-01-23T16:54:37+0530",
              "",
              "",
              "",
              "",
              ""
            ],
            [
              "2019-01-23T16:55:37+0530",
              7616,
              11902,
              "",
              "",
              ""
            ],
            [
              "2019-01-23T16:56:37+0530",
              5398,
              2908,
              "",
              "",
              ""
            ],
            [
              "2019-01-23T16:57:37+0530",
              6234,
              7490,
              "",
              "",
              ""
            ],
            [...]
          ],
          "min": [
            2759,
            0,
            0,
            0,
            0
          ],
          "max": [
            19756,
            31922,
            128815,
            15980,
            17716
          ],
          "percentile_95": [
            15459,
            17985,
            8205,
            12257,
            9572
          ]
        }
      },
      "legends": [
        "Chrome",
        "Firefox",
        "Opera",
        "Edge",
        "Others"
      ],
      "keys": [
        "Chrome",
        "Firefox",
        "Opera",
        "Edge",
        "Others"
      ],
      "units": [
        "ms"
      ]
    }
  }
}

API to get the browser details of the particular application whose application-id is passed as request parameter.

oauthscope : Site24x7.Reports.Read

Path Parameters

Param	Type	Description
time_window	string	Mandatory Time window for which the applications have to be listed. Time window
application_id	string	Mandatory Application id of RUM application.

Response Attributes

Attribute	Type	Description
browserslist	json Array	List of browsers and their information.
total_count	int	Total No. of Browsers
name	string	Browser Name.
total_response_time	long	Total response time for the browser.
throughput	int	Throughput for the browser.
average_response_time	long	Average response time for the browser.
app_info	json	Application Information. JSON Format: {apdex_threshold: “$apdex_threshold”, application_name: “$application_name”, application_id: “$application_id”, application_key: “$application_key”, state: “$state”, type: “$type”, license_key: “$license_key” }
rt_graph	json	Browsers resp.time trends graph data. JSON Format:{95_percentile: $95_percentile, min: $min, max: $max, average: $average, chart_data: $chart_data, legends: $legends, units: $units}
count_graph	json	Browsers count trends graph data. JSON Format:{95_percentile: $95_percentile, min: $min, max: $max, average: $average, chart_data: $chart_data, legends: $legends, units: $units}

JSON Format

Attribute	Type	Description
apdex_threshold	int	Apdex score. For details visit Apdex.
application_name	string	Application name.
application_key	string	Application key.
state	string	Active/Suspended status.
application_id	string	Application id.
license_key	string	License key of APM.
type	string	Type of application(web/android/ios).
95_percentile	Integer Array	95th percentile value.
chart_data	String Array	Data for plotting chart.
legends	String Array	Legends for graph.
units	String Array	Units.

Device details of RUM application

GET /rum/web/view/{application_id}/device/{time_window}

Request Example

$ curl https://www.site24x7.com/api/rum/web/view/1000000005003/device/H \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "app_info": {
      "apdex_threshold": "450",
      "application_name": "rum-sim",
      "application_key": "653ddf79144744612a2c80f44e04ca8b",
      "state": "0",
      "application_id": "1000000005003",
      "license_key": "621fa3538e196c7d0113db74af2a253e22a33bd9",
      "type": "web"
    },
   "rt_graph": {
      "0": {
        "responsetimegraph": {
          "average": [
            7397.63,
            0,
            4973.35,
            6311.7,
            4594.4,
            622.75,
            295.27,
            0,
            339.27,
            3495.33,
            0,
            0,
            0
          ],
          "chart_data": [
            [
              "2019-01-23T17:06:18+0530",
              "",
              "",
              "",
              "",
              "",
              "",
              "",
              "",
              "",
              "",
              "",
              "",
              ""
            ],
            [
              "2019-01-23T17:07:18+0530",
              11102,
              "",
              8065,
              17780,
              4895,
              "",
              "",
              "",
              "",
              2843,
              "",
              "",
              ""
            ],
            [
              "2019-01-23T17:08:18+0530",
              24264,
              "",
              2937,
              10997,
              6564,
              "",
              "",
              "",
              "",
              2369,
              "",
              "",
              ""
            ],
            [
              "2019-01-23T17:09:18+0530",
              5500,
              "",
              4847,
              3383,
              2856,
              "",
              "",
              "",
              "",
              "",
              "",
              "",
              ""
            ],
            [...]
          ],
          "min": [
            0,
            0,
            0,
            2741,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0
          ],
          "max": [
            30480,
            0,
            46264,
            24192,
            49620,
            9604,
            17716,
            0,
            10432,
            76745,
            0,
            0,
            0
          ],
          "percentile_95": [
            18928,
            0,
            13172,
            15962,
            8239,
            3338,
            0,
            0,
            2764,
            7128,
            0,
            0,
            0
          ]
        }
      },
      "legends": [
        "Android",
        "Blackberry",
        "Desktop Linux",
        "Desktop Windows",
        "Desktop Mac",
        "Desktop CrOS",
        "Desktop Others",
        "Iemobile",
        "Ipad",
        "iPhone",
        "Ipod",
        "Opera Mini",
        "Symbian"
      ],
      "keys": [
        "Android",
        "Blackberry",
        "Desktop Linux",
        "Desktop Windows",
        "Desktop Mac",
        "Desktop CrOS",
        "Desktop Others",
        "Iemobile",
        "Ipad",
        "iPhone",
        "Ipod",
        "Opera Mini",
        "Symbian"
      ],
      "units": [
        "ms"
      ]
    },
    "count_graph": {
      "0": {
        "collectioncountgraph": {
          "average": [
            2.48,
            0,
            2.22,
            13.92,
            2.22,
            0.18,
            0.02,
            0,
            0.07,
            1.05,
            0,
            0,
            0
          ],
          "chart_data": [
            [
              "2019-01-23T17:06:18+0530",
              "",
              "",
              "",
              "",
              "",
              "",
              "",
              "",
              "",
              "",
              "",
              "",
              ""
            ],
            [
              "2019-01-23T17:07:18+0530",
              5,
              "",
              6,
              9,
              4,
              "",
              "",
              "",
              "",
              2,
              "",
              "",
              ""
            ],
            [
              "2019-01-23T17:08:18+0530",
              3,
              "",
              2,
              14,
              4,
              "",
              "",
              "",
              "",
              3,
              "",
              "",
              ""
            ],
            [
              "2019-01-23T17:09:18+0530",
              2,
              "",
              4,
              19,
              6,
              "",
              "",
              "",
              "",
              "",
              "",
              "",
              ""
            ],
            [...]
          ],
          "min": [
            0,
            0,
            0,
            5,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0
          ],
          "max": [
            8,
            0,
            8,
            23,
            6,
            3,
            1,
            0,
            1,
            3,
            0,
            0,
            0
          ],
          "percentile_95": [
            5,
            0,
            5,
            20,
            5,
            1,
            0,
            0,
            1,
            3,
            0,
            0,
            0
          ]
        }
      },
      "legends": [
        "Android",
        "Blackberry",
        "Desktop Linux",
        "Desktop Windows",
        "Desktop Mac",
        "Desktop CrOS",
        "Desktop Others",
        "Iemobile",
        "Ipad",
        "iPhone",
        "Ipod",
        "Opera Mini",
        "Symbian"
      ],
      "keys": [
        "Android",
        "Blackberry",
        "Desktop Linux",
        "Desktop Windows",
        "Desktop Mac",
        "Desktop CrOS",
        "Desktop Others",
        "Iemobile",
        "Ipad",
        "iPhone",
        "Ipod",
        "Opera Mini",
        "Symbian"
      ],
      "units": [
        ""
      ]
    },
    "devices_list": [
      {
        "total_count": 22,
        "name": "iemobile",
        "total_response_time": 10149,
        "throughput": 0.37,
        "average_response_time": 461.32
      },
      {..}
    ]
  }
}

API to fetch the device details of the particular application whose application-id is passed as request parameter.

oauthscope : Site24x7.Reports.Read

Path Parameters

Param	Type	Description
time_window	string	Mandatory Time window for which the applications have to be listed. Time window
application_id	string	Mandatory Application id of RUM application.

Response Attributes

Attribute	Type	Description
app_info	json	Application Information. JSON Format: {apdex_threshold: “$apdex_threshold”, application_name:“$application_name”, application_id: “$application_id”, application_key: “$application_key”, state:“$state”, license_key: “$license_key”, type: “$type”}
rt_graph	json	Devices resp.time trends graph data. JSON Format:{95_percentile: $95_percentile, min: $min, max: $max, average: $average, chart_data: $chart_data, legends: $legends, units: $units}
count_graph	json	Devices count trends graph data. JSON Format:{95_percentile: $95_percentile, min: $min, max: $max, average: $average, chart_data: $chart_data, legends: $legends, units: $units}
devices_list	json Array	List of devices and their information.
total_count	int	Total No. of Devices
name	string	Browser Name.
total_response_time	long	Total response time for the device.
throughput	int	Throughput for the device.
average_response_time	long	Average response time for the device.

JSON Format

Attribute	Type	Description
apdex_threshold	int	Apdex score. For details visit Apdex.
application_name	string	Application name.
application_key	string	Application key.
state	string	Active/Suspended status.
application_id	string	Application id.
license_key	string	License key of APM.
type	string	Type of application(web/android/ios)
95_percentile	Integer Array	95th percentile value.
chart_data	String Array	Data for plotting chart.
legends	String Array	Legends for graph.
units	String Array	Units.

RUM Application - Top 10 report

APIs to fetch the top 10 report data of a specific RUM application.

Top 10 geographic details of RUM application

GET /rum/web/view/{application_id}/geographic/{attribute}/{time_window}

Request Example

$ curl https://www.site24x7.com/api/rum/web/view/1000000005003/geographic/apdex/H \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "map_data": {
      "data": [
        {
          "link": "j-changeMap-EU",
          "id": "142",
          "tooltext": "<span id='rum-loc-tooltip' style='font-size:12px;font-weight: bold;margin-bottom:200px!important'>Germany</span>{br}<hr class='mrgtop5 mrgbot5'><span style='font-weight: bold;'>Apdex :</span> 0.86{br}<span style='font-weight: bold;'>Avg.Resp.Time :</span> 4362 ms{br}<span style='font-weight: bold;'>Pageviews : </span>100{br}<span style='font-weight: bold;'>Throughput : </span>1.69 cpm{br}<span style='font-weight: bold;'>Errors : </span>115",
          "value": 4.36
        },
        {
          "id": "120",
          "tooltext": "<span id='rum-loc-tooltip' style='font-size:12px;font-weight: bold;margin-bottom:200px!important'>Sri Lanka</span>{br}<hr class='mrgtop5 mrgbot5'><span style='font-weight: bold;'>Apdex :</span> 0.67{br}<span style='font-weight: bold;'>Avg.Resp.Time :</span> 4824 ms{br}<span style='font-weight: bold;'>Pageviews : </span>3{br}<span style='font-weight: bold;'>Throughput : </span>0.05 cpm{br}<span style='font-weight: bold;'>Errors : </span>0",
          "value": 4.82
        }
      ]
    },
    "app_info": {
      "apdex_threshold": "2000",
      "application_name": "rumApplication",
      "beacon_type": "0",
      "locations": "",
      "state": "0",
      "type": "web",
      "application_key": "e61c2d7fdb64671ceb4ddda2b26dcb35",
      "application_id": "1000000013001",
      "rum_config": "{\"resources_config\":[{\"sub_type\":\"first\",\"name\":\"firstPartyResources\",\"domains\":[\"www.site24x7.com\",\"localhost:8080\"],\"type\":\"domain\"}],\"cx_ajax_enabled\":false,\"excluded_domains\":[\"google.com\",\"site24x7.com\"],\"ajax_enabled\":true,\"excluded_useragents\":[\"Mozilla\/5.0 (Linux; Android 7.0; SM-G892A Build\/NRD90M; wv) AppleWebKit\/537.36 (KHTML, like Gecko) Version\/4.0 Chrome\/60.0.3112.107 Mobile Safari\/537.36\"]}",
      "license_key": "ab_a2a5aa6ss501939c63c5219ssse3e7b5"
    },
    "rt_list": [
      {
        "code": "IR",
        "average_response_time": 16895.12,
        "total_response_time": 557539,
        "apdex": 0.4696969696969697,
        "total_count": 33,
        "name": "Iran",
        "throughput": 0.56,
        "error_count": 1
      },
      {
        "code": "FI",
        "average_response_time": 2100.26,
        "total_response_time": 39905,
        "apdex": 0.9736842105263158,
        "total_count": 19,
        "name": "Finland",
        "throughput": 0.32,
        "error_count": 1
      }
    ]
  }
}

API to get the geographic details of a particular RUM application across the world, whose application-id is passed as request parameter. Only Top 10 locations with highest average response time are fetched.

oauthscope : Site24x7.Reports.Read

Path Parameters

Param	Type	Description
time_window	string	Mandatory Time window for which the applications have to be listed. Time window
application_id	string	Mandatory Application id of RUM application.
attribute	string	Mandatory Attribute to be plotted in Map.

Response Attributes

Attribute	Type	Description
app_info	json	Application Information. JSON Format: {apdex_threshold: “$apdex_threshold”, application_name: “$application_name”, beacon_type : “$beacon_type”, application_key: “$application_key”, state: “$state”, application_id: “$application_id”, license_key: “$license_key”, type: “$type”,rum_config:“$rum_config”}
map_data	json	Map Data. JSON Format: {data:$data}
rt_list	Array	Response time data of locations.

JSON Format

Attribute	Type	Description
data	Array	Geographic data
apdex_threshold	int	Apdex score. For details visit Apdex.
application_name	string	Application name.
application_key	string	Application key.
state	string	Active/Suspended status.
application_id	string	Application id.
license_key	string	License key of APM.
type	string	Type of application(web/android/ios)
rum_config	string	Data collection configuration for the application
beacon_type	string	0 for traditional and 1 for single page application.

Top 10 geographic details of RUM application in US

GET /rum/web/view/{application_id}/geographic/{attribute}/US/{time_window}

Request Example

$ curl https://www.site24x7.com/api/rum/web/view/1000000005003/geographic/apdex/US/H \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "map_data": {
      "data": [
        {
          "id": "mi",
          "tooltext": "<span id='rum-loc-tooltip' style='font-size:12px;font-weight: bold;margin-bottom:200px!important'>Michigan</span>{br}<hr class='mrgtop5 mrgbot5'><span style='font-weight: bold;'>Apdex :</span> 1.0{br}<span style='font-weight: bold;'>Avg.Resp.Time :</span> 2974 ms{br}<span style='font-weight: bold;'>Pageviews : </span>6{br}<span style='font-weight: bold;'>Throughput : </span>0.1 cpm{br}<span style='font-weight: bold;'>Errors : </span>0",
          "value": 2.97
        },
        {
          "id": "sd",
          "tooltext": "<span id='rum-loc-tooltip' style='font-size:12px;font-weight: bold;margin-bottom:200px!important'>South Dakota</span>{br}<hr class='mrgtop5 mrgbot5'><span style='font-weight: bold;'>Apdex :</span> 0.0{br}<span style='font-weight: bold;'>Avg.Resp.Time :</span> 0 ms{br}<span style='font-weight: bold;'>Pageviews : </span>0{br}<span style='font-weight: bold;'>Throughput : </span>0.0 cpm{br}<span style='font-weight: bold;'>Errors : </span>2",
          "value": 0
        }
      ]
    },
    "app_info": {
      "apdex_threshold": "2000",
      "application_name": "rumApplication",
      "beacon_type": "0",
      "locations": "",
      "state": "0",
      "type": "web",
      "application_key": "e61c2d7fdb64671ceb4ddda2b26dcb35",
      "application_id": "1000000013001",
      "rum_config": "{\"resources_config\":[{\"sub_type\":\"first\",\"name\":\"firstPartyResources\",\"domains\":[\"www.site24x7.com\",\"localhost:8080\"],\"type\":\"domain\"}],\"cx_ajax_enabled\":false,\"excluded_domains\":[\"google.com\",\"site24x7.com\"],\"ajax_enabled\":true,\"excluded_useragents\":[\"Mozilla\/5.0 (Linux; Android 7.0; SM-G892A Build\/NRD90M; wv) AppleWebKit\/537.36 (KHTML, like Gecko) Version\/4.0 Chrome\/60.0.3112.107 Mobile Safari\/537.36\"]}",
      "license_key": "ab_a2a5aa6ss501939c63c5219ssse3e7b5"
    },
    "rt_list": [
      {
        "code": "va",
        "average_response_time": 21702.5,
        "total_response_time": 43405,
        "apdex": 0.25,
        "total_count": 2,
        "name": "Virginia",
        "throughput": 0.03,
        "error_count": 1
      },
      {
        "code": "pa",
        "average_response_time": 1816,
        "total_response_time": 7264,
        "apdex": 1,
        "total_count": 4,
        "name": "Pennsylvania",
        "throughput": 0.07,
        "error_count": 1
      },
      {..}
    ]
  }
}

API to get the geographic details of a particular RUM application across the United States, whose application-id is passed as request parameter. Only Top 10 states with highest average response time are fetched.

oauthscope : Site24x7.Reports.Read

Path Parameters

Param	Type	Description
time_window	string	Mandatory Time window for which the applications have to be listed. Time window
application_id	string	Mandatory Application id of RUM application.
attribute	string	Mandatory Attribute to be plotted in Map.

Response Attributes

Attribute	Type	Description
app_info	json	Application Information. JSON Format: {apdex_threshold: “$apdex_threshold”, application_name: “$application_name”, beacon_type : “$beacon_type”, application_key: “$application_key”, state: “$state”, application_id: “$application_id”, license_key: “$license_key”, type: “$type”,rum_config:“$rum_config”}
map_data	json	Map Data. JSON Format: {data:$data}
rt_list	Array	Response time data of locations.

JSON Format

Attribute	Type	Description
data	Array	Geographic data
apdex_threshold	int	Apdex score. For details visit Apdex.
application_name	string	Application name.
application_key	string	Application key.
state	string	Active/Suspended status.
application_id	string	Application id.
license_key	string	License key of APM.
type	string	Type of application(web/android/ios)
rum_config	string	Data collection configuration for the application
beacon_type	string	0 for traditional and 1 for single page application.

Top 10 Internet Service Provider details of RUM application

GET /rum/web/view/{application_id}/isp/{time_window}

Request Example

$ curl https://www.site24x7.com/api/rum/web/view/15698000010568013/isp/H \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "isps_graph": {
      "0": {
        "spilitupgraph": {
          "average": [
            11600.6
          ],
          "chart_data": [
            [
              "BHARTI AIRTEL LTD.",
              10581.32
            ],
            [
              "MAROC TELECOM",
              6243.67
            ]
          ],
          "min": [
            2114.5
          ],
          "max": [
            80758.67
          ],
          "percentile_95": [
            34776
          ]
        }
      },
      "legends": [
        "Splitup"
      ],
      "keys": [
        "Splitup"
      ],
      "units": [
        ""
      ]
    },
    "app_info": {
      "apdex_threshold": "2000",
      "application_name": "rumApplication",
      "beacon_type": "0",
      "locations": "",
      "state": "0",
      "type": "web",
      "application_key": "e61c2d7fdb64671ceb4ddda2b26dcb35",
      "application_id": "1000000013001",
      "rum_config": "{\"resources_config\":[{\"sub_type\":\"first\",\"name\":\"firstPartyResources\",\"domains\":[\"www.site24x7.com\",\"localhost:8080\"],\"type\":\"domain\"}],\"cx_ajax_enabled\":false,\"excluded_domains\":[\"google.com\",\"site24x7.com\"],\"ajax_enabled\":true,\"excluded_useragents\":[\"Mozilla\/5.0 (Linux; Android 7.0; SM-G892A Build\/NRD90M; wv) AppleWebKit\/537.36 (KHTML, like Gecko) Version\/4.0 Chrome\/60.0.3112.107 Mobile Safari\/537.36\"]}",
      "license_key": "ab_a2a5aa6ss501939c63c5219ssse3e7b5"
    },
    "isps_list": [
      {
        "average_response_time": 10581.32,
        "total_response_time": 529066,
        "total_count": 50,
        "name": "BHARTI AIRTEL LTD.",
        "throughput": 0.85
      },
      {
        "average_response_time": 6243.67,
        "total_response_time": 18731,
        "total_count": 3,
        "name": "MAROC TELECOM",
        "throughput": 0.05
      },
      {..}
    ]
  }
}

API to get the Internet Service Provider details of a particular RUM application, whose application-id is passed as request parameter. Only Top 10 ISPs with highest average response time are fetched.

oauthscope : Site24x7.Reports.Read

Path Parameters

Param	Type	Description
time_window	string	Mandatory Time window for which the applications have to be listed. Time window
application_id	string	Mandatory Application id of RUM application.

Response Attributes

Attribute	Type	Description
app_info	json	Application Information. JSON Format: {apdex_threshold: “$apdex_threshold”, application_name: “$application_name”, beacon_type : “$beacon_type”, application_key: “$application_key”, state: “$state”, application_id: “$application_id”, license_key: “$license_key”, type: “$type”,rum_config:“$rum_config”}
isps_graph	json	ISPs graph data. JSON Format:{95_percentile: $95_percentile, min: $min, max: $max, average: $average, chart_data: $chart_data, legends: $legends, units: $units}
ispslist	Array	List of ISPs and associated metrics.

JSON Format

Attribute	Type	Description
apdex_threshold	int	Apdex score. For details visit Apdex.
application_name	string	Application name.
application_key	string	Application key.
state	string	Active/Suspended status.
application_id	string	Application id.
license_key	string	License key of APM.
type	string	Type of application(web/android/ios)
rum_config	string	Data collection configuration for the application
beacon_type	string	0 for traditional and 1 for single page application.
95_percentile	Integer Array	95th percentile value.
min	Integer Array	minimum value.
max	Integer Array	maximun value.
chart_data	String Array	Data for plotting chart.
legends	String Array	Legends for graph.
units	String Array	Units.

RUM Application - Top N report

APIs to fetch the top ‘n’ report data of a specific RUM application, where the limit ‘n’ is passed as request parameter.

Top N geographic details of RUM application

GET /rum/web/view/{application_id}/geographic/{attribute}/{limit}/{time_window}

Request Example

$ curl https://www.site24x7.com/api/rum/web/view/1000000005003/geographic/apdex/3/H \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "map_data": {
      "data": [
        {
          "link": "j-changeMap-EU",
          "id": "142",
          "tooltext": "<span id='rum-loc-tooltip' style='font-size:12px;font-weight: bold;margin-bottom:200px!important'>Germany</span>{br}<hr class='mrgtop5 mrgbot5'><span style='font-weight: bold;'>Apdex :</span> 0.86{br}<span style='font-weight: bold;'>Avg.Resp.Time :</span> 4362 ms{br}<span style='font-weight: bold;'>Pageviews : </span>100{br}<span style='font-weight: bold;'>Throughput : </span>1.69 cpm{br}<span style='font-weight: bold;'>Errors : </span>115",
          "value": 4.36
        },
        {
          "id": "120",
          "tooltext": "<span id='rum-loc-tooltip' style='font-size:12px;font-weight: bold;margin-bottom:200px!important'>Sri Lanka</span>{br}<hr class='mrgtop5 mrgbot5'><span style='font-weight: bold;'>Apdex :</span> 0.67{br}<span style='font-weight: bold;'>Avg.Resp.Time :</span> 4824 ms{br}<span style='font-weight: bold;'>Pageviews : </span>3{br}<span style='font-weight: bold;'>Throughput : </span>0.05 cpm{br}<span style='font-weight: bold;'>Errors : </span>0",
          "value": 4.82
        }
      ]
    },
    "app_info": {
      "apdex_threshold": "2000",
      "application_name": "rumApplication",
      "beacon_type": "0",
      "locations": "",
      "state": "0",
      "type": "web",
      "application_key": "e61c2d7fdb64671ceb4ddda2b26dcb35",
      "application_id": "1000000013001",
      "rum_config": "{\"resources_config\":[{\"sub_type\":\"first\",\"name\":\"firstPartyResources\",\"domains\":[\"www.site24x7.com\",\"localhost:8080\"],\"type\":\"domain\"}],\"cx_ajax_enabled\":false,\"excluded_domains\":[\"google.com\",\"site24x7.com\"],\"ajax_enabled\":true,\"excluded_useragents\":[\"Mozilla\/5.0 (Linux; Android 7.0; SM-G892A Build\/NRD90M; wv) AppleWebKit\/537.36 (KHTML, like Gecko) Version\/4.0 Chrome\/60.0.3112.107 Mobile Safari\/537.36\"]}",
      "license_key": "ab_a2a5aa6ss501939c63c5219ssse3e7b5"
    },
    "rt_list": [
      {
        "code": "IR",
        "average_response_time": 16895.12,
        "total_response_time": 557539,
        "apdex": 0.4696969696969697,
        "total_count": 33,
        "name": "Iran",
        "throughput": 0.56,
        "error_count": 1
      },
      {
        "code": "FI",
        "average_response_time": 2100.26,
        "total_response_time": 39905,
        "apdex": 0.9736842105263158,
        "total_count": 19,
        "name": "Finland",
        "throughput": 0.32,
        "error_count": 1
      }
    ]
  }
}

API to get the geographic details of a particular RUM application across the world, whose application-id and the limit ‘n’ are passed as request parameter. Only Top ‘n’ locations with highest average response time are fetched.

oauthscope : Site24x7.Reports.Read

Path Parameters

Param	Type	Description
time_window	string	Mandatory Time window for which the applications have to be listed. Time window
application_id	string	Mandatory Application id of RUM application.
limit	int	Mandatory Number of details to be displayed.
attribute	string	Mandatory Attribute to be plotted in Map.

Response Attributes

Attribute	Type	Description
app_info	json	Application Information. JSON Format: {apdex_threshold: “$apdex_threshold”, application_name: “$application_name”, beacon_type : “$beacon_type”, application_key: “$application_key”, state: “$state”, application_id: “$application_id”, license_key: “$license_key”, type: “$type”,rum_config:“$rum_config”}
map_data	json	Map Data. JSON Format: {data:$data}
rt_list	Array	Response time data of locations.

JSON Format

Attribute	Type	Description
data	Array	Geographic data
apdex_threshold	int	Apdex score. For details visit Apdex.
application_name	string	Application name.
application_key	string	Application key.
state	string	Active/Suspended status.
application_id	string	Application id.
license_key	string	License key of APM.
type	string	Type of application(web/android/ios)
rum_config	string	Data collection configuration for the application
beacon_type	string	0 for traditional and 1 for single page application.

Top N geographic details of RUM application in US

GET /rum/web/view/{application_id}/geographic/US/{attribute}/{limit}/{time_window}

Request Example

$ curl https://www.site24x7.com/api/rum/web/view/1000000005003/geographic/apdex/US/3/H \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "map_data": {
      "data": [
        {
          "id": "mi",
          "tooltext": "<span id='rum-loc-tooltip' style='font-size:12px;font-weight: bold;margin-bottom:200px!important'>Michigan</span>{br}<hr class='mrgtop5 mrgbot5'><span style='font-weight: bold;'>Apdex :</span> 1.0{br}<span style='font-weight: bold;'>Avg.Resp.Time :</span> 2974 ms{br}<span style='font-weight: bold;'>Pageviews : </span>6{br}<span style='font-weight: bold;'>Throughput : </span>0.1 cpm{br}<span style='font-weight: bold;'>Errors : </span>0",
          "value": 2.97
        },
        {
          "id": "sd",
          "tooltext": "<span id='rum-loc-tooltip' style='font-size:12px;font-weight: bold;margin-bottom:200px!important'>South Dakota</span>{br}<hr class='mrgtop5 mrgbot5'><span style='font-weight: bold;'>Apdex :</span> 0.0{br}<span style='font-weight: bold;'>Avg.Resp.Time :</span> 0 ms{br}<span style='font-weight: bold;'>Pageviews : </span>0{br}<span style='font-weight: bold;'>Throughput : </span>0.0 cpm{br}<span style='font-weight: bold;'>Errors : </span>2",
          "value": 0
        }
      ]
    },
    "app_info": {
      "apdex_threshold": "2000",
      "application_name": "rumApplication",
      "beacon_type": "0",
      "locations": "",
      "state": "0",
      "type": "web",
      "application_key": "e61c2d7fdb64671ceb4ddda2b26dcb35",
      "application_id": "1000000013001",
      "rum_config": "{\"resources_config\":[{\"sub_type\":\"first\",\"name\":\"firstPartyResources\",\"domains\":[\"www.site24x7.com\",\"localhost:8080\"],\"type\":\"domain\"}],\"cx_ajax_enabled\":false,\"excluded_domains\":[\"google.com\",\"site24x7.com\"],\"ajax_enabled\":true,\"excluded_useragents\":[\"Mozilla\/5.0 (Linux; Android 7.0; SM-G892A Build\/NRD90M; wv) AppleWebKit\/537.36 (KHTML, like Gecko) Version\/4.0 Chrome\/60.0.3112.107 Mobile Safari\/537.36\"]}",
      "license_key": "ab_a2a5aa6ss501939c63c5219ssse3e7b5"
    },
    "rt_list": [
      {
        "code": "va",
        "average_response_time": 21702.5,
        "total_response_time": 43405,
        "apdex": 0.25,
        "total_count": 2,
        "name": "Virginia",
        "throughput": 0.03,
        "error_count": 1
      },
      {
        "code": "pa",
        "average_response_time": 1816,
        "total_response_time": 7264,
        "apdex": 1,
        "total_count": 4,
        "name": "Pennsylvania",
        "throughput": 0.07,
        "error_count": 1
      }
    ]
  }
}

API to get the geographic details of a particular RUM application across the United States, whose application-id and the limit ‘n’ are passed as request parameter. Only Top ‘n’ states with highest average response time are fetched.

oauthscope : Site24x7.Reports.Read

Path Parameters

Param	Type	Description
time_window	string	Mandatory Time window for which the applications have to be listed. Time window
application_id	string	Mandatory Application id of RUM application.
limit	int	Mandatory Number of details to be displayed.
attribute	string	Mandatory Attribute to be plotted in Map.

Response Attributes

Attribute	Type	Description
app_info	json	Application Information. JSON Format: {apdex_threshold: “$apdex_threshold”, application_name: “$application_name”, beacon_type : “$beacon_type”, application_key: “$application_key”, state: “$state”, application_id: “$application_id”, license_key: “$license_key”, type: “$type”,rum_config:“$rum_config”}
map_data	json	Map Data. JSON Format: {data:$data}
rt_list	Array	Response time data of locations.

JSON Format

Attribute	Type	Description
data	Array	Geographic data
apdex_threshold	int	Apdex score. For details visit Apdex.
application_name	string	Application name.
application_key	string	Application key.
state	string	Active/Suspended status.
application_id	string	Application id.
license_key	string	License key of APM.
type	string	Type of application(web/android/ios)
rum_config	string	Data collection configuration for the application
beacon_type	string	0 for traditional and 1 for single page application.

Top N Internet Service Provider details of RUM application

GET /rum/web/view/{appId}/isp/{limit}/{tw}

Request Example

$ curl https://www.site24x7.com/api/rum/web/view/15698000010568013/isp/3/H \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "isps_graph": {
      "0": {
        "spilitupgraph": {
          "average": [
            11600.6
          ],
          "chart_data": [
            [
              "BHARTI AIRTEL LTD.",
              10581.32
            ],
            [
              "MAROC TELECOM",
              6243.67
            ]
          ],
          "min": [
            2114.5
          ],
          "max": [
            80758.67
          ],
          "percentile_95": [
            34776
          ]
        }
      },
      "legends": [
        "Splitup"
      ],
      "keys": [
        "Splitup"
      ],
      "units": [
        ""
      ]
    },
    "app_info": {
      "apdex_threshold": "2000",
      "application_name": "rumApplication",
      "beacon_type": "0",
      "locations": "",
      "state": "0",
      "type": "web",
      "application_key": "e61c2d7fdb64671ceb4ddda2b26dcb35",
      "application_id": "1000000013001",
      "rum_config": "{\"resources_config\":[{\"sub_type\":\"first\",\"name\":\"firstPartyResources\",\"domains\":[\"www.site24x7.com\",\"localhost:8080\"],\"type\":\"domain\"}],\"cx_ajax_enabled\":false,\"excluded_domains\":[\"google.com\",\"site24x7.com\"],\"ajax_enabled\":true,\"excluded_useragents\":[\"Mozilla\/5.0 (Linux; Android 7.0; SM-G892A Build\/NRD90M; wv) AppleWebKit\/537.36 (KHTML, like Gecko) Version\/4.0 Chrome\/60.0.3112.107 Mobile Safari\/537.36\"]}",
      "license_key": "ab_a2a5aa6ss501939c63c5219ssse3e7b5"
    },
    "isps_list": [
      {
        "average_response_time": 10581.32,
        "total_response_time": 529066,
        "total_count": 50,
        "name": "BHARTI AIRTEL LTD.",
        "throughput": 0.85
      },
      {
        "average_response_time": 6243.67,
        "total_response_time": 18731,
        "total_count": 3,
        "name": "MAROC TELECOM",
        "throughput": 0.05
      },
      {..}
    ]
  }
}

API to get the Internet Service Provider details of a particular RUM application, whose application-id and the limit ‘n’ are passed as request parameter. Only Top ‘n’ ISPs with highest average response time are fetched.

oauthscope : Site24x7.Reports.Read

Path Parameters

Param	Type	Description
time_window	string	Mandatory Time window for which the applications have to be listed. Time window
application_id	string	Mandatory Application id of RUM application.
limit	int	Mandatory Number of details to be displayed

Response Attributes

Attribute	Type	Description
app_info	json	Application Information. JSON Format: {apdex_threshold: “$apdex_threshold”, application_name: “$application_name”, beacon_type : “$beacon_type”, application_key: “$application_key”, state: “$state”, application_id: “$application_id”, license_key: “$license_key”, type: “$type”,rum_config:“$rum_config”}
isps_graph	json	ISPs graph data. JSON Format:{95_percentile: $95_percentile, min: $min, max: $max, average: $average, chart_data: $chart_data, legends: $legends, units: $units}
ispslist	Array	List of ISPs and associated metrics.

JSON Format

Attribute	Type	Description
apdex_threshold	int	Apdex score. For details visit Apdex.
application_name	string	Application name.
application_key	string	Application key.
state	string	Active/Suspended status.
application_id	string	Application id.
license_key	string	License key of APM.
type	string	Type of application(web/android/ios)
rum_config	string	Data collection configuration for the application
beacon_type	string	0 for traditional and 1 for single page application.
95_percentile	Integer Array	95th percentile value.
min	Integer Array	minimum value.
max	Integer Array	maximum value.
chart_data	String Array	Data for plotting chart.
legends	String Array	Legends for graph.
units	String Array	Units.

RUM Application Graph Data

APIs to fetch RUM application graph data.

Response time split-up graph

GET /rum/web/view/{application_id}/graph/responsetime/{time_window}

Request Example

$ curl https://www.site24x7.com/api/rum/web/view/1000000005003/graph/responsetime/H \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response

{
  "code": 0,
  "message": "success",
  "data": "0": {
      "responsetimegraph": {
        "average": [
          42.28,
          89.13,
          505.95,
          164.8,
          434.55,
          1082.58,
          21.43,
          4731.83,
          5989.9
        ],
        "chart_data": [
          [
            "2019-01-23T17:11:52+0530",
            "",
            "",
            "",
            "",
            "",
            "",
            "",
            "",
            ""
          ],
          [
            "2019-01-23T17:12:52+0530",
            60,
            32,
            1303,
            190,
            523,
            1921,
            19,
            5124,
            7251
          ],
          [
            "2019-01-23T17:13:52+0530",
            5,
            29,
            416,
            75,
            392,
            843,
            13,
            3281,
            4211
          ],
          [
            "2019-01-23T17:14:52+0530",
            12,
            39,
            511,
            105,
            364,
            927,
            16,
            4378,
            5425
          ],
          [
            "2019-01-23T17:15:52+0530",
            29,
            242,
            433,
            71,
            335,
            1042,
            44,
            4141,
            5295
          ],
          [...]
        ],
        "min": [
          3,
          7,
          248,
          53,
          215,
          573,
          8,
          2277,
          3180
        ],
        "max": [
          328,
          1162,
          1303,
          747,
          2803,
          4041,
          49,
          13930,
          18264
        ],
        "percentile_95": [
          141,
          225,
          907,
          313,
          728,
          1921,
          40,
          8163,
          10599
        ]
      }
    },
    "legends": [
      "Redirection Time",
      "DNS time",
      "Connection time",
      "Document Download Time",
      "Server Time",
      "First Byte Time",
      "Page Rendering Time",
      "Document Rendering Time",
      "Overall Response Time"
    ],
    "units": [
      "ms"
    ]
   }
}

API to get network, server, page rendering time, first byte time & overall response time of a particular RUM application whose application-id and time-window are passed as mandatory arguments.

oauthscope : Site24x7.Reports.Read

Path Parameters

Param	Type	Description
time_window	string	Mandatory Time window for which the applications have to be listed. Time window
application_id	string	Mandatory Application id of RUM application.

Response Attributes

Attribute	Type	Description
responsetimegraph	json	Response time graph data. JSON Format:{95_percentile: $95_percentile, min: $min, max: $max, average: $average, chart_data: $chart_data, legends: $legends, units: $units}

JSON Format

Attribute	Type	Description
max	Integer Array	Max value.
min	Integer Array	Min value.
95_percentile	Integer Array	95th percentile value.
chart_data	String Array	Data for plotting chart.
legends	String Array	Legends for graph.
units	String Array	Units.

Throughput graph

GET /rum/web/view/{application_id}/graph/throughput/{time_window}

Request Example

$ curl https://www.site24x7.com/api/rum/web/view/1000000005003/graph/throughput/H \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "0": {
      "throughputgraph": {
        "min": [
          1
        ],
        "95_percentile": [
          6
        ],
        "max": [
          6
        ],
        "average": [
          3.64
        ],
        "chart_data": [
          [
            "2016-04-21T11:17:00+0530",
            "",
            ""
          ],
          [
            "2016-04-21T11:17:00+0530",
            24,
            37
          ]
          [..]
        ]
      }
    },
    "legends": [
      "Throughput"
    ],
    "units": [
      "rpm"
    ]
  }
}

API to get throughput (requests per minute) data of the particular RUM application whose application-id is passed as argument.

oauthscope : Site24x7.Reports.Read

Path Parameters

Param	Type	Description
time_window	string	Mandatory Time window for which the applications have to be listed. Time window
application_id	string	Mandatory Application id of RUM application.

Response Attributes

Attribute	Type	Description
throughputgraph	json	Throughput graph data. JSON Format:{95_percentile: $95_percentile, min: $min, max: $max, average: $average, chart_data: $chart_data, legends: $legends, units: $units}

JSON Format

Attribute	Type	Description
95_percentile	Integer Array	95th percentile value.
chart_data	String Array	Data for plotting chart.
legends	String Array	Legends for graph.
units	String Array	Units.

Development summary graph

GET /rum/web/view/{application_id}/developer/{time_window}

Request Example

$ curl https://www.site24x7.com/api/rum/web/view/1000000005003/developer/H \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "app_info": {
      "apdex_threshold": "450",
      "application_name": "rum-sim",
      "application_key": "653ddf79144744612a2c80f44e04ca8b",
      "state": "0",
      "application_id": "1000000005003",
      "license_key": "621fa3538e196c7d0113db74af2a253e22a33bd9",
      "type": "web"
    },
    "gantt_chart_data": {
      "processes": {
        "bgColor": "#FFFFFF",
        "headeralign": "left",
        "process": [
          {
            "id": "0",
            "isbold": "1",
            "label": "Total Response Time",
            "processid": "0"
          },
          {..}
        ],
        "isbold": "0",
        "headervalign": "bottom",
        "font": "Verdana",
        "align": "left",
        "fontsize": "10",
        "headertext": "Components",
        "headerfontsize": "11"
      },
      "chart": {
        "decimals": "2",
        "showborder": "0",
        "showCanvasBorder": "0",
        "dateformat": "mm/dd/yyyy",
        "outputDateFormat": "hh:mm:ss",
        "showplotborder": "0",
        "plotgradientcolor": "0",
        "showshadow": "0"
      },
      "categories": {
        "category": [
          {
            "start": "00:00:00",
            "end": "00:00:26"
          }
        ]
      },
      "tasks": {
        "task": [
          {
            "bordercolor": "BBDF73",
            "color": "BBDF73",
            "start": "00:00:00",
            "tooltext": "Total Response Time : 440 ms",
            "end": "00:00:26"
          },
          {..}
        ]
      },
      "datatable": {
        "datacolumn": {
          "bgColor": "#FFFFFF",
          "headeralign": "right",
          "text": [
            {
              "isbold": "1",
              "label": "440"
            },
            {..}
          ],
          "headervalign": "bottom",
          "font": "Verdana",
          "align": "right",
          "headerText": "Response Time (ms)",
          "fontsize": "10",
          "headerfontsize": "11"
        }
      }
    }
  }
}

API to get graph details of various components in RUM application’s response time, whose application-id is passed as argument.

oauthscope : Site24x7.Reports.Read

Path Parameters

Param	Type	Description
time_window	string	Mandatory Time window for which the applications have to be listed. Time window
application_id	string	Mandatory Application id of RUM application.

Response Attributes

Attribute	Type	Description
app_info	json	Application Information. JSON Format: {apdex_threshold: “$apdex_threshold”, application_name:“$application_name”, application_id: “$application_id”, application_key: “$application_key”, state:“$state”, license_key: “$license_key”, type: “$type”}
gantt_chart_data	json	Chart specifications.
rt_graph	json	Devices resp.time trends graph data. JSON Format:{95_percentile: $95_percentile, min: $min, max: $max, average: $average, chart_data: $chart_data, legends: $legends, units: $units}

JSON Format

Attribute	Type	Description
apdex_threshold	int	Apdex score. For details visit Apdex.
application_name	string	Application name.
application_key	string	Application key.
state	string	Active/Suspended status.
application_id	string	Application id.
license_key	string	License key of APM.
type	string	Type of application(web/android/ios)

RUM Application - individual transaction details

API to fetch the individual transaction details of the particular RUM application, where ‘application id’, ‘time window’ and ‘transaction name’ are mandatory fields.

Transaction details of individual RUM application

GET /rum/web/view/{application_id}/{time_window}?txn={trans_name}

Request Example

$ curl "https://www.site24x7.com/api/rum/web/view/1000000005003/H?txn=app/admin" \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "uniq_users": "192",
    "app_info": {
      "apdex_threshold": "2000",
      "application_name": "rumApplication",
      "beacon_type": "0",
      "state": "0",
      "type": "web",
      "application_key": "a11c2s7fd2h5ss1ceb4ddda2b26dcb3s",
      "application_id": "1000000013001",
      "rum_config": "{\"resources_config\":[{\"sub_type\":\"first\",\"name\":\"firstPartyResources\",\"domains\":[\"www.site24x7.com\",\"localhost:8080\"],\"type\":\"domain\"}],\"cx_ajax_enabled\":false,\"excluded_domains\":[\"google.com\",\"site24x7.com\"],\"ajax_enabled\":true,\"excluded_useragents\":[\"Mozilla\/5.0 (Linux; Android 7.0; SM-G892A Build\/NRD90M; wv) AppleWebKit\/537.36 (KHTML, like Gecko) Version\/4.0 Chrome\/60.0.3112.107 Mobile Safari\/537.36\"]}",
      "license_key": "ab_a2a5aa6ss501939c63c5219ssse3e7b5"
    },
    "app_data": {
      "error_count": "60",
      "frustrated_users": "0",
      "total_count": "30",
      "page_rendering_time": 3523,
      "first_byte_time": 1428,
      "document_rendering_time": 30,
      "frontend_time": 6787,
      "redirection_time": 2103,
      "document_processing_time": 1800,
      "document_download_time": 1464,
      "tolerated_users": "17",
      "satisfied_users": "13",
      "dns_time": 3573,
      "max_rt": 30756,
      "min_rt":100,
      "backend_time": 1168,
      "network_time": 6534,
      "total_response_time": 14489,
      "connection_time": 858
    },
    "last_archieved_time": "1461236414551"
  }
}

Transaction details of a particular RUM application is shown.

oauthscope : Site24x7.Reports.Read

Path Parameters

Param	Type	Description
time_window	string	Mandatory Time window for which the applications have to be listed. Time window
application_id	string	Mandatory Application id of RUM application.

Query Parameters

Param	Type	Description
txn	string	Transaction name for which response time split up to be listed.

Response Attributes

Attribute	Type	Description
uniq_users	int	Distinct individuals visiting per month.
app_info	json	Application Information. JSON Format: {apdex_threshold: “$apdex_threshold”, application_name: “$application_name”, application_key: “$application_key”, state: “$state”, application_id: “$application_id”, license_key: “$license_key”, type: “$type”}
app_data	json	Application metrics. JSON Format: {error_count: “$error_count”, frustrated_users: “$frustrated_users”, total_count: “$total_count”, page_rendering_time: $page_rendering_time, first_byte_time:$first_byte_time, document_rendering_time:$document_rendering_time, frontend_time: $frontend_time, redirection_time: $redirection_time, document_processing_time:$document_processing_time, document_download_time: $document_download_time, tolerated_users: “$tolerated_users”, satisfied_users: “$satisfied_users”, dns_time:$dns_time, backend_time: $backend_time, network_time: $network_time, total_response_time: $total_response_time, connection_time: $connection_time}
last_archieved_time	string	Most recent data collection time.

JSON Format

Attribute	Type	Description
apdex_threshold	int	Apdex score. For details visit Apdex.
application_name	string	Application name.
application_key	string	Application key.
state	string	Active/Suspended status.
application_id	string	Application id.
license_key	string	License key of APM.
type	string	Type of application(web/android/ios)
rum_config	string	Data collection configuration for the application
beacon_type	string	0 for traditional and 1 for single page application.
error_count	string	Total number of JavaScript errors.
frustrated_users	string	Frustrated users.
total_count	string	Number of times users have visited the page.
page_rendering_time	int	Page rendering time of application.
first_byte_time	int	First byte time of application.
document_rendering_time	int	Document rendering time of application.
frontend_time	int	Front end time of application.
redirection_time	int	Redirection time of application.
document_processing_time	int	Document processing time of application.
document_download_time	int	Document loading time of application.
tolerated_users	string	Tolerating users.
satisfied_users	string	Satisfied users.
dns_time	int	Domain Name Server(DNS) time of application.
backend_time	int	Back End time of application.
network_time	int	Network time of application
total_response_time	int	Total Response time of application.
connection_time	int	Connection time of application.
min_rt	int	minimum response time for the transaction.
max_rt	int	maximum response time for the transaction.

RUM Application - individual transaction graph data

APIs to fetch the individual transaction’s graph data of a particular RUM application, where ‘application id’, ‘time window’ and ‘transaction name’ are mandatory fields.

Response time split up graph of individual transaction of RUM application

GET /rum/web/view/{application_id}/wt/graph/rtStacked/{time_window}?txn={trans_name}

Request Example

$ curl "https://www.site24x7.com/api/rum/web/view/1000000005003/wt/graph/rtStacked/H?txn=app/admin" \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "0": {
      "spilitupgraph": {
        "min": [
          1168
        ],
        "95_percentile": [
          6534
        ],
        "max": [
          6534
        ],
        "average": [
          2897.8
        ],
        "chart_data": [
          [
            "Page Rendering Time",
            3523
          ],
          [
            "Document Processing Time",
            1800
          ],
          [
            "Document Download Time",
            1464
          ],
          [
            "Server Time",
            1168
          ],
          [
            "Network Time",
            6534
          ]
        ]
      }
    },
    "legends": [
      "Splitup"
    ],
    "units": [
      ""
    ]
  }
}

API to get the response time split up graph data of a particular transaction in a particular application whose transaction name and application id are passed as arguments.

oauthscope : Site24x7.Reports.Read

Path Parameters

Param	Type	Description
time_window	string	Mandatory Time window for which the applications have to be listed. Time window
application_id	string	Mandatory Application id of RUM application.

Query Parameters

Param	Type	Description
txn	string	Transaction name for which response time split up to be listed.

Response Attributes

Attribute	Type	Description
spilitupgraph	json	Split-up graph data. JSON Format:{95_percentile: $95_percentile, min: $min, max: $max, average: $average, chart_data: $chart_data, legends: $legends, units: $units}

JSON Format

Attribute	Type	Description
95_percentile	Integer Array	95th percentile value.
chart_data	String Array	Data for plotting chart.
legends	String Array	Legends for graph.
units	String Array	Units.

Response time and throughput graph of individual RUM application transactions

GET /rum/web/view/{appId}/wt/graph/rtandthroughput/{tw}?txn={trans_name}

Request Example

$ curl "https://www.site24x7.com/api/rum/web/view/1000000005003/wt/graph/rtandthroughput/H?txn=app/admin" \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "0": {
      "avgresponsetimethroughputgraph": {
        "min": [
          334,
          1
        ],
        "95_percentile": [
          696,
          2
        ],
        "max": [
          768,
          2
        ],
        "average": [
          490.64,
          1.2
        ],
        "chart_data": [
          [
            "2016-04-21T15:31:00+0530",
            "",
            ""
          ],
          [
            "2016-04-21T15:38:00+0530",
            517,
            1
          ]
        ]
      }
    },
    "legends": [
      "Avg. Response Time",
      "Throughput"
    ],
    "units": [
      "ms",
      "cpm"
    ]
  }
}

API to get the response time and throughput graph data of a particular transaction in a particular application whose transaction name and application id are passed as arguments.

oauthscope : Site24x7.Reports.Read

Path Parameters

Param	Type	Description
time_window	string	Mandatory Time window for which the applications have to be listed. Time window
application_id	string	Mandatory Application id of RUM application.

Query Parameters

Param	Type	Description
txn	string	Transaction name for which response time split up to be listed.

Response Attributes

Attribute	Type	Description
avgresponsetimethroughputgraph	json	Average Response time throughput graph data. JSON Format:{95_percentile: $95_percentile, min: $min, max: $max, average: $average, chart_data: $chart_data, legends: $legends, units: $units}

JSON Format

Attribute	Type	Description
95_percentile	Integer Array	95th percentile value.
chart_data	String Array	Data for plotting chart.
legends	String Array	Legends for graph.
units	String Array	Units.

Throughput graph of individual RUM application transactions

GET /rum/web/view/{application_id}/wt/graph/throughput/{time_window}?txn={trans_name}

Request Example

$ curl "https://www.site24x7.com/api/rum/web/view/1000000005003/wt/graph/throughput/H?txn=app/admin" \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "0": {
      "throughputgraph": {
        "min": [
          1
        ],
        "95_percentile": [
          2
        ],
        "max": [
          2
        ],
        "average": [
          1.2
        ],
        "chart_data": [
          [
            "2016-04-21T15:31:00+0530",
            ""
          ],
          [
            "2016-04-21T15:38:00+0530",
            1
          ]
        ]
      }
    },
    "legends": [
      "Throughput"
    ],
    "units": [
      "rpm"
    ]
  }
}

API to get the throughput graph data of a particular transaction in a particular application whose transaction name and application id are passed as arguments.

oauthscope : Site24x7.Reports.Read

Path Parameters

Param	Type	Description
time_window	string	Mandatory Time window for which the applications have to be listed. Time window
application_id	string	Mandatory Application id of RUM application.

Query Parameters

Param	Type	Description
txn	string	Transaction name for which response time split up to be listed.

Response Attributes

Attribute	Type	Description
throughputgraph	json	Throughput graph data. JSON Format:{95_percentile: $95_percentile, min: $min, max: $max, average: $average, chart_data: $chart_data, legends: $legends, units: $units}

JSON Format

Attribute	Type	Description
95_percentile	Integer Array	95th percentile value.
chart_data	String Array	Data for plotting chart.
legends	String Array	Legends for graph.
units	String Array	Units.

Response time graph of individual RUM application transactions

GET /rum/web/view/{application_id}/wt/graph/responsetime/{time_window}?txn={trans_name}

Request Example

$ curl "https://www.site24x7.com/api/rum/web/view/1000000005003/wt/graph/responsetime/H?txn=app/admin" \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "0": {
      "responsetimegraph": {
        "min": [
          115,
          1,
          1,
          10,
          334
        ],
        "95_percentile": [
          347,
          91,
          1,
          81,
          696
        ],
        "max": [
          365,
          100,
          1,
          83,
          768
        ],
        "average": [
          225.36,
          37.8,
          1,
          45.64,
          490.64
        ],
        "chart_data": [
          [
            "2016-04-21T15:31:00+0530",
            "",
            "",
            "",
            "",
            ""
          ],
          [
            "2016-04-21T15:38:00+0530",
            365,
            28,
            1,
            76,
            517
          ]
        ]
      }
    },
    "legends": [
      "Network Time",
      "Server Time",
      "Page Rendering Time",
      "First Byte Time",
      "Overall Response Time"
    ],
    "units": [
      "ms"
    ]
  }
}

API to get the response time graph data of a particular transaction in a particular application whose transaction name and application id are passed as arguments.

oauthscope : Site24x7.Reports.Read

Path Parameters

Param	Type	Description
time_window	string	Mandatory Time window for which the applications have to be listed. Time window
application_id	string	Mandatory Application id of RUM application.

Query Parameters

Param	Type	Description
txn	string	Transaction name for which response time split up to be listed.

Response Attributes

Attribute	Type	Description
responsetimegraph	json	Response time graph data. JSON Format:{95_percentile: $95_percentile, min: $min, max: $max, average: $average, chart_data: $chart_data, legends: $legends, units: $units}

JSON Format

Attribute	Type	Description
95_percentile	Integer Array	95th percentile value.
chart_data	String Array	Data for plotting chart.
legends	String Array	Legends for graph.
units	String Array	Units.

RUM JS Errors

APIs to fetch details of Java Script Errors in RUM.

JavaScript error summary

GET /rum/web/view/{application_id}/error/filter/info/{time_window}

Request Example

$ curl https://www.site24x7.com/api/rum/web/view/1000000005003/error/filter/info/H \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response

{
  "code": 0,
  "message": "success",
  "data": {
    errors: "86"
    files: "2"
    pages: "7"
    users: "8"
  }
}

To get the javascript errors summary that occur in a particular RUM application whose application id is passed as argument.

oauthscope : Site24x7.Reports.Read

Path Parameters

Param	Type	Description
time_window	string	Mandatory Time window for which the applications have to be listed. Time window
application_id	string	Mandatory Application id of RUM application.

Response Attributes

Attribute	Type	Description
errors	string	Total No. of js errors in the application.
files	string	Total No. of Unique files where js errors occurred in the application.
pages	string	Total No. of Unique pages where js errors occurred in the application.
users	string	Total No. of Unique users for whom js errors have occurred in the application.

JavaScript error list details

GET /rum/web/view/{application_id}/error/filter/list/{time_window}?mtype=error

Request Example

$ curl https://www.site24x7.com/api/rum/web/view/1000000005003/error/filter/list/H?mtype=error \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "error_list": [
      {
        "file": "main.min.js",
        "name": "Cannot read properties of null (reading 'setAttribute')",
        "count": "75",
        "error_id": -1607679792,
        "type": "TypeError",
        "latest": 1637565997651
      },
      {
        "file": "bundle.js",
        "name": "Cannot read properties of null (reading 'appendChild')",
        "count": "2",
        "error_id": 541499993,
        "type": "TypeError",
        "latest": 1637431351094
      }
    ]
  }
}

To get the list details of the javascript errors in a particular RUM application for the specified time window, whose application id is passed as argument.

oauthscope : Site24x7.Reports.Read

Path Parameters

Param	Type	Description
time_window	string	Mandatory Time window for which the applications have to be listed. Time window
application_id	string	Mandatory Application id of RUM application.

Query Parameters

Param	Type	Description
mtype	string	Mandatory metric type of js errors list like error,type(error type),file,page,browser,uid(users),domain.

Response Attributes

Attribute	Type	Description
error_list	json Array	List of errors.

JSON Format

Attribute	Type	Description
file	string	File where js errors have occurred.
name	string	Error message of the js error.
count	string	Total No. of JavaScript errors in the application.
error_id	number	Unique identifier for each js error.
type	string	Error Type of the js error.
latest	string	Time in milliseconds for first occurrence of error.

RUM Resources

Gather performance related metrics of your website resources from different domains, namely first party, third party and CDN with the help of RUM.

Overview details of resources performance

GET /rum/web/view/{application_id}/resources/overview/{time_window}

Request Example

$ curl https://www.site24x7.com/api/rum/web/view/1000000005003/resources/overview/H\
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "domainsList": {
      "third": [
        {
          "name": "quora.com",
          "totalCT": 1,
          "totalRT": 1687,
          "type": "third"
        },
        {
          "name": "npm.com",
          "totalCT": 27,
          "totalRT": 1665,
          "type": "third"
        }
      ],
      "CDN": [
        {
          "name": "youtube.com",
          "totalCT": 74,
          "totalRT": 559,
          "type": "CDN"
        },
        {
          "name": "translate.google.com",
          "totalCT": 46,
          "totalRT": 500,
          "type": "CDN"
        },
        {
          "name": "dtzpfzv31buvf.cloudfront.net",
          "totalCT": 735,
          "totalRT": 318,
          "type": "CDN"
        }
      ],
      "first": [
        {
          "name": "app.com",
          "totalCT": 3834,
          "totalRT": 3122,
          "type": "first"
        },
        {
          "name": "blogs.app.com",
          "totalCT": 18,
          "totalRT": 1830,
          "type": "first"
        }
      ]
    },
    "resourcesGraphData": {
      "0": {
        "throughputresponsetimeavgresponsetimegraph": {
          "chart_data": [
            [
              "2019-01-23T17:53:12+0530",
              "",
              "",
              ""
            ],
            [
              "2019-01-23T17:54:12+0530",
              447,
              722,
              3425
            ],
            [
              "2019-01-23T17:55:12+0530",
              683,
              1456,
              7393
            ]
          ]
        }
      },
      "legends": [
        "Resources Throughput",
        "Resources Avg. ResponseTime",
        "Application Avg. ResponseTime"
      ],
      "keys": [
        "Throughput",
        "Response Time",
        "Avg. Response Time"
      ],
      "units": [
        "cpm",
        "ms",
        "ms"
      ]
    }
  }
}

API to fetch performance details of top ten first party, third party and CDN domain resources. Impact of resources on application performance is also shown as a graph.

oauthscope : Site24x7.Reports.Read

Path Parameters

Param	Type	Description
time_window	string	Mandatory Time window for which the applications have to be listed. Time window
application_id	string	Mandatory Application id of RUM application.

Response Attributes

Attribute	Type	Description
domainsList	json	Domain performance information listed by first party, third party and CDN . JSON Format: {third:“$third”,first :“$first”, CDN: “$CDN”}
resourcesGraphData	json	resources vs application performance graph. JSON Format:{chart_data: $chart_data, legends: $legends, units: $units}

JSON Format

Attribute	Type	Description
third	Array	List of third party domains with resources performance
first	Array	List of first party domains with resources performance
CDN	Array	List of CDN domains with resources performance
chart_data	String Array	Data for plotting chart.
legends	String Array	Legends for graph.
units	String Array	Units.

Domain specific details of application resources

GET /rum/web/view/{application_id}/domain/info/{time_window}?domain_name={trans_name}&type={type}

Request Example

$ curl "https://www.site24x7.com/api/rum/web/view/2002000000934003/domain/info/H?domain_name=csi.gstatic.com&type=CDN" \
    -X GET \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "domainCT": 4,
    "domainRT": 804,
    "totalCT": {
      "domain_location": {
        "0": {
          "collectioncountdialgraph": {
            "average": [
              4
            ],
            "chart_data": [
              [
                "Brazil",
                4
              ]
            ],
            "min": [
              4
            ],
            "max": [
              4
            ],
            "percentile_95": [
              4
            ]
          }
        },
        "legends": [
          "Count"
        ],
        "keys": [
          "Count"
        ],
        "units": [
          ""
        ]
      },
      "resource_types": {
        "0": {
          "collectioncountdialgraph": {
            "average": [
              4
            ],
            "chart_data": [
              [
                "img",
                4
              ]
            ],
            "min": [
              4
            ],
            "max": [
              4
            ],
            "percentile_95": [
              4
            ]
          }
        },
        "legends": [
          "Count"
        ],
        "keys": [
          "Count"
        ],
        "units": [
          ""
        ]
      }
    },
    "totalRT": {
      "domain_location": {
        "0": {
          "avgresponsetimegraph": {
            "average": [
              3217
            ],
            "chart_data": [
              [
                "Brazil",
                804
              ]
            ],
            "min": [
              3217
            ],
            "max": [
              3217
            ],
            "percentile_95": [
              3217
            ]
          }
        },
        "legends": [
          "Avg. Response Time"
        ],
        "keys": [
          "Avg. Response Time"
        ],
        "units": [
          "ms"
        ]
      },
      "resource_types": {
        "0": {
          "avgresponsetimegraph": {
            "average": [
              3217
            ],
            "chart_data": [
              [
                "img",
                804
              ]
            ],
            "min": [
              3217
            ],
            "max": [
              3217
            ],
            "percentile_95": [
              3217
            ]
          }
        },
        "legends": [
          "Avg. Response Time"
        ],
        "keys": [
          "Avg. Response Time"
        ],
        "units": [
          "ms"
        ]
      }
    },
    "domainGraphData": {
      "0": {
        "avgresponsetimethroughputgraph": {
          "average": [],
          "chart_data": [
            [
              "2019-01-23T17:53:13+0530",
              "",
              ""
            ],
            [
              "2019-01-23T17:54:13+0530",
              0,
              0
            ]
          ],
          "min": [],
          "max": [],
          "percentile_95": []
        }
      },
      "legends": [
        "Avg. Response Time",
        "Throughput"
      ],
      "keys": [
        "Avg. Response Time",
        "Throughput"
      ],
      "units": [
        "ms",
        "cpm"
      ]
    }
  }
}

API to fetch performance details of resources by specific domains based on their location and resource type. The response time throughput graph of resources by their respective domains is also plotted.

oauthscope : Site24x7.Reports.Read

Path Parameters

Param	Type	Description
time_window	string	Mandatory Time window for which the applications have to be listed. Time window
application_id	string	Mandatory Application id of RUM application.
domain_name	string	Mandatory Domain name.
type	string	Mandatory Domain type(first/third/CDN).

Response Attributes

Attribute	Type	Description
domainCT	int	total count of resources from the domain.
domainRT	int	average response time of resources.
totalRT	json	average response time graphs based on locations and resource types. JSON Format:{domain_location: “$domain_location”,resource_types: “resources_types”}
totalCT	json	count graphs based on locations and resource types. JSON Format:{domain_location: “$domain_location”,resource_types: “resources_types”}
domainGraphData	json	domain’s resources vs application performance graph. JSON Format:{chart_data: “$chart_data”, legends: “$legends”, units: “$units”}

JSON Format

Attribute	Type	Description
domain_location	json	graph data for either average response time or count of resources from different locations.
resource_types	json	graph data for either average response time or count of resources for different resource types.
chart_data	String Array	Data for plotting chart.
95_percentile	Integer Array	95th percentile value.
min	Integer Array	minimum value.
max	Integer Array	maximum value.
legends	String Array	Legends for graph.
units	String Array	Units.

Note

Add a note to provide a brief description about your monitor.

Retrieve Note

GET /monitors/notes/{monitor_id}

Request Example

$ curl https://www.site24x7.com/api/monitors/notes/123412341234123411 \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

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

Retrieve the note added to a monitor.

oauthscope : Site24x7.Admin.Read

Path Parameters

Param	Type	Description
monitor_id	string	Mandatory Unique ID of the monitor. You can locate all Monitor IDs from the Monitor list API.

Response Attributes

Attribute	Type	Description
monitor_id	string	Unique ID of the monitor.
notes	string	A brief note about your monitor.

Add or Update Note

PUT /monitors/notes/{monitor_id}

Request Example

$ curl https://www.site24x7.com/api/monitors/notes/123412341234123411 \
    -X PUT \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \
    -d '{
      "notes": "Notes"
    }'

Response Example

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

Add a new note to your monitor or update the existing note.

oauthscope : Site24x7.Admin.Update

Path Parameters

Param	Type	Description
monitor_id	string	Mandatory Unique ID of the monitor. You can locate all Monitor IDs from the Monitor list API.

Response Attributes

Attribute	Type	Description
monitor_id	string	Unique ID of the monitor.
notes	string	A brief note about your monitor.

Delete Note

DELETE /monitors/notes/{monitor_id}

Request Example

$ curl https://www.site24x7.com/api/monitors/notes/123412341234123411 \
    -X DELETE \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \

Response Example

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

Delete note configured to a monitor.

oauthscope : Site24x7.Admin.Delete

Path Parameters

Param	Type	Description
monitor_id	string	Mandatory Unique ID of the monitor. You can locate all Monitor IDs from the Monitor list API.

Applog Log Types

A Log Type is a clear definition of the format in which an application writes logs.

Create a Custom Log Type

POST /api/applog/logtype

Request Example

$ curl https://www.site24x7.com/api/applog/logtype \
    -X POST \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \
    -d '{
      "display_name": "testLogType",
      "description": "test decription",
      "logtype": "samplelogtype",
      "sample_log": "INFO [main] 2016-11-04 02:14:23,494 DatabaseDescriptor.java (line 143) Data files directories: [/home/local/Softwares/Cassandra/data]\nINFO [main] 2016-11-04 02:14:23,494 DatabaseDescriptor.java (line 143) Data files directories: [/home/local/Softwares/Cassandra/data]\nINFO [main] 2016-11-04 02:14:23,494 DatabaseDescriptor.java (line 143) Data files directories: [/home/local/Softwares/Cassandra/data]\nINFO [main] 2016-11-04 02:14:23,494 DatabaseDescriptor.java (line 143) Data files directories: [/home/local/Softwares/Cassandra/data]",
      "log_pattern": "$LogLevel$ [$ThreadName$] $DateTime:date$ $SourceFileName$ (line $LineNumber:number$) $Message$",
      "auto_discovery": true,
      "searchable_days": 10,
      "api_upload": false,
      "max_upload_limit":"2"
    }'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "success",
    "data": {
        "fieldValues": [
            [
                "2016-11-04 02:14:23,494",
                "INFO",
                "main",
                "DatabaseDescriptor.java",
                "143",
                "Data files directories: [/home/local/Softwares/Cassandra/data]"
            ],
            [
                "2016-11-04 02:14:23,494",
                "INFO",
                "main",
                "DatabaseDescriptor.java",
                "143",
                "Data files directories: [/home/local/Softwares/Cassandra/data]"
            ],
            [
                "2016-11-04 02:14:23,494",
                "INFO",
                "main",
                "DatabaseDescriptor.java",
                "143",
                "Data files directories: [/home/local/Softwares/Cassandra/data]"
            ],
            [
                "2016-11-04 02:14:23,494",
                "INFO",
                "main",
                "DatabaseDescriptor.java",
                "143",
                "Data files directories: [/home/local/Softwares/Cassandra/data]"
            ]
        ],
        "auto_discovery": true,
        "searchable_days": 10,
        "logtype": "samplelogtype",
        "sample_log": "INFO [main] 2016-11-04 02:14:23,494 DatabaseDescriptor.java (line 143) Data files directories: [/home/local/Softwares/Cassandra/data]\nINFO [main] 2016-11-04 02:14:23,494 DatabaseDescriptor.java (line 143) Data files directories: [/home/local/Softwares/Cassandra/data]\nINFO [main] 2016-11-04 02:14:23,494 DatabaseDescriptor.java (line 143) Data files directories: [/home/local/Softwares/Cassandra/data]\nINFO [main] 2016-11-04 02:14:23,494 DatabaseDescriptor.java (line 143) Data files directories: [/home/local/Softwares/Cassandra/data]",
        "fields": [
            {
                "fieldType": "date",
                "fieldDataFormat": "",
                "fieldWidth": 9,
                "fieldName": "DateTime"
            },
            {
                "fieldType": "String",
                "fieldDataFormat": "",
                "fieldWidth": 5,
                "fieldName": "LogLevel"
            },
            {
                "fieldType": "String",
                "fieldDataFormat": "",
                "fieldWidth": 5,
                "fieldName": "ThreadName"
            },
            {
                "fieldType": "String",
                "fieldDataFormat": "",
                "fieldWidth": 5,
                "fieldName": "SourceFileName"
            },
            {
                "fieldType": "number",
                "fieldDataFormat": "",
                "fieldWidth": 4,
                "fieldName": "LineNumber"
            },
            {
                "fieldType": "String",
                "fieldDataFormat": "",
                "fieldWidth": 5,
                "fieldName": "Message"
            }
        ],
        "logtype_id": "4562000007138237",
        "max_upload_limit":"2",
        "log_pattern": "$LogLevel$ [$ThreadName$] $DateTime:date$ $SourceFileName$ (line $LineNumber:number$) $Message$",
        "display_name": "test",
        "description": "test decription",
        "api_upload": false,
        "fieldNames": [
            "DateTime",
            "LogLevel",
            "ThreadName",
            "SourceFileName",
            "LineNumber",
            "Message"
        ]
    }
}

Log Types helps to group logs from different applications to enable ease of access and assists in efficient searching.

oauthscope : Site24x7.Operations.Create

Request Parameters

Param	Type	Description
display_name	string	Mandatory A display name for the log type.
description	string	A description for the log type.
logtype	string	Mandatory Log type name is a unique identifier for logs following the same format.
sample_log	string	Mandatory Sample log lines from the files for which you need to configure the log type.
log_pattern	string	Mandatory Log Pattern allows you to seperate your logs into relevant fields.
auto_discovery	boolean	You can send log events to AppLogs through our HTTPS endpoint.
searchable_days	int	Retention period of logs.
api_upload	boolean	Look for the particular log format across new servers that have been associated with this log type, and start uploading logs, if found.
max_upload_limit	string	The maximum amount of logs (for this log type) that you could upload during the current billing cycle.

Response Attributes

Attribute	Type	Description
logtype_id	string	Unique ID generated by the server. This can be used as an identifier.
log_pattern	string	Log Pattern allows you to seperate your logs into relevant fields.
display_name	string	A display name for the Log Type.
description	string	A description for the log type.
logtype	string	Log Type name is a unique identifier for logs following the same format.
sample_log	string	Sample log lines from the files for which you need to configure log type.
api_upload	boolean	Look for the particular log format across new servers that have been associated with this log type, and start uploading logs, if found.
auto_discovery	boolean	You can send log events to AppLogs through our HTTPS endpoint.
fields	array	Field names and field data format associated with the logs.
fieldValues	array	Segregating sample logs into separate fields.
fieldNames	array	Field names associated with the logs.
searchable_days	int	Retention period of logs.
max_upload_limit	string	The maximum amount of logs (for this log type) that you could upload during the current billing cycle.

Get Custom Log Type

GET /api/applog/logtype/{logtype_id}

Request Example

$ curl https://www.site24x7.com/api/applog/logtype/4562000007138237 \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "success",
    "data": {
        "fieldValues": [
            [
                "2016-11-04 02:14:23,494",
                "INFO",
                "main",
                "DatabaseDescriptor.java",
                "143",
                "Data files directories: [/home/local/Softwares/Cassandra/data]"
            ],
            [
                "2016-11-04 02:14:23,494",
                "INFO",
                "main",
                "DatabaseDescriptor.java",
                "143",
                "Data files directories: [/home/local/Softwares/Cassandra/data]"
            ],
            [
                "2016-11-04 02:14:23,494",
                "INFO",
                "main",
                "DatabaseDescriptor.java",
                "143",
                "Data files directories: [/home/local/Softwares/Cassandra/data]"
            ],
            [
                "2016-11-04 02:14:23,494",
                "INFO",
                "main",
                "DatabaseDescriptor.java",
                "143",
                "Data files directories: [/home/local/Softwares/Cassandra/data]"
            ]
        ],
        "auto_discovery": true,
        "saved_search": false,
        "searchable_days": 10,
        "max_upload_limit":"2",
        "alerts": false,
        "logtype": "samplelogtype",
        "sample_log": "INFO [main] 2016-11-04 02:14:23,494 DatabaseDescriptor.java (line 143) Data files directories: [/home/local/Softwares/Cassandra/data]\nINFO [main] 2016-11-04 02:14:23,494 DatabaseDescriptor.java (line 143) Data files directories: [/home/local/Softwares/Cassandra/data]\nINFO [main] 2016-11-04 02:14:23,494 DatabaseDescriptor.java (line 143) Data files directories: [/home/local/Softwares/Cassandra/data]\nINFO [main] 2016-11-04 02:14:23,494 DatabaseDescriptor.java (line 143) Data files directories: [/home/local/Softwares/Cassandra/data]",
        "fields": [
            {
                "fieldType": "date",
                "fieldDataFormat": "",
                "fieldWidth": 9,
                "fieldName": "DateTime"
            },
            {
                "fieldType": "String",
                "fieldDataFormat": "",
                "fieldWidth": 5,
                "fieldName": "LogLevel"
            },
            {
                "fieldType": "String",
                "fieldDataFormat": "",
                "fieldWidth": 5,
                "fieldName": "ThreadName"
            },
            {
                "fieldType": "String",
                "fieldDataFormat": "",
                "fieldWidth": 5,
                "fieldName": "SourceFileName"
            },
            {
                "fieldType": "number",
                "fieldDataFormat": "",
                "fieldWidth": 4,
                "fieldName": "LineNumber"
            },
            {
                "fieldType": "String",
                "fieldDataFormat": "",
                "fieldWidth": 5,
                "fieldName": "Message"
            }
        ],
        "logtype_id": "4562000007138237",
        "log_pattern": "$LogLevel$ [$ThreadName$] $DateTime:date$ $SourceFileName$ (line $LineNumber:number$) $Message$",
        "display_name": "test",
        "description": "test decription",
        "api_upload": false,
        "fieldNames": [
            "DateTime",
            "LogLevel",
            "ThreadName",
            "SourceFileName",
            "LineNumber",
            "Message"
        ]
    }
}

Retrieve the configuration of a created custom log type.

oauthscope : Site24x7.Operations.Read

Path Parameters

Param	Type	Description
logtype_id	string	Mandatory Unique ID. This can be used as an identifier.

Response Attributes

Attribute	Type	Description
logtype_id	string	Unique ID generated by the server. This can be used as an identifier.
log_pattern	string	Log pattern allows you to seperate your logs into relevant fields.
display_name	string	A display name for the Log Type.
description	string	A description for the log type.
logtype	string	Log type name is a unique identifier for logs following the same format.
sample_log	string	Sample log lines from the files for which you need to configure log type.
api_upload	boolean	Look for the particular log format across new servers that have been associated with this log type, and start uploading logs, if found.
auto_discovery	boolean	You can send log events to AppLogs through our HTTPS endpoint.
fields	array	Field names and field data format associated with the logs.
fieldValues	array	Segregating sample logs into separate fields.
fieldNames	array	Field names associated with the logs.
searchable_days	int	Retention period of logs.
max_upload_limit	string	The maximum amount of logs (for this log type) that you could upload during the current billing cycle.
saved_search	boolean	True when there exists saved search for the log type.
alerts	boolean	True when there exists alert for the log type.

Update Custom Log Type

PUT /api/applog/logtype/{logtype_id}

Request Example

$ curl https://www.site24x7.com/api/applog/logtype/4562000007138237 \
    -X PUT \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \
    -d '{
      "display_name": "testUpdated",
      "description": "test decription updated",
      "logtype": "samplelogtype",
      "sample_log": "INFO [main] 2016-11-04 02:14:23,494 DatabaseDescriptor.java (line 143) Data files directories: [/home/local/Softwares/Cassandra/data]\nINFO [main] 2016-11-04 02:14:23,494 DatabaseDescriptor.java (line 143) Data files directories: [/home/local/Softwares/Cassandra/data]\nINFO [main] 2016-11-04 02:14:23,494 DatabaseDescriptor.java (line 143) Data files directories: [/home/local/Softwares/Cassandra/data]\nINFO [main] 2016-11-04 02:14:23,494 DatabaseDescriptor.java (line 143) Data files directories: [/home/local/Softwares/Cassandra/data]",
      "log_pattern": "$LogLevel$ [$ThreadName$] $DateTime:date$ $SourceFileName$ (line $LineNumber:number$) $Message$",
      "auto_discovery": true,
      "searchable_days": 5,
      "api_upload": false,
      "max_upload_limit":"1"
    }'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "success",
    "data": {
        "fieldValues": [
            [
                "2016-11-04 02:14:23,494",
                "INFO",
                "main",
                "DatabaseDescriptor.java",
                "143",
                "Data files directories: [/home/local/Softwares/Cassandra/data]"
            ],
            [
                "2016-11-04 02:14:23,494",
                "INFO",
                "main",
                "DatabaseDescriptor.java",
                "143",
                "Data files directories: [/home/local/Softwares/Cassandra/data]"
            ],
            [
                "2016-11-04 02:14:23,494",
                "INFO",
                "main",
                "DatabaseDescriptor.java",
                "143",
                "Data files directories: [/home/local/Softwares/Cassandra/data]"
            ],
            [
                "2016-11-04 02:14:23,494",
                "INFO",
                "main",
                "DatabaseDescriptor.java",
                "143",
                "Data files directories: [/home/local/Softwares/Cassandra/data]"
            ]
        ],
        "auto_discovery": true,
        "searchable_days": 5,
        "max_upload_limit":"1",
        "logtype": "samplelogtype",
        "sample_log": "INFO [main] 2016-11-04 02:14:23,494 DatabaseDescriptor.java (line 143) Data files directories: [/home/local/Softwares/Cassandra/data]\nINFO [main] 2016-11-04 02:14:23,494 DatabaseDescriptor.java (line 143) Data files directories: [/home/local/Softwares/Cassandra/data]\nINFO [main] 2016-11-04 02:14:23,494 DatabaseDescriptor.java (line 143) Data files directories: [/home/local/Softwares/Cassandra/data]\nINFO [main] 2016-11-04 02:14:23,494 DatabaseDescriptor.java (line 143) Data files directories: [/home/local/Softwares/Cassandra/data]",
        "fields": [
            {
                "fieldType": "date",
                "fieldDataFormat": "",
                "fieldWidth": 9,
                "fieldName": "DateTime"
            },
            {
                "fieldType": "String",
                "fieldDataFormat": "",
                "fieldWidth": 5,
                "fieldName": "LogLevel"
            },
            {
                "fieldType": "String",
                "fieldDataFormat": "",
                "fieldWidth": 5,
                "fieldName": "ThreadName"
            },
            {
                "fieldType": "String",
                "fieldDataFormat": "",
                "fieldWidth": 5,
                "fieldName": "SourceFileName"
            },
            {
                "fieldType": "number",
                "fieldDataFormat": "",
                "fieldWidth": 4,
                "fieldName": "LineNumber"
            },
            {
                "fieldType": "String",
                "fieldDataFormat": "",
                "fieldWidth": 5,
                "fieldName": "Message"
            }
        ],
        "logtype_id": "4562000007138237",
        "log_pattern": "$LogLevel$ [$ThreadName$] $DateTime:date$ $SourceFileName$ (line $LineNumber:number$) $Message$",
        "display_name": "testUpdated",
        "description": "test decription updated",
        "api_upload": false,
        "fieldNames": [
            "DateTime",
            "LogLevel",
            "ThreadName",
            "SourceFileName",
            "LineNumber",
            "Message"
        ]
    }
}

Update the configuration of an existing log type.

oauthscope : Site24x7.Operations.Update

Path Parameters

Param	Type	Description
logtype_id	string	Mandatory Unique ID. This can be used as an identifier.

Request Parameters

Param	Type	Description
display_name	string	Mandatory A display name for the log type.
description	string	A description for the log type.
logtype	string	Mandatory Log Type name is a unique identifier for logs following the same format.
sample_log	string	Mandatory Sample log lines from the files for which you need to configure the log type.
log_pattern	string	Mandatory Log Pattern allows you to seperate your logs into relevant fields.
auto_discovery	boolean	You can send log events to AppLogs through our HTTPS endpoint.
searchable_days	int	Retention period of logs.
api_upload	boolean	Look for the particular log format across new servers that have been associated with this log type, and start uploading logs, if found.
max_upload_limit	string	The maximum amount of logs (for this log type) that you could upload during the current billing cycle.

Response Attributes

Attribute	Type	Description
logtype_id	string	Unique ID generated by the server. This can be used as an identifier.
log_pattern	string	Log Pattern allows you to seperate your logs into relevant fields.
display_name	string	A display name for the Log Type.
description	string	A description for the log type.
logtype	string	Log type name is a unique identifier for logs following the same format.
sample_log	string	Sample log lines from the files for which you need to configure the log type.
api_upload	boolean	Look for the particular log format across new servers that have been associated with this log type, and start uploading logs, if found.
auto_discovery	boolean	You can send log events to AppLogs through our HTTPS endpoint.
fields	array	Field names and field data format associated with the logs.
fieldValues	array	Segregating sample logs into separate fields.
fieldNames	array	Field names associated with the logs.
searchable_days	int	Retention period of logs.
max_upload_limit	string	The maximum amount of logs (for this log type) that you could upload during the current billing cycle.

Delete Log Type

DELETE /api/applog/logtype/{logtype_id}

Request Example

$ curl https://www.site24x7.com/api/applog/logtype/4562000007138237 \
    -X DELETE \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

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

Delete the existing log type.

oauthscope : Site24x7.Operations.Delete

Path Parameters

Param	Type	Description
logtype_id	string	Mandatory Unique ID. This can be used as an identifier.

List Log types

GET /api/applog/logtypes

Request Example

$ curl https://www.site24x7.com/api/applog/logtypes \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "success",
    "data": [
         {
           "logtype": "samplelogtype",
           "log_usage": "0",
           "max_upload_limit": "1",
           "api_upload": true,
           "log_pattern": "$LogLevel$ [$ThreadName$] $DateTime:date$ $SourceFileName$ (line $LineNumber:number$) $Message$",
           "searchable_days": 5,
           "logtype_id": "4562000007138237",
           "auto_discovery": true,
           "display_name": "testUpdated",
           "sample_log": "INFO [main] 2016-11-04 02:14:23,494 DatabaseDescriptor.java (line 143) Data files directories: [/home/local/Softwares/Cassandra/data]\nINFO [main] 2016-11-04 02:14:23,494 DatabaseDescriptor.java (line 143) Data files directories: [/home/local/Softwares/Cassandra/data]\nINFO [main] 2016-11-04 02:14:23,494 DatabaseDescriptor.java (line 143) Data files directories: [/home/local/Softwares/Cassandra/data]\nINFO [main] 2016-11-04 02:14:23,494 DatabaseDescriptor.java (line 143) Data files directories: [/home/local/Softwares/Cassandra/data]"
        },
       {..},
       {..}
     ]
}

List of all log types.

oauthscope : Site24x7.Operations.Read

Response Attributes

Attribute	Type	Description
logtype_id	string	Unique ID generated by the server. This can be used as an identifier.
logtype	string	Log type name is a unique identifier for logs following the same format.
log_usage	string	Amount of logs collected.
max_upload_limit	string	The maximum amount of logs (for this log type) that you could upload during the current billing cycle.
api_upload	boolean	Look for the particular log format across new servers that have been associated with this log type, and start uploading logs, if found.
log_pattern	string	Log Pattern allows you to seperate your logs into relevant fields.
searchable_days	int	Retention period of logs.
auto_discovery	boolean	You can send log events to AppLogs through our HTTPS endpoint.
display_name	string	A display name for the Log Type.
sample_log	string	Sample log lines from the files for which you need to configure the log type.

Applog Log Profiles

A Log Profile enables you to associate the log types to a particular set of servers.

Create a Log Profile

POST /api/applog/log_profiles

Request Example

$ curl https://www.site24x7.com/api/applog/log_profiles \
    -X POST \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \
    -d '{
      "source":1,
      "timezone":"Etc/GMT+12",
      "display_name":"automationTest",
      "logtype":"samplelogtype",
      "include_filenames":["/home/sas/include1/*","/home/sas/include2.log"],
      "exclude_filenames":["/home/sas/exclude1/*","/home/sas/exclude2.log"],
      "monitor_groups":["123412341234123416","123412341234123417"],
      "monitors":["113770000039133011","113770000039079003"]
    }'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "success",
    "data": {
        "source":1,
        "timezone":"Etc/GMT+12",
        "include_filenames":["/home/sas/include1/*","/home/sas/include2.log"],
        "exclude_filenames":["/home/sas/exclude1/*","/home/sas/exclude2.log"],
        "monitors":["113770000039133011","113770000039079003"],
        "logtype":"samplelogtype",
        "sample_log":"INFO [main] 2016-11-04 02:14:23,494 DatabaseDescriptor.java (line 143) Data files directories: [/home/local/Softwares/Cassandra/data]\nINFO [main] 2016-11-04 02:14:23,494 DatabaseDescriptor.java (line 143) Data files directories: [/home/local/Softwares/Cassandra/data]\nINFO [main] 2016-11-04 02:14:23,494 DatabaseDescriptor.java (line 143) Data files directories: [/home/local/Softwares/Cassandra/data]\nINFO [main] 2016-11-04 02:14:23,494 DatabaseDescriptor.java (line 143) Data files directories: [/home/local/Softwares/Cassandra/data]",
        "log_pattern":"$LogLevel$ [$ThreadName$] $DateTime:date$ $SourceFileName$ (line $LineNumber:number$) $Message$",
        "monitor_groups":["123412341234123416","123412341234123417"],
        "display_name":"automationTest",
        "profile_id":"312021000000639005"
     }
}

Once a Log Profile is created, corresponding logs will automatically be pushed to your account.

oauthscope : Site24x7.Operations.Create

Request Parameters

Param	Type	Description
source	int	Source type to be associated with this log profile.
timezone	string	Time zone for your logs.
display_name	string	Mandatory A display name for the log profile.
logtype	string	Mandatory Log type to be associated to this log profile.
include_filenames	array	Mandatory Includes the file path from which you want to collect the logs.
exclude_filenames	array	Mandatory Excludes the file path from which you doesn’t want to collect the logs.
monitor_groups	array	Mandatory,if any one of the monitors is not chosen. Monitor Groups to be associated to this log profile.
monitors	array	Mandatory,if any one of the monitor_groups is not chosen. Monitors to be associated to this log profile.

Response Attributes

Attribute	Type	Description
profile_id	string	Unique ID generated by the server. This can be used as an identifier.
log_pattern	string	Log pattern allows you to seperate your logs into relevant fields.
display_name	string	A display name for the Log profile.
logtype	string	Log type associated with the log profile.
sample_log	string	Sample log lines from the files for which you need to configure the log type.
source	int	Source type to be associated with this log profile.
timezone	string	Time zone for your logs.
include_filenames	array	Included file path from which you want to collect the logs.
exclude_filenames	array	Excluded file path from which you doesn’t want to collect the logs.
monitor_groups	array	It will list an array of all the associated monitor groups of the log profile.
monitors	array	It will list an array of all the associated monitors of the log profile.

Get Log Profile

GET /api/applog/log_profiles/{profile_id}

Request Example

$ curl https://www.site24x7.com/api/applog/log_profiles/312021000000639005 \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "success",
    "data": {
        "source":1,
        "timezone":"Etc/GMT+12",
        "include_filenames":["/home/sas/include1/*","/home/sas/include2.log"],
        "exclude_filenames":["/home/sas/exclude1/*","/home/sas/exclude2.log"],
        "monitors":["113770000039133011","113770000039079003"],
        "logtype":"samplelogtype",
        "sample_log":"INFO [main] 2016-11-04 02:14:23,494 DatabaseDescriptor.java (line 143) Data files directories: [/home/local/Softwares/Cassandra/data]\nINFO [main] 2016-11-04 02:14:23,494 DatabaseDescriptor.java (line 143) Data files directories: [/home/local/Softwares/Cassandra/data]\nINFO [main] 2016-11-04 02:14:23,494 DatabaseDescriptor.java (line 143) Data files directories: [/home/local/Softwares/Cassandra/data]\nINFO [main] 2016-11-04 02:14:23,494 DatabaseDescriptor.java (line 143) Data files directories: [/home/local/Softwares/Cassandra/data]",
        "log_pattern":"$LogLevel$ [$ThreadName$] $DateTime:date$ $SourceFileName$ (line $LineNumber:number$) $Message$",
        "monitor_groups":["123412341234123416","123412341234123417"],
        "display_name":"automationTest",
        "profile_id":"312021000000639005"
    }
}

Retrieve the configuration of a created log profile.

oauthscope : Site24x7.Operations.Read

Path Parameters

Param	Type	Description
profile_id	string	Mandatory Unique ID. This can be used as an identifier.

Response Attributes

Attribute	Type	Description
profile_id	string	Unique ID generated by the server. This can be used as an identifier.
log_pattern	string	Log Pattern allows you to seperate your logs into relevant fields.
display_name	string	A display name for the Log profile.
logtype	string	Log types associated with the log profile.
sample_log	string	Sample log lines from the files for which you need to configure the log type.
source	int	Source type to be associated with this log profile.
timezone	string	Time zone for your logs.
include_filenames	array	Included file path from which you want to collect the logs.
exclude_filenames	array	Excluded file path from which you doesn’t want to collect the logs.
monitor_groups	array	It will list an array of all the associated monitor groups of the log profile.
monitors	array	It will list an array of all the associated monitors of the log profile.

Update Log Profile

PUT /api/applog/log_profiles/{profile_id}

Request Example

$ curl https://www.site24x7.com/api/applog/log_profiles/312021000000639005 \
    -X PUT \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \
    -d '{
      "source":1,
      "timezone":"Pacific/Tahiti",
      "display_name":"automationTestUpdated",
      "logtype":"samplelogtype",
      "include_filenames":["/home/sas/include1/*","/home/sas/include2.log"],
      "exclude_filenames":["/home/sas/exclude1/*","/home/sas/exclude2.log"],
      "monitor_groups":["123412341234123416","123412341234123417","12341234123412378"],
      "monitors":["113770000039133011"]
    }'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "success",
    "data": {
        "source":1,
        "timezone":"Pacific/Tahiti",
        "include_filenames":["/home/sas/include1/*","/home/sas/include2.log"],
        "exclude_filenames":["/home/sas/exclude1/*","/home/sas/exclude2.log"],
        "monitors":["113770000039133011"],
        "logtype":"samplelogtype",
        "sample_log":"INFO [main] 2016-11-04 02:14:23,494 DatabaseDescriptor.java (line 143) Data files directories: [/home/local/Softwares/Cassandra/data]\nINFO [main] 2016-11-04 02:14:23,494 DatabaseDescriptor.java (line 143) Data files directories: [/home/local/Softwares/Cassandra/data]\nINFO [main] 2016-11-04 02:14:23,494 DatabaseDescriptor.java (line 143) Data files directories: [/home/local/Softwares/Cassandra/data]\nINFO [main] 2016-11-04 02:14:23,494 DatabaseDescriptor.java (line 143) Data files directories: [/home/local/Softwares/Cassandra/data]",
        "log_pattern":"$LogLevel$ [$ThreadName$] $DateTime:date$ $SourceFileName$ (line $LineNumber:number$) $Message$",
        "monitor_groups":["123412341234123416","123412341234123417",,"12341234123412378"],
        "display_name":"automationTestUpdated",
        "profile_id":"312021000000639005"
    }
}

Update the configuration of an existing log profile.

oauthscope : Site24x7.Operations.Update

Path Parameters

Param	Type	Description
profile_id	string	Mandatory Unique ID. This can be used as an identifier.

Request Parameters

Param	Type	Description
source	int	Source type to be associated with this log profile.
timezone	string	Time zone for your logs.
display_name	string	Mandatory A display name for the log profile.
logtype	string	Mandatory Log Type to be associated to this log profile.
include_filenames	array	Mandatory Includes the file path from which you want to collect the logs.
exclude_filenames	array	Mandatory Excludes the file path from which you doesn’t want to collect the logs.
monitor_groups	array	Mandatory,if any one of the monitors is not chosen. Monitor Groups to be associated to this log profile.
monitors	array	Mandatory,if any one of the monitor_groups is not chosen. Monitors to be associated to this log profile.

Response Attributes

Attribute	Type	Description
profile_id	string	Unique ID generated by the server. This can be used as an identifier.
log_pattern	string	Log Pattern allows you to seperate your logs into relevant fields.
display_name	string	A display name for the Log profile.
logtype	string	Log type associated to this log profile.
sample_log	string	Sample log lines from the files for which you need to configure the log type.
source	int	Source type to be associated with this log profile.
timezone	string	Time zone for your logs.
include_filenames	array	Included file path from which you want to collect the logs.
exclude_filenames	array	Excluded file path from which you doesn’t want to collect the logs.
monitor_groups	array	It will list an array of all the associated monitor groups of the log profile.
monitors	array	It will list an array of all the associated monitors of the log profile.

Delete Log Profile

DELETE /api/applog/log_profiles/{profile_id}

Request Example

$ curl https://www.site24x7.com/api/applog/log_profiles/312021000000639005 \
    -X DELETE \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

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

Delete the existing log profile.

oauthscope : Site24x7.Operations.Delete

Path Parameters

Param	Type	Description
profile_id	string	Mandatory Unique ID. This can be used as an identifier.

List Log Profiles

GET /api/applog/log_profiles

Request Example

$ curl https://www.site24x7.com/api/applog/log_profiles \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "success",
    "data":[
        {
            "created_time": 1530860656345,
            "logtype": "samplelogtype",
            "profile_id": "312021000000639005",
            "monitors_count": 1,
            "source": 1,
            "timezone":"Pacific/Tahiti",
            "display_name": "automationTestUpdated",
            "logtype_display_name": "testUpdated",
            "include_filenames": "/home/sas/include1/*, /home/sas/include2.log",
            "exclude_filenames":"/home/sas/exclude1/*","/home/sas/exclude2.log",
            "monitors": [
                  {
                    "status": [
                        {
                            "error_reason": [
                                {
                                    "lmt": "98 days 0 Hrs 49 Mins ago",
                                    "fileName": "/home/local/Downloads/loadtest/dh/homepage*.txt"
                                }
                            ],
                            "error_code": 1002,
                            "error_title": "Recent Files Not Found"
                        }
                    ],
                    "last_communicated_duration": "98 days 0 Hrs 37 Mins ago",
                    "display_name": "i-014dc0d0b9eb4ef9b",
                    "row_bg": "bgred",
                    "monitor_id": "4562000004670003"
                }
               ]
            },
            {..},
            {..}
          ]
}

List of all log profiles.

oauthscope : Site24x7.Operations.Read

Response Attributes

Attribute	Type	Description
profile_id	string	Unique ID generated by the server. This can be used as an identifier.
display_name	string	A display name for the log profile.
logtype	string	Log type associated to this log profile.
logtype_display_name	string	Log type name associated to the log profile.
source	int	Source type to be associated with this log profile.
timezone	string	Time zone for your logs.
monitors_count	int	Count of monitors assocaited with the log profile.
created_time	long	Time at which the log profile was created.
include_filenames	array	Includes the file path from which you want to collect the logs.
exclude_filenames	array	Excludes the file path from which you doesn’t want to collect the logs.
monitor_groups	array	It will list an array of all the associated monitor groups of the log profile.
monitors	array	It will list an array of all the associated monitors of the log profile.

Credential Profiles

Credential Profile helps you easily add and associate credentials with monitors

Create Credential Profile

POST /credential_profile

Request Example

$ curl https://www.site24x7.com/api/credential_profile \
    -X POST \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \
    -d '{
    "credential_type": "3",
    "credential_name": "Admin Profile",
    "username":"Zylker Username",
    "password":"Zylker Password",
}'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "success",
    "data":    {
        "credential_profile_id": "726000000002465",
        "credential_name": "Admin Profile",
        "credential_type":"3",
    "is_credential_associated":"false",
    "username":"Zylker Username"

  }
}

Create a new Credential Profile.

oauthscope : Site24x7.Admin.Create

Request Parameters

Param	Type	Description
credential_name	string	Mandatory Name for the Credential profile.
username	string	Mandatory Username of Credential.
password	string	Password of Credential.
credential_type	int	Mandatory Credential Type ID ( 1=VCenter, 2=VMwareESX 3=Website Credential)

Response Attributes

Attribute	Type	Description
credential_profile_id	string	Unique ID generated by the server for the Credential profile.
credential_name	string	Display name for the Credential profile.
credential_type	int	Credential Type ID ( 1=VCenter, 2=VMwareESX 3=Website Credential)
username	string	Username of Credential.
is_credential_associated	boolean	Indicates if credential is associated with any Monitor.

Update a Credential Profile

PUT /credential_profile/{profile_id}

Request Example

$ curl https://www.site24x7.com/api/credential_profile\726000000002465 \
    -X PUT \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \
    -d '{
    "credential_profile_id": "726000000002465",
    "credential_type":2,
    "credential_name": "Zylker Credential",
    "username":"Zylker Password",
    "password":"Zylker Password"

}'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "success",
    "data":    {
    "is_credential_associated": true,
    "credential_type": 2,
    "credential_name": "Zylker Credential",
    "credential_profile_id":"726000000002465",
    "username":"Zylker Username",
    "password":"Zylker Password"

  }
}

Update an existing Credential Profile.

oauthscope : Site24x7.Admin.Update

Path Parameters

Param	Type	Description
credential_profile_id	string	Mandatory Unique ID generated by the server for the location profile.

Attribute	Type	Description
credential_profile_id	string	Mandatory Unique ID generated by the server for the location profile.
credential_type	int	Mandatory Type of Credential ( 1=VCenter, 2=VMwareESX 3=Website Credential)
credential_name	String	Mandatory Name of Credential
username	String	Mandatory Username Associated Credential
password	String	Password associated to Credential

Response Attributes

Attribute	Type	Description
credential_profile_id	string	Mandatory Unique ID generated by the server for the location profile.
credential_type	int	Mandatory Type of Credential ( 1=VCenter, 2=VMwareESX 3=Website Credential)
credential_name	String	Name of Credential
username	String	Username Associated Credential

Delete an existing Credential profile.

DELETE /credential_profile/{profile_id}

Request Example

$ curl https://www.site24x7.com/api/credential_profile/726000000002465 \
    -X DELETE \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

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

Delete an existing Credential Profile.

oauthscope : Site24x7.Admin.Delete

Path Parameters

Param	Type	Description
credential_profile_id	string	Mandatory Unique ID generated by the server for the Credential profile.

List of all Credential Profiles

GET /credential_profiles

Request Example

$ curl https://www.site24x7.com/api/credential_profiles \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data":
  [
    {
      "credential_profile_id": "726000000002465",
      "credential_name": "Admin Credential",
      "is_credential_associated": "true",
      "associated_monitor_count": "2",
      "username":Zylker Username,
      "credential_type":"2"

    }
    {..},
    {..}
  ]
}

List of all Credential Profiles.

oauthscope : Site24x7.Admin.Read

Response Attributes

Attribute	Type	Description
credential_profile_id	string	Unique ID generated by the server for the Credential profile.
credential_name	string	Display name for the Credential profile.
credential_type	int	Credential Type ID ( 1=VCenter, 2=VMwareESX 3=Website Credential)
is_credential_associated	boolean	Indicates if credential is associated with any Monitor.
associated_monitor_count	int	Count of Monitors associated with Credential.

On-Premise Poller

Monitor your internal network, resources behind a firewall or virtual private network (VPN), and user experience from different branch offices.

Configure a Standby On-Premise Poller

PUT /poller/{primary_poller_id}/configure_ha_poller/{failover_poller_id}

Request Example

$ curl https://www.site24x7.com/api/poller/726000000002460/configure_ha_poller/726000000002462 \
    -X PUT \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Accept: application/json; version=2.0" \
    -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7ab2d1.8fcc9810810a216793f385b9dd6e125f" \
    -d '{
}'

Sample Response

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "status": "success",
  "primary_poller_id":"726000000002460",
  "failover_poller_id":"726000000002462"
}

Configure a Standby On-Premise Poller for High Availability

oauthscope : Site24x7.Admin.Update

Path Parameters

Param	Type	Description
primary_poller_id	int	Mandatory On-Premise Poller ID of Primary On-Premise Poller
failover_poller_id	int	Mandatory On-Premise Poller ID of Standby On-Premise Poller

Response Attributes

Attribute	Type	Description
status	string	status of the operation
primary_poller_id	int	Mandatory On-Premise Poller ID of Primary On-Premise Poller
failover_poller_id	int	Mandatory On-Premise Poller ID of Standby On-Premise Poller