Get environment

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

Approval settings

The approvalSettings and resourceApprovalSettings keys are only returned when the approvals feature is enabled.

Get an environment given a project and key.

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

Get environment

cURL

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

200

{
  "_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": {}
}

Authorizations

Authorization · string · header · required

Path Parameters

projectKey · string<string> · required

The project key

environmentKey · string<string> · required

The environment key

Response

200

application/json

Environment response

_links · object · required

The location and content type of related resources

Show child attributes

Example:

{
  "self": {
    "href": "/api/v2/projects/my-project/environments/my-environment",
    "type": "application/json"
  }
}

_id · string · required

The ID for the environment. Use this as the client-side ID for authorization in some client-side SDKs, and to associate LaunchDarkly environments with CDN integrations in edge SDKs.

Example:

"57be1db38b75bf0772d11384"

key · string · required

A project-unique key for the new environment

Example:

"environment-key-123abc"

name · string · required

A human-friendly name for the new environment

Example:

"My Environment"

apiKey · string · required

The SDK key for the environment. Use this for authorization in server-side SDKs.

Example:

"sdk-xxx"

mobileKey · string · required

The mobile key for the environment. Use this for authorization in mobile SDKs.

Example:

"mob-xxx"

color · string · required

The color used to indicate this environment in the UI

Example:

"F5A623"

defaultTtl · integer · required

The default time (in minutes) that the PHP SDK can cache feature flag rules locally

Example:

5

secureMode · boolean · required

Ensures that one end user of the client-side SDK cannot inspect the variations for another end user

Example:

true

defaultTrackEvents · boolean · required

Enables tracking detailed information for new flags by default

Example:

false

requireComments · boolean · required

Whether members who modify flags and segments through the LaunchDarkly user interface are required to add a comment

Example:

true

confirmChanges · boolean · required

Whether members who modify flags and segments through the LaunchDarkly user interface are required to confirm those changes

Example:

true

tags · string[] · required

A list of tags for this environment

Example:

["ops"]

critical · boolean · required

Whether the environment is critical

Example:

true

_access · object

Show child attributes

approvalSettings · object

Details about the approval settings for flags in this environment

Show child attributes

resourceApprovalSettings · object

Details about the approval settings for other resources in this environment, organized by resource kind (for example, "aiconfig" and "segment")

Show child attributes