List environment releases

curl --request GET \
  --url https://app.launchdarkly.com/api/v2/projects/{projectKey}/flags/{flagKey}/environments/{environmentKey}/releases \
  --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"

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', 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",
  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"

	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")
  .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")

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

{
  "_links": {
    "key": {
      "href": "href",
      "type": "type"
    }
  },
  "totalCount": 1,
  "items": [
    {
      "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"
    },
    {
      "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"
}

List environment releases

Returns the environment releases for the flag in the environment, newest first. Each release includes its phases in phase-index order. Metric definitions are not included. To get them, call getEnvironmentRelease with expand=metrics. Returns an empty items array when the flag has no releases in the environment, or when no release matches the filter. Releases that ended more than 90 days ago are not returned.

Results are paginated. By default, the first 25 releases are returned. Use limit and offset to page through the rest, and totalCount to learn how many releases match in total. The _links object includes first, prev, next, and last links where they apply.

GET

api

projects

{projectKey}

flags

{flagKey}

environments

{environmentKey}

releases

List environment releases

curl --request GET \
  --url https://app.launchdarkly.com/api/v2/projects/{projectKey}/flags/{flagKey}/environments/{environmentKey}/releases \
  --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"

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', 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",
  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"

	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")
  .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")

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

{
  "_links": {
    "key": {
      "href": "href",
      "type": "type"
    }
  },
  "totalCount": 1,
  "items": [
    {
      "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"
    },
    {
      "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

Query Parameters

filter

string

A queryfilter expression that narrows the list. Supported fields and operators: kind (equals) with values progressive or guarded.

limit

integer

default:25

The number of releases to return. Defaults to 25. Maximum is 100.

Required range: 1 <= x <= 100

offset

integer

default:0

Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten releases and then returns the next releases in the list, up to the query limit.

Required range: x >= 0

_snapshot

string

Pins the read to a moment in time (nanoseconds since the Unix epoch) so pages walked in sequence reflect one consistent snapshot. Follow the pagination links rather than constructing this value. Out-of-range values are ignored.

Response

Environment releases.

One page of environment releases for one flag in one environment, newest first.

items

object[]

required

The releases on this page.

Show child attributes

totalCount

integer

required

The total number of releases that match the request, before limit and offset are applied.

_links

object

Links to this page (self), the flag (parent), and, where they apply, the first, prev, next, and last pages.

Show child attributes