API Documentation
User Guide Contact Us

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

Japan
https://app.site24x7.jp/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:

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

For Japan DC, the API Root Endpoint would be https://app.site24x7.jp

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

Japan
https://accounts.zoho.jp

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:

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.
  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 List of scopes (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

POST https://accounts.zoho.com/oauth/v2/token?client_id={client_id}&client_secret={client_secret}&code={code}&grant_type=authorization_code

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:

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.

Note:

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.

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

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

POST https://accounts.zoho.com/oauth/v2/token?client_id={client_id}&client_secret={client_secret}&refresh_token={refresh_token}&grant_type=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.

Note:

Make the following POST request with the given params to get a new access 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

POST https://accounts.zoho.com/oauth/v2/token/revoke?token={refresh_token}

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

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.

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

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

MSP 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
4 Maximum
5 Minimum

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
FILEUPLOAD File Upload
GRPC gRPC
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
VEEAM_ENTERPRISEMANAGER Veeam Enterprise Manager 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
EBSVOLUME_AVAIL EBS Volume
AWSBATCH AWS Batch
AWSBATCH-QUEUE AWS Batch Queue
EBS_SNAPSHOT EBS Snapshot
SECRET-MANAGER AWS Secret Manager
SECRET-MANAGER-REGIONAL AWS Secret Manager Regional
ELASTIC-IP-ADDRESS Elastic IP
PROCSTAT Procstat
VPC_META Virtual Private Cloud
VPC_REGIONAL VPC Region
VPC_AZ VPC Availability Zone
VPC VPC
VPC_NI VPC Subnet
VPC_NI VPC Network Interface
VPC_PROTOCOL VPC Protocol
VPC_RT VPC Route Table
MSK_TOPIC MSK Topic
MSK_BROKER MSK Broker
MSK_CLUSTER MSK Cluster
MSK_CONNECT MSK Connect
MSK_REPLICATOR MSK Replicator
MSK_SERVERLESS MSK Serverless
TRUSTED-ADVISOR-CATEGORY AWS Trusted Advisor Category
TRUSTED-ADVISOR-CHECKS AWS Trusted Advisor Checks
TGW_FLOW_LOGS Transit Gateway Flow Logs Monitor
TGWATT_FLOW_LOGS Transit Gateway Attachment Flow Logs Monitor
GLUE-JOB Glue Job Monitor
GLUE-CRAWLER Glue Crawler Monitor
RABBIT_MQ RabbitMQ Broker
RABBIT_MQ_QUEUE RabbitMQ Queue
RABBIT_MQ_NODE RabbitMQ Node
DRSREGION DRS Region
DRS-SOURCE-SERVER DRS Source Server
DRS-RECOVERY-INSTANCE DRS Recovery Instance

List Monitor Types

Get the monitor type list.

GET /api/monitor_type_constants

Request Example

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

Response Example


{
    "code": 0,
    "message": "success",
    "data": [
        {
            "name": "Capacity Planning",
            "id": "CAPACITY"
        },
        {
            "name": "Server Capacity",
            "id": "SERVER_CAPACITY"
        },
        {
            "name": "On-Premise Poller Capacity",
            "id": "PROBE_CAPACITY"
        }
    ]
}

oauthscope : Site24x7.Admin.Read

Response Attributes

Attribute Type Description
id string Monitor type ID.
name string Name of the monitor type in Site24x7.

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
88 Elastic IP
92 AWS Batch
93 AWS Batch Queue
95 AWS Secret Manager
113 AWS MSK Replicator
114 AWS MSK Connect
116 AWS MSK Clusterl
122 AWS Glue
127 RabbitMQ

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
84 VPC
87 EBS Volume
88 Elastic IP
92 AWS Batch
93 AWS Batch Queue
94 EBS Snapshot
95 AWS Secret Manager
96 AWS Secret Manager Regional
97 VPC Region
98 VPC Availability Zone
99 VPC Subnet
100 VPC Network Interface
101 VPC Protocol
109 Virtual Private Cloud
111 VPC Route Table
110 Transit Gateway Attachment Flow Logs
112 Transit Gateway Flow Logs
113 MSK Replicator
114 MSK Connect
116 MSK Cluster
122 Glue Job
124 Glue Crawler

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

Customize your own HTTP Method for API monitoring (REST API and REST API Transaction) if your preferred method is not available in the options provided. (E.x.) UPDATE, MERGE

ID HTTP Method
P POST
G GET
H HEAD
U PUT
D DELETE
A PATCH
F PROPFIND
PROPPATCH PROPPATCH
MKCOL MKCOL
CONNECT CONNECT
OPTIONS OPTIONS
TRACE TRACE
COPY COPY
MOVE MOVE
LOCK LOCK
UNLOCK UNLOCK

HTTP Protocol Constants

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

Internnet Protocol Constants

ID Internet Protocol
0 Monitoring is performed over IPv4 from supported locations
1 Monitoring is performed over IPv6 from supported locations
2 IPv4 or IPv6 option will help in flexibly switching to the protocol that is supported in a particular location if one protocol fails.
3 IPv4 and IPv6 will create two connections for each protocol.

Secondary Resource Alert Severity Constants

ID Alert Severity
2 Trouble
3 Critical

Primary Internet Protocol Constants

ID Protocol
0 IPv4
1 IPv6

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

IP TYPE

ID Ip Type
0 use only ipv4
1 use only ipv6
2 use both ipv4 and ipv6

Browser Type Constants

Indicates which browser will be used for monitoring.

ID Type
1 Firefox
2 Chrome
VERSION Type
83 Firefox
88 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
A AWS Signature

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 Protocol type Constants

ID Type
0 UDP
1 TCP

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
6 Matches
7 Starts With
8 Ends With

Threshold Strategy Constants

ID Strategy
1 Poll Count
2 Poll Avg
3 Time Range
4 Avg Time
5 Poll Sum
6 Time Sum
7 Min Poll
8 Min Time
9 Max Poll
10 Max Time
11 95th percentile Poll
12 95th percentile 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

Data Collection Constants

ID Type
1 Normal
2 Secondary Recheck
3 Poll Now
4 Screenshot
5 Hourly Poll
6 Uptime Steroid
7 Up Screenshot
8 Retry
9 Down Recheck
10 Other ISP

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

IT Automation Resource Type Constants

ID Type
1 Monitor
2 Monitor Group
4 Tags

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.
EBSVOLUME_AVAIL
volume_count The number of available volumes in the region.
volume_count_used The number of attached volumes in the region.
volume_count_created The count of unattached volumes created since the last poll in that region.
volume_count_created_used The count of attached volumes created since the last poll in that region.
tot_volume_size The sum of all unattached volumes size in the region.
tot_volume_size_used The sum of all attached volumes size in the region.
snap_count The number of snapshots in the region.
snap_count_created The snapshot count created since last poll in that region.
tot_snap_size The sum of all snapshots' size in the region.
volume_size The volume size.
volume_age The volume age.
snapshot_count The number of snapshots in the volume.
snap_size The snapshot size.
snap_age The snapshot age.
AWSBATCH
total_succeeded The total number of succeeded jobs in the queues attached to the compute environment.
total_failed The total number of failed jobs in the queues attached to the compute environment.
total_submitted The total number of submitted jobs in the queues attached to the compute environment.
total_pending The total number of pending jobs in the queues attached to the compute environment.
total_runnable The total number of runnable jobs in the queues attached to the compute environment.
total_starting The total number of starting jobs in the queues attached to the compute environment.
total_running The total number of running jobs in the queues attached to the compute environment.
AWSBATCH-QUEUE
succeeded The number of succeeded jobs in the queue.
failed The number of failed jobs in the queue.
submitted The number of submitted jobs in the queue.
pending The number of pending jobs in the queue.
runnable The number of runnable jobs in the queue.
running The number of running jobs in the queue.
starting The number of starting jobs in the queue.
EBS_SNAPSHOT
snap_count The number of snapshots in the ebs volume.
snap_count_created The count of snapshots created since the last poll in that ebs volume.
tot_snap_size The sum of all snapshots size in the ebs volume.
snap_size The snapshot size.
snap_age The snapshot age.
SECRET-MANAGER
secret_changed The value gets updated to one when a secret change happens.
secret_rotated The value gets updated to one when a secret rotation happens.
SECRET-MANAGER-REGIONAL
resource_count The number of secrets in your account, including secrets that are marked for deletion.
rotate_secret_call_count The number of times a rotate secret call occurs for the secrets.
ELASTIC-IP-ADDRESS
total_ips The total number of IP addresses in a region with the same address pool (Amazon- or customer-owned pool).
total_associated_ips The total number of associated IP addresses in a region with the same address pool (Amazon- or customer-owned pool).
total_disassociated_ips The total number of disassociated IP addresses in a region with the same address pool (Amazon- or customer-owned pool).
total_vpc_ips The number of VPC Domain IP addresses in a region with the same address pool (Amazon- or customer-owned pool).
PROCSTAT
cpu_usage The amount of CPU utilized by the process.
VPC_META
number_of_region_up The total number of Region monitors in available status in the Amazon account.
number_of_region_trouble The total number of Region monitors in trouble status in the Amazon account.
number_of_region_critical The total number of Region monitors in critical status in the Amazon account.
number_of_az_up The total number of Availability Zone monitors in available status in the Amazon account.
number_of_az_trouble The total number of Availability Zone monitors in trouble status in the Amazon account.
number_of_az_critical The total number of Availability Zone monitors in critical status in the Amazon account.
number_of_vpc_up The total number of VPC monitors in available status in the Amazon account.
number_of_vpc_trouble The total number of VPC monitors in trouble status in the Amazon account.
number_of_vpc_critical The total number of VPC monitors in critical status in the Amazon account.
number_of_subnet_up The total number of Subnet monitors in available status in the Amazon account.
number_of_subnet_trouble The total number of Subnet monitors in trouble status in the Amazon account.
number_of_subnet_critical The total number of Subnet monitors in critical status in the Amazon account.
number_of_ni_up The total number of Network Interface monitors in available status in the Amazon account.
number_of_ni_trouble The total number of Network Interface monitors in trouble status in the Amazon account.
number_of_ni_critical The total number of Network Interface monitors in critical status in the Amazon account.
number_of_protocol_up The total number of Protocol monitors in available status in the Amazon account.
number_of_protocol_trouble The total number of Protocol monitors in trouble status in the Amazon account.
number_of_protocol_critical The total number of Protocol monitors in critical status in the Amazon account.
number_of_rt_up The total number of Route Table monitors in available status in the Amazon account.
VPC_REGIONAL
tot_rx_volume The total amount of received (Rx) traffic volumes in a region.
min_rx_volume The minimum amount of received traffic volume in a region.
max_rx_volume The maximum amount of received traffic volume in a region.
tot_rx_packet The total number of received traffic packets in a region.
min_rx_packet The minimum number of received traffic packets in a region.
max_rx_packet The maximum number of received traffic packets in a region.
tot_tx_volume The total amount of transmitted (Tx) traffic volumes in a region.
min_tx_volume The minimum amount of transmitted traffic volume in a region.
max_tx_volume The maximum amount of transmitted traffic volume in a region.
tot_tx_packet The total number of transmitted traffic packets in a region.
min_tx_packet The number of minimum transmitted traffic packets in a region.
max_tx_packet The number of maximum transmitted traffic packets in a region.
avg_rx_packet_size The average received packet size in a region.
avg_tx_packet_size The average transmitted packet size in a region.
tot_volume The total traffic volumes in a region.
tot_packet The total traffic packets in a region
in_traffic The total incoming traffic throughput in a region.
out_traffic The total outgoing traffic throughput in a region.
tot_traffic The total traffic throughput in a region.
accepted_requests The total number of accepted requests in a region.
rejected_requests The total number of rejected requests in a region.
skipped_records The total number of skipped records in a region.
nodata_records The total number of no data records in a region.
tot_free_ip The total number of free IPs in a region.
tot_ni The total number of network interfaces in a region.
tot_subnet The total number of Subnets in a region.
tot_vpc The total number of VPCs in a region.
VPC_AZ
tot_rx_volume The total amount of received (Rx) traffic volumes in an availability zone.
min_rx_volume The minimum amount of received traffic volume in an availability zone.
max_rx_volume The maximum amount of received traffic volume in an availability zone.
tot_rx_packet The total number of received traffic packets in an availability zone.
min_rx_packet The minimum number of received traffic packets in an availability zone.
max_rx_packet The maximum number of received traffic packets in an availability zone.
tot_tx_volume The total amount of transmitted (Tx) traffic volumes in an availability zone.
min_tx_volume The minimum amount of transmitted traffic volume in an availability zone.
max_tx_volume The maximum amount of transmitted traffic volume in an availability zone.
tot_tx_packet The total number of transmitted traffic packets in an availability zone.
min_tx_packet The number of minimum transmitted traffic packets in an availability zone.
max_tx_packet The number of maximum transmitted traffic packets in an availability zone.
avg_rx_packet_size The average received packet size in an availability zone.
avg_tx_packet_size The average transmitted packet size in an availability zone.
tot_volume The total traffic volumes in an availability zone.
tot_packet The total traffic packets in a region
in_traffic The total incoming traffic throughput in an availability zone.
out_traffic The total outgoing traffic throughput in an availability zone.
tot_traffic The total traffic throughput in an availability zone.
accepted_requests The total number of accepted requests in an availability zone.
rejected_requests The total number of rejected requests in an availability zone.
skipped_records The total number of skipped records in an availability zone.
nodata_records The total number of no data records in an availability zone.
tot_free_ip The total number of free IPs in an availability zone.
tot_ni The total number of network interfaces in an availability zone.
tot_subnet The total number of Subnets in an availability zone.
VPC
tot_rx_volume The total amount of received (Rx) traffic volumes in a VPC.
min_rx_volume The minimum amount of received traffic volume in a VPC.
max_rx_volume The maximum amount of received traffic volume in a VPC.
tot_rx_packet The total number of received traffic packets in a VPC.
min_rx_packet The minimum number of received traffic packets in a VPC.
max_rx_packet The maximum number of received traffic packets in a VPC.
tot_tx_volume The total amount of transmitted (Tx) traffic volumes in a VPC.
min_tx_volume The minimum amount of transmitted traffic volume in a VPC.
max_tx_volume The maximum amount of transmitted traffic volume in a VPC.
tot_tx_packet The total number of transmitted traffic packets in a VPC.
min_tx_packet The number of minimum transmitted traffic packets in a VPC.
max_tx_packet The number of maximum transmitted traffic packets in a VPC.
avg_rx_packet_size The average received packet size in a VPC.
avg_tx_packet_size The average transmitted packet size in a VPC.
tot_volume The total traffic volumes in a VPC.
tot_packet The total traffic packets in a region
in_traffic The total incoming traffic throughput in a VPC.
out_traffic The total outgoing traffic throughput in a VPC.
tot_traffic The total traffic throughput in a VPC.
accepted_requests The total number of accepted requests in a VPC.
rejected_requests The total number of rejected requests in a VPC.
skipped_records The total number of skipped records in a VPC.
nodata_records The total number of no data records in a VPC.
tot_free_ip The total number of free IPs in a VPC.
tot_ni The total number of network interfaces in a VPC.
tot_subnet The total number of Subnets in a VPC.
VPC_SUBNET
tot_rx_volume The total amount of received (Rx) traffic volumes in a subnet.
min_rx_volume The minimum amount of received traffic volume in a subnet.
max_rx_volume The maximum amount of received traffic volume in a subnet.
tot_rx_packet The total number of received traffic packets in a subnet.
min_rx_packet The minimum number of received traffic packets in a subnet.
max_rx_packet The maximum number of received traffic packets in a subnet.
tot_tx_volume The total amount of transmitted (Tx) traffic volumes in a subnet.
min_tx_volume The minimum amount of transmitted traffic volume in a subnet.
max_tx_volume The maximum amount of transmitted traffic volume in a subnet.
tot_tx_packet The total number of transmitted traffic packets in a subnet.
min_tx_packet The number of minimum transmitted traffic packets in a subnet.
max_tx_packet The number of maximum transmitted traffic packets in a subnet.
avg_rx_packet_size The average received packet size in a subnet.
avg_tx_packet_size The average transmitted packet size in a subnet.
tot_volume The total traffic volumes in a subnet.
tot_packet The total traffic packets in a region
in_traffic The total incoming traffic throughput in a subnet.
out_traffic The total outgoing traffic throughput in a subnet.
tot_traffic The total traffic throughput in a subnet.
accepted_requests The total number of accepted requests in a subnet.
rejected_requests The total number of rejected requests in a subnet.
skipped_records The total number of skipped records in a subnet.
nodata_records The total number of no data records in a subnet.
tot_free_ip The total number of free IPs in a subnet.
tot_ni The total number of network interfaces in a subnet.
VPC_NI
tot_rx_volume The total amount of received (Rx) traffic volumes in a network interface.
min_rx_volume The minimum amount of received traffic volume in a network interface.
max_rx_volume The maximum amount of received traffic volume in a network interface.
tot_rx_packet The total number of received traffic packets in a network interface.
min_rx_packet The minimum number of received traffic packets in a network interface.
max_rx_packet The maximum number of received traffic packets in a network interface.
tot_tx_volume The total amount of transmitted (Tx) traffic volumes in a network interface.
min_tx_volume The minimum amount of transmitted traffic volume in a network interface.
max_tx_volume The maximum amount of transmitted traffic volume in a network interface.
tot_tx_packet The total number of transmitted traffic packets in a network interface.
min_tx_packet The number of minimum transmitted traffic packets in a network interface.
max_tx_packet The number of maximum transmitted traffic packets in a network interface.
avg_rx_packet_size The average received packet size in a network interface.
avg_tx_packet_size The average transmitted packet size in a network interface.
tot_volume The total traffic volumes in a network interface.
tot_packet The total traffic packets in a region
in_traffic The total incoming traffic throughput in a network interface.
out_traffic The total outgoing traffic throughput in a network interface.
tot_traffic The total traffic throughput in a network interface.
accepted_requests The total number of accepted requests in a network interface.
rejected_requests The total number of rejected requests in a network interface.
skipped_records The total number of skipped records in a network interface.
nodata_records The total number of no data records in a network interface.
VPC_PROTOCOL
tot_rx_volume The total amount of received (Rx) traffic volumes in a protocol in network interface.
min_rx_volume The minimum amount of received traffic volume in a protocol in network interface.
max_rx_volume The maximum amount of received traffic volume in a protocol in network interface.
tot_rx_packet The total number of received traffic packets in a protocol in network interface.
min_rx_packet The minimum number of received traffic packets in a protocol in network interface.
max_rx_packet The maximum number of received traffic packets in a protocol in network interface.
tot_tx_volume The total amount of transmitted (Tx) traffic volumes in a protocol in network interface.
min_tx_volume The minimum amount of transmitted traffic volume in a protocol in network interface.
max_tx_volume The maximum amount of transmitted traffic volume in a protocol in network interface.
tot_tx_packet The total number of transmitted traffic packets in a protocol in network interface.
min_tx_packet The number of minimum transmitted traffic packets in a protocol in network interface.
max_tx_packet The number of maximum transmitted traffic packets in a protocol in network interface.
avg_rx_packet_size The average received packet size in a protocol in network interface.
avg_tx_packet_size The average transmitted packet size in a protocol in network interface.
tot_volume The total traffic volumes in a protocol in network interface.
tot_packet The total traffic packets in a region
in_traffic The total incoming traffic throughput in a protocol in network interface.
out_traffic The total outgoing traffic throughput in a protocol in network interface.
tot_traffic The total traffic throughput in a protocol in network interface.
accepted_requests The total number of accepted requests in a protocol in network interface.
rejected_requests The total number of rejected requests in a protocol in network interface.
TRUSTED-ADVISOR-CATEGORY
red_checks The number of checks that are recommended to take an action.
yellow_checks The number of checks that are recommended for an investigation.
green_checks The number of checks without problems.
TRUSTED-ADVISOR-CHECKS
red_resources The number of resources that are in red state (action recommended).
yellow_resources The number of resources that are in yellow state (investigation recommended).
green_resources The number of resources that are in green state (no issues detected).
MSK Topic
topic_bytes_in_persec Number of bytes per second received from clients.
topic_bytes_out_persec Number of bytes per second sent to clients.
topic_msg_in_persec Number of incoming messages per second for the topic.
topic_fet_msg_conv_persec Number of fetch message conversions per second.
topic_prod_msg_conv_persec Number of produce message conversions per second.
topic_rem_bytes_in_persec Number of bytes transferred from tiered storage in response to consumer fetches for the specified topic and broker.
topic_rem_bytes_out_persec Number of bytes transferred to tiered storage for the specified topic and broker.
topic_rem_read_err_persec Rate of errors in response to read requests that the specified broker sends to tiered storage to retrieve data in response to consumer fetches on the specified topic.
topic_rem_read_req_persec Number of read requests that the specified broker sends to tiered storage to retrieve data in response to consumer fetches on the specified topic.
topic_rem_write_err_persec Rate of errors in response to write requests that the specified broker sends to tiered storage to transfer data upstream.
MSK Broker
kafka_burst_balance Available credit balance for the EBS volumes in the cluster.
kafka_cli_connection_count Number of active authenticated client connections.
kafka_connection_count Number of active authenticated, unauthenticated, and inter-broker connections.
kafka_cpu_credit_balance Number of earned CPU credits used by a broker.
kafka_cpu_idle The percentage of CPU idle time.
kafka_cpu_io_wait CPU idle time during a pending disk operation.
kafka_cpu_system Percentage of CPU time in kernel space.
kafka_cpu_user Percentage of CPU time in user space.
kafka_applogs_disk_used Disk space used for application logs.
kafka_broker_datalogs_disk_used Disk space used for data logs.
kafka_leader_count Number of leaders for the partitions without including replicas.
kafka_memory_buffered The size in bytes of buffered memory for the broker.
kafka_memory_cached The size in bytes of cached memory for the broker.
kafka_memory_free The size in bytes of memory that is free and available for the broker.
kafka_heap_memory_after_gc Total heap memory in use after garbage collection.
kafka_memory_used Memory in use by the broker.
kafka_messages_in_per_sec Number of messages received per second.
kafka_net_rx_dropped Number of dropped receive packages.
kafka_net_rx_err Number of network receive errors for the broker.
kafka_net_rx_packets Number of packets received by the broker.
kafka_net_tx_dropped Number of dropped transmit packages.
kafka_net_tx_err Number of network transmit errors for the broker.
kafka_net_tx_packets Number of packets transmitted by the broker.
kafka_offline_partitions_count Total number of partitions that are offline in the cluster.
kafka_partition_count Number of partitions per broker, including replicas.
kafka_produce_totaltime_msmean Mean produce time in milliseconds.
kafka_req_bytes_mean Average number of request bytes for the broker.
kafka_req_time Average time spent in broker network and I/O threads to process requests.
kafka_root_disk_used Percentage of the root disk used by the broker.
kafka_swap_free Swap memory available for the broker.
kafka_swap_used Swap memory in use by the broker.
kafka_traffic_shaping Number of packets shaped (dropped or queued) due to exceeding network allocations.
kafka_undermin_isr_partition_count Number of under minIsr partitions for the broker.
kafka_under_replicated_partitions Number of under-replicated partitions for the broker.
kafka_zookeeper_req_latency_msmean Mean latency for Apache ZooKeeper requests from the broker.
kafka_zookeeper_session_state Connection status of the broker’s ZooKeeper session.
kafka_bw_in_allowance_exceeded The number of packets shaped because the inbound aggregate bandwidth exceeded the maximum for the broker.
kafka_bw_out_allowance_exceeded The number of packets shaped because the outbound aggregate bandwidth exceeded the maximum for the broker.
kafka_conn_track_allowance_exceeded The number of packets shaped because the connection tracking exceeded the maximum for the broker.
kafka_connection_close_rate The number of connections closed per second per listener.
kafka_connection_creation_rate The number of new connections established per second per listener.
kafka_cpu_credit_usage The number of CPU credits spent by the broker.
kafka_fet_cons_localtime_msmean The mean time in milliseconds that the consumer request is processed at the leader.
kafka_fet_cons_req_queue_time_ms_mean The mean time in milliseconds that the consumer request waits in the request queue.
kafka_fet_cons_resp_queuetime_msmean The mean time in milliseconds that the consumer request waits in the response queue.
kafka_fet_cons_resp_sendtime_msmean The mean time in milliseconds for the consumer to send a response.
kafka_fet_cons_tottime_msmean The mean total time in milliseconds that consumers spend on fetching data from the broker.
kafka_fet_foll_loctime_msmean The mean time in milliseconds that the follower request is processed at the leader.
kafka_fet_foll_req_queue_time_msmean The mean time in milliseconds that the follower request waits in the request queue.
kafka_fet_foll_resp_queue_time_msmean The mean time in milliseconds that the follower request waits in the response queue.
kafka_fet_foll_resp_sendtime_msmean The mean time in milliseconds for the follower to send a response.
kafka_fet_foll_tottime_ms_mean The mean total time in milliseconds that followers spend on fetching data from the broker.
kafka_fet_msg_conv_persec The number of fetch message conversions per second for the broker.
kafka_fet_throt_byte_rate The number of throttled bytes per second.
kafka_fet_throt_queue_size The number of messages in the throttle queue.
kafka_fet_throt_time The average fetch throttle time in milliseconds.
kafka_net_proc_avg_idle_percent The average percentage of the time the network processors are idle.
kafka_pps_allowance_exceeded The number of packets shaped because the bidirectional PPS exceeded the maximum for the broker.
kafka_prod_loctime_msmean The mean time in milliseconds that the request is processed at the leader.
kafka_prod_msg_conv_persec The number of produce message conversions per second for the broker.
kafka_prod_msg_conv_time_msmean The mean time in milliseconds spent on message format conversions.
kafka_prod_req_queue_time_msmean The mean time in milliseconds that request messages spend in the queue.
kafka_prod_resp_queue_time_msmean The mean time in milliseconds that response messages spend in the queue.
kafka_prod_resp_sendtime_msmean The mean time in milliseconds spent on sending response messages.
kafka_prod_throt_byte_rate The number of throttled bytes per second.
kafka_prod_throt_queue_size The number of messages in the throttle queue.
kafka_prod_throt_time The average produce throttle time in milliseconds.
kafka_rem_bytesin_persec The total number of bytes transferred from tiered storage in response to consumer fetches.
kafka_rem_bytesout_persec The total number of bytes transferred to tiered storage, including data from log segments, indexes, and other auxiliary files.
kafka_remlog_managertasks_avgidle_percent The average percentage of time the remote log manager spent idle.
kafka_remlog_reader_avgidle_percent The average percentage of time the remote log reader spent idle.
kafka_remlog_reader_taskqueue_size The number of tasks responsible for reads from tiered storage.
kafka_rem_read_err_persec The total rate of errors in response to read requests that the specified broker sent to tiered storage to retrieve data in response to consumer fetches.
kafka_rem_readreq_persec The total number of read requests that the specifies broker sent to tiered storage to retrieve data in response to consumer fetches.
kafka_rem_write_err_persec The total rate of errors in response to write requests that the specified broker sent to tiered storage to transfer data upstream.
kafka_repli_bytesin_persec The number of bytes per second received from other brokers.
kafka_repli_bytesout_persec The number of bytes per second sent to other brokers.
kafka_req_exempt_from_throttime The average time in milliseconds spent in broker network and I/O threads to process requests that are exempt from throttling.
kafka_req_handler_avgidle_percent The average percentage of the time the request handler threads are idle.
kafka_req_throt_queue_size The number of messages in the throttle queue.
kafka_req_throttime The average request throttle time in milliseconds.
kafka_tcp_connections Shows number of incoming and outgoing TCP segments with the SYN flag set.
kafka_tot_tier_byteslag The total number of bytes of the data that is eligible for tiering on the broker but has not been transferred to tiered storage yet.
kafka_traf_bytes Shows network traffic in overall bytes between clients (producers and consumers) and brokers.
kafka_vol_queue_length The number of read and write operation requests waiting to be completed in a specified time period.
kafka_vol_read_bytes The number of bytes read in a specified time period.
kafka_vol_read_ops The number of read operations in a specified time period.
kafka_vol_tot_readtime The total number of seconds spent by all read operations that completed in a specified time period.
kafka_vol_tot_writetime The total number of seconds spent by all write operations that completed in a specified time period.
kafka_vol_write_bytes The number of bytes written in a specified time period.
kafka_vol_write_ops The number of write operations in a specified time period.
MSK Cluster
kafka_datalogs_disk_used The disk space used for datalogs in percentage.
active_controller_count Number of active controllers at a given time.
zookeeper_request_latency_msmean The mean latency for Apache ZooKeeper requests in milliseconds.
client_connection_count Number of clients which are actively connected.
global_partition_count Total number of partitions in a cluster excluding replicas.
global_topic_count Total number of topics in a cluster.
offline_partitions_count Number of partitions which are offline.
MSK Connect
connect_bytes_in_persec Number of bytes received by connector.
connect_bytes_out_persec Number of bytes delivered by the connector.
connect_cpu_utilization Amount of CPU consumption by system and user as a percentage.
connect_errored_task_count Number of tasks that have errored out.
connect_memory_utilization Percentage of the total memory on a worker instance.
connect_rebalance_completed_total Total number of rebalances completed by this connector.
connect_rebalance_time_avg Average time in milliseconds spent by the connector on rebalancing.
connect_rebalance_time_max Maximum time in milliseconds spent by the connector on rebalancing.
connect_rebalance_time_sincelast Time in milliseconds since this connector completed the most recent rebalance.
connect_running_task_count Number of running tasks in the connector.
connect_sinkrecord_read_rate The average number of records read from the Apache Kafka or Amazon MSK Cluster per second.
connect_sinkrecord_send_rate The average number of records per second that are produced from the transformations and sent to the destination excluding filtered records.
connect_source_record_poll_rate The average number of records produced or polled per second.
connect_source_record_write_rate The average number of records per second that are produced from the transformations and written to the Apache Kafka or Amazon MSK Cluster.
connect_task_startup_attempts_total Total number of task startups that the connector has attempted.
connect_task_startup_success_percent Average percentage of successful task starts for the connector.
connect_worker_count Number of workers that are running in the connector.
MSK Replicator
kafka_replication_latency Duration between record produce time at source and replicated to target.
kafka_message_lag Number of messages the replicator is behind the source cluster.
kafka_replicator_throughput Average number of bytes replicated per second.
kafka_replicator_failure Number of failures that the replicator is experiencing.
TGW_FLOW_LOGS
in_traffic The total incoming traffic throughput in a Transit Gateway.
out_traffic The total outgoing traffic throughput in a Transit Gateway.
tot_traffic The total traffic throughput in a Transit Gateway.
pkt_loss_mtu_exceeded The number of packets dropped because MTU Exceeded in a Transit Gateway.
pkt_loss_ttl_expired The number of packets dropped because TTL expired in a Transit Gateway.
pkt_loss_rate The percentage of packets dropped in a Transit Gateway.
avg_rx_pkt_size The average received packet size in a Transit Gateway.
avg_tx_pkt_size The average transmitted packet size in a Transit Gateway.
skipped_records The total number of skipped records in a Transit Gateway.
nodata_records The total number of no data records in a Transit Gateway.
TGWATT_FLOW_LOGS
in_traffic The total incoming traffic throughput in a Transit Gateway Attachment.
out_traffic The total outgoing traffic throughput in a Transit Gateway Attachment.
tot_traffic The total traffic throughput in a Transit Gateway Attachment.
pkt_loss_mtu_exceeded The number of packets dropped because MTU Exceeded in a Transit Gateway Attachment.
pkt_loss_ttl_expired The number of packets dropped because TTL expired in a Transit Gateway Attachment.
pkt_loss_rate The percentage of packets dropped in a Transit Gateway Attachment.
avg_rx_pkt_size The average received packet size in a Transit Gateway Attachment.
avg_tx_pkt_size The average transmitted packet size in a Transit Gateway Attachment.
skipped_records The total number of skipped records in a Transit Gateway Attachment.
nodata_records The total number of no data records in a Transit Gateway Attachment.
GLUE-JOB
cpu_load_used The fraction of CPU system load used by the driver in all runs.
bytes_read The number of bytes read from all data sources by all completed Spark tasks running in all executors.
shuffle_bytes_written The number of bytes written by all executors to shuffle data between them.
job_disk_used The number of megabytes of disk space used across all executors.
GLUE-CRAWLER
median_runtime_seconds The median runtime seconds of Crawler runs.
tables_created The total number of tables created in the last Crawler run.
RABBIT_MQ
sys_cpu_utilization The percentage of allocated Amazon EC2 compute units that the broker currently uses. For cluster deployments, this value represents the aggregate of all three RabbitMQ nodes' corresponding metric values.
queue_count The total number of queues configured on the broker.
consumer_count The total number of consumers connected to the broker.
message_count The total number of messages in the queues.
channel_count The total number of channels established on the broker.
RABBIT_MQ_QUEUE
consumer_count The number of consumers subscribed to the queue.
message_count The total number of MessageReadyCount and MessageUnacknowledgedCount (also known as queue depth).
message_ready_count The number of messages that are currently available to be delivered.
message_un_ack_count The number of messages for which the server is awaiting acknowledgement.
RABBIT_MQ_NODE
sys_cpu_utilization The percentage of allocated Amazon EC2 compute units that the broker currently uses.
fd_used Number of file descriptors used.
mem_used The volume of RAM used by a RabbitMQ node. When memory use goes above the limit, the cluster will block all producer connections.
mem_limit The RAM limit for a RabbitMQ node.
disk_free_limit The disk limit for a RabbitMQ node.
disk_free The total volume of free disk space available in a RabbitMQ node. When disk usage goes above its limit, the cluster will block all producer connections.
DRSREGION
total_source_server_count The total number of Source Servers.
active_source_server_count The total number of active Source Servers.
DRS-SOURCE-SERVER
lag_duration The latest consistent snapshot age, in seconds.
back_log The amount of data yet to be synced, in bytes.
elapsed_replication_duration The amount of time that has passed since the last Drill or Recovery instance launch in seconds.
duration_since_last_successful_recovery_launch The cumulative amount of time this server has been replicating for in seconds.
DRS-RECOVERY-INSTANCE
lag_duration The latest consistent snapshot age, in seconds.
back_log The amount of data yet to be synced, in bytes.
elapsed_replication_duration The amount of time that has passed since the last Drill or Recovery instance launch in seconds.

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
MEMORYUTILIZEDPERCENT Memory Utilization
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
EMAIL_USAGE Percentage of email usage in the last 24 hours
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.
EBSVOLUME_AVAIL
VOLUME_COUNT The number of available volumes in the region.
VOLUME_COUNT_USED The number of attached volumes in the region.
VOLUME_COUNT_CREATED The count of unattached volumes created since the last poll in that region.
VOLUME_COUNT_CREATED_USED The count of attached volumes created since the last poll in that region.
TOT_VOLUME_SIZE The sum of all unattached volumes size in the region.
TOT_VOLUME_SIZE_USED The sum of all attached volumes size in the region.
SNAP_COUNT The number of snapshots in the region.
TOT_SNAP_SIZE The sum of all snapshots' size in the region.
VOLUME_SIZE The volume size.
VOLUME_AGE The volume age.
AWSBATCH
TOTALSUBMITTEDJOB The total number of submitted jobs in the queues attached to the compute environment.
TOTALPENDINGJOB The total number of pending jobs in the queues attached to the compute environment.
TOTALRUNNABLEJOB The total number of runnable jobs in the queues attached to the compute environment.
TOTALSTARTINGJOB The total number of starting jobs in the queues attached to the compute environment.
TOTALRUNNINGJOB The total number of running jobs in the queues attached to the compute environment.
TOTALSUCCEEDEDJOB The total number of succeeded jobs in the queues attached to the compute environment.
TOTALFAILEDJOB The total number of failed jobs in the queues attached to the compute environment.
TOTALQUEUECOUNT The total number of queues attached to the compute environment.
AWSBATCH-QUEUE
JOBSUBMITTED The number of submitted jobs in the queue.
JOBPENDING The number of pending jobs in the queue.
JOBRUNNABLE The number of runnable jobs in the queue.
JOBSTARTING The number of starting jobs in the queue.
JOBSUCCEEDED The number of succeeded jobs in the queue.
JOBRUNNING The number of running jobs in the queue.
JOBFAILED The number of failed jobs in the queue.
TOTALCOMPUTEENV The total number of compute environment jobs in the queue.
EBS_SNAPSHOT
SNAP_COUNT The number of snapshots in the ebs volume.
SNAP_COUNT_CREATED The count of snapshots created since the last poll in that ebs volume.
TOT_SNAP_SIZE The sum of all snapshots size in the ebs volume.
SNAP_SIZE The snapshot size.
SNAP_AGE The snapshot age.
SECRET-MANAGER
SECRETCHANGED The value gets updated to one when a secret change occurs.
SECRETROTATED The value gets updated to one when a secret rotation occurs.
SECRET-MANAGER-REGIONAL
RESOURCECOUNT The number of secrets in your account, including secrets that are marked for deletion.
ROTATESECRETCALLCOUNT The number of times a rotate secret call occurs for the secrets.
ELASTIC-IP-ADDRESS
TOTALIP The total number of IP addresses in a region with the same address pool (Amazon- or customer-owned pool).
ASSOCIATEDIP The total number of associated IP addresses in a region with the same address pool (Amazon- or customer-owned pool).
DISASSOCIATEDIP The total number of disassociated IP addresses in a region with the same address pool (Amazon- or customer-owned pool).
VPCDOMAINIP The number of VPC Domain IP addresses in a region with the same address pool (Amazon- or customer-owned pool).
PROCSTAT
CPU_TIME_SYSTEM The CPU time in system mode.
CPU_TIME_USER The CPU time in user mode.
CPU_USAGE The CPU used.
MEMORY_RSS The resident set memory.
MEMORY_VMS The virtual memory.
PID The process ID.
PID_COUNT The process ID count.
READ_BYTES The number of bytes read.
WRITE_BYTES The number of bytes written.
READ_COUNT The number of disk read operations.
WRITE_COUNT The number of disk write operations.
CPU_TIME The CPU time.
MEMORY_SWAP The swap memory.
MEMORY_STACK The stack memory.
MEMORY_LOCKED The locked memory.
MEMORY_DATA The data memory.
INVOLUNTARY_CONTEXT_SWITCHES The involuntary context switches.
VOLUNTARY_CONTEXT_SWITCHES The voluntary context switches.
REALTIME_PRIORITY Realtime Priority
NICE_PRIORITY Nice Priority
SIGNALS_PENDING The number of pending signals.
RLIMIT_CPU_TIME_HARD The Hard CPU time resource limit.
RLIMIT_CPU_TIME_SOFT THe Soft CPU time resource limit.
RLIMIT_FILE_LOCKS_HARD The Hard file locks resource limit.
RLIMIT_FILE_LOCKS_SOFT The Soft file locks resource limit.
RLIMIT_MEMORY_DATA_HARD The Hard resource limit on the process for memory used for data.
RLIMIT_MEMORY_DATA_SOFT The Soft resource limit on the process for memory used for data.
RLIMIT_MEMORY_LOCKED_HARD Hard resource limit on the process for the locked memory.
RLIMIT_MEMORY_LOCKED_SOFT The Soft resource limit on the process for the locked memory.
RLIMIT_MEMORY_RSS_HARD The Hard resource limit on the process for the physical memory.
RLIMIT_MEMORY_RSS_SOFT The Soft resource limit on the process for the physical memory.
RLIMIT_MEMORY_STACK_HARD The Hard resource limit on the process stack.
RLIMIT_MEMORY_STACK_SOFT The Soft resource limit on the process stack.
RLIMIT_MEMORY_VMS_HARD The Hard resource limit on the process for the virtual memory.
VPC_META
NUMBER_OF_REGION_UP The total number of Region monitors in available status in the Amazon account.
NUMBER_OF_REGION_TROUBLE The total number of Region monitors in trouble status in the Amazon account.
NUMBER_OF_REGION_CRITICAL The total number of Region monitors in critical status in the Amazon account.
NUMBER_OF_AZ_UP The total number of Availability Zone monitors in available status in the Amazon account.
NUMBER_OF_AZ_TROUBLE The total number of Availability Zone monitors in trouble status in the Amazon account.
NUMBER_OF_AZ_CRITICAL The total number of Availability Zone monitors in critical status in the Amazon account.
NUMBER_OF_VPC_UP The total number of VPC monitors in available status in the Amazon account.
NUMBER_OF_VPC_TROUBLE The total number of VPC monitors in trouble status in the Amazon account.
NUMBER_OF_VPC_CRITICAL The total number of VPC monitors in critical status in the Amazon account.
NUMBER_OF_SUBNET_UP The total number of Subnet monitors in available status in the Amazon account.
NUMBER_OF_SUBNET_TROUBLE The total number of Subnet monitors in trouble status in the Amazon account.
NUMBER_OF_SUBNET_CRITICAL The total number of Subnet monitors in critical status in the Amazon account.
NUMBER_OF_NI_UP The total number of Network Interface monitors in available status in the Amazon account.
NUMBER_OF_NI_TROUBLE The total number of Network Interface monitors in trouble status in the Amazon account.
NUMBER_OF_NI_CRITICAL The total number of Network Interface monitors in critical status in the Amazon account.
NUMBER_OF_PROTOCOL_UP The total number of Protocol monitors in available status in the Amazon account.
NUMBER_OF_PROTOCOL_TROUBLE The total number of Protocol monitors in trouble status in the Amazon account.
NUMBER_OF_PROTOCOL_CRITICAL The total number of Protocol monitors in critical status in the Amazon account.
NUMBER_OF_RT_UP The total number of Route Table monitors in available status in the Amazon account.
VPC_REGIONAL
TOT_RX_VOLUME The total amount of received (Rx) traffic volumes in a region.
MIN_RX_VOLUME The minimum amount of received traffic volume in a region.
MAX_RX_VOLUME The maximum amount of received traffic volume in a region.
TOT_RX_PACKET The total number of received traffic packets in a region.
MIN_RX_PACKET The minimum number of received traffic packets in a region.
MAX_RX_PACKET The maximum number of received traffic packets in a region.
TOT_TX_VOLUME The total amount of transmitted (Tx) traffic volumes in a region.
MIN_TX_VOLUME The minimum amount of transmitted traffic volume in a region.
MAX_TX_VOLUME The maximum amount of transmitted traffic volume in a region.
TOT_TX_PACKET The total number of transmitted traffic packets in a region.
MIN_TX_PACKET The number of minimum transmitted traffic packets in a region.
MAX_TX_PACKET The number of maximum transmitted traffic packets in a region.
AVG_RX_PACKET_SIZE The average received packet size in a region.
AVG_TX_PACKET_SIZE The average transmitted packet size in a region.
TOT_VOLUME The total traffic volumes in a region.
TOT_PACKET The total traffic packets in a region
IN_TRAFFIC The total incoming traffic throughput in a region.
OUT_TRAFFIC The total outgoing traffic throughput in a region.
TOT_TRAFFIC The total traffic throughput in a region.
ACCEPTED_REQUESTS The total number of accepted requests in a region.
REJECTED_REQUESTS The total number of rejected requests in a region.
SKIPPED_RECORDS The total number of skipped records in a region.
NODATA_RECORDS The total number of no data records in a region.
TOTAL_FREE_IP The total number of free IPs in a region.
TOTAL_NI The total number of network interfaces in a region.
TOTAL_SUBNET The total number of Subnets in a region.
TOTAL_VPC The total number of VPCs in a region.
VPC_AZ
TOT_RX_VOLUME The total amount of received (Rx) traffic volumes in an availability zone.
MIN_RX_VOLUME The minimum amount of received traffic volume in an availability zone.
MAX_RX_VOLUME The maximum amount of received traffic volume in an availability zone.
TOT_RX_PACKET The total number of received traffic packets in an availability zone.
MIN_RX_PACKET The minimum number of received traffic packets in an availability zone.
MAX_RX_PACKET The maximum number of received traffic packets in an availability zone.
TOT_TX_VOLUME The total amount of transmitted (Tx) traffic volumes in an availability zone.
MIN_TX_VOLUME The minimum amount of transmitted traffic volume in an availability zone.
MAX_TX_VOLUME The maximum amount of transmitted traffic volume in an availability zone.
TOT_TX_PACKET The total number of transmitted traffic packets in an availability zone.
MIN_TX_PACKET The number of minimum transmitted traffic packets in an availability zone.
MAX_TX_PACKET The number of maximum transmitted traffic packets in an availability zone.
AVG_RX_PACKET_SIZE The average received packet size in an availability zone.
AVG_TX_PACKET_SIZE The average transmitted packet size in an availability zone.
TOT_VOLUME The total traffic volumes in an availability zone.
TOT_PACKET The total traffic packets in a region
IN_TRAFFIC The total incoming traffic throughput in an availability zone.
OUT_TRAFFIC The total outgoing traffic throughput in an availability zone.
TOT_TRAFFIC The total traffic throughput in an availability zone.
ACCEPTED_REQUESTS The total number of accepted requests in an availability zone.
REJECTED_REQUESTS The total number of rejected requests in an availability zone.
SKIPPED_RECORDS The total number of skipped records in an availability zone.
NODATA_RECORDS The total number of no data records in an availability zone.
TOTAL_FREE_IP The total number of free IPs in an availability zone.
TOTAL_NI The total number of network interfaces in an availability zone.
TOTAL_SUBNET The total number of Subnets in an availability zone.
VPC
TOT_RX_VOLUME The total amount of received (Rx) traffic volumes in a VPC.
MIN_RX_VOLUME The minimum amount of received traffic volume in a VPC.
MAX_RX_VOLUME The maximum amount of received traffic volume in a VPC.
TOT_RX_PACKET The total number of received traffic packets in a VPC.
MIN_RX_PACKET The minimum number of received traffic packets in a VPC.
MAX_RX_PACKET The maximum number of received traffic packets in a VPC.
TOT_TX_VOLUME The total amount of transmitted (Tx) traffic volumes in a VPC.
MIN_TX_VOLUME The minimum amount of transmitted traffic volume in a VPC.
MAX_TX_VOLUME The maximum amount of transmitted traffic volume in a VPC.
TOT_TX_PACKET The total number of transmitted traffic packets in a VPC.
MIN_TX_PACKET The number of minimum transmitted traffic packets in a VPC.
MAX_TX_PACKET The number of maximum transmitted traffic packets in a VPC.
AVG_RX_PACKET_SIZE The average received packet size in a VPC.
AVG_TX_PACKET_SIZE The average transmitted packet size in a VPC.
TOT_VOLUME The total traffic volumes in a VPC.
TOT_PACKET The total traffic packets in a region
IN_TRAFFIC The total incoming traffic throughput in a VPC.
OUT_TRAFFIC The total outgoing traffic throughput in a VPC.
TOT_TRAFFIC The total traffic throughput in a VPC.
ACCEPTED_REQUESTS The total number of accepted requests in a VPC.
REJECTED_REQUESTS The total number of rejected requests in a VPC.
SKIPPED_RECORDS The total number of skipped records in a VPC.
NODATA_RECORDS The total number of no data records in a VPC.
TOTAL_FREE_IP The total number of free IPs in a VPC.
TOTAL_NI The total number of network interfaces in a VPC.
TOTAL_SUBNET The total number of Subnets in a VPC.
VPC_SUBNET
TOT_RX_VOLUME The total amount of received (Rx) traffic volumes in a subent.
MIN_RX_VOLUME The minimum amount of received traffic volume in a subent.
MAX_RX_VOLUME The maximum amount of received traffic volume in a subent.
TOT_RX_PACKET The total number of received traffic packets in a subent.
MIN_RX_PACKET The minimum number of received traffic packets in a subent.
MAX_RX_PACKET The maximum number of received traffic packets in a subent.
TOT_TX_VOLUME The total amount of transmitted (Tx) traffic volumes in a subent.
MIN_TX_VOLUME The minimum amount of transmitted traffic volume in a subent.
MAX_TX_VOLUME The maximum amount of transmitted traffic volume in a subent.
TOT_TX_PACKET The total number of transmitted traffic packets in a subent.
MIN_TX_PACKET The number of minimum transmitted traffic packets in a subent.
MAX_TX_PACKET The number of maximum transmitted traffic packets in a subent.
AVG_RX_PACKET_SIZE The average received packet size in a subent.
AVG_TX_PACKET_SIZE The average transmitted packet size in a subent.
TOT_VOLUME The total traffic volumes in a subent.
TOT_PACKET The total traffic packets in a region
IN_TRAFFIC The total incoming traffic throughput in a subent.
OUT_TRAFFIC The total outgoing traffic throughput in a subent.
TOT_TRAFFIC The total traffic throughput in a subent.
ACCEPTED_REQUESTS The total number of accepted requests in a subent.
REJECTED_REQUESTS The total number of rejected requests in a subent.
SKIPPED_RECORDS The total number of skipped records in a subent.
NODATA_RECORDS The total number of no data records in a subent.
TOTAL_FREE_IP The total number of free IPs in a subent.
TOTAL_NI The total number of network interfaces in a subent.
VPC_NI
TOT_RX_VOLUME The total amount of received (Rx) traffic volumes in a network interface.
MIN_RX_VOLUME The minimum amount of received traffic volume in a network interface.
MAX_RX_VOLUME The maximum amount of received traffic volume in a network interface.
TOT_RX_PACKET The total number of received traffic packets in a network interface.
MIN_RX_PACKET The minimum number of received traffic packets in a network interface.
MAX_RX_PACKET The maximum number of received traffic packets in a network interface.
TOT_TX_VOLUME The total amount of transmitted (Tx) traffic volumes in a network interface.
MIN_TX_VOLUME The minimum amount of transmitted traffic volume in a network interface.
MAX_TX_VOLUME The maximum amount of transmitted traffic volume in a network interface.
TOT_TX_PACKET The total number of transmitted traffic packets in a network interface.
MIN_TX_PACKET The number of minimum transmitted traffic packets in a network interface.
MAX_TX_PACKET The number of maximum transmitted traffic packets in a network interface.
AVG_RX_PACKET_SIZE The average received packet size in a network interface.
AVG_TX_PACKET_SIZE The average transmitted packet size in a network interface.
TOT_VOLUME The total traffic volumes in a network interface.
TOT_PACKET The total traffic packets in a region
IN_TRAFFIC The total incoming traffic throughput in a network interface.
OUT_TRAFFIC The total outgoing traffic throughput in a network interface.
TOT_TRAFFIC The total traffic throughput in a network interface.
ACCEPTED_REQUESTS The total number of accepted requests in a network interface.
REJECTED_REQUESTS The total number of rejected requests in a network interface.
SKIPPED_RECORDS The total number of skipped records in a network interface.
NODATA_RECORDS The total number of no data records in a network interface.
VPC_PROTOCOL
TOT_RX_VOLUME The total amount of received (Rx) traffic volumes in a protocol in network interface.
MIN_RX_VOLUME The minimum amount of received traffic volume in a protocol in network interface.
MAX_RX_VOLUME The maximum amount of received traffic volume in a protocol in network interface.
TOT_RX_PACKET The total number of received traffic packets in a protocol in network interface.
MIN_RX_PACKET The minimum number of received traffic packets in a protocol in network interface.
MAX_RX_PACKET The maximum number of received traffic packets in a protocol in network interface.
TOT_TX_VOLUME The total amount of transmitted (Tx) traffic volumes in a protocol in network interface.
MIN_TX_VOLUME The minimum amount of transmitted traffic volume in a protocol in network interface.
MAX_TX_VOLUME The maximum amount of transmitted traffic volume in a protocol in network interface.
TOT_TX_PACKET The total number of transmitted traffic packets in a protocol in network interface.
MIN_TX_PACKET The number of minimum transmitted traffic packets in a protocol in network interface.
MAX_TX_PACKET The number of maximum transmitted traffic packets in a protocol in network interface.
AVG_RX_PACKET_SIZE The average received packet size in a protocol in network interface.
AVG_TX_PACKET_SIZE The average transmitted packet size in a protocol in network interface.
TOT_VOLUME The total traffic volumes in a protocol in network interface.
TOT_PACKET The total traffic packets in a region
IN_TRAFFIC The total incoming traffic throughput in a protocol in network interface.
OUT_TRAFFIC The total outgoing traffic throughput in a protocol in network interface.
TOT_TRAFFIC The total traffic throughput in a protocol in network interface.
ACCEPTED_REQUESTS The total number of accepted requests in a protocol in network interface.
REJECTED_REQUESTS The total number of rejected requests in a protocol in network interface.
TRUSTED-ADVISOR-CATEGORY
REDCHECKS The number of checks that are recommended to take an action.
YELLOWCHECKS The number of checks that are recommended for an investigation.
GREENCHECKS The number of checks without problems.
TRUSTED-ADVISOR-CHECKS
REDRESOURCES The number of resources that are in red state (action recommended).
YELLOWRESOURCES The number of resources that are in yellow state (investigation recommended).
GREENRESOURCES The number of resources that are in green state (no issues detected).
MSK_TOPIC
BYTES_IN_PERSEC NetworkTraffic
MSG_IN_PERSEC Number of incoming messages per second for the topic.
FET_MSG_CONV_PERSEC Number of fetch message conversions per second.
PROD_MSG_CONV_PERSEC Number of produce message conversions per second.
REM_BYTES_IN_PERSEC Total bytes transferred to and from tiered storage including log segments, indexes, and auxiliary files in response to consumer fetches.
REM_READ_ERR_PERSEC The total rate of errors in response to read or write requests sent by the specified broker to tiered storage for data retrieval or transfer.
REM_READ_REQ_PERSEC The number of read requests that the specifies broker sends to tiered storage to retrieve data in response to consumer fetches on the specified topic.
MSK_BROKER
BURST_BALANCE Available credit balance for the EBS volumes in the cluster.
CLIENT_CONNECTION_COUNT The number of active authenticated client connections.
CONNECTION_COUNT The number of active authenticated, unauthenticated, and inter-broker connections.
CPU_CREDIT_BALANCE Number of earned CPU credits used by a broker.
CPU_IDLE The percentage of CPU idle time.
CPU_IO_WAIT The percentage of CPU idle time during a pending disk operation.
CPU_SYSTEM The percentage of CPU in kernel space.
CPU_USER The percentage of CPU in user space.
KAFKA_APPLOGS_DISK_USED The percentage of disk space used for application logs.
KAFKA_DATALOGS_DISK_USED The disk space used for datalogs in percentage.
LEADER_COUNT The total number of leaders of partitions per broker, not including replicas.
MEMORY_BUFFERED The size in bytes of buffered memory for the broker.
MEMORY_CACHED The size in bytes of cached memory for the broker.
MEMORY_FREE The size in bytes of memory that is free and available for the broker.
HEAP_MEMORY_AFTER_GC Total heap memory in use after garbage collection.
MEMORY_USED The size in bytes of memory that is in use for the broker.
MESSAGES_IN_PER_SEC Number of messages received per second.
NET_RX_DROPPED The number of dropped receive packages.
NET_RX_ERR The number of network receive errors for the broker.
NET_RX_PACKETS The number of packets received by the broker.
OFFLINE_PARTITIONS_COUNT Total number of partitions that are offline in the cluster.
PARTITION_COUNT The total number of topic partitions per broker, including replicas.
PRODUCE_TOTALTIME_MS_MEAN Mean produce time in milliseconds.
REQ_BYTES_MEAN Average number of request bytes for the broker.
REQ_TIME Average time spent in broker network and I/O threads to process requests.
ROOT_DISK_USED Percentage of the root disk used by the broker.
SWAP_FREE The size in bytes of swap memory that is available for the broker.
SWAP_USED The size in bytes of swap memory that is in use for the broker.
TRAFFIC_SHAPING Number of packets shaped (dropped or queued) due to exceeding network allocations.
UNDER_MIN_ISR_PARTITION_COUNT The number of under minIsr partitions for the broker.
UNDER_REPLICATED_PARTITIONS The number of under-replicated partitions for the broker.
ZOOKEEPER_REQ_LATENCY_MS_MEAN Mean latency for Apache ZooKeeper requests from the broker.
ZOOKEEPER_SESSION_STATE Connection status of the broker’s ZooKeeper session.
BW_IN_ALLOWANCE_EXCEEDED The number of packets shaped because the inbound aggregate bandwidth exceeded the maximum for the broker.
BW_OUT_ALLOWANCE_EXCEEDED The number of packets shaped because the outbound aggregate bandwidth exceeded the maximum for the broker.
CONN_TRACK_ALLOWANCE_EXCEEDED The number of packets shaped because the connection tracking exceeded the maximum for the broker.
CONNECTION_CLOSE_RATE The number of connections closed per second per listener.
CONNECTION_CREATION_RATE The number of new connections established per second per listener.
CPU_CREDIT_USAGE The number of CPU credits spent by the broker.
FET_CONS_LOCALTIME_MS_MEAN The mean time in milliseconds that the consumer request is processed at the leader.
FET_CONS_REQ_QUEUE_TIME_MS_MEAN The mean time in milliseconds that the consumer request waits in the request queue.
FET_CONS_RESP_QUEUE_TIME_MS_MEAN The mean time in milliseconds that the consumer request waits in the response queue.
FET_CONS_RESP_SENDTIME_MS_MEAN The mean time in milliseconds for the consumer to send a response.
FET_CONS_TOTTIME_MS_MEAN The mean total time in milliseconds that consumers spend on fetching data from the broker.
FET_FOLL_LOCTIME_MS_MEAN The mean time in milliseconds that the follower request is processed at the leader.
FET_FOLL_REQ_QUEUE_TIME_MS_MEAN The mean time in milliseconds that the follower request waits in the request queue.
FET_FOLL_RESP_QUEUE_TIME_MS_MEAN The mean time in milliseconds that the follower request waits in the response queue.
FET_FOLL_RESP_SENDTIME_MS_MEAN The mean time in milliseconds for the follower to send a response.
FET_FOLL_TOT_TIME_MS_MEAN The mean total time in milliseconds that followers spend on fetching data from the broker.
FET_MSG_CONV_PER_SEC The number of fetch message conversions per second for the broker.
FET_THROT_BYTE_RATE The number of throttled bytes per second.
FET_THROT_QUEUE_SIZE The number of messages in the throttle queue.
FET_THROT_TIME The average fetch throttle time in milliseconds.
NET_PROC_AVG_IDLE_PERCENT The average percentage of the time the network processors are idle.
PPS_ALLOWANCE_EXCEEDED The number of packets shaped because the bidirectional PPS exceeded the maximum for the broker.
PROD_LOCTIME_MS_MEAN The mean time in milliseconds that the request is processed at the leader.
PROD_MSG_CONV_PER_SEC The number of produce message conversions per second for the broker.
PROD_MSG_CONV_TIME_MS_MEAN The mean time in milliseconds spent on message format conversions.
PROD_REQ_QUEUE_TIME_MS_MEAN The mean time in milliseconds that request messages spend in the queue.
PROD_RESP_QUEUE_TIME_MS_MEAN The mean time in milliseconds that response messages spend in the queue.
PROD_RESP_SENDTIME_MS_MEAN The mean time in milliseconds spent on sending response messages.
PROD_THROT_BYTE_RATE The number of throttled bytes per second.
PROD_THROT_QUEUE_SIZE The number of messages in the throttle queue.
PROD_THROT_TIME The average produce throttle time in milliseconds.
REM_BYTESIN_PER_SEC The total number of bytes transferred from tiered storage in response to consumer fetches.
REM_BYTESOUT_PER_SEC The total number of bytes transferred to tiered storage including data from log segments, indexes, and other auxiliary files.
REMLOG_MANAGERTASKS_AVG_IDLE_PERCENT The average percentage of time the remote log manager spent idle.
REMLOG_READER_AVG_IDLE_PERCENT The average percentage of time the remote log reader spent idle.
REMLOG_READER_TASKQUEUE_SIZE The number of tasks responsible for reads from tiered storage that are waiting to be scheduled.
REM_READ_ERR_PERSEC The total rate of errors in response to read requests that the specified broker sent to tiered storage to retrieve data in response to consumer fetches.
REM_READ_REQ_PERSEC The total number of read requests that the specifies broker sent to tiered storage to retrieve data in response to consumer fetches.
REM_WRITE_ERR_PERSEC The total rate of errors in response to write requests that the specified broker sent to tiered storage to transfer data upstream.
REPLI_BYTESIN_PERSEC The number of bytes per second received from other brokers.
REPLI_BYTESOUT_PERSEC The number of bytes per second sent to other brokers.
REQ_EXEMPT_FROM_THROT_TIME The average time in milliseconds spent in broker network and I/O threads to process requests that are exempt from throttling.
REQ_HANDLER_AVG_IDLE_PERCENT The average percentage of the time the request handler threads are idle.
REQ_THROT_QUEUE_SIZE The number of messages in the throttle queue.
REQ_THROTTLE_TIME The average request throttle time in milliseconds.
TCP_CONNECTIONS Shows number of incoming and outgoing TCP segments with the SYN flag set.
TOT_TIER_BYTES_LAG The total number of bytes of the data that is eligible for tiering on the broker but has not been transferred to tiered storage yet.
TRAF_BYTES Shows network traffic in overall bytes between clients (producers and consumers) and brokers.
VOL_QUEUE_LENGTH The number of read and write operation requests waiting to be completed in a specified time period.
VOL_READ_BYTES The number of bytes read in a specified time period.
VOL_READ_OPS The number of read operations in a specified time period.
VOL_TOT_READTIME The total number of seconds spent by all read operations that completed in a specified time period.
VOL_TOT_WRITETIME The total number of seconds spent by all write operations that completed in a specified time period.
VOL_WRITE_BYTES The number of bytes written in a specified time period.
VOL_WRITE_OPS The number of write operations in a specified time period.
NET_TX_DROPPED The number of dropped transmit packages.
NET_TX_ERR The number of network transmit errors for the broker.
NET_TX_PACKETS The number of packets transmitted by the broker.
MSK_CLUSTER
KAFKA_DATA_LOGS_DISK_USED Shows the disk space used for datalogs in %.
ACTIVE_CONTROLLER_COUNT Number of active controllers at a given time.
CLIENT_CONNECTION_COUNT Number of clients which are actively connected.
ZOOKEEPER_REQUEST_LATENCY_MSMEAN The mean latency for Apache ZooKeeper requests in milliseconds.
GLOBAL_PARTITION_COUNT The number of partitions across all topics in the cluster, excluding replicas.
GLOBAL_TOPIC_COUNT Total number of topics in a cluster.
OFFLINE_PARTITIONS_COUNT Total number of partitions that are offline in the cluster.
MSK_CONNECT
BYTESIN_PERSEC NetworkTraffic
WORKER_COUNT Number of workers that are running in the connector.
CPU_UTILIZATION Amount of CPU consumption by system and user as a percentage.
MEMORY_UTILIZATION Percentage of the total memory on a worker instance.
SINKRECORD_READ_RATE The average number of records read from the Apache Kafka or Amazon MSK Cluster per second.
SOURCE_RECORD_POLL_RATE The average number of records produced or polled per second.
REBALANCE_TIME_AVG Average time in milliseconds spent by the connector on rebalancing.
REBALANCE_COMPLETED_TOTAL Total number of rebalances completed by this connector.
TASK_STARTUP_ATTEMPTS_TOTAL The total number of task startups that the connector has attempted.
TASK_STARTUP_SUCCESS_PERCENT The average percentage of successful task starts for the connector
RUNNING_TASK_COUNT Number of running tasks in the connector.
MSK_REPLICATOR
REPLICATION_LATENCY Duration between record produce time at source and replicated to target.
MESSAGE_LAG Number of messages the replicator is behind the source cluster
REPLICATOR_THROUGHPUT Average number of bytes replicated per second.
REPLICATOR_FAILURE Number of failures that the replicator is experiencing.
TGW_FLOW_LOGS
IN_TRAFFIC The total incoming traffic throughput in a Transit Gateway.
OUT_TRAFFIC The total outgoing traffic throughput in a Transit Gateway.
TOT_TRAFFIC The total traffic throughput in a Transit Gateway.
PKTLOSS_MTUEXD The number of packets dropped because MTU Exceeded in a Transit Gateway.
PKTLOSS_TTLEXP The number of packets dropped because TTL expired in a Transit Gateway.
PKTLOSSRATE The percentage of packets dropped in a Transit Gateway.
AVG_RX_PKT_SIZE The average received packet size in a Transit Gateway.
AVG_TX_PKT_SIZE The average transmitted packet size in a Transit Gateway.
SKIPPED_RECORDS The total number of skipped records in a Transit Gateway.
NODATA_RECORDS The total number of no data records in a Transit Gateway.
TGWATT_FLOW_LOGS
IN_TRAFFIC The total incoming traffic throughput in a Transit Gateway Attachment.
OUT_TRAFFIC The total outgoing traffic throughput in a Transit Gateway Attachment.
TOT_TRAFFIC The total traffic throughput in a Transit Gateway Attachment.
PKTLOSS_MTUEXD The number of packets dropped because MTU Exceeded in a Transit Gateway Attachment.
PKTLOSS_TTLEXP The number of packets dropped because TTL expired in a Transit Gateway Attachment.
PKTLOSSRATE The percentage of packets dropped in a Transit Gateway Attachment.
AVG_RX_PKT_SIZE The average received packet size in a Transit Gateway Attachment.
AVG_TX_PKT_SIZE The average transmitted packet size in a Transit Gateway Attachment.
SKIPPED_RECORDS The total number of skipped records in a Transit Gateway Attachment.
NODATA_RECORDS The total number of no data records in a Transit Gateway Attachment.
GLUE-JOB
CPULOADUSED The fraction of CPU system load used by the driver.
BYTESREAD The number of bytes read from all data sources by all completed Spark tasks running in all executors.
RECORDSREAD The number of records read from all data sources.
S3READ The number of bytes read from Amazon S3 by all executors.
S3WRITE The number of bytes written to Amazon S3 by all executors.
SHUFFLEBYTESREAD The number of bytes read by all executors to shuffle data between them.
SHUFFLEBYTESWRITTEN The number of bytes written by all executors to shuffle data between them.
JVMMEMORYUSEDDRIVER The number of memory bytes used by the JVM heap for the driver.
JVMMEMORYUSEDEXECUTOR The number of memory bytes used by the JVM heap for all executors.
DISKUSED The number of megabytes of disk space used across all executors.
ETLELAPSEDTIME The ETL elapsed time in milliseconds.
COMPLETEDTASKS The number of completed tasks in the job.
FAILEDTASKS The number of failed tasks.
KILLEDTASKS The number of tasks killed.
COMPLETEDSTAGES The number of completed stages in the job.
JOBSKEWNESS The weighted average of the job stages skewness.
WORKERUTILIZATION The percentage of the allocated workers which are actually used.
STREAMRECORDSREAD The number of records that are received in a micro-batch.
STREAMBATCHTIMETAKEN Processing time of streaming batch.
ALLEXECUTOR Number of actively running job executors.
MAXEXECUTOR Number of maximum (actively running and pending) job executors required to satisfy the current load.
DRIVERDISKPERCENT The percentage of disk space used by driver.
EXECUTORDISKPERCENT The percentage of disk space used by executor.
TOTALRUNS The number of runs in a Job.
COMPLETEDRUNS The number of completed runs in a Job.
FAILEDRUNS The number of failed runs in a Job.
CANCELEDRUNS The number of canceled runs in a Job.
ERRORRUNS The number of error runs in a Job.
WAITINGRUNS The number of waiting runs in a Job.
TIMEOUTRUNS The number of timeout runs in a Job.
COMPLETEDRUNPERCENT The percentage of completed runs.
FAILEDRUNPERCENT The percentage of failed runs.
CANCELRUNPERCENT The percentage of canceled runs.
ERRORRUNPERCENT The percentage of error runs.
WAITINGRUNPERCENT The percentage of waiting run.
TIMEOUTRUNPERCENT The percentage of timeout run.
INPUTRECORDS The rate at which input records are received.
PROCESSINGRECORDS The rate at which records are being processed.
GLUE-CRAWLER
TABLESCREATED The number of tables created.
TABLESUPDATED The number of tables updated.
TABLESDELETED The number of tables deleted.
MEDIANRUNTIMESEC The median runtime seconds of Crawler runs.
LASTRUNTIMESEC The Last Runtime seconds of Crawler run.
TIMELEFTSECONDS The timeleft runtime of Crawler run.
TOTALCRAWLS The number of runs in a Crawler.
COMPLETEDCRAWLS The number of completed runs in a Crawler.
FAILEDCRAWLS The number of failed runs in a Crawler.
CANCELEDCRAWLS The number of canceled runs in a Crawler.
COMPLETEDCRAWLPERCENT The percentage of completed runs.
FAILEDCRAWLPERCENT The percentage of failed runs.
CANCELCRAWLPERCENT The percentage of canceled runs.
RABBIT_MQ
SYS_CPU_UTILIZATION The percentage of allocated Amazon EC2 compute units that the broker currently uses. For cluster deployments, this value represents the aggregate of all three RabbitMQ nodes' corresponding metric values.
EXCHANGE_COUNT The total number of exchanges configured on the broker.
QUEUE_COUNT The total number of queues configured on the broker.
MSG_COUNT The total number of messages in the queues.
MSG_READY_COUNT The total number of ready messages in the queues.
MSG_UN_ACK_COUNT The total number of unacknowledged messages in the queues.
CONSUMER_COUNT The total number of consumers connected to the broker.
CHANNEL_COUNT The total number of channels established on the broker.
PUBLISH_RATE The rate at which messages are published to the broker.
CONFIRM_RATE The rate at which the RabbitMQ server is confirming published messages.
ACK_RATE The rate at which messages are being acknowledged by consumers.
MEM_LIMIT The RAM limit for a RabbitMQ broker.
MEM_USED The volume of RAM used by a RabbitMQ broker.
DISK_FREE The total volume of free disk space available in a RabbitMQ broker.
DISK_FREE_LIMIT The disk limit for a RabbitMQ broker. For cluster deployments, this value represents the aggregate of all three RabbitMQ nodes' corresponding metric values.
FD_USED Number of file descriptors used.
IO_READ_AVERAGE_TIME The average time (in milliseconds) for RabbitMQ to perform one read operation.
IO_WRITE_AVERAGE_TIME The average time (in milliseconds) for RabbitMQ to perform one write operation.
RABBIT_MQ_QUEUE
CONSUMER_COUNT The number of consumers subscribed to the queue.
MSG_COUNT The total number of MessageReadyCount and MessageUnacknowledgedCount (also known as queue depth).
MSG_READY_COUNT The number of messages that are currently available to be delivered.
MSG_UN_ACK_COUNT The number of messages for which the server is awaiting acknowledgement.
RABBIT_MQ_NODE
SYS_CPU_UTILIZATION The percentage of allocated Amazon EC2 compute units that the broker currently uses.
MEM_LIMIT The RAM limit for a RabbitMQ node.
MEM_USED The volume of RAM used by a RabbitMQ node. When memory use goes above the limit, the cluster will block all producer connections.
DISK_FREE The total volume of free disk space available in a RabbitMQ node.
DISK_FREE_LIMIT The disk limit for a RabbitMQ node. This metric is different per instance size.
FD_USED Number of file descriptors used.
DRSREGION
TOTAL_SOURCE_SERVER_COUNT The total number of Source Servers.
ACTIVE_SOURCE_SERVER_COUNT The total number of active Source Servers.
DRS-SOURCE-SERVER
LAG_DURATION The latest consistent snapshot age, in seconds.
BACKLOG The amount of data yet to be synced, in bytes.
ELAPSED_REPLICATION_DURATION The amount of time that has passed since the last Drill or Recovery instance launch in seconds.
DURATION_SUCCESSFUL_RECOVERY_LAUNCH The cumulative amount of time this server has been replicating for in seconds.
REPLICATION_PERCENTAGE The percentage of the server’s storage that was successfully replicated.
DRS-RECOVERY-INSTANCE
LAG_DURATION The latest consistent snapshot age, in seconds.
BACKLOG The amount of data yet to be synced, in bytes.
ELAPSED_REPLICATION_DURATION The amount of time that has passed since the last Drill or Recovery instance launch in seconds.
REPLICATION_PERCENTAGE The percentage of the server’s storage that was successfully replicated.

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
ip_type int Monitoring is performed over the selected internet protocol.
primary_protocol int Choose the primary internet protocol for the resources.Select only if you’re configuring ip_type=3 (Both IPv4 and IPv6 monitoring)
secondary_protocol_severity int Configure the status change for the secondary resource for which you want to get notified.Select only if you’re configuring ip_type=3 (Both IPv4 and IPv6 monitoring)
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.
follow_redirect boolean Enter true to follow up to 10 HTTP redirection responses or false not to follow HTTP redirections.
ignore_cert_err boolean Enter true to trust the server certificate and ignore the validation error or false to get alerted when the server certificate validation fails.
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 Mandatory Choose the browser type. Default is value is 1.
browser_version int Mandatory Choose the browser version. Default is value is 83.
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_method string Authentication method to access the endpoint.
credential_profile_id string Credential Profile to associate.
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 - 2, Response Header - 3) 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: 2, header_name: “$Header Name”, header_value: “$Header Value”}, {link: “$URL”, type: 3, 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.
ip_type int Mandatory Choose the Ip Type. Default is value is 2.
ignore_trust boolean To ignore the validation of SSL/TLS certificate chain.
jwt_id string Token ID of the Webtoken to be associated with the monitor.
element_check JSON Object Enter the type of the identifier (XPath - 1, css - 2, id - 3, name - 4, linktext - 5) that you wish to validate, and enter the Element locator and value. (The Value can also be a regular expression.)
JSON Format:{ value: “[{type: 1, locator: ”$Element locator", value: “$Element Value”}, {type: 2, locator: “$Element locator”, value: “$Element Value”}], severity: “$alert_type_constant”}

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_method string Authentication method to access the endpoint.
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 Web Token to be associated with the monitor.
aws_monitor_id string Amazon Monitor ID to be associated with the monitor for authentication.
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.

File Upload

Monitor the performance and availability of your File Upload API.

Attribute Type Description
display_name string Mandatory
Name of the monitor.
type string Mandatory
FILEUPLOAD
website string Mandatory
URL to be monitored.
check_frequency string Mandatory
The frequency or interval for monitoring.
timeout int Mandatory
The maximum duration within which a connection should be established with the 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, Provide an on_call_scheduler_id to receive alerts if you haven’t specified a user_group_id.
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 be done 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.
multipart_headers JSONArray Key-Value pair of text data and file data which should be present in the request body
JSON Format: [{“name”:“$fileKey”,“value”:“$fileFormat”,“response_type”:“F”},{“name”:“$textKey”,“value”:“textValue”,“response_type”:“T”}]
Supported File Formats: json,txt,xml,zip,jpg and csv.
binary_file_name string The file format which needs to sent in the request body
Supported File Formats: json,txt,xml,zip,jpg and csv.
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 with.
Create new monitor group or find your preferred monitor group’s ID.
dependency_resource_ids array Suppress alert when dependent monitor(s) are 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 absence 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 searches.
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 for sending notifications.
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.

gRPC

Monitor the performance and availability of a gRPC server by simulating client calls to gRPC services.

Attribute Type Description
display_name string Mandatory
Name of the monitor.
type string Mandatory
GRPC
host_name string Mandatory
IP address or domain name of the gRPC endpoint.
port int Mandatory
The port the host is listening to.
check_frequency string Mandatory
The frequency or interval for monitoring.
use_ssl boolean Use a secure connection (SSL).
timeout int Mandatory
The time within which a connection should be established with the gRPC endpoint.
Range 1 - 45.
use_ipv6 boolean Select IPv6 for monitoring the gRPC endpoint hosted on IPv6 addresses. Monitoring for non-IPv6 locations will be through IPv4.
proto_file string Name of the proto file that is being uploaded.
proto string The contents of the proto file that defines the gRPC endpoint services.
service string Mandatory
Name of the gRPC service you would like to monitor.
method string Method name of your preference to initiate the gRPC call for monitoring.
message string Input message for the gRPC call as JSON format.
auth_method string Authentication method to access the gRPC endpoint.
credential_profile_id string Web Credential Profile to be associated.
Add a new profile or find the ID of your preferred Credential Profile.
clientcert_credential_profile_id string Client Certificate Credential Profile to be associated.
Add a new profile or find the ID of your preferred Credential Profile.
oauth2_provider string Provider ID of the OAuth Provider to be associated with the monitor.
jwt_id string Token ID of the Web Token to be associated with the monitor.
match_json json Check the JSON in the response recieved.
JSON Format: {jsonpath: [{name: “$JSONPATH”}], severity: “$alert_type_constant”}
response_headers_check json Check whether the gRPC trailers are present or verify gRPC trailers and corresponding values against predefined names and values. Trigger Down or Trouble alerts during failure.
JSON Format: {value: [{name: “$trailer_name”, value: “$trailer_value”}], severity: “$alert_type_constant”}
custom_headers JSON array Metadata name and value in a string array.
JSON Format: {name: “$Metadata Name”, value: “$Metadata Value”}
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 chosen,
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, Provide an on_call_scheduler_id to receive alerts if you haven’t specified a user_group_id.
Create new On-Call Schedule or find your preferred On-Call Schedule ID.
monitor_groups array Mandatory
Group IDs to associate monitors with.
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 which notifications should be sent.
tag_ids array Tag IDs to be associated with the monitor.
Create new tag or find your preferred tag’s ID.

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.
protocol int Mandatory
HTTP protocol version of your preference for communication with the server. Default value: 0.
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
application_type string Provide the application type that runs on the configured port.
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).
invert_port_check boolean Invert the default behaviour of PORT check.
  • true - Notify when the port is open or when the port is listening.
  • false - Notify when the port is closed or when the port is not listening.

Default value: false
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
oauth2_provider string Provider ID of the OAuth provider to be associated with the monitor.
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.
authentication_required 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_oauth2_provider string Provider ID of the OAuth provider to fetch the email.
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.
steps JSONArray Step stands for the API transactions for a single monitor. Create multiple steps and arrange them in order of execution.
JSON Format [$Step, $Step]

REST API Transaction Step 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 API request details related to this step. Array should contain only one item.
JSON Format [$Step Detail]

Step Detail

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_method string Authentication method to access the endpoint.
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.
aws_monitor_id string Amazon Monitor ID to be associated with the monitor for authentication.
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”}
ssl_protocol string Specify the version of the SSL protocol. If you are not sure about the version, use Auto.
The 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.
step_delay int Time delay in seconds to invoke a step after completing the previous step. A maximum delay of 60 seconds is allowed for one monitor.

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,
            "http_protocol":"H2",
            "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",
            "use_alpn":true,
            "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

Type Description
JSONArray JSON Format [$Step, $Step]

Web Transaction (Browser)

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
base_url string Mandatory
BaseURL of the transaction.
selenium_script string Mandatory
Recorded Trasanction script to create a monitor.
script_type string Mandatory
Recorded transaction script type.(txt , side)
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.
ip_type int Mandatory Choose the Ip Type. Default is value is 2.
ignore_trust boolean To ignore the validation of SSL/TLS certificate chain.

Web Transaction Browser Steps - POST not allowed

Steps are the individual transactions for the single monitor.

GET /monitors/steps/{monitor_id}

Retrieve Step details of an existing Web Transaction (Browser) 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": [
{
"step_actions": [
{
"type": "Open",
"value": "https://manageengine.com/"
}
],
"step_name": "Loading - https://manageengine.com",
"step_url": "https://manageengine.com",
"step_no": 1,
"step_id": "1000000084040"
},
{
"step_actions": [
{
"identifier": "xpath = //div[@id='header-mainsec']/div/div/div[2]/nav/div/ul/li/span",
"type": "Click"
}
],
"step_name": "click Products",
"step_url": "https://www.manageengine.com/",
"step_no": 2,
"step_id": "1000000084042"
},
{
"step_actions": [
{
"identifier": "xpath = //div[@id='header-mainsec']/div/div/div[2]/nav/div/ul/li[2]/span",
"type": "Click"
}
],
"step_name": "click Solutions",
"step_url": "https://www.manageengine.com/",
"step_no": 3,
"step_id": "1000000084044"
},
{
"step_actions": [
{
"identifier": "xpath = //div[@id='header-mainsec']/div/div/div[2]/nav/div/ul/li[3]/span",
"type": "Click"
}
],
"step_name": "click Company",
"step_url": "https://www.manageengine.com/",
"step_no": 4,
"step_id": "1000000084046"
},
{
"step_actions": [
{
"identifier": "xpath = //div[@id='header-mainsec']/div/div/div[2]/nav/div/ul/li[4]/span",
"type": "Click"
}
],
"step_name": "click Support",
"step_url": "https://www.manageengine.com/",
"step_no": 5,
"step_id": "1000000084048"
}
]
}

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

Type Description
JSONArray JSON Format [$Step, $Step]

Web Transaction Browser Update Step - POST not allowed

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

Path Parameters

Param Type Description
monitor_id string Mandatory
Unique ID of the monitor. You can find monitor_id using the monitor list api.
step_id string Mandatory
Unique ID for the individual transaction steps of the monitor.you can find step_id using the Get Steps.
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.
cluster_discovery boolean Auto discover VMWare cluster.
rp_auto_discovery boolean Auto discover VMWare cluster.
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.

Veeam Enterprise Manager Monitor

Monitor all your Veeam backup jobs and get notified about job failures, completion status, or any other relevant updates to safeguard your data integrity and prevent loss

Attribute Type Description
display_name string Mandatory
Name for the serve monitor.
type string Mandatory
VEEAM_ENTERPRISEMANAGER
veeam_ep_host_name string Mandatory
Hostname / IP Address of the Veeam Enterprise Manager.
veeam_api_port int Mandatory
Veeam Enterprise Manager API port.
credential_profile_id string Mandatory
Credential Profile to associate.
check_frequency string Mandatory
Check interval for monitoring.
Supported Frequencies : 5 mins, 10 mins, 15 mins, 30 mins.
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.
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.

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.
aws_arn string Mandatory
Amazon Resource Name for the Transit Gateway.
enable_tgw_flowlogs boolean Enable Flow Logs Metrics Collection for this Transit Gateway and its attachments.
flow_log_poll_interval int MandatoryPoll Interval for Transit Gateway Flow logs and Transit Gateway Attachment Flow Logs.
flow_log_threshold_profile_id string Mandatory
Threshold profile to be associated with the Transit Gateway Flow Logs.
Create new threshold profile or find your preferred threshold profile’s ID.
is_flow_log_integrated boolean Flow Logs Integrated for Transit Gateway.

Transit Gateway Attachment Monitor - POST not allowed

Monitor availability and performance of Transit Gateway Attachment.

Attribute Type Description
display_name string Mandatory
Transit Gateway Attachment name.
type string Mandatory
TGWATTACHMENT
resource_name string Mandatory
Transit Gateway Attachment ID.
region string Mandatory
System discovered region of the Transit Gateway Attachment.
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 Attachment.
enable_uptime_monitoring boolean Monitor the availability status of Transit Gateway Attachment.
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.
aws_arn string Mandatory
Amazon Resource Name for the Transit Gateway Attachment.
flow_log_threshold_profile_id string Mandatory
Threshold profile to be associated with the Transit Gateway Attachment Flow Logs.
Create new threshold profile or find your preferred threshold profile’s ID.
is_flow_log_integrated boolean Flow Logs Integrated for Transit Gateway.

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.

EBS Volume Monitor - POST not allowed

Monitor the usage and performance of Amazon EBS Volume

Attribute Type Description
display_name string Mandatory
The EBS Volume monitor name.
resource_name string Mandatory
The resource name for the EBS Volume monitor.
check_frequency string Mandatory
Check interval for monitoring.
aws_child_type string Mandatory
AWS child type for the EBS Volume monitor.
region string Mandatory
The system discovered region of the EBS Volume monitor.
aws_arn string The Amazon resource name for the Amazon Ebs Volume monitor.
aws_account_id string Mandatory
The AWS monitor 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.
auto_discover_ebssnapshots boolean Mandatory
Auto Discover EBS Snapshots
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.
tag_ids array Tag IDs used to associate with a monitor.
Create a new tag or find your preferred tag’s ID.
type string Mandatory
EBSVOLUME_AVAIL

AWS Batch Monitor - POST not allowed

Monitor the usage and performance of AWS Batch

Attribute Type Description
display_name string Mandatory
The compute environment name.
resource_name string Mandatory
The compute environment name.
aws_child_type string Mandatory
AWS child type for the AWS Batch monitor.
region string Mandatory
The system discovered region of the AWS Batch monitor.
aws_arn string Mandatory
The Amazon resource name for the AWS Batch monitor.
aws_account_id string Mandatory
The AWS monitor ID.
threshold_profile_id string Mandatory
Threshold profile to be associated with the monitor.
Create new threshold profile or find your preferred threshold profile’s ID.
notification_profile_id string Mandatory
Notification profile to be associated with the monitor.
Create new notification profile or find your preferred notification profile’s ID.
user_group_ids array Mandatory
User group to be notified on down.
Create new user group or find your preferred user group’s ID.
monitor_groups array Group IDs to associate monitor.
Create new monitor group or find your preferred monitor group’s ID.
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.

AWS Batch-Queue Monitor - POST not allowed

Monitor the usage and performance of AWS Batch Queue

Attribute Type Description
display_name string Mandatory
The compute environment name.
resource_name string Mandatory
The compute environment name.
aws_child_type string Mandatory
AWS child type for the AWS Batch monitor.
region string Mandatory
The system discovered region of the AWS Batch monitor.
aws_arn string Mandatory
The Amazon resource name for the AWS Batch monitor.
aws_account_id string Mandatory
The AWS monitor ID.
threshold_profile_id string Mandatory
Threshold profile to be associated with the monitor.
Create new threshold profile or find your preferred threshold profile’s ID.
notification_profile_id string Mandatory
Notification profile to be associated with the monitor.
Create new notification profile or find your preferred notification profile’s ID.
user_group_ids array Mandatory
User group to be notified on down.
Create new user group or find your preferred user group’s ID.
monitor_groups array Group IDs to associate monitor.
Create new monitor group or find your preferred monitor group’s ID.
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.

EBS Snapshot Monitor - POST not allowed

Monitor the usage and performance of Amazon EBS Snapshot

Attribute Type Description
display_name string Mandatory
The EBS Snapshot monitor name.
resource_name string Mandatory
The resource name for the EBS Snapshot monitor.
check_frequency string Mandatory
Check interval for monitoring.
aws_child_type string Mandatory
AWS child type for the EBS Snapshot monitor.
region string Mandatory
The system discovered region of the EBS Snapshot monitor.
aws_account_id string Mandatory
The AWS monitor 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.
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.
tag_ids array Tag IDs used to associate with a monitor.
Create a new tag or find your preferred tag’s ID.
type string Mandatory
EBS_SNAPSHOT

AWS Secret Manager Monitor - POST not allowed

Monitor the usage and performance of AWS Secret Manager

Attribute Type Description
display_name string Mandatory
AWS Secret Manager monitor name.
resource_name string Mandatory
AWS Secret Manager secret identifier.
aws_child_type string Mandatory
AWS child type for the AWS Secret Manager monitor.
region string Mandatory
The system discovered region of the AWS Secret Manager monitor.
aws_arn string Mandatory
The Amazon resource name for the AWS Secret Manager monitor.
aws_account_id string Mandatory
The AWS monitor ID.
threshold_profile_id string Mandatory
Threshold profile to be associated with the monitor.
Create new threshold profile or find your preferred threshold profile’s ID.
notification_profile_id string Mandatory
Notification profile to be associated with the monitor.
Create new notification profile or find your preferred notification profile’s ID.
user_group_ids array Mandatory
User group to be notified on down.
Create new user group or find your preferred user group’s ID.
monitor_groups array Group IDs to associate monitor.
Create new monitor group or find your preferred monitor group’s ID.
action_ids json array The 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.

AWS Secret Manager Regional Monitor - POST not allowed

Monitor the usage and performance of AWS Secret Manager Regional

Attribute Type Description
display_name string Mandatory
The Secret Manager Regional monitor name.
resource_name string Mandatory
The Secret Manager Regional identifier.
aws_child_type string Mandatory
AWS child type for the AWS Secret Manager Regional monitor.
region string Mandatory
The system discovered region of the AWS Secret Manager Regional monitor.
aws_arn string Mandatory
The Amazon resource name for the AWS Secret Manager Regional monitor.
aws_account_id string Mandatory
The AWS monitor ID.
threshold_profile_id string Mandatory
Threshold profile to be associated with the monitor.
Create new threshold profile or find your preferred threshold profile’s ID.
notification_profile_id string Mandatory
Notification profile to be associated with the monitor.
Create new notification profile or find your preferred notification profile’s ID.
user_group_ids array Mandatory
User group to be notified on down.
Create new user group or find your preferred user group’s ID.
monitor_groups array Group IDs to associate monitor.
Create new monitor group or find your preferred monitor group’s ID.
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.

AWS Elastic IP Monitor - POST not allowed

Monitor the usage and performance of AWS Elastic IP

Attribute Type Description
display_name string Mandatory
The Elastic IP monitor name.
resource_name string Mandatory
The Elastic IP identifier.
aws_child_type string Mandatory
AWS child type for the AWS Elastic IP monitor.
region string Mandatory
The system discovered region of the AWS Elastic IP monitor.
aws_arn string Mandatory
The Amazon resource name for the AWS Elastic IP monitor.
aws_account_id string Mandatory
The AWS monitor ID.
threshold_profile_id string Mandatory
Threshold profile to be associated with the monitor.
Create new threshold profile or find your preferred threshold profile’s ID.
notification_profile_id string Mandatory
Notification profile to be associated with the monitor.
Create new notification profile or find your preferred notification profile’s ID.
user_group_ids array Mandatory
User group to be notified on down.
Create new user group or find your preferred user group’s ID.
monitor_groups array Group IDs to associate monitor.
Create new monitor group or find your preferred monitor group’s ID.
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.

PROCSTAT Monitor - POST not allowed

Monitor the usage and performance of EC2 Cloudwatch Agent Monitor.

Attribute Type Description
display_name string Mandatory
The Procstat monitor name.
type string Mandatory
PROCSTAT
resource_name string Mandatory
The Procstat monitor name.
aws_child_type string Mandatory
AWS child type for the Procstat monitor.
region string Mandatory
The system discovered region of the Procstat monitor.
aws_arn string Mandatory
The Amazon resource name for the Procstat monitor.
aws_account_id string Mandatory
The AWS monitor ID.
threshold_profile_id string Mandatory
Threshold profile to be associated with the monitor.
Create new threshold profile or find your preferred threshold profile’s ID.
notification_profile_id string Mandatory
Notification profile to be associated with the monitor.
Create new notification profile or find your preferred notification profile’s ID.
user_group_ids array Mandatory
User group to be notified on down.
Create new user group or find your preferred user group’s ID.
monitor_groups array Group IDs to associate monitor.
Create new monitor group or find your preferred monitor group’s ID.
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.

Virtual Private Cloud Monitor - POST not allowed

Monitor the usage and performance of Amazon Virtual Private Cloud

Attribute Type Description
display_name string Mandatory
The Virtual Private Cloud monitor name.
resource_name string Mandatory
The resource name for the Virtual Private Cloud monitor.
check_frequency string Mandatory
Check interval for monitoring.
aws_child_type string Mandatory
AWS child type for the Virtual Private Cloud monitor.
region string Mandatory
The system discovered region of the Virtual Private Cloud monitor.
aws_account_id string Mandatory
The AWS monitor 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.
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.
tag_ids array Tag IDs used to associate with a monitor.
Create a new tag or find your preferred tag’s ID.
type string Mandatory
VPC_META
enable_uptime_monitoring boolean Monitor the availability status of Virtual Private Cloud.

VPC Region Monitor - POST not allowed

Monitor the usage and performance of Amazon VPC Region

Attribute Type Description
display_name string Mandatory
The VPC Region monitor name.
resource_name string Mandatory
The resource name for the VPC Region monitor.
check_frequency string Mandatory
Check interval for monitoring.
aws_child_type string Mandatory
AWS child type for the VPC Region monitor.
region string Mandatory
The system discovered region of the VPC Region monitor.
aws_account_id string Mandatory
The AWS monitor 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.
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.
tag_ids array Tag IDs used to associate with a monitor.
Create a new tag or find your preferred tag’s ID.
type string Mandatory
VPC_REGIONAL
enable_uptime_monitoring boolean Monitor the availability status of VPC Region.

VPC Availability Zone Monitor - POST not allowed

Monitor the usage and performance of Amazon VPC Availability Zone

Attribute Type Description
display_name string Mandatory
The VPC Availability Zone monitor name.
resource_name string Mandatory
The resource name for the VPC Availability Zone monitor.
check_frequency string Mandatory
Check interval for monitoring.
aws_child_type string Mandatory
AWS child type for the VPC Availability Zone monitor.
region string Mandatory
The system discovered region of the VPC Availability Zone monitor.
aws_account_id string Mandatory
The AWS monitor 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.
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.
tag_ids array Tag IDs used to associate with a monitor.
Create a new tag or find your preferred tag’s ID.
type string Mandatory
VPC_AZ
enable_uptime_monitoring boolean Monitor the availability status of VPC Availability Zone.

VPC Monitor - POST not allowed

Monitor the usage and performance of Amazon VPC

Attribute Type Description
display_name string Mandatory
The VPC monitor name.
resource_name string Mandatory
The resource name for the VPC monitor.
check_frequency string Mandatory
Check interval for monitoring.
aws_child_type string Mandatory
AWS child type for the VPC monitor.
region string Mandatory
The system discovered region of the VPC monitor.
aws_account_id string Mandatory
The AWS monitor 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.
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.
tag_ids array Tag IDs used to associate with a monitor.
Create a new tag or find your preferred tag’s ID.
type string Mandatory
VPC
enable_uptime_monitoring boolean Monitor the availability status of VPC.

VPC Subnet Monitor - POST not allowed

Monitor the usage and performance of Amazon VPC Subnet

Attribute Type Description
display_name string Mandatory
The VPC Subnet monitor name.
resource_name string Mandatory
The resource name for the VPC Subnet monitor.
check_frequency string Mandatory
Check interval for monitoring.
aws_child_type string Mandatory
AWS child type for the VPC Subnet monitor.
region string Mandatory
The system discovered region of the VPC Subnet monitor.
aws_account_id string Mandatory
The AWS monitor 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.
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.
tag_ids array Tag IDs used to associate with a monitor.
Create a new tag or find your preferred tag’s ID.
type string Mandatory
VPC_SUBNET
enable_uptime_monitoring boolean Monitor the availability status of VPC Subnet.

VPC Network Interface Monitor - POST not allowed

Monitor the usage and performance of Amazon VPC Network Interface

Attribute Type Description
display_name string Mandatory
The VPC Network Interface monitor name.
resource_name string Mandatory
The resource name for the VPC Network Interface monitor.
check_frequency string Mandatory
Check interval for monitoring.
aws_child_type string Mandatory
AWS child type for the VPC Network Interface monitor.
region string Mandatory
The system discovered region of the VPC Network Interface monitor.
aws_account_id string Mandatory
The AWS monitor 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.
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.
tag_ids array Tag IDs used to associate with a monitor.
Create a new tag or find your preferred tag’s ID.
type string Mandatory
VPC_NI
enable_uptime_monitoring boolean Monitor the availability status of VPC Network Interface.

VPC Protocol Monitor - POST not allowed

Monitor the usage and performance of Amazon VPC Protocol

Attribute Type Description
display_name string Mandatory
The VPC Protocol monitor name.
resource_name string Mandatory
The resource name for the VPC Protocol monitor.
check_frequency string Mandatory
Check interval for monitoring.
aws_child_type string Mandatory
AWS child type for the VPC Protocol monitor.
region string Mandatory
The system discovered region of the VPC Protocol monitor.
aws_account_id string Mandatory
The AWS monitor ID.
dependency_resource_ids array Suppress alert when dependent monitor(s) is down.
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.
tag_ids array Tag IDs used to associate with a monitor.
Create a new tag or find your preferred tag’s ID.
type string Mandatory
VPC_PROTOCOL
enable_uptime_monitoring boolean Monitor the availability status of VPC Protocol.

VPC Route Table Monitor - POST not allowed

Monitor the usage and performance of Amazon VPC Route Table

Attribute Type Description
display_name string Mandatory
The VPC Route Table monitor name.
resource_name string Mandatory
The resource name for the VPC Route Table monitor.
check_frequency string Mandatory
Check interval for monitoring.
aws_child_type string Mandatory
AWS child type for the VPC Protocol monitor.
region string Mandatory
The system discovered region of the VPC Protocol monitor.
aws_account_id string Mandatory
The AWS monitor ID.
dependency_resource_ids array Suppress alert when dependent monitor(s) 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.
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.
tag_ids array Tag IDs used to associate with a monitor.
Create a new tag or find your preferred tag’s ID.
type string Mandatory
VPC_RT
enable_uptime_monitoring boolean Monitor the availability status of VPC Route Table.

AWS Trusted Advisor Category Monitor - POST not allowed

Monitor the usage and performance of AWS Trusted Advisor Category Monitor.

Attribute Type Description
display_name string Mandatory
The AWS Trusted Advisor Category monitor name.
resource_name string Mandatory
The AWS Trusted Advisor Category identifier.
check_frequency string Mandatory
Poll interval for monitoring.
region string Mandatory
The system discovered region of the AWS Trusted Advisor Category monitor.
aws_child_type string Mandatory
AWS child type for the AWS Trusted Advisor Category monitor.
aws_account_id string Mandatory
The AWS Monitor Id.
aws_arn string The Amazon resource name for the AWS Trusted Advisor Category monitor.
monitor_groups array Group IDs to associate monitor.
Create new monitor group or find your preferred monitor group’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..
tag_ids array Tag IDs to associate with a monitor.
Create a new tag or find your preferred tag’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.
user_group_ids array Mandatory
User group to be notified on down.
Create a new user group or find your preferred user group’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.
third_party_services array Third party services to be notified.

AWS Trusted Advisor Checks Monitor - POST not allowed

Monitor the usage and performance of AWS Trusted Advisor Checks Monitor.

Attribute Type Description
display_name string Mandatory
The AWS Trusted Advisor Checks monitor name.
resource_name string Mandatory
The AWS Trusted Advisor Checks identifier.
check_frequency string Mandatory
Poll interval for monitoring.
region string Mandatory
The system discovered region of the AWS Trusted Advisor Checks monitor.
aws_child_type string Mandatory
AWS child type for the Trusted Advisor Checks monitor.
aws_account_id string Mandatory
The AWS Monitor Id.
aws_arn string The Amazon resource name for the AWS Trusted Advisor Checks monitor.
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..
tag_ids array Tag IDs to associate with a monitor.
Create a new tag or find your preferredtag’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.

AWS MSK Serverless - POST not allowed

Monitor the usage and performance of MSK Serverless .

Attribute Type Description
display_name string Mandatory
The MSK Serverless monitor name.
resource_name string Mandatory
The MSK Serverless identifier.
check_frequency string Mandatory
Poll interval for monitoring.
region string Mandatory
The system discovered region of the MSK Serverless monitor.
aws_child_type string Mandatory
AWS child type for the MSK Serverless monitor.
aws_account_id string Mandatory
The AWS monitor ID.
aws_arn string The Amazon resource name for the MSK Serverless monitor.
monitor_groups array Group IDs to associate monitor.
Create new monitor group or find your preferred monitor group’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..
tag_ids array Tag IDs to associate with a monitor.
Create a new tag or find your preferred tag’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.
user_group_ids array Mandatory
User group to be notified on down.
Create a new user group or find your preferred user group’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.
third_party_services array Third party services to be notified.

AWS MSK Connect - POST not allowed

Monitor the usage and performance of MSK Connect .

Attribute Type Description
display_name string Mandatory
The MSK Connect monitor name.
resource_name string Mandatory
The MSK Connect identifier.
check_frequency string Mandatory
Poll interval for monitoring.
region string Mandatory
The system discovered region of the MSK Connect monitor.
aws_child_type string Mandatory
AWS child type for the MSK Connect monitor.
aws_account_id string Mandatory
The AWS monitor ID.
aws_arn string The Amazon resource name for the MSK Connect monitor.
monitor_groups array Group IDs to associate monitor.
Create new monitor group or find your preferred monitor group’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..
tag_ids array Tag IDs to associate with a monitor.
Create a new tag or find your preferred tag’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.
user_group_ids array Mandatory
User group to be notified on down.
Create a new user group or find your preferred user group’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.
third_party_services array Third party services to be notified.

AWS MSK Cluster - POST not allowed

Monitor the usage and performance of MSK Cluster .

Attribute Type Description
display_name string Mandatory
The MSK Cluster monitor name.
resource_name string Mandatory
The MSK Cluster identifier.
check_frequency string Mandatory
Poll interval for monitoring.
region string Mandatory
The system discovered region of the MSK Cluster monitor.
aws_child_type string Mandatory
AWS child type for the MSK Cluster monitor.
aws_account_id string Mandatory
The AWS monitor ID.
aws_arn string The Amazon resource name for the MSK Cluster monitor.
monitor_groups array Group IDs to associate monitor.
Create new monitor group or find your preferred monitor group’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..
tag_ids array Tag IDs to associate with a monitor.
Create a new tag or find your preferred tag’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.
user_group_ids array Mandatory
User group to be notified on down.
Create a new user group or find your preferred user group’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.
third_party_services array Third party services to be notified.

AWS MSK Replicator - POST not allowed

Monitor the usage and performance of MSK Replicator .

Attribute Type Description
display_name string Mandatory
The MSK Replicator monitor name.
resource_name string Mandatory
The MSK Replicator identifier.
check_frequency string Mandatory
Poll interval for monitoring.
region string Mandatory
The system discovered region of the MSK Replicator monitor.
aws_child_type string Mandatory
AWS child type for the MSK Replicator monitor.
aws_account_id string Mandatory
The AWS monitor ID.
aws_arn string The Amazon resource name for the MSK Replicator monitor.
monitor_groups array Group IDs to associate monitor.
Create new monitor group or find your preferred monitor group’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..
tag_ids array Tag IDs to associate with a monitor.
Create a new tag or find your preferred tag’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.
user_group_ids array Mandatory
User group to be notified on down.
Create a new user group or find your preferred user group’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.
third_party_services array Third party services to be notified.

AWS MSK Topic - POST not allowed

Monitor the usage and performance of MSK Topic .

Attribute Type Description
display_name string Mandatory
The MSK Topic monitor name.
resource_name string Mandatory
The MSK Topic identifier.
check_frequency string Mandatory
Poll interval for monitoring.
region string Mandatory
The system discovered region of the MSK Topic monitor.
aws_child_type string Mandatory
AWS child type for the MSK Topic monitor.
aws_account_id string Mandatory
The AWS monitor ID.
aws_arn string The Amazon resource name for the MSK Topic monitor.
monitor_groups array Group IDs to associate monitor.
Create new monitor group or find your preferred monitor group’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..
tag_ids array Tag IDs to associate with a monitor.
Create a new tag or find your preferred tag’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.
user_group_ids array Mandatory
User group to be notified on down.
Create a new user group or find your preferred user group’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.
third_party_services array Third party services to be notified.

AWS MSK Broker - POST not allowed

Monitor the usage and performance of MSK Broker .

Attribute Type Description
display_name string Mandatory
The MSK Broker monitor name.
resource_name string Mandatory
The MSK Broker identifier.
check_frequency string Mandatory
Poll interval for monitoring.
region string Mandatory
The system discovered region of the MSK Broker monitor.
aws_child_type string Mandatory
AWS child type for the MSK Broker monitor.
aws_account_id string Mandatory
The AWS monitor ID.
aws_arn string The Amazon resource name for the MSK Broker monitor.
monitor_groups array Group IDs to associate monitor.
Create new monitor group or find your preferred monitor group’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..
tag_ids array Tag IDs to associate with a monitor.
Create a new tag or find your preferred tag’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.
user_group_ids array Mandatory
User group to be notified on down.
Create a new user group or find your preferred user group’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.
third_party_services array Third party services to be notified.

Glue Job - POST not allowed

Monitor the usage and performance of Glue Job .

Attribute Type Description
display_name string Mandatory
The Glue Job monitor name.
job_name string Mandatory
The Glue Job identifier.
check_frequency string Mandatory
Poll interval for monitoring.
region string Mandatory
The system discovered region of the Glue Job monitor.
aws_child_type string Mandatory
AWS child type for the Glue Job monitor.
job_type string Mandatory
The Glue Job type.
aws_account_id string Mandatory
The AWS monitor ID.
aws_arn string The Amazon resource name for the Glue Job monitor.
monitor_groups array Group IDs to associate monitor.
Create new monitor group or find your preferred monitor group’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..
tag_ids array Tag IDs to associate with a monitor.
Create a new tag or find your preferred tag’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.
user_group_ids array Mandatory
User group to be notified on down.
Create a new user group or find your preferred user group’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.
third_party_services array Third party services to be notified.

Glue Crawler - POST not allowed

Monitor the usage and performance of Glue Crawler .

Attribute Type Description
display_name string Mandatory
The Glue Crawler monitor name.
crawler_name string Mandatory
The Glue Crawler identifier.
check_frequency string Mandatory
Poll interval for monitoring.
region string Mandatory
The system discovered region of the Glue Crawler monitor.
aws_child_type string Mandatory
AWS child type for the Glue Crawler monitor.
aws_account_id string Mandatory
The AWS monitor ID.
aws_arn string The Amazon resource name for the Glue Crawler monitor.
monitor_groups array Group IDs to associate monitor.
Create new monitor group or find your preferred monitor group’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..
tag_ids array Tag IDs to associate with a monitor.
Create a new tag or find your preferred tag’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.
user_group_ids array Mandatory
User group to be notified on down.
Create a new user group or find your preferred user group’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.
third_party_services array Third party services to be notified.

DRS Region - POST not allowed

Monitor the usage and performance of DRS Region.

Attribute Type Description
display_name string Mandatory
The DRS Region monitor name.
resource_name string Mandatory
The DRS Region identifier.
check_frequency string Mandatory
Poll interval for monitoring.
region string Mandatory
The system discovered region of the DRS Region monitor.
aws_child_type string Mandatory
AWS child type for the DRS Region monitor.
aws_account_id string Mandatory
The AWS monitor ID.
aws_arn string The Amazon resource name for the DRS Region monitor.
monitor_groups array Group IDs to associate monitor.
Create new monitor group or find your preferred monitor group’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..
tag_ids array Tag IDs to associate with a monitor.
Create a new tag or find your preferred tag’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.
user_group_ids array Mandatory
User group to be notified on down.
Create a new user group or find your preferred user group’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.
third_party_services array Third party services to be notified.

DRS Source Server - POST not allowed

Monitor the usage and performance of DRS Source Server.

Attribute Type Description
display_name string Mandatory
The DRS Source Server monitor name.
resource_name string Mandatory
The DRS Source Server identifier.
check_frequency string Mandatory
Poll interval for monitoring.
region string Mandatory
The system discovered region of the DRS Source Server monitor.
aws_child_type string Mandatory
AWS child type for the DRS Source Server monitor.
aws_account_id string Mandatory
The AWS monitor ID.
aws_arn string The Amazon resource name for the DRS Source Server monitor.
monitor_groups array Group IDs to associate monitor.
Create new monitor group or find your preferred monitor group’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..
tag_ids array Tag IDs to associate with a monitor.
Create a new tag or find your preferred tag’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.
user_group_ids array Mandatory
User group to be notified on down.
Create a new user group or find your preferred user group’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.
third_party_services array Third party services to be notified.

DRS Recovery Instance - POST not allowed

Monitor the usage and performance of DRS Recovery Instance.

Attribute Type Description
display_name string Mandatory
The DRS Recovery Instance monitor name.
resource_name string Mandatory
The DRS Recovery Instance identifier.
check_frequency string Mandatory
Poll interval for monitoring.
region string Mandatory
The system discovered region of the DRS Recovery Instance monitor.
aws_child_type string Mandatory
AWS child type for the DRS Recovery Instance monitor.
aws_account_id string Mandatory
The AWS monitor ID.
aws_arn string The Amazon resource name for the DRS Recovery Instance monitor.
monitor_groups array Group IDs to associate monitor.
Create new monitor group or find your preferred monitor group’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..
tag_ids array Tag IDs to associate with a monitor.
Create a new tag or find your preferred tag’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.
user_group_ids array Mandatory
User group to be notified on down.
Create a new user group or find your preferred user group’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.
third_party_services array Third party services to be notified.

RabbitMQ Broker Monitor - POST not allowed

Monitor the usage and performance of RabbitMQ Broker.

Attribute Type Description
display_name string Mandatory
Name for the RabbitMQ Broker.
type string Mandatory
RABBIT_MQ
resource_name string Mandatory
RabbitMQ Broker instance ID.
region string Mandatory
System discovered region of the RabbitMQ 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
127
AWS child type for the RabbitMQ Broker.
enable_uptime_monitoring boolean Monitor the availability status of RabbitMQ 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.

RabbitMQ Queue Monitor - POST not allowed

Monitor the usage and performance of RabbitMQ Queue.

Attribute Type Description
display_name string Mandatory
Name for the RabbitMQ Queue.
type string Mandatory
RABBIT_MQ
resource_name string Mandatory
Name of the RabbitMQ Queue.
region string Mandatory
System discovered region of the RabbitMQ 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
128
AWS child type for the RabbitMQ Queue.
enable_uptime_monitoring boolean Monitor the availability status of RabbitMQ 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.

RabbitMQ Node Monitor - POST not allowed

Monitor the usage and performance of RabbitMQ Node.

Attribute Type Description
display_name string Mandatory
Name for the RabbitMQ Node.
type string Mandatory
RABBIT_MQ
resource_name string Mandatory
RabbitMQ Node name in AWS.
region string Mandatory
System discovered region of the RabbitMQ 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
130
AWS child type for the RabbitMQ Node.
enable_uptime_monitoring boolean Monitor the availability status of RabbitMQ 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.

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_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.
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 us