Skip to content

AWS CodePipeline API

by amazonaws.com

API keyHTTPSCloud Platforms
Open documentation ↗

Overview

<fullname>AWS CodePipeline</fullname> <p> <b>Overview</b> </p> <p>This is the AWS CodePipeline API Reference. This guide provides descriptions of the actions and data types for AWS CodePipeline. Some functionality for your pipeline can only be configured through the API. For more information, see the <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/welcome.html">AWS CodePipeline User Guide</a>.</p> <p>You can use the AWS CodePipeline API to work with pipelines, stages, actions, and transitions.</p> <p> <i>Pipelines</i> are models of automated release processes. Each pipeline is uniquely named, and consists of stages, actions, and transitions. </p> <p>You can work with pipelines by calling:</p> <ul> <li> <p> <a>CreatePipeline</a>, which creates a uniquely named pipeline.</p> </li> <li> <p> <a>DeletePipeline</a>, which deletes the specified pipeline.</p> </li> <li> <p> <a>GetPipeline</a>, which returns information about the pipeline structure and pipeline metadata, including the pipeline Amazon Resource Name (ARN).</p> </li> <li> <p> <a>GetPipelineExecution</a>, which returns information about a specific execution of a pipeline.</p> </li> <li> <p> <a>GetPipelineState</a>, which returns information about the current state of the stages and actions of a pipeline.</p> </li> <li> <p> <a>ListActionExecutions</a>, which returns action-level details for past executions. The details include full stage and action-level details, including individual action duration, status, any errors that occurred during the execution, and input and output artifact location details.</p> </li> <li> <p> <a>ListPipelines</a>, which gets a summary of all of the pipelines associated with your account.</p> </li> <li> <p> <a>ListPipelineExecutions</a>, which gets a summary of the most recent executions for a pipeline.</p> </li> <li> <p> <a>StartPipelineExecution</a>, which runs the most recent revision of an artifact through the pipeline.</p> </li> <li> <p> <a>StopPipelineExecution</a>, which stops the specified pipeline execution from continuing through the pipeline.</p> </li> <li> <p> <a>UpdatePipeline</a>, which updates a pipeline with edits or changes to the structure of the pipeline.</p> </li> </ul> <p>Pipelines include <i>stages</i>. Each stage contains one or more actions that must complete before the next stage begins. A stage results in success or failure. If a stage fails, the pipeline stops at that stage and remains stopped until either a new version of an artifact appears in the source location, or a user takes action to rerun the most recent artifact through the pipeline. You can call <a>GetPipelineState</a>, which displays the status of a pipeline, including the status of stages in the pipeline, or <a>GetPipeline</a>, which returns the entire structure of the pipeline, including the stages of that pipeline. For more information about the structure of stages and actions, see <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/pipeline-structure.html">AWS CodePipeline Pipeline Structure Reference</a>.</p> <p>Pipeline stages include <i>actions</i> that are categorized into categories such as source or build actions performed in a stage of a pipeline. For example, you can use a source action to import artifacts into a pipeline from a source such as Amazon S3. Like stages, you do not work with actions directly in most cases, but you do define and interact with actions when working with pipeline operations such as <a>CreatePipeline</a> and <a>GetPipelineState</a>. Valid action categories are:</p> <ul> <li> <p>Source</p> </li> <li> <p>Build</p> </li> <li> <p>Test</p> </li> <li> <p>Deploy</p> </li> <li> <p>Approval</p> </li> <li> <p>Invoke</p> </li> </ul> <p>Pipelines also include <i>transitions</i>, which allow the transition of artifacts from one stage to the next in a pipeline after the actions in one stage complete.</p> <p>You can work with transitions by calling:</p> <ul> <li> <p> <a>DisableStageTransition</a>, which

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

At a glance

Authentication
API key
HTTPS
Yes
CORS
Unknown
Version
2015-07-09
Endpoints
39
Spec updated
2020-03-11

Endpoints

MethodPathWhat it does
POST/#X-Amz-Target=CodePipeline_20150709.AcknowledgeJobReturns information about a specified job and whether that job has been received by the job worker. Used for custom actions only.
POST/#X-Amz-Target=CodePipeline_20150709.AcknowledgeThirdPartyJobConfirms a job worker has received the specified job. Used for partner actions only.
POST/#X-Amz-Target=CodePipeline_20150709.CreateCustomActionTypeCreates a new custom action that can be used in all pipelines associated with the AWS account. Only used for custom actions.
POST/#X-Amz-Target=CodePipeline_20150709.CreatePipeline<p>Creates a pipeline.</p> <note> <p>In the pipeline structure, you must include either <code>artifactStore</code> or <code>artifactStores</code> in your pipeli
POST/#X-Amz-Target=CodePipeline_20150709.DeleteCustomActionType<p>Marks a custom action as deleted. <code>PollForJobs</code> for the custom action fails after the action is marked for deletion. Used for custom actions only.
POST/#X-Amz-Target=CodePipeline_20150709.DeletePipelineDeletes the specified pipeline.
POST/#X-Amz-Target=CodePipeline_20150709.DeleteWebhookDeletes a previously created webhook by name. Deleting the webhook stops AWS CodePipeline from starting a pipeline every time an external event occurs. The API
POST/#X-Amz-Target=CodePipeline_20150709.DeregisterWebhookWithThirdPartyRemoves the connection between the webhook that was created by CodePipeline and the external tool with events to be detected. Currently supported only for webho
POST/#X-Amz-Target=CodePipeline_20150709.DisableStageTransitionPrevents artifacts in a pipeline from transitioning to the next stage in the pipeline.
POST/#X-Amz-Target=CodePipeline_20150709.EnableStageTransitionEnables artifacts in a pipeline to transition to a stage in a pipeline.
POST/#X-Amz-Target=CodePipeline_20150709.GetActionTypeReturns information about an action type created for an external provider, where the action is to be used by customers of the external provider. The action can
POST/#X-Amz-Target=CodePipeline_20150709.GetJobDetails<p>Returns information about a job. Used for custom actions only.</p> <important> <p>When this API is called, AWS CodePipeline returns temporary credentials for
POST/#X-Amz-Target=CodePipeline_20150709.GetPipelineReturns the metadata, structure, stages, and actions of a pipeline. Can be used to return the entire structure of a pipeline in JSON format, which can then be m
POST/#X-Amz-Target=CodePipeline_20150709.GetPipelineExecutionReturns information about an execution of a pipeline, including details about artifacts, the pipeline execution ID, and the name, version, and status of the pip
POST/#X-Amz-Target=CodePipeline_20150709.GetPipelineState<p>Returns information about the state of a pipeline, including the stages and actions.</p> <note> <p>Values returned in the <code>revisionId</code> and <code>r
POST/#X-Amz-Target=CodePipeline_20150709.GetThirdPartyJobDetails<p>Requests the details of a job for a third party action. Used for partner actions only.</p> <important> <p>When this API is called, AWS CodePipeline returns t
POST/#X-Amz-Target=CodePipeline_20150709.ListActionExecutionsLists the action executions that have occurred in a pipeline.
POST/#X-Amz-Target=CodePipeline_20150709.ListActionTypesGets a summary of all AWS CodePipeline action types associated with your account.
POST/#X-Amz-Target=CodePipeline_20150709.ListPipelineExecutionsGets a summary of the most recent executions for a pipeline.
POST/#X-Amz-Target=CodePipeline_20150709.ListPipelinesGets a summary of all of the pipelines associated with your account.
POST/#X-Amz-Target=CodePipeline_20150709.ListTagsForResourceGets the set of key-value pairs (metadata) that are used to manage the resource.
POST/#X-Amz-Target=CodePipeline_20150709.ListWebhooksGets a listing of all the webhooks in this AWS Region for this account. The output lists all webhooks and includes the webhook URL and ARN and the configuration
POST/#X-Amz-Target=CodePipeline_20150709.PollForJobs<p>Returns information about any jobs for AWS CodePipeline to act on. <code>PollForJobs</code> is valid only for action types with "Custom" in the owner field.
POST/#X-Amz-Target=CodePipeline_20150709.PollForThirdPartyJobs<p>Determines whether there are any third party jobs for a job worker to act on. Used for partner actions only.</p> <important> <p>When this API is called, AWS
POST/#X-Amz-Target=CodePipeline_20150709.PutActionRevisionProvides information to AWS CodePipeline about new revisions to a source.
POST/#X-Amz-Target=CodePipeline_20150709.PutApprovalResultProvides the response to a manual approval request to AWS CodePipeline. Valid responses include Approved and Rejected.
POST/#X-Amz-Target=CodePipeline_20150709.PutJobFailureResultRepresents the failure of a job as returned to the pipeline by a job worker. Used for custom actions only.
POST/#X-Amz-Target=CodePipeline_20150709.PutJobSuccessResultRepresents the success of a job as returned to the pipeline by a job worker. Used for custom actions only.
POST/#X-Amz-Target=CodePipeline_20150709.PutThirdPartyJobFailureResultRepresents the failure of a third party job as returned to the pipeline by a job worker. Used for partner actions only.
POST/#X-Amz-Target=CodePipeline_20150709.PutThirdPartyJobSuccessResultRepresents the success of a third party job as returned to the pipeline by a job worker. Used for partner actions only.
POST/#X-Amz-Target=CodePipeline_20150709.PutWebhookDefines a webhook and returns a unique webhook URL generated by CodePipeline. This URL can be supplied to third party source hosting providers to call every tim
POST/#X-Amz-Target=CodePipeline_20150709.RegisterWebhookWithThirdPartyConfigures a connection between the webhook that was created and the external tool with events to be detected.
POST/#X-Amz-Target=CodePipeline_20150709.RetryStageExecutionResumes the pipeline execution by retrying the last failed actions in a stage. You can retry a stage immediately if any of the actions in the stage fail. When y
POST/#X-Amz-Target=CodePipeline_20150709.StartPipelineExecutionStarts the specified pipeline. Specifically, it begins processing the latest commit to the source location specified as part of the pipeline.
POST/#X-Amz-Target=CodePipeline_20150709.StopPipelineExecutionStops the specified pipeline execution. You choose to either stop the pipeline execution by completing in-progress actions without starting subsequent actions,
POST/#X-Amz-Target=CodePipeline_20150709.TagResourceAdds to or modifies the tags of the given resource. Tags are metadata that can be used to manage a resource.
POST/#X-Amz-Target=CodePipeline_20150709.UntagResourceRemoves tags from an AWS resource.
POST/#X-Amz-Target=CodePipeline_20150709.UpdateActionTypeUpdates an action type that was created with any supported integration model, where the action type is to be used by customers of the action type provider. Use
POST/#X-Amz-Target=CodePipeline_20150709.UpdatePipelineUpdates a specified pipeline with edits or changes to its structure. Use a JSON file with the pipeline structure and <code>UpdatePipeline</code> to provide the

Questions

Does the AWS CodePipeline API need an API key?

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

Does the AWS CodePipeline API support HTTPS?

Yes, the AWS CodePipeline API is served over HTTPS.

How many endpoints does the AWS CodePipeline API have?

Its OpenAPI description lists 39 endpoints in version 2015-07-09. All of them are shown on this page.

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