Open documentation ↗Overview
<fullname>Amazon Elastic Container Service</fullname> <p>Amazon Elastic Container Service (Amazon ECS) is a highly scalable, fast, container management service. It makes it easy to run, stop, and manage Docker containers. You can host your cluster on a serverless infrastructure that's managed by Amazon ECS by launching your services or tasks on Fargate. For more control, you can host your tasks on a cluster of Amazon Elastic Compute Cloud (Amazon EC2) or External (on-premises) instances that you manage.</p> <p>Amazon ECS makes it easy to launch and stop container-based applications with simple API calls. This makes it easy to get the state of your cluster from a centralized service, and gives you access to many familiar Amazon EC2 features.</p> <p>You can use Amazon ECS to schedule the placement of containers across your cluster based on your resource needs, isolation policies, and availability requirements. With Amazon ECS, you don't need to operate your own cluster management and configuration management systems. You also don't need to worry about scaling your management infrastructure.</p>
Amazon EC2 Container Service is a cloud platforms API from amazonaws.com. Requests are authenticated with an API key. It is served over HTTPS. Its OpenAPI description documents 56 endpoints.
At a glance
- Authentication
- API key
- HTTPS
- Yes
- CORS
- Unknown
- Category
- Cloud Platforms
- Version
- 2014-11-13
- Endpoints
- 56
- OpenAPI
- Specification ↗
- Spec updated
- 2020-04-09
Endpoints
| Method | Path | What it does |
|---|---|---|
| POST | /#X-Amz-Target=AmazonEC2ContainerServiceV20141113.CreateCapacityProvider | <p>Creates a new capacity provider. Capacity providers are associated with an Amazon ECS cluster and are used in capacity provider strategies to facilitate clus |
| POST | /#X-Amz-Target=AmazonEC2ContainerServiceV20141113.CreateCluster | <p>Creates a new Amazon ECS cluster. By default, your account receives a <code>default</code> cluster when you launch your first container instance. However, yo |
| POST | /#X-Amz-Target=AmazonEC2ContainerServiceV20141113.CreateService | <p>Runs and maintains your desired number of tasks from a specified task definition. If the number of tasks running in a service drops below the <code>desiredCo |
| POST | /#X-Amz-Target=AmazonEC2ContainerServiceV20141113.CreateTaskSet | Create a task set in the specified cluster and service. This is used when a service uses the <code>EXTERNAL</code> deployment controller type. For more informat |
| POST | /#X-Amz-Target=AmazonEC2ContainerServiceV20141113.DeleteAccountSetting | Disables an account setting for a specified user, role, or the root user for an account. |
| POST | /#X-Amz-Target=AmazonEC2ContainerServiceV20141113.DeleteAttributes | Deletes one or more custom attributes from an Amazon ECS resource. |
| POST | /#X-Amz-Target=AmazonEC2ContainerServiceV20141113.DeleteCapacityProvider | <p>Deletes the specified capacity provider.</p> <note> <p>The <code>FARGATE</code> and <code>FARGATE_SPOT</code> capacity providers are reserved and can't be de |
| POST | /#X-Amz-Target=AmazonEC2ContainerServiceV20141113.DeleteCluster | <p>Deletes the specified cluster. The cluster transitions to the <code>INACTIVE</code> state. Clusters with an <code>INACTIVE</code> status might remain discove |
| POST | /#X-Amz-Target=AmazonEC2ContainerServiceV20141113.DeleteService | <p>Deletes a specified service within a cluster. You can delete a service if you have no running tasks in it and the desired task count is zero. If the service |
| POST | /#X-Amz-Target=AmazonEC2ContainerServiceV20141113.DeleteTaskDefinitions | <p>Deletes one or more task definitions.</p> <p>You must deregister a task definition revision before you delete it. For more information, see <a href="https:// |
| POST | /#X-Amz-Target=AmazonEC2ContainerServiceV20141113.DeleteTaskSet | Deletes a specified task set within a service. This is used when a service uses the <code>EXTERNAL</code> deployment controller type. For more information, see |
| POST | /#X-Amz-Target=AmazonEC2ContainerServiceV20141113.DeregisterContainerInstance | <p>Deregisters an Amazon ECS container instance from the specified cluster. This instance is no longer available to run tasks.</p> <p>If you intend to use the c |
| POST | /#X-Amz-Target=AmazonEC2ContainerServiceV20141113.DeregisterTaskDefinition | <p>Deregisters the specified task definition by family and revision. Upon deregistration, the task definition is marked as <code>INACTIVE</code>. Existing tasks |
| POST | /#X-Amz-Target=AmazonEC2ContainerServiceV20141113.DescribeCapacityProviders | Describes one or more of your capacity providers. |
| POST | /#X-Amz-Target=AmazonEC2ContainerServiceV20141113.DescribeClusters | Describes one or more of your clusters. |
| POST | /#X-Amz-Target=AmazonEC2ContainerServiceV20141113.DescribeContainerInstances | Describes one or more container instances. Returns metadata about each container instance requested. |
| POST | /#X-Amz-Target=AmazonEC2ContainerServiceV20141113.DescribeServices | Describes the specified services running in your cluster. |
| POST | /#X-Amz-Target=AmazonEC2ContainerServiceV20141113.DescribeTaskDefinition | <p>Describes a task definition. You can specify a <code>family</code> and <code>revision</code> to find information about a specific task definition, or you can |
| POST | /#X-Amz-Target=AmazonEC2ContainerServiceV20141113.DescribeTaskSets | Describes the task sets in the specified cluster and service. This is used when a service uses the <code>EXTERNAL</code> deployment controller type. For more in |
| POST | /#X-Amz-Target=AmazonEC2ContainerServiceV20141113.DescribeTasks | <p>Describes a specified task or tasks.</p> <p>Currently, stopped tasks appear in the returned results for at least one hour.</p> |
| POST | /#X-Amz-Target=AmazonEC2ContainerServiceV20141113.DiscoverPollEndpoint | <note> <p>This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.</p> </note> <p>Returns an endpoint for the Amaz |
| POST | /#X-Amz-Target=AmazonEC2ContainerServiceV20141113.ExecuteCommand | <p>Runs a command remotely on a container within a task.</p> <p>If you use a condition key in your IAM policy to refine the conditions for the policy statement, |
| POST | /#X-Amz-Target=AmazonEC2ContainerServiceV20141113.GetTaskProtection | Retrieves the protection status of tasks in an Amazon ECS service. |
| POST | /#X-Amz-Target=AmazonEC2ContainerServiceV20141113.ListAccountSettings | Lists the account settings for a specified principal. |
| POST | /#X-Amz-Target=AmazonEC2ContainerServiceV20141113.ListAttributes | Lists the attributes for Amazon ECS resources within a specified target type and cluster. When you specify a target type and cluster, <code>ListAttributes</code |
| POST | /#X-Amz-Target=AmazonEC2ContainerServiceV20141113.ListClusters | Returns a list of existing clusters. |
| POST | /#X-Amz-Target=AmazonEC2ContainerServiceV20141113.ListContainerInstances | Returns a list of container instances in a specified cluster. You can filter the results of a <code>ListContainerInstances</code> operation with cluster query l |
| POST | /#X-Amz-Target=AmazonEC2ContainerServiceV20141113.ListServices | Returns a list of services. You can filter the results by cluster, launch type, and scheduling strategy. |
| POST | /#X-Amz-Target=AmazonEC2ContainerServiceV20141113.ListServicesByNamespace | This operation lists all of the services that are associated with a Cloud Map namespace. This list might include services in different clusters. In contrast, <c |
| POST | /#X-Amz-Target=AmazonEC2ContainerServiceV20141113.ListTagsForResource | List the tags for an Amazon ECS resource. |
| POST | /#X-Amz-Target=AmazonEC2ContainerServiceV20141113.ListTaskDefinitionFamilies | <p>Returns a list of task definition families that are registered to your account. This list includes task definition families that no longer have any <code>ACT |
| POST | /#X-Amz-Target=AmazonEC2ContainerServiceV20141113.ListTaskDefinitions | Returns a list of task definitions that are registered to your account. You can filter the results by family name with the <code>familyPrefix</code> parameter o |
| POST | /#X-Amz-Target=AmazonEC2ContainerServiceV20141113.ListTasks | <p>Returns a list of tasks. You can filter the results by cluster, task definition family, container instance, launch type, what IAM principal started the task, |
| POST | /#X-Amz-Target=AmazonEC2ContainerServiceV20141113.PutAccountSetting | <p>Modifies an account setting. Account settings are set on a per-Region basis.</p> <p>If you change the root user account setting, the default settings are res |
| POST | /#X-Amz-Target=AmazonEC2ContainerServiceV20141113.PutAccountSettingDefault | Modifies an account setting for all users on an account for whom no individual account setting has been specified. Account settings are set on a per-Region basi |
| POST | /#X-Amz-Target=AmazonEC2ContainerServiceV20141113.PutAttributes | Create or update an attribute on an Amazon ECS resource. If the attribute doesn't exist, it's created. If the attribute exists, its value is replaced with the s |
| POST | /#X-Amz-Target=AmazonEC2ContainerServiceV20141113.PutClusterCapacityProviders | <p>Modifies the available capacity providers and the default capacity provider strategy for a cluster.</p> <p>You must specify both the available capacity provi |
| POST | /#X-Amz-Target=AmazonEC2ContainerServiceV20141113.RegisterContainerInstance | <note> <p>This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.</p> </note> <p>Registers an EC2 instance into t |
| POST | /#X-Amz-Target=AmazonEC2ContainerServiceV20141113.RegisterTaskDefinition | <p>Registers a new task definition from the supplied <code>family</code> and <code>containerDefinitions</code>. Optionally, you can add data volumes to your con |
| POST | /#X-Amz-Target=AmazonEC2ContainerServiceV20141113.RunTask | <p>Starts a new task using the specified task definition.</p> <p>You can allow Amazon ECS to place tasks for you, or you can customize how Amazon ECS places tas |
| POST | /#X-Amz-Target=AmazonEC2ContainerServiceV20141113.StartTask | <p>Starts a new task from the specified task definition on the specified container instance or instances.</p> <note> <p>Starting April 15, 2023, Amazon Web Serv |
| POST | /#X-Amz-Target=AmazonEC2ContainerServiceV20141113.StopTask | <p>Stops a running task. Any tags associated with the task will be deleted.</p> <p>When <a>StopTask</a> is called on a task, the equivalent of <code>docker stop |
| POST | /#X-Amz-Target=AmazonEC2ContainerServiceV20141113.SubmitAttachmentStateChanges | <note> <p>This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.</p> </note> <p>Sent to acknowledge that an atta |
| POST | /#X-Amz-Target=AmazonEC2ContainerServiceV20141113.SubmitContainerStateChange | <note> <p>This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.</p> </note> <p>Sent to acknowledge that a conta |
| POST | /#X-Amz-Target=AmazonEC2ContainerServiceV20141113.SubmitTaskStateChange | <note> <p>This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.</p> </note> <p>Sent to acknowledge that a task |
| POST | /#X-Amz-Target=AmazonEC2ContainerServiceV20141113.TagResource | Associates the specified tags to a resource with the specified <code>resourceArn</code>. If existing tags on a resource aren't specified in the request paramete |
| POST | /#X-Amz-Target=AmazonEC2ContainerServiceV20141113.UntagResource | Deletes specified tags from a resource. |
| POST | /#X-Amz-Target=AmazonEC2ContainerServiceV20141113.UpdateCapacityProvider | Modifies the parameters for a capacity provider. |
| POST | /#X-Amz-Target=AmazonEC2ContainerServiceV20141113.UpdateCluster | Updates the cluster. |
| POST | /#X-Amz-Target=AmazonEC2ContainerServiceV20141113.UpdateClusterSettings | Modifies the settings to use for a cluster. |
| POST | /#X-Amz-Target=AmazonEC2ContainerServiceV20141113.UpdateContainerAgent | <p>Updates the Amazon ECS container agent on a specified container instance. Updating the Amazon ECS container agent doesn't interrupt running tasks or services |
| POST | /#X-Amz-Target=AmazonEC2ContainerServiceV20141113.UpdateContainerInstancesState | <p>Modifies the status of an Amazon ECS container instance.</p> <p>Once a container instance has reached an <code>ACTIVE</code> state, you can change the status |
| POST | /#X-Amz-Target=AmazonEC2ContainerServiceV20141113.UpdateService | <p>Modifies the parameters of a service.</p> <p>For services using the rolling update (<code>ECS</code>) you can update the desired count, deployment configurat |
| POST | /#X-Amz-Target=AmazonEC2ContainerServiceV20141113.UpdateServicePrimaryTaskSet | Modifies which task set in a service is the primary task set. Any parameters that are updated on the primary task set in a service will transition to the servic |
| POST | /#X-Amz-Target=AmazonEC2ContainerServiceV20141113.UpdateTaskProtection | <p>Updates the protection status of a task. You can set <code>protectionEnabled</code> to <code>true</code> to protect your task from termination during scale-i |
| POST | /#X-Amz-Target=AmazonEC2ContainerServiceV20141113.UpdateTaskSet | Modifies a task set. This is used when a service uses the <code>EXTERNAL</code> deployment controller type. For more information, see <a href="https://docs.aws. |
Questions
Does the Amazon EC2 Container Service API need an API key?
Yes. The Amazon EC2 Container Service API uses API key authentication; the documentation explains how to get credentials.
Does the Amazon EC2 Container Service API support HTTPS?
Yes, the Amazon EC2 Container Service API is served over HTTPS.
How many endpoints does the Amazon EC2 Container Service API have?
Its OpenAPI description lists 56 endpoints in version 2014-11-13. All of them are shown on this page.
What are alternatives to the Amazon EC2 Container Service 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).