OverviewRelease pipelines (beta)

Create a release pipeline

Creates a new release pipeline.

The first release pipeline you create is automatically set as the default release pipeline for your project. To change the default release pipeline, use the Update project API to set the defaultReleasePipelineKey.

You can create up to 20 release pipelines per project.

Path parameters

projectKeystringRequired
The project key

Headers

AuthorizationstringRequired

Request

This endpoint expects an object.
keystringRequired
The unique identifier of this release pipeline
namestringRequired
The name of the release pipeline
phaseslist of objectsRequired
A logical grouping of one or more environments that share attributes for rolling out changes
descriptionstringOptional
The release pipeline description
tagslist of stringsOptional
A list of tags for this release pipeline
isProjectDefaultbooleanOptional
Whether or not the newly created pipeline should be set as the default pipeline for this project
isLegacybooleanOptional
Whether or not the pipeline is enabled for Release Automation.

Response

Release pipeline response
createdAtdatetime
Timestamp of when the release pipeline was created
keystring
The release pipeline key
namestring
The release pipeline name
phaseslist of objects
An ordered list of the release pipeline phases. Each phase is a logical grouping of one or more environments that share attributes for rolling out changes.
descriptionstring or null
The release pipeline description
tagslist of strings or null
A list of the release pipeline's tags
_versioninteger or null
The release pipeline version
_accessobject or null
Details on the allowed and denied actions for this release pipeline
isProjectDefaultboolean or null
Whether this release pipeline is the default pipeline for the project
_isLegacyboolean or null
Whether this release pipeline is a legacy pipeline

Errors