Open documentation ↗Overview
<fullname>AWS Elastic Beanstalk</fullname> <p>AWS Elastic Beanstalk makes it easy for you to create, deploy, and manage scalable, fault-tolerant applications running on the Amazon Web Services cloud.</p> <p>For more information about this product, go to the <a href="http://aws.amazon.com/elasticbeanstalk/">AWS Elastic Beanstalk</a> details page. The location of the latest AWS Elastic Beanstalk WSDL is <a href="https://elasticbeanstalk.s3.amazonaws.com/doc/2010-12-01/AWSElasticBeanstalk.wsdl">https://elasticbeanstalk.s3.amazonaws.com/doc/2010-12-01/AWSElasticBeanstalk.wsdl</a>. To install the Software Development Kits (SDKs), Integrated Development Environment (IDE) Toolkits, and command line tools that enable you to access the API, go to <a href="http://aws.amazon.com/tools/">Tools for Amazon Web Services</a>.</p> <p> <b>Endpoints</b> </p> <p>For a list of region-specific endpoints that AWS Elastic Beanstalk supports, go to <a href="https://docs.aws.amazon.com/general/latest/gr/rande.html#elasticbeanstalk_region">Regions and Endpoints</a> in the <i>Amazon Web Services Glossary</i>.</p>
AWS Elastic Beanstalk is a cloud platforms API from amazonaws.com. Requests are authenticated with an API key. It is served over HTTPS. Its OpenAPI description documents 94 endpoints.
At a glance
- Authentication
- API key
- HTTPS
- Yes
- CORS
- Unknown
- Category
- Cloud Platforms
- Version
- 2010-12-01
- Endpoints
- 94
- OpenAPI
- Specification ↗
- Spec updated
- 2020-04-07
Endpoints
| Method | Path | What it does |
|---|---|---|
| GET | /#Action=AbortEnvironmentUpdate | Cancels in-progress environment configuration update or application version deployment. |
| POST | /#Action=AbortEnvironmentUpdate | Cancels in-progress environment configuration update or application version deployment. |
| GET | /#Action=ApplyEnvironmentManagedAction | Applies a scheduled managed action immediately. A managed action can be applied only if its status is <code>Scheduled</code>. Get the status and action ID of a |
| POST | /#Action=ApplyEnvironmentManagedAction | Applies a scheduled managed action immediately. A managed action can be applied only if its status is <code>Scheduled</code>. Get the status and action ID of a |
| GET | /#Action=AssociateEnvironmentOperationsRole | Add or change the operations role used by an environment. After this call is made, Elastic Beanstalk uses the associated operations role for permissions to down |
| POST | /#Action=AssociateEnvironmentOperationsRole | Add or change the operations role used by an environment. After this call is made, Elastic Beanstalk uses the associated operations role for permissions to down |
| GET | /#Action=CheckDNSAvailability | Checks if the specified CNAME is available. |
| POST | /#Action=CheckDNSAvailability | Checks if the specified CNAME is available. |
| GET | /#Action=ComposeEnvironments | Create or update a group of environments that each run a separate component of a single application. Takes a list of version labels that specify application sou |
| POST | /#Action=ComposeEnvironments | Create or update a group of environments that each run a separate component of a single application. Takes a list of version labels that specify application sou |
| GET | /#Action=CreateApplication | Creates an application that has one configuration template named <code>default</code> and no application versions. |
| POST | /#Action=CreateApplication | Creates an application that has one configuration template named <code>default</code> and no application versions. |
| GET | /#Action=CreateApplicationVersion | <p>Creates an application version for the specified application. You can create an application version from a source bundle in Amazon S3, a commit in AWS CodeCo |
| POST | /#Action=CreateApplicationVersion | <p>Creates an application version for the specified application. You can create an application version from a source bundle in Amazon S3, a commit in AWS CodeCo |
| GET | /#Action=CreateConfigurationTemplate | <p>Creates an AWS Elastic Beanstalk configuration template, associated with a specific Elastic Beanstalk application. You define application configuration setti |
| POST | /#Action=CreateConfigurationTemplate | <p>Creates an AWS Elastic Beanstalk configuration template, associated with a specific Elastic Beanstalk application. You define application configuration setti |
| GET | /#Action=CreateEnvironment | Launches an AWS Elastic Beanstalk environment for the specified application using the specified configuration. |
| POST | /#Action=CreateEnvironment | Launches an AWS Elastic Beanstalk environment for the specified application using the specified configuration. |
| GET | /#Action=CreatePlatformVersion | Create a new version of your custom platform. |
| POST | /#Action=CreatePlatformVersion | Create a new version of your custom platform. |
| GET | /#Action=CreateStorageLocation | Creates a bucket in Amazon S3 to store application versions, logs, and other files used by Elastic Beanstalk environments. The Elastic Beanstalk console and EB |
| POST | /#Action=CreateStorageLocation | Creates a bucket in Amazon S3 to store application versions, logs, and other files used by Elastic Beanstalk environments. The Elastic Beanstalk console and EB |
| GET | /#Action=DeleteApplication | <p>Deletes the specified application along with all associated versions and configurations. The application versions will not be deleted from your Amazon S3 buc |
| POST | /#Action=DeleteApplication | <p>Deletes the specified application along with all associated versions and configurations. The application versions will not be deleted from your Amazon S3 buc |
| GET | /#Action=DeleteApplicationVersion | <p>Deletes the specified version from the specified application.</p> <note> <p>You cannot delete an application version that is associated with a running enviro |
| POST | /#Action=DeleteApplicationVersion | <p>Deletes the specified version from the specified application.</p> <note> <p>You cannot delete an application version that is associated with a running enviro |
| GET | /#Action=DeleteConfigurationTemplate | <p>Deletes the specified configuration template.</p> <note> <p>When you launch an environment using a configuration template, the environment gets a copy of the |
| POST | /#Action=DeleteConfigurationTemplate | <p>Deletes the specified configuration template.</p> <note> <p>When you launch an environment using a configuration template, the environment gets a copy of the |
| GET | /#Action=DeleteEnvironmentConfiguration | <p>Deletes the draft configuration associated with the running environment.</p> <p>Updating a running environment with any configuration changes creates a draft |
| POST | /#Action=DeleteEnvironmentConfiguration | <p>Deletes the draft configuration associated with the running environment.</p> <p>Updating a running environment with any configuration changes creates a draft |
| GET | /#Action=DeletePlatformVersion | Deletes the specified version of a custom platform. |
| POST | /#Action=DeletePlatformVersion | Deletes the specified version of a custom platform. |
| GET | /#Action=DescribeAccountAttributes | <p>Returns attributes related to AWS Elastic Beanstalk that are associated with the calling AWS account.</p> <p>The result currently has one set of attributes—r |
| POST | /#Action=DescribeAccountAttributes | <p>Returns attributes related to AWS Elastic Beanstalk that are associated with the calling AWS account.</p> <p>The result currently has one set of attributes—r |
| GET | /#Action=DescribeApplicationVersions | Retrieve a list of application versions. |
| POST | /#Action=DescribeApplicationVersions | Retrieve a list of application versions. |
| GET | /#Action=DescribeApplications | Returns the descriptions of existing applications. |
| POST | /#Action=DescribeApplications | Returns the descriptions of existing applications. |
| GET | /#Action=DescribeConfigurationOptions | Describes the configuration options that are used in a particular configuration template or environment, or that a specified solution stack defines. The descrip |
| POST | /#Action=DescribeConfigurationOptions | Describes the configuration options that are used in a particular configuration template or environment, or that a specified solution stack defines. The descrip |
| GET | /#Action=DescribeConfigurationSettings | <p>Returns a description of the settings for the specified configuration set, that is, either a configuration template or the configuration set associated with |
| POST | /#Action=DescribeConfigurationSettings | <p>Returns a description of the settings for the specified configuration set, that is, either a configuration template or the configuration set associated with |
| GET | /#Action=DescribeEnvironmentHealth | Returns information about the overall health of the specified environment. The <b>DescribeEnvironmentHealth</b> operation is only available with AWS Elastic Bea |
| POST | /#Action=DescribeEnvironmentHealth | Returns information about the overall health of the specified environment. The <b>DescribeEnvironmentHealth</b> operation is only available with AWS Elastic Bea |
| GET | /#Action=DescribeEnvironmentManagedActionHistory | Lists an environment's completed and failed managed actions. |
| POST | /#Action=DescribeEnvironmentManagedActionHistory | Lists an environment's completed and failed managed actions. |
| GET | /#Action=DescribeEnvironmentManagedActions | Lists an environment's upcoming and in-progress managed actions. |
| POST | /#Action=DescribeEnvironmentManagedActions | Lists an environment's upcoming and in-progress managed actions. |
| GET | /#Action=DescribeEnvironmentResources | Returns AWS resources for this environment. |
| POST | /#Action=DescribeEnvironmentResources | Returns AWS resources for this environment. |
| GET | /#Action=DescribeEnvironments | Returns descriptions for existing environments. |
| POST | /#Action=DescribeEnvironments | Returns descriptions for existing environments. |
| GET | /#Action=DescribeEvents | <p>Returns list of event descriptions matching criteria up to the last 6 weeks.</p> <note> <p>This action returns the most recent 1,000 events from the specifie |
| POST | /#Action=DescribeEvents | <p>Returns list of event descriptions matching criteria up to the last 6 weeks.</p> <note> <p>This action returns the most recent 1,000 events from the specifie |
| GET | /#Action=DescribeInstancesHealth | Retrieves detailed information about the health of instances in your AWS Elastic Beanstalk. This operation requires <a href="https://docs.aws.amazon.com/elastic |
| POST | /#Action=DescribeInstancesHealth | Retrieves detailed information about the health of instances in your AWS Elastic Beanstalk. This operation requires <a href="https://docs.aws.amazon.com/elastic |
| GET | /#Action=DescribePlatformVersion | <p>Describes a platform version. Provides full details. Compare to <a>ListPlatformVersions</a>, which provides summary information about a list of platform vers |
| POST | /#Action=DescribePlatformVersion | <p>Describes a platform version. Provides full details. Compare to <a>ListPlatformVersions</a>, which provides summary information about a list of platform vers |
| GET | /#Action=DisassociateEnvironmentOperationsRole | Disassociate the operations role from an environment. After this call is made, Elastic Beanstalk uses the caller's permissions for permissions to downstream ser |
| POST | /#Action=DisassociateEnvironmentOperationsRole | Disassociate the operations role from an environment. After this call is made, Elastic Beanstalk uses the caller's permissions for permissions to downstream ser |
| GET | /#Action=ListAvailableSolutionStacks | Returns a list of the available solution stack names, with the public version first and then in reverse chronological order. |
| POST | /#Action=ListAvailableSolutionStacks | Returns a list of the available solution stack names, with the public version first and then in reverse chronological order. |
| GET | /#Action=ListPlatformBranches | <p>Lists the platform branches available for your account in an AWS Region. Provides summary information about each platform branch.</p> <p>For definitions of p |
| POST | /#Action=ListPlatformBranches | <p>Lists the platform branches available for your account in an AWS Region. Provides summary information about each platform branch.</p> <p>For definitions of p |
| GET | /#Action=ListPlatformVersions | <p>Lists the platform versions available for your account in an AWS Region. Provides summary information about each platform version. Compare to <a>DescribePlat |
| POST | /#Action=ListPlatformVersions | <p>Lists the platform versions available for your account in an AWS Region. Provides summary information about each platform version. Compare to <a>DescribePlat |
| GET | /#Action=ListTagsForResource | <p>Return the tags applied to an AWS Elastic Beanstalk resource. The response contains a list of tag key-value pairs.</p> <p>Elastic Beanstalk supports tagging |
| POST | /#Action=ListTagsForResource | <p>Return the tags applied to an AWS Elastic Beanstalk resource. The response contains a list of tag key-value pairs.</p> <p>Elastic Beanstalk supports tagging |
| GET | /#Action=RebuildEnvironment | Deletes and recreates all of the AWS resources (for example: the Auto Scaling group, load balancer, etc.) for a specified environment and forces a restart. |
| POST | /#Action=RebuildEnvironment | Deletes and recreates all of the AWS resources (for example: the Auto Scaling group, load balancer, etc.) for a specified environment and forces a restart. |
| GET | /#Action=RequestEnvironmentInfo | <p>Initiates a request to compile the specified type of information of the deployed environment.</p> <p> Setting the <code>InfoType</code> to <code>tail</code> |
| POST | /#Action=RequestEnvironmentInfo | <p>Initiates a request to compile the specified type of information of the deployed environment.</p> <p> Setting the <code>InfoType</code> to <code>tail</code> |
| GET | /#Action=RestartAppServer | Causes the environment to restart the application container server running on each Amazon EC2 instance. |
| POST | /#Action=RestartAppServer | Causes the environment to restart the application container server running on each Amazon EC2 instance. |
| GET | /#Action=RetrieveEnvironmentInfo | <p>Retrieves the compiled information from a <a>RequestEnvironmentInfo</a> request.</p> <p>Related Topics</p> <ul> <li> <p> <a>RequestEnvironmentInfo</a> </p> < |
| POST | /#Action=RetrieveEnvironmentInfo | <p>Retrieves the compiled information from a <a>RequestEnvironmentInfo</a> request.</p> <p>Related Topics</p> <ul> <li> <p> <a>RequestEnvironmentInfo</a> </p> < |
| GET | /#Action=SwapEnvironmentCNAMEs | Swaps the CNAMEs of two environments. |
| POST | /#Action=SwapEnvironmentCNAMEs | Swaps the CNAMEs of two environments. |
| GET | /#Action=TerminateEnvironment | Terminates the specified environment. |
| POST | /#Action=TerminateEnvironment | Terminates the specified environment. |
| GET | /#Action=UpdateApplication | <p>Updates the specified application to have the specified properties.</p> <note> <p>If a property (for example, <code>description</code>) is not provided, the |
| POST | /#Action=UpdateApplication | <p>Updates the specified application to have the specified properties.</p> <note> <p>If a property (for example, <code>description</code>) is not provided, the |
| GET | /#Action=UpdateApplicationResourceLifecycle | Modifies lifecycle settings for an application. |
| POST | /#Action=UpdateApplicationResourceLifecycle | Modifies lifecycle settings for an application. |
| GET | /#Action=UpdateApplicationVersion | <p>Updates the specified application version to have the specified properties.</p> <note> <p>If a property (for example, <code>description</code>) is not provid |
| POST | /#Action=UpdateApplicationVersion | <p>Updates the specified application version to have the specified properties.</p> <note> <p>If a property (for example, <code>description</code>) is not provid |
| GET | /#Action=UpdateConfigurationTemplate | <p>Updates the specified configuration template to have the specified properties or configuration option values.</p> <note> <p>If a property (for example, <code |
| POST | /#Action=UpdateConfigurationTemplate | <p>Updates the specified configuration template to have the specified properties or configuration option values.</p> <note> <p>If a property (for example, <code |
| GET | /#Action=UpdateEnvironment | <p>Updates the environment description, deploys a new application version, updates the configuration settings to an entirely new configuration template, or upda |
| POST | /#Action=UpdateEnvironment | <p>Updates the environment description, deploys a new application version, updates the configuration settings to an entirely new configuration template, or upda |
| GET | /#Action=UpdateTagsForResource | <p>Update the list of tags applied to an AWS Elastic Beanstalk resource. Two lists can be passed: <code>TagsToAdd</code> for tags to add or update, and <code>Ta |
| POST | /#Action=UpdateTagsForResource | <p>Update the list of tags applied to an AWS Elastic Beanstalk resource. Two lists can be passed: <code>TagsToAdd</code> for tags to add or update, and <code>Ta |
| GET | /#Action=ValidateConfigurationSettings | <p>Takes a set of configuration settings and either a configuration template or environment, and determines whether those values are valid.</p> <p>This action r |
| POST | /#Action=ValidateConfigurationSettings | <p>Takes a set of configuration settings and either a configuration template or environment, and determines whether those values are valid.</p> <p>This action r |
Questions
Does the AWS Elastic Beanstalk API need an API key?
Yes. The AWS Elastic Beanstalk API uses API key authentication; the documentation explains how to get credentials.
Does the AWS Elastic Beanstalk API support HTTPS?
Yes, the AWS Elastic Beanstalk API is served over HTTPS.
How many endpoints does the AWS Elastic Beanstalk API have?
Its OpenAPI description lists 94 endpoints in version 2010-12-01. All of them are shown on this page.
What are alternatives to the AWS Elastic Beanstalk API?
Other Cloud Platforms APIs include Remote Settings PROD, Linode API, DigitalOcean API, Vercel API, Platform API.
Similar cloud platforms APIs
Compare alternatives →Remote Settings PROD
Cloud PlatformsFirefox is a free web browser backed by Mozilla, a non-profit dedicated to internet health and privacy.
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
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
Vercel API
Cloud PlatformsVercel combines the best developer experience with an obsessive focus on end-user performance. Our platform enables frontend teams to do their best work.
Platform API
Cloud PlatformsThe [REST API specification](https://www.ably.io/documentation/rest-api) for Ably.
Azure Data Lake Storage
Cloud PlatformsAzure Data Lake Storage provides storage for Hadoop and other big data workloads.
Listed from APIs.guru (CC0).