Skip to content

AWS CloudFormation API

by amazonaws.com

API keyHTTPSCloud Platforms
Open documentation ↗

Overview

<fullname>CloudFormation</fullname> <p>CloudFormation allows you to create and manage Amazon Web Services infrastructure deployments predictably and repeatedly. You can use CloudFormation to leverage Amazon Web Services products, such as Amazon Elastic Compute Cloud, Amazon Elastic Block Store, Amazon Simple Notification Service, Elastic Load Balancing, and Auto Scaling to build highly reliable, highly scalable, cost-effective applications without creating or configuring the underlying Amazon Web Services infrastructure.</p> <p>With CloudFormation, you declare all your resources and dependencies in a template file. The template defines a collection of resources as a single unit called a stack. CloudFormation creates and deletes all member resources of the stack together and manages all dependencies between the resources for you.</p> <p>For more information about CloudFormation, see the <a href="http://aws.amazon.com/cloudformation/">CloudFormation product page</a>.</p> <p>CloudFormation makes use of other Amazon Web Services products. If you need additional technical information about a specific Amazon Web Services product, you can find the product's technical documentation at <a href="https://docs.aws.amazon.com/"> <code>docs.aws.amazon.com</code> </a>.</p>

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

At a glance

Authentication
API key
HTTPS
Yes
CORS
Unknown
Version
2010-05-15
Endpoints
132
Spec updated
2020-04-09

Endpoints

MethodPathWhat it does
GET/#Action=ActivateType<p>Activates a public third-party extension, making it available for use in stack templates. For more information, see <a href="https://docs.aws.amazon.com/AWSC
POST/#Action=ActivateType<p>Activates a public third-party extension, making it available for use in stack templates. For more information, see <a href="https://docs.aws.amazon.com/AWSC
GET/#Action=BatchDescribeTypeConfigurations<p>Returns configuration data for the specified CloudFormation extensions, from the CloudFormation registry for the account and region.</p> <p>For more informat
POST/#Action=BatchDescribeTypeConfigurations<p>Returns configuration data for the specified CloudFormation extensions, from the CloudFormation registry for the account and region.</p> <p>For more informat
GET/#Action=CancelUpdateStack<p>Cancels an update on the specified stack. If the call completes successfully, the stack rolls back the update and reverts to the previous stack configuration
POST/#Action=CancelUpdateStack<p>Cancels an update on the specified stack. If the call completes successfully, the stack rolls back the update and reverts to the previous stack configuration
GET/#Action=ContinueUpdateRollback<p>For a specified stack that's in the <code>UPDATE_ROLLBACK_FAILED</code> state, continues rolling it back to the <code>UPDATE_ROLLBACK_COMPLETE</code> state.
POST/#Action=ContinueUpdateRollback<p>For a specified stack that's in the <code>UPDATE_ROLLBACK_FAILED</code> state, continues rolling it back to the <code>UPDATE_ROLLBACK_COMPLETE</code> state.
GET/#Action=CreateChangeSet<p>Creates a list of changes that will be applied to a stack so that you can review the changes before executing them. You can create a change set for a stack t
POST/#Action=CreateChangeSet<p>Creates a list of changes that will be applied to a stack so that you can review the changes before executing them. You can create a change set for a stack t
GET/#Action=CreateStackCreates a stack as specified in the template. After the call completes successfully, the stack creation starts. You can check the status of the stack through th
POST/#Action=CreateStackCreates a stack as specified in the template. After the call completes successfully, the stack creation starts. You can check the status of the stack through th
GET/#Action=CreateStackInstancesCreates stack instances for the specified accounts, within the specified Amazon Web Services Regions. A stack instance refers to a stack in a specific account a
POST/#Action=CreateStackInstancesCreates stack instances for the specified accounts, within the specified Amazon Web Services Regions. A stack instance refers to a stack in a specific account a
GET/#Action=CreateStackSetCreates a stack set.
POST/#Action=CreateStackSetCreates a stack set.
GET/#Action=DeactivateType<p>Deactivates a public extension that was previously activated in this account and region.</p> <p>Once deactivated, an extension can't be used in any CloudForm
POST/#Action=DeactivateType<p>Deactivates a public extension that was previously activated in this account and region.</p> <p>Once deactivated, an extension can't be used in any CloudForm
GET/#Action=DeleteChangeSet<p>Deletes the specified change set. Deleting change sets ensures that no one executes the wrong change set.</p> <p>If the call successfully completes, CloudFor
POST/#Action=DeleteChangeSet<p>Deletes the specified change set. Deleting change sets ensures that no one executes the wrong change set.</p> <p>If the call successfully completes, CloudFor
GET/#Action=DeleteStackDeletes a specified stack. Once the call completes successfully, stack deletion starts. Deleted stacks don't show up in the <a>DescribeStacks</a> operation if t
POST/#Action=DeleteStackDeletes a specified stack. Once the call completes successfully, stack deletion starts. Deleted stacks don't show up in the <a>DescribeStacks</a> operation if t
GET/#Action=DeleteStackInstancesDeletes stack instances for the specified accounts, in the specified Amazon Web Services Regions.
POST/#Action=DeleteStackInstancesDeletes stack instances for the specified accounts, in the specified Amazon Web Services Regions.
GET/#Action=DeleteStackSetDeletes a stack set. Before you can delete a stack set, all its member stack instances must be deleted. For more information about how to complete this, see <a>
POST/#Action=DeleteStackSetDeletes a stack set. Before you can delete a stack set, all its member stack instances must be deleted. For more information about how to complete this, see <a>
GET/#Action=DeregisterType<p>Marks an extension or extension version as <code>DEPRECATED</code> in the CloudFormation registry, removing it from active use. Deprecated extensions or exte
POST/#Action=DeregisterType<p>Marks an extension or extension version as <code>DEPRECATED</code> in the CloudFormation registry, removing it from active use. Deprecated extensions or exte
GET/#Action=DescribeAccountLimitsRetrieves your account's CloudFormation limits, such as the maximum number of stacks that you can create in your account. For more information about account lim
POST/#Action=DescribeAccountLimitsRetrieves your account's CloudFormation limits, such as the maximum number of stacks that you can create in your account. For more information about account lim
GET/#Action=DescribeChangeSetReturns the inputs for the change set and a list of changes that CloudFormation will make if you execute the change set. For more information, see <a href="http
POST/#Action=DescribeChangeSetReturns the inputs for the change set and a list of changes that CloudFormation will make if you execute the change set. For more information, see <a href="http
GET/#Action=DescribeChangeSetHooksReturns hook-related information for the change set and a list of changes that CloudFormation makes when you run the change set.
POST/#Action=DescribeChangeSetHooksReturns hook-related information for the change set and a list of changes that CloudFormation makes when you run the change set.
GET/#Action=DescribePublisher<p>Returns information about a CloudFormation extension publisher.</p> <p>If you don't supply a <code>PublisherId</code>, and you have registered as an extensio
POST/#Action=DescribePublisher<p>Returns information about a CloudFormation extension publisher.</p> <p>If you don't supply a <code>PublisherId</code>, and you have registered as an extensio
GET/#Action=DescribeStackDriftDetectionStatus<p>Returns information about a stack drift detection operation. A stack drift detection operation detects whether a stack's actual configuration differs, or has
POST/#Action=DescribeStackDriftDetectionStatus<p>Returns information about a stack drift detection operation. A stack drift detection operation detects whether a stack's actual configuration differs, or has
GET/#Action=DescribeStackEvents<p>Returns all stack related events for a specified stack in reverse chronological order. For more information about a stack's event history, go to <a href="htt
POST/#Action=DescribeStackEvents<p>Returns all stack related events for a specified stack in reverse chronological order. For more information about a stack's event history, go to <a href="htt
GET/#Action=DescribeStackInstance<p>Returns the stack instance that's associated with the specified stack set, Amazon Web Services account, and Region.</p> <p>For a list of stack instances that
POST/#Action=DescribeStackInstance<p>Returns the stack instance that's associated with the specified stack set, Amazon Web Services account, and Region.</p> <p>For a list of stack instances that
GET/#Action=DescribeStackResource<p>Returns a description of the specified resource in the specified stack.</p> <p>For deleted stacks, DescribeStackResource returns resource information for up
POST/#Action=DescribeStackResource<p>Returns a description of the specified resource in the specified stack.</p> <p>For deleted stacks, DescribeStackResource returns resource information for up
GET/#Action=DescribeStackResourceDrifts<p>Returns drift information for the resources that have been checked for drift in the specified stack. This includes actual and expected configuration values f
POST/#Action=DescribeStackResourceDrifts<p>Returns drift information for the resources that have been checked for drift in the specified stack. This includes actual and expected configuration values f
GET/#Action=DescribeStackResources<p>Returns Amazon Web Services resource descriptions for running and deleted stacks. If <code>StackName</code> is specified, all the associated resources that a
POST/#Action=DescribeStackResources<p>Returns Amazon Web Services resource descriptions for running and deleted stacks. If <code>StackName</code> is specified, all the associated resources that a
GET/#Action=DescribeStackSetReturns the description of the specified stack set.
POST/#Action=DescribeStackSetReturns the description of the specified stack set.
GET/#Action=DescribeStackSetOperationReturns the description of the specified stack set operation.
POST/#Action=DescribeStackSetOperationReturns the description of the specified stack set operation.
GET/#Action=DescribeStacks<p>Returns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks created.</p> <note> <p>If
POST/#Action=DescribeStacks<p>Returns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks created.</p> <note> <p>If
GET/#Action=DescribeType<p>Returns detailed information about an extension that has been registered.</p> <p>If you specify a <code>VersionId</code>, <code>DescribeType</code> returns i
POST/#Action=DescribeType<p>Returns detailed information about an extension that has been registered.</p> <p>If you specify a <code>VersionId</code>, <code>DescribeType</code> returns i
GET/#Action=DescribeTypeRegistration<p>Returns information about an extension's registration, including its current status and type and version identifiers.</p> <p>When you initiate a registration
POST/#Action=DescribeTypeRegistration<p>Returns information about an extension's registration, including its current status and type and version identifiers.</p> <p>When you initiate a registration
GET/#Action=DetectStackDrift<p>Detects whether a stack's actual configuration differs, or has <i>drifted</i>, from it's expected configuration, as defined in the stack template and any val
POST/#Action=DetectStackDrift<p>Detects whether a stack's actual configuration differs, or has <i>drifted</i>, from it's expected configuration, as defined in the stack template and any val
GET/#Action=DetectStackResourceDrift<p>Returns information about whether a resource's actual configuration differs, or has <i>drifted</i>, from it's expected configuration, as defined in the stack
POST/#Action=DetectStackResourceDrift<p>Returns information about whether a resource's actual configuration differs, or has <i>drifted</i>, from it's expected configuration, as defined in the stack
GET/#Action=DetectStackSetDrift<p>Detect drift on a stack set. When CloudFormation performs drift detection on a stack set, it performs drift detection on the stack associated with each stack
POST/#Action=DetectStackSetDrift<p>Detect drift on a stack set. When CloudFormation performs drift detection on a stack set, it performs drift detection on the stack associated with each stack
GET/#Action=EstimateTemplateCostReturns the estimated monthly cost of a template. The return value is an Amazon Web Services Simple Monthly Calculator URL with a query string that describes th
POST/#Action=EstimateTemplateCostReturns the estimated monthly cost of a template. The return value is an Amazon Web Services Simple Monthly Calculator URL with a query string that describes th
GET/#Action=ExecuteChangeSet<p>Updates a stack using the input information that was provided when the specified change set was created. After the call successfully completes, CloudFormatio
POST/#Action=ExecuteChangeSet<p>Updates a stack using the input information that was provided when the specified change set was created. After the call successfully completes, CloudFormatio
GET/#Action=GetStackPolicyReturns the stack policy for a specified stack. If a stack doesn't have a policy, a null value is returned.
POST/#Action=GetStackPolicyReturns the stack policy for a specified stack. If a stack doesn't have a policy, a null value is returned.
GET/#Action=GetTemplate<p>Returns the template body for a specified stack. You can get the template for running or deleted stacks.</p> <p>For deleted stacks, <code>GetTemplate</code>
POST/#Action=GetTemplate<p>Returns the template body for a specified stack. You can get the template for running or deleted stacks.</p> <p>For deleted stacks, <code>GetTemplate</code>
GET/#Action=GetTemplateSummary<p>Returns information about a new or existing template. The <code>GetTemplateSummary</code> action is useful for viewing parameter information, such as default
POST/#Action=GetTemplateSummary<p>Returns information about a new or existing template. The <code>GetTemplateSummary</code> action is useful for viewing parameter information, such as default
GET/#Action=ImportStacksToStackSet<p>Import existing stacks into a new stack sets. Use the stack import operation to import up to 10 stacks into a new stack set in the same account as the source
POST/#Action=ImportStacksToStackSet<p>Import existing stacks into a new stack sets. Use the stack import operation to import up to 10 stacks into a new stack set in the same account as the source
GET/#Action=ListChangeSetsReturns the ID and status of each active change set for a stack. For example, CloudFormation lists change sets that are in the <code>CREATE_IN_PROGRESS</code> o
POST/#Action=ListChangeSetsReturns the ID and status of each active change set for a stack. For example, CloudFormation lists change sets that are in the <code>CREATE_IN_PROGRESS</code> o
GET/#Action=ListExports<p>Lists all exported output values in the account and Region in which you call this action. Use this action to see the exported output values that you can impo
POST/#Action=ListExports<p>Lists all exported output values in the account and Region in which you call this action. Use this action to see the exported output values that you can impo
GET/#Action=ListImports<p>Lists all stacks that are importing an exported output value. To modify or remove an exported output value, first use this action to see which stacks are usi
POST/#Action=ListImports<p>Lists all stacks that are importing an exported output value. To modify or remove an exported output value, first use this action to see which stacks are usi
GET/#Action=ListStackInstancesReturns summary information about stack instances that are associated with the specified stack set. You can filter for stack instances that are associated with
POST/#Action=ListStackInstancesReturns summary information about stack instances that are associated with the specified stack set. You can filter for stack instances that are associated with
GET/#Action=ListStackResources<p>Returns descriptions of all resources of the specified stack.</p> <p>For deleted stacks, ListStackResources returns resource information for up to 90 days af
POST/#Action=ListStackResources<p>Returns descriptions of all resources of the specified stack.</p> <p>For deleted stacks, ListStackResources returns resource information for up to 90 days af
GET/#Action=ListStackSetOperationResultsReturns summary information about the results of a stack set operation.
POST/#Action=ListStackSetOperationResultsReturns summary information about the results of a stack set operation.
GET/#Action=ListStackSetOperationsReturns summary information about operations performed on a stack set.
POST/#Action=ListStackSetOperationsReturns summary information about operations performed on a stack set.
GET/#Action=ListStackSets<p>Returns summary information about stack sets that are associated with the user.</p> <ul> <li> <p>[Self-managed permissions] If you set the <code>CallAs</code
POST/#Action=ListStackSets<p>Returns summary information about stack sets that are associated with the user.</p> <ul> <li> <p>[Self-managed permissions] If you set the <code>CallAs</code
GET/#Action=ListStacksReturns the summary information for stacks whose status matches the specified StackStatusFilter. Summary information for stacks that have been deleted is kept f
POST/#Action=ListStacksReturns the summary information for stacks whose status matches the specified StackStatusFilter. Summary information for stacks that have been deleted is kept f
GET/#Action=ListTypeRegistrationsReturns a list of registration tokens for the specified extension(s).
POST/#Action=ListTypeRegistrationsReturns a list of registration tokens for the specified extension(s).
GET/#Action=ListTypeVersionsReturns summary information about the versions of an extension.
POST/#Action=ListTypeVersionsReturns summary information about the versions of an extension.
GET/#Action=ListTypesReturns summary information about extension that have been registered with CloudFormation.
POST/#Action=ListTypesReturns summary information about extension that have been registered with CloudFormation.

Showing the first 100 of 132 endpoints; the full list is in the documentation.

Questions

Does the AWS CloudFormation API need an API key?

Yes. The AWS CloudFormation API uses API key authentication; the documentation explains how to get credentials.

Does the AWS CloudFormation API support HTTPS?

Yes, the AWS CloudFormation API is served over HTTPS.

How many endpoints does the AWS CloudFormation API have?

Its OpenAPI description lists 132 endpoints in version 2010-05-15. The first 100 are shown on this page.

What are alternatives to the AWS CloudFormation 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).