For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Sign inTry it free
DocsGuidesSDKsIntegrationsAPI docsTutorialsFlagship blog
DocsGuidesSDKsIntegrationsAPI docsTutorialsFlagship blog
  • REST API overview
    • Access Tokens
    • Account Members
    • Account Usage Beta
    • AI Configs
    • Announcements
    • Applications Beta
    • Approvals
    • Approvals Beta
    • Audit Log
    • Code References
    • Contexts
    • Context Settings
    • Custom Roles
    • Data Export Destinations
    • Environments
    • Experiments
    • Feature Flags
    • Feature Flags Beta
    • Flag Import Configurations Beta
    • Flag Links Beta
    • Flag Triggers
    • Follow Flags
    • Holdouts Beta
    • Insights Charts Beta
    • Insights Deployments Beta
    • Insights Flag Events Beta
    • Insights Pull Requests Beta
    • Insights Repositories Beta
    • Insights Scores Beta
    • Integration Audit Log Subscriptions
    • Integration Delivery Configurations Beta
    • Integrations Beta
    • Layers
    • Metrics
    • Metrics Beta
    • OAuth2 Clients
    • Persistent Store Integrations Beta
    • Projects
    • Relay Proxy Configurations
    • Release Pipelines Beta
      • POSTCreate a release pipeline
      • DELDelete release pipeline
      • GETGet all release pipelines
      • GETGet release pipeline by key
      • GETGet release progressions for release pipeline
      • PUTUpdate a release pipeline
    • Releases Beta
    • Scheduled Changes
    • Segments
    • Tags
    • Teams
    • Teams Beta
    • Users
    • Users Beta
    • User Settings
    • Views Beta
    • Webhooks
    • Workflows
    • Workflow Templates
    • Other
Sign inTry it free
LogoLogo
REST API overviewRelease Pipelines Beta

Get release progressions for release pipeline

GET
/api/v2/projects/:projectKey/release-pipelines/:pipelineKey/releases
GET
/api/v2/projects/:projectKey/release-pipelines/:pipelineKey/releases
$curl https://app.launchdarkly.com/api/v2/projects/projectKey/release-pipelines/pipelineKey/releases \
>     -H "Authorization: <apiKey>"
1{
2  "activeCount": 3,
3  "completedCount": 1,
4  "items": [
5    {
6      "_createdAt": 1684262711507,
7      "flagKey": "flag-key-123abc",
8      "_links": {},
9      "_completedAt": 1684262711509,
10      "activePhaseId": "1234a56b7c89d012345e678f"
11    }
12  ],
13  "phases": [
14    {
15      "_id": "1234a56b7c89d012345e678f",
16      "name": "Phase 1 - Testing",
17      "releaseCount": 2
18    }
19  ],
20  "totalCount": 8,
21  "_links": {}
22}
Get details on the progression of all releases, across all flags, for a release pipeline
Was this page helpful?
Previous

Update a release pipeline

Next
Built with

Authentication

Authorizationstring
API Key authentication via header

Path parameters

projectKeystringRequiredformat: "string"
The project key
pipelineKeystringRequiredformat: "string"
The pipeline key

Query parameters

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

Errors

404
Not Found Error

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.