v5

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

Release 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.

post/api/v2/projects/{projectKey}/release-pipelines

Path parameters

projectKeystring string required

The project key

Request body

descriptionstring

The release pipeline description

keystring required

The unique identifier of this release pipeline

namestring required

The name of the release pipeline

tagsstring[]

A list of tags for this release pipeline

isProjectDefaultboolean

Whether or not the newly created pipeline should be set as the default pipeline for this project

isLegacyboolean

Whether or not the pipeline is enabled for Release Automation.

Example request

{
  "description": "Standard pipeline to roll out to production",
  "key": "standard-pipeline",
  "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
}