LaunchDarkly REST API
LaunchDarkly DocsSign in
HomeAPI ReferenceSDKsContext Plugin
Release pipelines (beta)

Update a release pipeline

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

Updates a release pipeline.

Authorization

ApiKey read, write
Authorization<token>

In: header

Scope: read, write

Path Parameters

projectKey*string

The project key

Formatstring
pipelineKey*string

The release pipeline key

Formatstring

Request Body

application/json

description?string

The release pipeline description

name*string

The name of the release pipeline

phases*array<>

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

tags?array<string>

A list of tags for this release pipeline

Response Body

application/json

application/json

application/json

application/json

curl -X PUT "https://example.com/api/v2/projects/string/release-pipelines/string" \  -H "Content-Type: application/json" \  -d '{    "name": "Standard Pipeline",    "phases": [      {        "audiences": [          {            "environmentKey": "string",            "name": "string"          }        ],        "name": "Phase 1 - Testing"      }    ]  }'
{  "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": {            "releaseStrategy": "monitoredRelease",            "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",      "configuration": {}    }  ],  "tags": [    "example-tag"  ],  "_version": 1,  "_access": {    "denied": [      {        "action": "string",        "reason": {          "resources": [            "proj/*:env/*;qa_*:/flag/*"          ],          "notResources": [            "string"          ],          "actions": [            "*"          ],          "notActions": [            "string"          ],          "effect": "allow",          "role_name": "string"        }      }    ],    "allowed": [      {        "action": "string",        "reason": {          "resources": [            "proj/*:env/*;qa_*:/flag/*"          ],          "notResources": [            "string"          ],          "actions": [            "*"          ],          "notActions": [            "string"          ],          "effect": "allow",          "role_name": "string"        }      }    ]  },  "isProjectDefault": true,  "_isLegacy": true}

Delete release pipeline DELETE

Deletes a release pipeline. You cannot delete the default release pipeline. If you want to delete a release pipeline that is currently the default, create a second release pipeline and set it as the default. Then delete the first release pipeline. To change the default release pipeline, use the [Update project](https://launchdarkly.com/docs/api/projects/patch-project) API to set the `defaultReleasePipelineKey`.

Get release progressions for release pipeline GET

Get details on the progression of all releases, across all flags, for a release pipeline