Skip to content

AWS CodeDeploy API

by amazonaws.com

API keyHTTPSCloud Platforms
Open documentation ↗

Overview

<p>CodeDeploy is a deployment service that automates application deployments to Amazon EC2 instances, on-premises instances running in your own facility, serverless Lambda functions, or applications in an Amazon ECS service.</p> <p>You can deploy a nearly unlimited variety of application content, such as an updated Lambda function, updated applications in an Amazon ECS service, code, web and configuration files, executables, packages, scripts, multimedia files, and so on. CodeDeploy can deploy application content stored in Amazon S3 buckets, GitHub repositories, or Bitbucket repositories. You do not need to make changes to your existing code before you can use CodeDeploy.</p> <p>CodeDeploy makes it easier for you to rapidly release new features, helps you avoid downtime during application deployment, and handles the complexity of updating your applications, without many of the risks associated with error-prone manual deployments.</p> <p> <b>CodeDeploy Components</b> </p> <p>Use the information in this guide to help you work with the following CodeDeploy components:</p> <ul> <li> <p> <b>Application</b>: A name that uniquely identifies the application you want to deploy. CodeDeploy uses this name, which functions as a container, to ensure the correct combination of revision, deployment configuration, and deployment group are referenced during a deployment.</p> </li> <li> <p> <b>Deployment group</b>: A set of individual instances, CodeDeploy Lambda deployment configuration settings, or an Amazon ECS service and network details. A Lambda deployment group specifies how to route traffic to a new version of a Lambda function. An Amazon ECS deployment group specifies the service created in Amazon ECS to deploy, a load balancer, and a listener to reroute production traffic to an updated containerized application. An Amazon EC2/On-premises deployment group contains individually tagged instances, Amazon EC2 instances in Amazon EC2 Auto Scaling groups, or both. All deployment groups can specify optional trigger, alarm, and rollback settings.</p> </li> <li> <p> <b>Deployment configuration</b>: A set of deployment rules and deployment success and failure conditions used by CodeDeploy during a deployment.</p> </li> <li> <p> <b>Deployment</b>: The process and the components used when updating a Lambda function, a containerized application in an Amazon ECS service, or of installing content on one or more instances. </p> </li> <li> <p> <b>Application revisions</b>: For an Lambda deployment, this is an AppSpec file that specifies the Lambda function to be updated and one or more functions to validate deployment lifecycle events. For an Amazon ECS deployment, this is an AppSpec file that specifies the Amazon ECS task definition, container, and port where production traffic is rerouted. For an EC2/On-premises deployment, this is an archive file that contains source content—source code, webpages, executable files, and deployment scripts—along with an AppSpec file. Revisions are stored in Amazon S3 buckets or GitHub repositories. For Amazon S3, a revision is uniquely identified by its Amazon S3 object key and its ETag, version, or both. For GitHub, a revision is uniquely identified by its commit ID.</p> </li> </ul> <p>This guide also contains information to help you get details about the instances in your deployments, to make on-premises instances available for CodeDeploy deployments, to get details about a Lambda function deployment, and to get details about Amazon ECS service deployments.</p> <p> <b>CodeDeploy Information Resources</b> </p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/codedeploy/latest/userguide">CodeDeploy User Guide</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/codedeploy/latest/APIReference/">CodeDeploy API Reference Guide</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/cli/latest/reference/deploy/index.html">CLI Reference for CodeDeploy</a> </p> </li> <li> <p> <a href="https://forums.aws.amazo

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

At a glance

Authentication
API key
HTTPS
Yes
CORS
Unknown
Version
2014-10-06
Endpoints
47
Spec updated
2020-03-11

Endpoints

MethodPathWhat it does
POST/#X-Amz-Target=CodeDeploy_20141006.AddTagsToOnPremisesInstancesAdds tags to on-premises instances.
POST/#X-Amz-Target=CodeDeploy_20141006.BatchGetApplicationRevisionsGets information about one or more application revisions. The maximum number of application revisions that can be returned is 25.
POST/#X-Amz-Target=CodeDeploy_20141006.BatchGetApplicationsGets information about one or more applications. The maximum number of applications that can be returned is 100.
POST/#X-Amz-Target=CodeDeploy_20141006.BatchGetDeploymentGroupsGets information about one or more deployment groups.
POST/#X-Amz-Target=CodeDeploy_20141006.BatchGetDeploymentInstancesdeprecated<note> <p> This method works, but is deprecated. Use <code>BatchGetDeploymentTargets</code> instead. </p> </note> <p> Returns an array of one or more instances
POST/#X-Amz-Target=CodeDeploy_20141006.BatchGetDeploymentTargets<p> Returns an array of one or more targets associated with a deployment. This method works with all compute types and should be used instead of the deprecated
POST/#X-Amz-Target=CodeDeploy_20141006.BatchGetDeploymentsGets information about one or more deployments. The maximum number of deployments that can be returned is 25.
POST/#X-Amz-Target=CodeDeploy_20141006.BatchGetOnPremisesInstancesGets information about one or more on-premises instances. The maximum number of on-premises instances that can be returned is 25.
POST/#X-Amz-Target=CodeDeploy_20141006.ContinueDeploymentFor a blue/green deployment, starts the process of rerouting traffic from instances in the original environment to instances in the replacement environment with
POST/#X-Amz-Target=CodeDeploy_20141006.CreateApplicationCreates an application.
POST/#X-Amz-Target=CodeDeploy_20141006.CreateDeploymentDeploys an application revision through the specified deployment group.
POST/#X-Amz-Target=CodeDeploy_20141006.CreateDeploymentConfigCreates a deployment configuration.
POST/#X-Amz-Target=CodeDeploy_20141006.CreateDeploymentGroupCreates a deployment group to which application revisions are deployed.
POST/#X-Amz-Target=CodeDeploy_20141006.DeleteApplicationDeletes an application.
POST/#X-Amz-Target=CodeDeploy_20141006.DeleteDeploymentConfig<p>Deletes a deployment configuration.</p> <note> <p>A deployment configuration cannot be deleted if it is currently in use. Predefined configurations cannot be
POST/#X-Amz-Target=CodeDeploy_20141006.DeleteDeploymentGroupDeletes a deployment group.
POST/#X-Amz-Target=CodeDeploy_20141006.DeleteGitHubAccountTokenDeletes a GitHub account connection.
POST/#X-Amz-Target=CodeDeploy_20141006.DeleteResourcesByExternalIdDeletes resources linked to an external ID.
POST/#X-Amz-Target=CodeDeploy_20141006.DeregisterOnPremisesInstanceDeregisters an on-premises instance.
POST/#X-Amz-Target=CodeDeploy_20141006.GetApplicationGets information about an application.
POST/#X-Amz-Target=CodeDeploy_20141006.GetApplicationRevisionGets information about an application revision.
POST/#X-Amz-Target=CodeDeploy_20141006.GetDeployment<p>Gets information about a deployment.</p> <note> <p> The <code>content</code> property of the <code>appSpecContent</code> object in the returned revision is a
POST/#X-Amz-Target=CodeDeploy_20141006.GetDeploymentConfigGets information about a deployment configuration.
POST/#X-Amz-Target=CodeDeploy_20141006.GetDeploymentGroupGets information about a deployment group.
POST/#X-Amz-Target=CodeDeploy_20141006.GetDeploymentInstancedeprecatedGets information about an instance as part of a deployment.
POST/#X-Amz-Target=CodeDeploy_20141006.GetDeploymentTargetReturns information about a deployment target.
POST/#X-Amz-Target=CodeDeploy_20141006.GetOnPremisesInstanceGets information about an on-premises instance.
POST/#X-Amz-Target=CodeDeploy_20141006.ListApplicationRevisionsLists information about revisions for an application.
POST/#X-Amz-Target=CodeDeploy_20141006.ListApplicationsLists the applications registered with the IAM user or Amazon Web Services account.
POST/#X-Amz-Target=CodeDeploy_20141006.ListDeploymentConfigsLists the deployment configurations with the IAM user or Amazon Web Services account.
POST/#X-Amz-Target=CodeDeploy_20141006.ListDeploymentGroupsLists the deployment groups for an application registered with the IAM user or Amazon Web Services account.
POST/#X-Amz-Target=CodeDeploy_20141006.ListDeploymentInstancesdeprecated<note> <p> The newer <code>BatchGetDeploymentTargets</code> should be used instead because it works with all compute types. <code>ListDeploymentInstances</code>
POST/#X-Amz-Target=CodeDeploy_20141006.ListDeploymentTargetsReturns an array of target IDs that are associated a deployment.
POST/#X-Amz-Target=CodeDeploy_20141006.ListDeploymentsLists the deployments in a deployment group for an application registered with the IAM user or Amazon Web Services account.
POST/#X-Amz-Target=CodeDeploy_20141006.ListGitHubAccountTokenNamesLists the names of stored connections to GitHub accounts.
POST/#X-Amz-Target=CodeDeploy_20141006.ListOnPremisesInstances<p>Gets a list of names for one or more on-premises instances.</p> <p>Unless otherwise specified, both registered and deregistered on-premises instance names ar
POST/#X-Amz-Target=CodeDeploy_20141006.ListTagsForResourceReturns a list of tags for the resource identified by a specified Amazon Resource Name (ARN). Tags are used to organize and categorize your CodeDeploy resources
POST/#X-Amz-Target=CodeDeploy_20141006.PutLifecycleEventHookExecutionStatusSets the result of a Lambda validation function. The function validates lifecycle hooks during a deployment that uses the Lambda or Amazon ECS compute platform.
POST/#X-Amz-Target=CodeDeploy_20141006.RegisterApplicationRevisionRegisters with CodeDeploy a revision for the specified application.
POST/#X-Amz-Target=CodeDeploy_20141006.RegisterOnPremisesInstance<p>Registers an on-premises instance.</p> <note> <p>Only one IAM ARN (an IAM session ARN or IAM user ARN) is supported in the request. You cannot use both.</p>
POST/#X-Amz-Target=CodeDeploy_20141006.RemoveTagsFromOnPremisesInstancesRemoves one or more tags from one or more on-premises instances.
POST/#X-Amz-Target=CodeDeploy_20141006.SkipWaitTimeForInstanceTerminationdeprecatedIn a blue/green deployment, overrides any specified wait time and starts terminating instances immediately after the traffic routing is complete.
POST/#X-Amz-Target=CodeDeploy_20141006.StopDeploymentAttempts to stop an ongoing deployment.
POST/#X-Amz-Target=CodeDeploy_20141006.TagResourceAssociates the list of tags in the input <code>Tags</code> parameter with the resource identified by the <code>ResourceArn</code> input parameter.
POST/#X-Amz-Target=CodeDeploy_20141006.UntagResourceDisassociates a resource from a list of tags. The resource is identified by the <code>ResourceArn</code> input parameter. The tags are identified by the list of
POST/#X-Amz-Target=CodeDeploy_20141006.UpdateApplicationChanges the name of an application.
POST/#X-Amz-Target=CodeDeploy_20141006.UpdateDeploymentGroupChanges information about a deployment group.

Questions

Does the AWS CodeDeploy API need an API key?

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

Does the AWS CodeDeploy API support HTTPS?

Yes, the AWS CodeDeploy API is served over HTTPS.

How many endpoints does the AWS CodeDeploy API have?

Its OpenAPI description lists 47 endpoints in version 2014-10-06. All of them are shown on this page.

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