Skip to content

Amazon CloudWatch API

by amazonaws.com

API keyHTTPSCloud Platforms
Open documentation ↗

Overview

<p>Amazon CloudWatch monitors your Amazon Web Services (Amazon Web Services) resources and the applications you run on Amazon Web Services in real time. You can use CloudWatch to collect and track metrics, which are the variables you want to measure for your resources and applications.</p> <p>CloudWatch alarms send notifications or automatically change the resources you are monitoring based on rules that you define. For example, you can monitor the CPU usage and disk reads and writes of your Amazon EC2 instances. Then, use this data to determine whether you should launch additional instances to handle increased load. You can also use this data to stop under-used instances to save money.</p> <p>In addition to monitoring the built-in metrics that come with Amazon Web Services, you can monitor your own custom metrics. With CloudWatch, you gain system-wide visibility into resource utilization, application performance, and operational health.</p>

Amazon CloudWatch is a cloud platforms API from amazonaws.com. Requests are authenticated with an API key. It is served over HTTPS. Its OpenAPI description documents 76 endpoints.

At a glance

Authentication
API key
HTTPS
Yes
CORS
Unknown
Version
2010-08-01
Endpoints
76
Spec updated
2020-04-02

Endpoints

MethodPathWhat it does
GET/#Action=DeleteAlarms<p>Deletes the specified alarms. You can delete up to 100 alarms in one operation. However, this total can include no more than one composite alarm. For example
POST/#Action=DeleteAlarms<p>Deletes the specified alarms. You can delete up to 100 alarms in one operation. However, this total can include no more than one composite alarm. For example
GET/#Action=DeleteAnomalyDetectorDeletes the specified anomaly detection model from your account. For more information about how to delete an anomaly detection model, see <a href="https://docs.
POST/#Action=DeleteAnomalyDetectorDeletes the specified anomaly detection model from your account. For more information about how to delete an anomaly detection model, see <a href="https://docs.
GET/#Action=DeleteDashboardsDeletes all dashboards that you specify. You can specify up to 100 dashboards to delete. If there is an error during this call, no dashboards are deleted.
POST/#Action=DeleteDashboardsDeletes all dashboards that you specify. You can specify up to 100 dashboards to delete. If there is an error during this call, no dashboards are deleted.
GET/#Action=DeleteInsightRules<p>Permanently deletes the specified Contributor Insights rules.</p> <p>If you create a rule, delete it, and then re-create it with the same name, historical da
POST/#Action=DeleteInsightRules<p>Permanently deletes the specified Contributor Insights rules.</p> <p>If you create a rule, delete it, and then re-create it with the same name, historical da
GET/#Action=DeleteMetricStreamPermanently deletes the metric stream that you specify.
POST/#Action=DeleteMetricStreamPermanently deletes the metric stream that you specify.
GET/#Action=DescribeAlarmHistory<p>Retrieves the history for the specified alarm. You can filter the results by date range or item type. If an alarm name is not specified, the histories for ei
POST/#Action=DescribeAlarmHistory<p>Retrieves the history for the specified alarm. You can filter the results by date range or item type. If an alarm name is not specified, the histories for ei
GET/#Action=DescribeAlarms<p>Retrieves the specified alarms. You can filter the results by specifying a prefix for the alarm name, the alarm state, or a prefix for any action.</p> <p>To
POST/#Action=DescribeAlarms<p>Retrieves the specified alarms. You can filter the results by specifying a prefix for the alarm name, the alarm state, or a prefix for any action.</p> <p>To
GET/#Action=DescribeAlarmsForMetric<p>Retrieves the alarms for the specified metric. To filter the results, specify a statistic, period, or unit.</p> <p>This operation retrieves only standard ala
POST/#Action=DescribeAlarmsForMetric<p>Retrieves the alarms for the specified metric. To filter the results, specify a statistic, period, or unit.</p> <p>This operation retrieves only standard ala
GET/#Action=DescribeAnomalyDetectorsLists the anomaly detection models that you have created in your account. For single metric anomaly detectors, you can list all of the models in your account or
POST/#Action=DescribeAnomalyDetectorsLists the anomaly detection models that you have created in your account. For single metric anomaly detectors, you can list all of the models in your account or
GET/#Action=DescribeInsightRules<p>Returns a list of all the Contributor Insights rules in your account.</p> <p>For more information about Contributor Insights, see <a href="https://docs.aws.a
POST/#Action=DescribeInsightRules<p>Returns a list of all the Contributor Insights rules in your account.</p> <p>For more information about Contributor Insights, see <a href="https://docs.aws.a
GET/#Action=DisableAlarmActionsDisables the actions for the specified alarms. When an alarm's actions are disabled, the alarm actions do not execute when the alarm state changes.
POST/#Action=DisableAlarmActionsDisables the actions for the specified alarms. When an alarm's actions are disabled, the alarm actions do not execute when the alarm state changes.
GET/#Action=DisableInsightRulesDisables the specified Contributor Insights rules. When rules are disabled, they do not analyze log groups and do not incur costs.
POST/#Action=DisableInsightRulesDisables the specified Contributor Insights rules. When rules are disabled, they do not analyze log groups and do not incur costs.
GET/#Action=EnableAlarmActionsEnables the actions for the specified alarms.
POST/#Action=EnableAlarmActionsEnables the actions for the specified alarms.
GET/#Action=EnableInsightRulesEnables the specified Contributor Insights rules. When rules are enabled, they immediately begin analyzing log data.
POST/#Action=EnableInsightRulesEnables the specified Contributor Insights rules. When rules are enabled, they immediately begin analyzing log data.
GET/#Action=GetDashboard<p>Displays the details of the dashboard that you specify.</p> <p>To copy an existing dashboard, use <code>GetDashboard</code>, and then use the data returned w
POST/#Action=GetDashboard<p>Displays the details of the dashboard that you specify.</p> <p>To copy an existing dashboard, use <code>GetDashboard</code>, and then use the data returned w
GET/#Action=GetInsightRuleReport<p>This operation returns the time series data collected by a Contributor Insights rule. The data includes the identity and number of contributors to the log gr
POST/#Action=GetInsightRuleReport<p>This operation returns the time series data collected by a Contributor Insights rule. The data includes the identity and number of contributors to the log gr
GET/#Action=GetMetricData<p>You can use the <code>GetMetricData</code> API to retrieve CloudWatch metric values. The operation can also include a CloudWatch Metrics Insights query, and
POST/#Action=GetMetricData<p>You can use the <code>GetMetricData</code> API to retrieve CloudWatch metric values. The operation can also include a CloudWatch Metrics Insights query, and
GET/#Action=GetMetricStatistics<p>Gets statistics for the specified metric.</p> <p>The maximum number of data points returned from a single call is 1,440. If you request more than 1,440 data
POST/#Action=GetMetricStatistics<p>Gets statistics for the specified metric.</p> <p>The maximum number of data points returned from a single call is 1,440. If you request more than 1,440 data
GET/#Action=GetMetricStreamReturns information about the metric stream that you specify.
POST/#Action=GetMetricStreamReturns information about the metric stream that you specify.
GET/#Action=GetMetricWidgetImage<p>You can use the <code>GetMetricWidgetImage</code> API to retrieve a snapshot graph of one or more Amazon CloudWatch metrics as a bitmap image. You can then e
POST/#Action=GetMetricWidgetImage<p>You can use the <code>GetMetricWidgetImage</code> API to retrieve a snapshot graph of one or more Amazon CloudWatch metrics as a bitmap image. You can then e
GET/#Action=ListDashboards<p>Returns a list of the dashboards for your account. If you include <code>DashboardNamePrefix</code>, only those dashboards with names starting with the prefix
POST/#Action=ListDashboards<p>Returns a list of the dashboards for your account. If you include <code>DashboardNamePrefix</code>, only those dashboards with names starting with the prefix
GET/#Action=ListManagedInsightRulesReturns a list that contains the number of managed Contributor Insights rules in your account.
POST/#Action=ListManagedInsightRulesReturns a list that contains the number of managed Contributor Insights rules in your account.
GET/#Action=ListMetricStreamsReturns a list of metric streams in this account.
POST/#Action=ListMetricStreamsReturns a list of metric streams in this account.
GET/#Action=ListMetrics<p>List the specified metrics. You can use the returned metrics with <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricData
POST/#Action=ListMetrics<p>List the specified metrics. You can use the returned metrics with <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricData
GET/#Action=ListTagsForResourceDisplays the tags associated with a CloudWatch resource. Currently, alarms and Contributor Insights rules support tagging.
POST/#Action=ListTagsForResourceDisplays the tags associated with a CloudWatch resource. Currently, alarms and Contributor Insights rules support tagging.
GET/#Action=PutAnomalyDetector<p>Creates an anomaly detection model for a CloudWatch metric. You can use the model to display a band of expected normal values when the metric is graphed.</p>
POST/#Action=PutAnomalyDetector<p>Creates an anomaly detection model for a CloudWatch metric. You can use the model to display a band of expected normal values when the metric is graphed.</p>
GET/#Action=PutCompositeAlarm<p>Creates or updates a <i>composite alarm</i>. When you create a composite alarm, you specify a rule expression for the alarm that takes into account the alarm
POST/#Action=PutCompositeAlarm<p>Creates or updates a <i>composite alarm</i>. When you create a composite alarm, you specify a rule expression for the alarm that takes into account the alarm
GET/#Action=PutDashboard<p>Creates a dashboard if it does not already exist, or updates an existing dashboard. If you update a dashboard, the entire contents are replaced with what you
POST/#Action=PutDashboard<p>Creates a dashboard if it does not already exist, or updates an existing dashboard. If you update a dashboard, the entire contents are replaced with what you
GET/#Action=PutInsightRule<p>Creates a Contributor Insights rule. Rules evaluate log events in a CloudWatch Logs log group, enabling you to find contributor data for the log events in th
POST/#Action=PutInsightRule<p>Creates a Contributor Insights rule. Rules evaluate log events in a CloudWatch Logs log group, enabling you to find contributor data for the log events in th
GET/#Action=PutManagedInsightRulesCreates a managed Contributor Insights rule for a specified Amazon Web Services resource. When you enable a managed rule, you create a Contributor Insights rule
POST/#Action=PutManagedInsightRulesCreates a managed Contributor Insights rule for a specified Amazon Web Services resource. When you enable a managed rule, you create a Contributor Insights rule
GET/#Action=PutMetricAlarm<p>Creates or updates an alarm and associates it with the specified metric, metric math expression, anomaly detection model, or Metrics Insights query. For more
POST/#Action=PutMetricAlarm<p>Creates or updates an alarm and associates it with the specified metric, metric math expression, anomaly detection model, or Metrics Insights query. For more
GET/#Action=PutMetricData<p>Publishes metric data points to Amazon CloudWatch. CloudWatch associates the data points with the specified metric. If the specified metric does not exist, C
POST/#Action=PutMetricData<p>Publishes metric data points to Amazon CloudWatch. CloudWatch associates the data points with the specified metric. If the specified metric does not exist, C
GET/#Action=PutMetricStream<p>Creates or updates a metric stream. Metric streams can automatically stream CloudWatch metrics to Amazon Web Services destinations, including Amazon S3, and
POST/#Action=PutMetricStream<p>Creates or updates a metric stream. Metric streams can automatically stream CloudWatch metrics to Amazon Web Services destinations, including Amazon S3, and
GET/#Action=SetAlarmState<p>Temporarily sets the state of an alarm for testing purposes. When the updated state differs from the previous value, the action configured for the appropriat
POST/#Action=SetAlarmState<p>Temporarily sets the state of an alarm for testing purposes. When the updated state differs from the previous value, the action configured for the appropriat
GET/#Action=StartMetricStreamsStarts the streaming of metrics for one or more of your metric streams.
POST/#Action=StartMetricStreamsStarts the streaming of metrics for one or more of your metric streams.
GET/#Action=StopMetricStreamsStops the streaming of metrics for one or more of your metric streams.
POST/#Action=StopMetricStreamsStops the streaming of metrics for one or more of your metric streams.
GET/#Action=TagResource<p>Assigns one or more tags (key-value pairs) to the specified CloudWatch resource. Currently, the only CloudWatch resources that can be tagged are alarms and C
POST/#Action=TagResource<p>Assigns one or more tags (key-value pairs) to the specified CloudWatch resource. Currently, the only CloudWatch resources that can be tagged are alarms and C
GET/#Action=UntagResourceRemoves one or more tags from the specified resource.
POST/#Action=UntagResourceRemoves one or more tags from the specified resource.

Questions

Does the Amazon CloudWatch API need an API key?

Yes. The Amazon CloudWatch API uses API key authentication; the documentation explains how to get credentials.

Does the Amazon CloudWatch API support HTTPS?

Yes, the Amazon CloudWatch API is served over HTTPS.

How many endpoints does the Amazon CloudWatch API have?

Its OpenAPI description lists 76 endpoints in version 2010-08-01. All of them are shown on this page.

What are alternatives to the Amazon CloudWatch API?

Other Cloud Platforms APIs include Remote Settings PROD, Linode API, DigitalOcean API, Vercel API, Platform API.

Compare alternatives →

Remote Settings PROD

Cloud Platforms

Firefox is a free web browser backed by Mozilla, a non-profit dedicated to internet health and privacy.

No auth19 endpoints

Linode API

Cloud Platforms

## Introduction The Linode API provides the ability to programmatically manage the full range of Linode products and services. This reference is designed to assist application developers and system administrators. Each endpoint includes descriptions, request syntax, and examples using standard HTTP requests. Response data is returned in JSON format. This document was generated from our OpenAPI Specification. See the <a target="_top" href="https://www.openapis.org">OpenAPI website</a> for more information. <a target="_top" href="/docs/api/openapi.yaml">Download the Linode OpenAPI Specification</a>. ## Changelog <a target="_top" href="/docs/products/tools/api/release-notes/">View our Changelog</a> to see release notes on all changes made to our API. ## Access and Authentication Some endpoints are publicly accessible without requiring authentication. All endpoints affecting your Account, however, require either a Personal Access Token or OAuth authentication (when using third-party applications). ### Personal Access Token The easiest way to access the API is with a Personal Access Token (PAT) generated from the <a target="_top" href="https://cloud.linode.com/profile/tokens">Linode Cloud Manager</a> or the [Create Personal Access Token](/docs/api/profile/#personal-access-token-create) endpoint. All scopes for the OAuth security model ([defined below](/docs/api/profile/#oauth)) apply to this security model as well. #### Authentication | Security Scheme Type: | HTTP | |-----------------------|------| | **HTTP Authorization Scheme** | bearer | ### OAuth If you only need to access the Linode API for personal use, we recommend that you create a [personal access token](/docs/api/#personal-access-token). If you're designing an application that can authenticate with an arbitrary Linode user, then you should use the OAuth 2.0 workflows presented in this section. For a more detailed example of an OAuth 2.0 implementation, see our guide on [How to Create an OAuth App with the Linode Python API Library](/docs/products/tools/api/guides/create-an-oauth-app-with-the-python-api-library/#oauth-2-authentication-exchange). Before you implement OAuth in your application, you first need to create an OAuth client. You can do this [with the Linode API](/docs/api/account/#oauth-client-create) or [via the Cloud Manager](https://cloud.linode.com/profile/clients): - When creating the client, you'll supply a `label` and a `redirect_uri` (referred to as the Callback URL in the Cloud Manager). - The response from this endpoint will give you a `client_id` and a `secret`. - Clients can be public or private, and are private by default. You can choose to make the client public when it is created. - A private client is used with applications which can securely store the client secret (that is, the secret returned to you when you first created the client). For example, an application running on a secured server that only the developer has access to would use a private OAuth client. This is also called a confidential client in some OAuth documentation. - A public client is used with applications where the client secret is not guaranteed to be secure. For example, a native app running on a user's computer may not be able to keep the client secret safe, as a user could potentially inspect the source of the application. So, native apps or apps that run in a user's browser should use a public client. - Public and private clients follow different workflows, as described below. #### OAuth Workflow The OAuth workflow is a series of exchanges between your third-party app and Linode. The workflow is used to authenticate a user before an application can start making API calls on the user's behalf. Notes: - With respect to the diagram in [section 1.2 of RFC 6749](https://tools.ietf.org/html/rfc6749#section-1.2), login.linode.com (referred to in this section as the *login server*) is the Resource Owner and the Authorization Server; api.linode.com (referred to here as the *api se

Bearer token350 endpoints

DigitalOcean API

Cloud Platforms

# Introduction The DigitalOcean API allows you to manage Droplets and resources within the DigitalOcean cloud in a simple, programmatic way using conventional HTTP requests. All of the functionality that you are familiar with in the DigitalOcean control panel is also available through the API, allowing you to script the complex actions that your situation requires. The API documentation will start with a general overview about the design and technology that has been implemented, followed by reference information about specific endpoints. ## Requests Any tool that is fluent in HTTP can communicate with the API simply by requesting the correct URI. Requests should be made using the HTTPS protocol so that traffic is encrypted. The interface responds to different methods depending on the action required. |Method|Usage| |--- |--- | |GET|For simple retrieval of information about your account, Droplets, or environment, you should use the GET method. The information you request will be returned to you as a JSON object. The attributes defined by the JSON object can be used to form additional requests. Any request using the GET method is read-only and will not affect any of the objects you are querying.| |DELETE|To destroy a resource and remove it from your account and environment, the DELETE method should be used. This will remove the specified object if it is found. If it is not found, the operation will return a response indicating that the object was not found. This idempotency means that you do not have to check for a resource's availability prior to issuing a delete command, the final state will be the same regardless of its existence.| |PUT|To update the information about a resource in your account, the PUT method is available. Like the DELETE Method, the PUT method is idempotent. It sets the state of the target using the provided values, regardless of their current values. Requests using the PUT method do not need to check the current attributes of the object.| |PATCH|Some resources support partial modification. In these cases, the PATCH method is available. Unlike PUT which generally requires a complete representation of a resource, a PATCH request is is a set of instructions on how to modify a resource updating only specific attributes.| |POST|To create a new object, your request should specify the POST method. The POST request includes all of the attributes necessary to create a new object. When you wish to create a new object, send a POST request to the target endpoint.| |HEAD|Finally, to retrieve metadata information, you should use the HEAD method to get the headers. This returns only the header of what would be returned with an associated GET request. Response headers contain some useful information about your API access and the results that are available for your request. For instance, the headers contain your current rate-limit value and the amount of time available until the limit resets. It also contains metrics about the total number of objects found, pagination information, and the total content length.| ## HTTP Statuses Along with the HTTP methods that the API responds to, it will also return standard HTTP statuses, including error codes. In the event of a problem, the status will contain the error code, while the body of the response will usually contain additional information about the problem that was encountered. In general, if the status returned is in the 200 range, it indicates that the request was fulfilled successfully and that no error was encountered. Return codes in the 400 range typically indicate that there was an issue with the request that was sent. Among other things, this could mean that you did not authenticate correctly, that you are requesting an action that you do not have authorization for, that the object you are requesting does not exist, or that your request is malformed. If you receive a status in the 500 range, this generally indicates a server-side problem. This means that we are having

Bearer token290 endpoints

Vercel API

Cloud Platforms

Vercel combines the best developer experience with an obsessive focus on end-user performance. Our platform enables frontend teams to do their best work.

Bearer token112 endpoints

Platform API

Cloud Platforms

The [REST API specification](https://www.ably.io/documentation/rest-api) for Ably.

HTTP Basic22 endpoints

Azure Data Lake Storage

Cloud Platforms

Azure Data Lake Storage provides storage for Hadoop and other big data workloads.

No auth10 endpoints

Listed from APIs.guru (CC0).