Get an environment release

curl --request GET \
  --url https://app.launchdarkly.com/api/v2/projects/{projectKey}/flags/{flagKey}/environments/{environmentKey}/releases/{releaseId} \
  --header 'Authorization: <api-key>' \
  --header 'LD-API-Version: <ld-api-version>'

import requests

url = "https://app.launchdarkly.com/api/v2/projects/{projectKey}/flags/{flagKey}/environments/{environmentKey}/releases/{releaseId}"

headers = {
    "LD-API-Version": "<ld-api-version>",
    "Authorization": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'LD-API-Version': '<ld-api-version>', Authorization: '<api-key>'}
};

fetch('https://app.launchdarkly.com/api/v2/projects/{projectKey}/flags/{flagKey}/environments/{environmentKey}/releases/{releaseId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.launchdarkly.com/api/v2/projects/{projectKey}/flags/{flagKey}/environments/{environmentKey}/releases/{releaseId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "LD-API-Version: <ld-api-version>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app.launchdarkly.com/api/v2/projects/{projectKey}/flags/{flagKey}/environments/{environmentKey}/releases/{releaseId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("LD-API-Version", "<ld-api-version>")
	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://app.launchdarkly.com/api/v2/projects/{projectKey}/flags/{flagKey}/environments/{environmentKey}/releases/{releaseId}")
  .header("LD-API-Version", "<ld-api-version>")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.launchdarkly.com/api/v2/projects/{projectKey}/flags/{flagKey}/environments/{environmentKey}/releases/{releaseId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["LD-API-Version"] = '<ld-api-version>'
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "originalVariationId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "_links": {
    "key": {
      "href": "href",
      "type": "type"
    }
  },
  "kind": "progressive",
  "startedAt": 7,
  "originalVariationValue": "",
  "cleanupBehavior": "remove_rules_and_update_default_rule",
  "environmentKey": "environmentKey",
  "targetVariationValue": "",
  "createdAt": 4,
  "projectKey": "projectKey",
  "statusReason": "waiting_regression_detected",
  "advancementMode": "manual",
  "endedAt": 1,
  "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "targetVariationId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "metrics": [
    {
      "metricKey": "metricKey",
      "definition": "",
      "autoRollback": true,
      "analysisUnit": "analysisUnit",
      "metricVersionId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
    },
    {
      "metricKey": "metricKey",
      "definition": "",
      "autoRollback": true,
      "analysisUnit": "analysisUnit",
      "metricVersionId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
    }
  ],
  "randomizationUnit": "randomizationUnit",
  "currentPhaseIndex": 0,
  "flagKey": "flagKey",
  "phases": [
    {
      "metricStatuses": {
        "key": "ok"
      },
      "statusReason": null,
      "endedAt": 3,
      "phaseIndex": 0,
      "description": "description",
      "currentStepIndex": 0,
      "startedAt": 9,
      "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "ruleId": "ruleId",
      "steps": [
        {
          "allocation": 14658,
          "stepIndex": 0,
          "endedAt": 2,
          "startedAt": 5,
          "durationMillis": 1
        },
        {
          "allocation": 14658,
          "stepIndex": 0,
          "endedAt": 2,
          "startedAt": 5,
          "durationMillis": 1
        }
      ],
      "status": null
    },
    {
      "metricStatuses": {
        "key": "ok"
      },
      "statusReason": null,
      "endedAt": 3,
      "phaseIndex": 0,
      "description": "description",
      "currentStepIndex": 0,
      "startedAt": 9,
      "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "ruleId": "ruleId",
      "steps": [
        {
          "allocation": 14658,
          "stepIndex": 0,
          "endedAt": 2,
          "startedAt": 5,
          "durationMillis": 1
        },
        {
          "allocation": 14658,
          "stepIndex": 0,
          "endedAt": 2,
          "startedAt": 5,
          "durationMillis": 1
        }
      ],
      "status": null
    }
  ],
  "status": "pending"
}

{
  "code": "code",
  "message": "message"
}

{
  "code": "code",
  "message": "message"
}

{
  "code": "code",
  "message": "message"
}

{
  "code": "code",
  "message": "message"
}

{
  "code": "code",
  "message": "message"
}

{
  "code": "code",
  "message": "message"
}

Get an environment release

Returns an environment release and all its phases in phase-index order. The release ID must belong to the flag and environment in the path. Returns 404 for a release that ended more than 90 days ago. Pass expand=metrics to attach each metric’s definition to the top-level metrics array. Analysis settings come from the version pinned when the release started (metricVersionId); name, description, tags, maintainer, and archive state reflect the current metric and may change afterwards.

GET

api

projects

{projectKey}

flags

{flagKey}

environments

{environmentKey}

releases

{releaseId}

Get an environment release

curl --request GET \
  --url https://app.launchdarkly.com/api/v2/projects/{projectKey}/flags/{flagKey}/environments/{environmentKey}/releases/{releaseId} \
  --header 'Authorization: <api-key>' \
  --header 'LD-API-Version: <ld-api-version>'

import requests

url = "https://app.launchdarkly.com/api/v2/projects/{projectKey}/flags/{flagKey}/environments/{environmentKey}/releases/{releaseId}"

headers = {
    "LD-API-Version": "<ld-api-version>",
    "Authorization": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'LD-API-Version': '<ld-api-version>', Authorization: '<api-key>'}
};

fetch('https://app.launchdarkly.com/api/v2/projects/{projectKey}/flags/{flagKey}/environments/{environmentKey}/releases/{releaseId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.launchdarkly.com/api/v2/projects/{projectKey}/flags/{flagKey}/environments/{environmentKey}/releases/{releaseId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "LD-API-Version: <ld-api-version>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app.launchdarkly.com/api/v2/projects/{projectKey}/flags/{flagKey}/environments/{environmentKey}/releases/{releaseId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("LD-API-Version", "<ld-api-version>")
	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://app.launchdarkly.com/api/v2/projects/{projectKey}/flags/{flagKey}/environments/{environmentKey}/releases/{releaseId}")
  .header("LD-API-Version", "<ld-api-version>")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.launchdarkly.com/api/v2/projects/{projectKey}/flags/{flagKey}/environments/{environmentKey}/releases/{releaseId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["LD-API-Version"] = '<ld-api-version>'
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "originalVariationId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "_links": {
    "key": {
      "href": "href",
      "type": "type"
    }
  },
  "kind": "progressive",
  "startedAt": 7,
  "originalVariationValue": "",
  "cleanupBehavior": "remove_rules_and_update_default_rule",
  "environmentKey": "environmentKey",
  "targetVariationValue": "",
  "createdAt": 4,
  "projectKey": "projectKey",
  "statusReason": "waiting_regression_detected",
  "advancementMode": "manual",
  "endedAt": 1,
  "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "targetVariationId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "metrics": [
    {
      "metricKey": "metricKey",
      "definition": "",
      "autoRollback": true,
      "analysisUnit": "analysisUnit",
      "metricVersionId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
    },
    {
      "metricKey": "metricKey",
      "definition": "",
      "autoRollback": true,
      "analysisUnit": "analysisUnit",
      "metricVersionId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
    }
  ],
  "randomizationUnit": "randomizationUnit",
  "currentPhaseIndex": 0,
  "flagKey": "flagKey",
  "phases": [
    {
      "metricStatuses": {
        "key": "ok"
      },
      "statusReason": null,
      "endedAt": 3,
      "phaseIndex": 0,
      "description": "description",
      "currentStepIndex": 0,
      "startedAt": 9,
      "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "ruleId": "ruleId",
      "steps": [
        {
          "allocation": 14658,
          "stepIndex": 0,
          "endedAt": 2,
          "startedAt": 5,
          "durationMillis": 1
        },
        {
          "allocation": 14658,
          "stepIndex": 0,
          "endedAt": 2,
          "startedAt": 5,
          "durationMillis": 1
        }
      ],
      "status": null
    },
    {
      "metricStatuses": {
        "key": "ok"
      },
      "statusReason": null,
      "endedAt": 3,
      "phaseIndex": 0,
      "description": "description",
      "currentStepIndex": 0,
      "startedAt": 9,
      "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "ruleId": "ruleId",
      "steps": [
        {
          "allocation": 14658,
          "stepIndex": 0,
          "endedAt": 2,
          "startedAt": 5,
          "durationMillis": 1
        },
        {
          "allocation": 14658,
          "stepIndex": 0,
          "endedAt": 2,
          "startedAt": 5,
          "durationMillis": 1
        }
      ],
      "status": null
    }
  ],
  "status": "pending"
}

{
  "code": "code",
  "message": "message"
}

{
  "code": "code",
  "message": "message"
}

{
  "code": "code",
  "message": "message"
}

{
  "code": "code",
  "message": "message"
}

{
  "code": "code",
  "message": "message"
}

{
  "code": "code",
  "message": "message"
}

Authorizations

Authorization

string

header

required

Headers

LD-API-Version

enum<string>

required

Version of the endpoint.

Available options:

beta

Path Parameters

projectKey

string

required

flagKey

string

required

environmentKey

string

required

releaseId

string<uuid>

required

Query Parameters

expand

enum<string>[]

Optional fields to expand.

Available options:

metrics

Response

Environment release.

A flag release in one environment, made up of one or more ordered phases. The top-level status is derived from the phases: it reflects the active phase, reports waiting between successfully completed phases, and reports the terminal outcome of the release.

string<uuid>

required

status

enum<string>

required

High-level status of an environment release or release phase.

pending: The release or phase has not started.
in_progress: The release or phase is progressing without requiring action.
waiting: The release is partially rolled out, but is paused and waiting for action from the user.
completed: The release or phase reached the target variation.
reverted: The release or phase returned to the original variation.

Available options:

pending,

in_progress,

waiting,

completed,

reverted

projectKey

string

required

environmentKey

string

required

flagKey

string

required

originalVariationId

string<uuid>

required

ID of the variation the release started from.

originalVariationValue

any

required

The value of the variation. This may be a string, boolean, number, JSON object, or array.

targetVariationId

string<uuid>

required

ID of the variation being released.

targetVariationValue

any

required

The value of the variation. This may be a string, boolean, number, JSON object, or array.

randomizationUnit

string

required

Key of the context kind the release randomizes on.

cleanupBehavior

enum<string>

required

What happens to the release rules when the final phase completes, either on its own or because a stop rolls it forward while it's running:

remove_rules_and_update_default_rule: The release rules are removed and the default rule serves the target variation.
leave_rules_in_place: The release rules stay and serve the target variation.

In every other case, including a revert, it has no effect: release rules left on the flag keep serving the variation the release ended on, ahead of rules added later without beforeRuleId.

Available options:

remove_rules_and_update_default_rule,

leave_rules_in_place

kind

enum<string>

required

Whether the release uses metric monitoring.

Available options:

progressive,

guarded

metrics

object[]

required

Show child attributes

phases

object[]

required

Minimum array length: 1

Show child attributes

currentPhaseIndex

integer | null

required

Zero-based index of the active phase. Null before the first phase, between phases, and after the release reaches a terminal status.

Required range: x >= 0

advancementMode

enum<string>

required

Whether a multi-phase release advances to the next phase automatically once the current phase's steps complete, or waits for an explicit advance. Has no effect on a single-phase release.

Available options:

manual,

automatic

createdAt

integer<int64>

required

Creation time in Unix milliseconds.

statusReason

enum<string>

Additional detail for a waiting, completed, or reverted status. The field may be absent for a waiting status when there is no specific reason. waiting_phase_ended appears only on the release, never on a phase. It means a phase of a multi-phase release with advancementMode manual ended and the release must be advanced to the next phase. reverted_discarded means the phase ended without a regression or a member rolling it back. A running phase is discarded when the flag changes underneath it, for example when the flag is turned off, archived, or deleted. A pending phase is discarded when the release ends before it starts, either because an earlier phase reverted or because the release was stopped with a resolution that removes pending phases. A release reports reverted_discarded only when the last phase that started was discarded.

Available options:

waiting_regression_detected,

waiting_phase_ended,

completed_automatic,

completed_manual,

reverted_regression_detected,

reverted_manual,

reverted_discarded,

reverted_insufficient_data

startedAt

integer<int64>

read-only

Start of the first phase in Unix milliseconds. Absent until a phase has started.

endedAt

integer<int64>

read-only

End of the last started phase in Unix milliseconds. Present only after the release reaches a terminal status of completed or reverted.

_links

object

Show child attributes