# LaunchDarkly Releases (beta) API

**Canonical:** https://apis.io/apis/launchdarkly/launchdarkly-releases-beta-api/  
**Provider:** LaunchDarkly — https://apis.io/providers/launchdarkly/  
**Base URL:** https://app.launchdarkly.com/api/v2  
**Documentation:** https://launchdarkly.com/docs/api/webhooks

LaunchDarkly Releases (beta) API is one of 68 APIs that [LaunchDarkly](https://apis.io/providers/launchdarkly/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Releases (beta). The published artifact set on APIs.io includes an OpenAPI specification.

> ### This feature is in beta > > To use this feature, pass in a header including the `LD-API-Version` key with value set to `beta`. Use this header with each call. To learn more, read [Beta resources](https://launchdarkly.com/docs/api#beta-resources). > > Resources that are in beta are still undergoing testing and development. They may change without notice, including becoming backwards incompatible. Release pipelines standardize and automate the release process for feature flags across a series of phases, where each phase consists of one or more environments and audiences. When you add a flag to an existing release pipeline, you create a "release" to automate that flag's progress through the pipeline. Use the releases API to add a flag to an existing release pipeline, or to monitor or update an ongoing release for a flag. Updating an ongoing release generally involves the following steps: 1. Obtain the release phases associated with the release. The `phases` field provides an ordered list of all pipeline phases associated with the flag's release. `phases` is returned in the response when you [Create a new release for a flag](https://launchdarkly.com/docs/api/releases-beta/create-release-for-flag) or [Get the release for a flag](https://launchdarkly.com/docs/api/releases-beta/get-release-by-flag-key). 2. Determine the `_id` of the phase you want to start. Release pipeline phases take place in their configured order, so find the first incomplete, unstarted phase in the `phases` list. For example, in a newly-created release the first phase in the `phases` list has both the `complete` and `started` fields set to `false`. 3. Use the phase `_id` value with the [Update phase status for release](https://launchdarkly.com/docs/api/releases-beta/update-phase-status) endpoint to start the release phase. At a minimum, you must provide `{"status": active}` in the request object to start a pipeline phase. If the phase requires approvals or guarded rollouts, provide the additional required information in the `audiences` list. ### Configuring release pipelines Use the related [release pipelines API](https://launchdarkly.com/docs/api/release-pipelines-beta) to view, create, update, and delete release pipelines, or to view the progress of all ongoing releases across all flags in a project for a given release pipeline.

## Operations (5)

| Method | Path | Summary |
|---|---|---|
| GET | `/api/v2/flags/{projectKey}/{flagKey}/release` | Get release for flag |
| PATCH | `/api/v2/flags/{projectKey}/{flagKey}/release` | Patch release for flag |
| DELETE | `/api/v2/flags/{projectKey}/{flagKey}/release` | Delete a release for flag |
| PUT | `/api/v2/projects/{projectKey}/flags/{flagKey}/release` | Create a new release for flag |
| PUT | `/api/v2/projects/{projectKey}/flags/{flagKey}/release/phases/{phaseId}` | Update phase status for release |

## Machine-readable artifacts (1)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/launchdarkly/refs/heads/main/openapi/launchdarkly-releases-beta-api-openapi.yml

## Other LaunchDarkly APIs (12)

- [LaunchDarkly Webhooks API](https://apis.io/apis/launchdarkly/webhooks-api/)
- [launchdarkly Access Tokens API](https://apis.io/apis/launchdarkly/launchdarkly-access-tokens-api/)
- [launchdarkly Account Members API](https://apis.io/apis/launchdarkly/launchdarkly-account-members-api/)
- [launchdarkly Approvals API](https://apis.io/apis/launchdarkly/launchdarkly-approvals-api/)
- [launchdarkly Audit Log API](https://apis.io/apis/launchdarkly/launchdarkly-audit-log-api/)
- [launchdarkly Client-Side Evaluation API](https://apis.io/apis/launchdarkly/launchdarkly-client-side-evaluation-api/)
- [launchdarkly Client-Side Streaming API](https://apis.io/apis/launchdarkly/launchdarkly-client-side-streaming-api/)
- [launchdarkly Code References API](https://apis.io/apis/launchdarkly/launchdarkly-code-references-api/)
- [launchdarkly Custom Roles API](https://apis.io/apis/launchdarkly/launchdarkly-custom-roles-api/)
- [launchdarkly Environments API](https://apis.io/apis/launchdarkly/launchdarkly-environments-api/)
- [launchdarkly Experiments API](https://apis.io/apis/launchdarkly/launchdarkly-experiments-api/)
- [launchdarkly Feature Flags API](https://apis.io/apis/launchdarkly/launchdarkly-feature-flags-api/)

## Tags

Releases (beta)

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/launchdarkly/launchdarkly-releases-beta-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/launchdarkly/.