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 CloudFormation Templates API

Operations for retrieving, validating, and summarizing templates.

AWS CloudFormation Templates API is one of 13 APIs that AWS CloudFormation publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Templates. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, pricing, a getting-started guide, and a changelog.

This API exposes 3 operations across 3 paths, and defines 2 schemas. It is described by OpenAPI 3.1.0, at version 2021-09-30.

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

3 operations 3 paths 2 schemas 3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2021-09-30
Base URL
https://cloudformation.{region}.amazonaws.com
Authentication
API Key
License
Resource Areas
1

Authentication & Security 1

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

  • AWS_Signature_V4 — AWS Signature Version 4 authentication.

Paths & Operations 3

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

Templates 3

Operations for retrieving, validating, and summarizing templates.

POST
/?Action=GetTemplate
Retrieve a Stack Template
getTemplate 1 param body → 200400404500
POST
/?Action=GetTemplateSummary
Get Summary Information About a Template
getTemplateSummary 1 param body → 200400500
POST
/?Action=ValidateTemplate
Validate a Cloudformation Template
validateTemplate 1 param body → 200400500

Schemas 2

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

ErrorResponse
object
2 properties
ParameterDeclaration
object
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cloudformation-templates-api-openapi.yml Raw ↑

Other APIs AWS CloudFormation publishes across the network.

AWS CloudFormation Change Sets API
AWS CloudFormation Exports API
AWS CloudFormation Registry API
AWS CloudFormation Request Status API
AWS CloudFormation Resources API
AWS CloudFormation Stack Drift API
AWS CloudFormation Stack Events API
AWS CloudFormation Stack Instances API
AWS CloudFormation Stack Policies API
AWS CloudFormation Stack Resources API
AWS CloudFormation Stack Sets API
AWS CloudFormation Stacks API