Skip to main content
PUT
Update a release pipeline

Authorizations

Authorization
string
header
required

Path Parameters

projectKey
string<string>
required

The project key

pipelineKey
string<string>
required

The release pipeline key

Body

application/json
name
string
required

The name of the release pipeline

Example:

"Standard Pipeline"

phases
object[]
required

A logical grouping of one or more environments that share attributes for rolling out changes

description
string

The release pipeline description

Example:

"Standard pipeline to roll out to production"

tags
string[]

A list of tags for this release pipeline

Example:

Response

Release pipeline response

createdAt
string<date-time>
required

Timestamp of when the release pipeline was created

Example:

"1684262711507"

key
string
required

The release pipeline key

Example:

"standard-pipeline"

name
string
required

The release pipeline name

Example:

"Standard Pipeline"

phases
object[]
required

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.

description
string

The release pipeline description

Example:

"Standard pipeline to roll out to production"

tags
string[]

A list of the release pipeline's tags

Example:
_version
integer

The release pipeline version

Example:

1

_access
object

Details on the allowed and denied actions for this release pipeline

isProjectDefault
boolean

Whether this release pipeline is the default pipeline for the project

_isLegacy
boolean

Whether this release pipeline is a legacy pipeline

Example:

true