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

Get all release pipelines

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

Get all release pipelines for a project.

Filtering release pipelines

LaunchDarkly supports the following fields for filters:

  • query is a string that matches against the release pipeline key, name, and description. It is not case sensitive. For example: ?filter=query:examplePipeline.

  • env is a string that matches an environment key. For example: ?filter=env:production.

Authorization

ApiKey read, write
Authorization<token>

In: header

Scope: read, write

Path Parameters

projectKey*string

The project key

Formatstring

Query Parameters

filter?string

A comma-separated list of filters. Each filter is of the form field:value. Read the endpoint description for a full list of available filter fields.

Formatstring
limit?integer

The maximum number of items to return. Defaults to 20.

Formatint64
offset?integer

Where to start in the list. Defaults to 0. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query limit.

Formatint64

Response Body

application/json

application/json

curl -X GET "https://example.com/api/v2/projects/string/release-pipelines"
{  "items": [    {      "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    }  ],  "totalCount": 1}

Delete metric group DELETE

Delete a metric group by key.

Create a release pipeline POST

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](https://launchdarkly.com/docs/api/projects/patch-project) API to set the `defaultReleasePipelineKey`. You can create up to 20 release pipelines per project.