Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

AWS CloudWatch Dashboards API

Operations for creating and managing CloudWatch dashboards

AWS CloudWatch Dashboards API is one of 8 APIs that AWS CloudWatch publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 2 JSON Schema definitions.

Tagged areas include Dashboards. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, pricing, a getting-started guide, an API reference, and 2 JSON Schemas.

This API exposes 4 operations across 4 paths, and defines 10 schemas. It is described by OpenAPI 3.1.0, at version 2010-08-01.

Requests are made against a single base URL, https://monitoring.{region}.amazonaws.com.

4 operations 4 paths 10 schemas 4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2010-08-01
Base URL
https://monitoring.amazonaws.com
Authentication
API Key
License
Resource Areas
1

Authentication & Security 1

AWS CloudWatch Dashboards API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (aws_sigv4). By default, every request must be authenticated.

  • aws_sigv4 — AWS Signature Version 4 authentication

Paths & Operations 4

Across 4 paths, the API surfaces 4 operations — 4 POST. Each is listed below with its method, path, parameters, and response codes.

Dashboards 4

Operations for creating and managing CloudWatch dashboards

POST
/#PutDashboard
Aws Cloudwatch Create or Update a Cloudwatch Dashboard
PutDashboard 2 params body → 200400500
POST
/#GetDashboard
Aws Cloudwatch Retrieve Details for a Specified Dashboard
GetDashboard 2 params body → 200400500
POST
/#ListDashboards
Aws Cloudwatch List the Dashboards in Your Account
ListDashboards 2 params body → 200400500
POST
/#DeleteDashboards
Aws Cloudwatch Delete Specified Dashboards
DeleteDashboards 2 params body → 200400500

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are DashboardEntry (4 properties), GetDashboardOutput (3 properties), ErrorResponse (2 properties), ListDashboardsInput (2 properties). Each schema is shown below with its type and property counts.

DashboardValidationMessage
object
An error or warning for the PutDashboard operation.
2 properties
DeleteDashboardsInput
object
1 property 1 required
ListDashboardsOutput
object
2 properties
GetDashboardOutput
object
3 properties
PutDashboardInput
object
2 properties 2 required
DashboardEntry
object
Represents a specific dashboard.
4 properties
GetDashboardInput
object
1 property 1 required
ListDashboardsInput
object
2 properties
PutDashboardOutput
object
1 property
ErrorResponse
object
Standard error response from CloudWatch API.
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cloudwatch-dashboards-api-openapi.yml Raw ↑

Other APIs AWS CloudWatch publishes across the network.

Amazon CloudWatch Application Signals API
Amazon CloudWatch Network Monitor API
AWS CloudWatch Alarms API
AWS CloudWatch Anomaly Detection API
AWS CloudWatch Composite Alarms API
AWS CloudWatch Metric Streams API
AWS CloudWatch Metrics API