v5

latestOpenAPI 3.0.3Apache 2.0raw.githubusercontent.com2026-02-283466592.5 MB

Release pipelines (beta)

Update a release pipeline

Updates a release pipeline.

put/api/v2/projects/{projectKey}/release-pipelines/{pipelineKey}

Path parameters

projectKeystring string required

The project key

pipelineKeystring string required

The release pipeline key

Request body

descriptionstring

The release pipeline description

namestring required

The name of the release pipeline

tagsstring[]

A list of tags for this release pipeline

Example request

{
  "description": "Standard pipeline to roll out to production",
  "name": "Standard Pipeline",
  "phases": [
    {
      "audiences": [
        {
          "configuration": {
            "requireApproval": true,
            "notifyMemberIds": [
              "1234a56b7c89d012345e678f"
            ],
            "notifyTeamKeys": [
              "example-reviewer-team"
            ],
            "releaseGuardianConfiguration": {
              "monitoringWindowMilliseconds": 60000,
              "rolloutWeight": 50,
              "rollbackOnRegression": true,
              "randomizationUnit": "user"
            }
          }
        }
      ],
      "name": "Phase 1 - Testing"
    }
  ],
  "tags": [
    "example-tag"
  ]
}

Response

Release pipeline response

createdAtstring date-time required

Timestamp of when the release pipeline was created

descriptionstring

The release pipeline description

keystring required

The release pipeline key

namestring required

The release pipeline name

tagsstring[]

A list of the release pipeline's tags

_versioninteger

The release pipeline version

isProjectDefaultboolean

Whether this release pipeline is the default pipeline for the project

_isLegacyboolean

Whether this release pipeline is a legacy pipeline

Example response

{
  "createdAt": "1684262711507",
  "description": "Standard pipeline to roll out to production",
  "key": "standard-pipeline",
  "name": "Standard Pipeline",
  "phases": [
    {
      "id": "1234a56b7c89d012345e678f",
      "audiences": [
        {
          "environment": {
            "_links": {
              "self": {
                "href": "/api/v2/projects/my-project/environments/my-environment",
                "type": "application/json"
              }
            },
            "key": "environment-key-123abc",
            "name": "My Environment",
            "color": "F5A623"
          },
          "name": "Phase 1 - Testing",
          "configuration": {
            "requireApproval": true,
            "notifyMemberIds": [
              "1234a56b7c89d012345e678f"
            ],
            "notifyTeamKeys": [
              "example-reviewer-team"
            ],
            "releaseGuardianConfiguration": {
              "monitoringWindowMilliseconds": 60000,
              "rolloutWeight": 50,
              "rollbackOnRegression": true,
              "randomizationUnit": "user"
            }
          },
          "segmentKeys": [
            "segment-key-123abc"
          ]
        }
      ],
      "name": "Phase 1 - Testing"
    }
  ],
  "tags": [
    "example-tag"
  ],
  "_version": 1,
  "_access": {
    "denied": [
      {
        "reason": {
          "resources": [
            "proj/*:env/*;qa_*:/flag/*"
          ],
          "actions": [
            "*"
          ],
          "effect": "allow"
        }
      }
    ],
    "allowed": [
      {
        "reason": {
          "resources": [
            "proj/*:env/*;qa_*:/flag/*"
          ],
          "actions": [
            "*"
          ],
          "effect": "allow"
        }
      }
    ]
  },
  "_isLegacy": true
}