List environments

For the complete documentation index, see llms.txt. For the full documentation snapshot, see llms-full.txt.

Return a list of environments for the specified project.

By default, this returns the first 20 environments. Page through this list with the limit parameter and by following the first, prev, next, and last links in the _links field that returns. If those links do not appear, the pages they refer to don’t exist. For example, the first and prev links will be missing from the response on the first page, because there is no previous page and you cannot return to the first page when you are already on the first page.

Filtering environments

LaunchDarkly supports two fields for filters:

• query is a string that matches against the environments’ names and keys. It is not case sensitive.
• tags is a +-separated list of environment tags. It filters the list of environments that have all of the tags in the list.

For example, the filter filter=query:abc,tags:tag-1+tag-2 matches environments with the string abc in their name or key and also are tagged with tag-1 and tag-2. The filter is not case-sensitive.

The documented values for filter query parameters are prior to URL encoding. For example, the + in filter=tags:tag-1+tag-2 must be encoded to %2B.

Sorting environments

LaunchDarkly supports the following fields for sorting:

• createdOn sorts by the creation date of the environment.
• critical sorts by whether the environments are marked as critical.
• name sorts by environment name.

For example, sort=name sorts the response by environment name in ascending order.

GET /api/v2/projects/{projectKey}/environments

List environments

cURL

curl --request GET \
  --url https://app.launchdarkly.com/api/v2/projects/{projectKey}/environments \
  --header 'Authorization: <api-key>'

200

{
  "items": [
    {
      "_links": {
        "self": {
          "href": "/api/v2/projects/my-project/environments/my-environment",
          "type": "application/json"
        }
      },
      "_id": "57be1db38b75bf0772d11384",
      "key": "environment-key-123abc",
      "name": "My Environment",
      "apiKey": "sdk-xxx",
      "mobileKey": "mob-xxx",
      "color": "F5A623",
      "defaultTtl": 5,
      "secureMode": true,
      "defaultTrackEvents": false,
      "requireComments": true,
      "confirmChanges": true,
      "tags": [
        "ops"
      ],
      "critical": true,
      "_access": {
        "denied": [
          {
            "action": "<string>",
            "reason": {
              "effect": "allow",
              "resources": [
                "proj/*:env/*;qa_*:/flag/*"
              ],
              "notResources": [
                "<string>"
              ],
              "actions": [
                "*"
              ],
              "notActions": [
                "<string>"
              ],
              "role_name": "<string>"
            }
          }
        ],
        "allowed": [
          {
            "action": "<string>",
            "reason": {
              "effect": "allow",
              "resources": [
                "proj/*:env/*;qa_*:/flag/*"
              ],
              "notResources": [
                "<string>"
              ],
              "actions": [
                "*"
              ],
              "notActions": [
                "<string>"
              ],
              "role_name": "<string>"
            }
          }
        ]
      },
      "approvalSettings": {
        "required": true,
        "bypassApprovalsForPendingChanges": false,
        "minNumApprovals": 1,
        "canReviewOwnRequest": false,
        "canApplyDeclinedChanges": true,
        "serviceKind": "launchdarkly",
        "serviceConfig": {},
        "requiredApprovalTags": [
          "require-approval"
        ],
        "autoApplyApprovedChanges": true,
        "serviceKindConfigurationId": "1ef45a85-218f-4428-a8b2-a97e5f56c258"
      },
      "resourceApprovalSettings": {}
    }
  ],
  "_links": {},
  "totalCount": 2
}

Authorizations

Authorization · string · header · required

Path Parameters

projectKey · string<string> · required

The project key

Query Parameters

limit · integer<int64>

The number of environments to return in the response. Defaults to 20.

offset · integer<int64>

Where to start in the list. This is for use 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.

filter · string<string>

A comma-separated list of filters. Each filter is of the form field:value.

sort · string<string>

A comma-separated list of fields to sort by. Fields prefixed by a dash ( - ) sort in descending order.

Response

200

application/json

Environments collection response

items · object[] · required

An array of environments

Show child attributes

_links · object

The location and content type of related resources

Show child attributes

totalCount · integer

The number of environments returned

Example:

2