Get all release pipelines | LaunchDarkly

curl https://app.launchdarkly.com/api/v2/projects/projectKey/release-pipelines \
     -H "Authorization: <apiKey>"

{
  "items": [
    {
      "createdAt": "1684262711507",
      "key": "standard-pipeline",
      "name": "Standard Pipeline",
      "phases": [
        {
          "id": "1234a56b7c89d012345e678f",
          "audiences": [
            {
              "name": "Phase 1 - Testing",
              "environment": {
                "_links": {
                  "self": {
                    "href": "/api/v2/projects/my-project/environments/my-environment",
                    "type": "application/json"
                  }
                },
                "key": "environment-key-123abc",
                "name": "My Environment",
                "color": "F5A623"
              },
              "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": {}
        }
      ],
      "description": "Standard pipeline to roll out to production",
      "tags": [
        "example-tag"
      ],
      "_version": 1,
      "_access": {
        "denied": [
          {
            "action": "string",
            "reason": {
              "effect": "allow",
              "resources": [
                "proj/*:env/*;qa_*:/flag/*"
              ],
              "notResources": [
                "string"
              ],
              "actions": [
                "*"
              ],
              "notActions": [
                "string"
              ],
              "role_name": "string"
            }
          }
        ],
        "allowed": [
          {
            "action": "string",
            "reason": {
              "effect": "allow",
              "resources": [
                "proj/*:env/*;qa_*:/flag/*"
              ],
              "notResources": [
                "string"
              ],
              "actions": [
                "*"
              ],
              "notActions": [
                "string"
              ],
              "role_name": "string"
            }
          }
        ]
      },
      "isProjectDefault": true,
      "_isLegacy": true
    }
  ],
  "totalCount": 1
}

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

curl https://app.launchdarkly.com/api/v2/projects/projectKey/release-pipelines \
     -H "Authorization: <apiKey>"

{
  "items": [
    {
      "createdAt": "1684262711507",
      "key": "standard-pipeline",
      "name": "Standard Pipeline",
      "phases": [
        {
          "id": "1234a56b7c89d012345e678f",
          "audiences": [
            {
              "name": "Phase 1 - Testing",
              "environment": {
                "_links": {
                  "self": {
                    "href": "/api/v2/projects/my-project/environments/my-environment",
                    "type": "application/json"
                  }
                },
                "key": "environment-key-123abc",
                "name": "My Environment",
                "color": "F5A623"
              },
              "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": {}
        }
      ],
      "description": "Standard pipeline to roll out to production",
      "tags": [
        "example-tag"
      ],
      "_version": 1,
      "_access": {
        "denied": [
          {
            "action": "string",
            "reason": {
              "effect": "allow",
              "resources": [
                "proj/*:env/*;qa_*:/flag/*"
              ],
              "notResources": [
                "string"
              ],
              "actions": [
                "*"
              ],
              "notActions": [
                "string"
              ],
              "role_name": "string"
            }
          }
        ],
        "allowed": [
          {
            "action": "string",
            "reason": {
              "effect": "allow",
              "resources": [
                "proj/*:env/*;qa_*:/flag/*"
              ],
              "notResources": [
                "string"
              ],
              "actions": [
                "*"
              ],
              "notActions": [
                "string"
              ],
              "role_name": "string"
            }
          }
        ]
      },
      "isProjectDefault": true,
      "_isLegacy": true
    }
  ],
  "totalCount": 1
}

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.

Authentication

Authorizationstring

API Key authentication via header

Path parameters

projectKeystringRequiredformat: "string"

The project key

Query parameters

filterstringOptionalformat: "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.

limitlongOptional

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

offsetlongOptional

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.

Response

Release pipeline collection

itemslist of objects

An array of release pipelines

totalCountinteger

Total number of release pipelines

Errors

404

Not Found Error

$	curl https://app.launchdarkly.com/api/v2/projects/projectKey/release-pipelines \
>	-H "Authorization: <apiKey>"

1	{
2	"items": [
3	{
4	"createdAt": "1684262711507",
5	"key": "standard-pipeline",
6	"name": "Standard Pipeline",
7	"phases": [
8	{
9	"id": "1234a56b7c89d012345e678f",
10	"audiences": [
11	{
12	"name": "Phase 1 - Testing",
13	"environment": {
14	"_links": {
15	"self": {
16	"href": "/api/v2/projects/my-project/environments/my-environment",
17	"type": "application/json"
18	}
19	},
20	"key": "environment-key-123abc",
21	"name": "My Environment",
22	"color": "F5A623"
23	},
24	"configuration": {
25	"releaseStrategy": "monitoredRelease",
26	"requireApproval": true,
27	"notifyMemberIds": [
28	"1234a56b7c89d012345e678f"
29	],
30	"notifyTeamKeys": [
31	"example-reviewer-team"
32	],
33	"releaseGuardianConfiguration": {
34	"monitoringWindowMilliseconds": 60000,
35	"rolloutWeight": 50,
36	"rollbackOnRegression": true,
37	"randomizationUnit": "user"
38	}
39	},
40	"segmentKeys": [
41	"segment-key-123abc"
42	]
43	}
44	],
45	"name": "Phase 1 - Testing",
46	"configuration": {}
47	}
48	],
49	"description": "Standard pipeline to roll out to production",
50	"tags": [
51	"example-tag"
52	],
53	"_version": 1,
54	"_access": {
55	"denied": [
56	{
57	"action": "string",
58	"reason": {
59	"effect": "allow",
60	"resources": [
61	"proj/:env/;qa_:/flag/"
62	],
63	"notResources": [
64	"string"
65	],
66	"actions": [
67	"*"
68	],
69	"notActions": [
70	"string"
71	],
72	"role_name": "string"
73	}
74	}
75	],
76	"allowed": [
77	{
78	"action": "string",
79	"reason": {
80	"effect": "allow",
81	"resources": [
82	"proj/:env/;qa_:/flag/"
83	],
84	"notResources": [
85	"string"
86	],
87	"actions": [
88	"*"
89	],
90	"notActions": [
91	"string"
92	],
93	"role_name": "string"
94	}
95	}
96	]
97	},
98	"isProjectDefault": true,
99	"_isLegacy": true
100	}
101	],
102	"totalCount": 1
103	}