Get release progressions for release pipeline

1 import requests 2 3 url = "https://app.launchdarkly.com/api/v2/projects/projectKey/release-pipelines/pipelineKey/releases" 4 5 headers = {"Authorization": "<apiKey>"} 6 7 response = requests.get(url, headers=headers) 8 9 print(response.json())

1 { 2 "activeCount": 3, 3 "completedCount": 1, 4 "items": [ 5 { 6 "_createdAt": 1000000, 7 "flagKey": "flag-key-123abc", 8 "_links": { 9 "key": {} 10 }, 11 "_completedAt": 1000000, 12 "activePhaseId": "1234a56b7c89d012345e678f" 13 } 14 ], 15 "phases": [ 16 { 17 "_id": "1234a56b7c89d012345e678f", 18 "name": "Phase 1 - Testing", 19 "releaseCount": 2 20 } 21 ], 22 "totalCount": 8, 23 "_links": { 24 "key": { 25 "href": "href", 26 "type": "type" 27 } 28 } 29 }

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

Path parameters

projectKeystringRequired

The project key

pipelineKeystringRequired

The pipeline key

Query parameters

filterstringOptional

Accepts filter by status and activePhaseId. status can take a value of completed or active. activePhaseId takes a UUID and will filter results down to releases active on the specified phase. Providing status equals completed along with an activePhaseId filter will return an error as they are disjoint sets of data. The combination of status equals active and activePhaseId will return the same results as activePhaseId alone.

Accepts filter by `status` and `activePhaseId`. `status` can take a value of `completed` or `active`. `activePhaseId` takes a UUID and will filter results down to releases active on the specified phase. Providing `status equals completed` along with an `activePhaseId` filter will return an error as they are disjoint sets of data. The combination of `status equals active` and `activePhaseId` will return the same results as `activePhaseId` alone.

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 progression collection

activeCountinteger

The number of active releases

completedCountinteger

The number of completed releases

itemslist of objects

A list of details for each release, across all flags, for this release pipeline

phaseslist of objects

A list of details for each phase, across all releases, for this release pipeline

totalCountinteger

The total number of releases for this release pipeline

_linksmap from strings to objects

The location and content type of related resources

Path parameters

Headers

Query parameters

Response

Errors