Environments

Environments allow you to maintain separate rollout rules in different contexts, from local development to QA, staging, and production. With the LaunchDarkly Environments API, you can programmatically create, delete, and update environments. To learn more, read Environments.

Create environment

Approval settings

The approvalSettings key is only returned when the Flag Approvals feature is enabled.

You cannot update approval settings when creating new environments. Update approval settings with the PATCH Environment API.

Create a new environment in a specified project with a given name, key, swatch color, and default TTL.

SecurityApiKey

Request

path Parameters

projectKey

required

string <string>

The project key

Request Body schema: application/json

name required	string A human-friendly name for the new environment.
key required	string A project-unique key for the new environment.
color required	string A color to indicate this environment in the UI.
defaultTtl	integer The default time (in minutes) that the PHP SDK can cache feature flag rules locally.
secureMode	boolean Ensures that a user of the client-side SDK cannot impersonate another user.
defaultTrackEvents	boolean Enables tracking detailed information for new flags by default.
confirmChanges	boolean Requires confirmation for all flag and segment changes via the UI in this environment.
requireComments	boolean Requires comments for all flag and segment changes via the UI in this environment.
tags	Array of strings Tags to apply to the new environment.
	object (SourceEnv)

Responses

201

Successful environment response

400

Invalid request

401

Invalid access token

403

Forbidden

404

Invalid resource identifier

409

Status conflict

429

Rate limited

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

Request samples

Payload
curl
Node.js
Python

application/json

{"color": "DADBEE",
"key": "my-environment",
"name": "My Environment"
}

Response samples

application/json

{"_links": {"self": {"href": "/api/v2/projects/my-project/environments/my-environment",
"type": "application/json"
}
},
"_id": "57be1db38b75bf0772d11384",
"key": "my-environment",
"name": "My Environment",
"apiKey": "XYZ",
"mobileKey": "XYZ",
"color": "F5A623",
"defaultTtl": 5,
"secureMode": true,
"defaultTrackEvents": false,
"requireComments": true,
"confirmChanges": true,
"tags": ["ops"
],
"approvalSettings": {"required": true,
"bypassApprovalsForPendingChanges": false,
"minNumApprovals": 1,
"canReviewOwnRequest": false,
"canApplyDeclinedChanges": true,
"serviceKind": "launchdarkly",
"serviceConfig": { },
"requiredApprovalTags": ["require-approval"
]
}
}

Get environment

Approval settings

The approvalSettings key is only returned when the Flag Approvals feature is enabled.

Get an environment given a project and key.

SecurityApiKey

Request

path Parameters

projectKey required	string <string> The project key
environmentKey required	string <string> The environment key

Responses

200

Environment response JSON

401

Invalid access token

403

Forbidden

404

Invalid resource identifier

429

Rate limited

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

Request samples

curl
Node.js
Python

curl -i -X GET \
  'https://app.launchdarkly.com/api/v2/projects/{projectKey}/environments/{environmentKey}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

{"_links": {"self": {"href": "/api/v2/projects/my-project/environments/my-environment",
"type": "application/json"
}
},
"_id": "57be1db38b75bf0772d11384",
"key": "my-environment",
"name": "My Environment",
"apiKey": "XYZ",
"mobileKey": "XYZ",
"color": "F5A623",
"defaultTtl": 5,
"secureMode": true,
"defaultTrackEvents": false,
"requireComments": true,
"confirmChanges": true,
"tags": ["ops"
],
"approvalSettings": {"required": true,
"bypassApprovalsForPendingChanges": false,
"minNumApprovals": 1,
"canReviewOwnRequest": false,
"canApplyDeclinedChanges": true,
"serviceKind": "launchdarkly",
"serviceConfig": { },
"requiredApprovalTags": ["require-approval"
]
}
}

Update environment

Update an environment. Requires a JSON Patch representation of the desired changes to the environment.

To update fields in the environment object that are arrays, set the path to the name of the field and then append /<array index>. Using /0 appends to the beginning of the array.

Approval settings

This request only returns the approvalSettings key if the Flag Approvals feature is enabled.

Only the canReviewOwnRequest, canApplyDeclinedChanges, minNumApprovals, required and requiredApprovalTagsfields are editable.

If you try to patch the environment by setting both required and requiredApprovalTags, the request fails and an error appears. You can specify either required approvals for all flags in an environment or those with specific tags, but not both.

SecurityApiKey

Request

path Parameters

projectKey required	string <string> The project key
environmentKey required	string <string> The environment key

Request Body schema: application/json

Array

op required	string The type of operation to perform
path required	string A JSON Pointer string specifying the part of the document to operate on
value required	any A JSON value used in "add", "replace", and "test" operations

Responses

200

Environment response JSON

400

Invalid request

401

Invalid access token

404

Invalid resource identifier

409

Status conflict

429

Rate limited

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

Request samples

Payload
curl
Node.js
Python

application/json

[{"op": "replace",
"path": "/requireComments",
"value": true
}
]

Response samples

application/json

{"_links": {"self": {"href": "/api/v2/projects/my-project/environments/my-environment",
"type": "application/json"
}
},
"_id": "57be1db38b75bf0772d11384",
"key": "my-environment",
"name": "My Environment",
"apiKey": "XYZ",
"mobileKey": "XYZ",
"color": "F5A623",
"defaultTtl": 5,
"secureMode": true,
"defaultTrackEvents": false,
"requireComments": true,
"confirmChanges": true,
"tags": ["ops"
],
"approvalSettings": {"required": true,
"bypassApprovalsForPendingChanges": false,
"minNumApprovals": 1,
"canReviewOwnRequest": false,
"canApplyDeclinedChanges": true,
"serviceKind": "launchdarkly",
"serviceConfig": { },
"requiredApprovalTags": ["require-approval"
]
}
}

Delete environment

Delete a environment by key.

SecurityApiKey

Request

path Parameters

projectKey required	string <string> The project key
environmentKey required	string <string> The environment key

Responses

204

Action succeeded

401

Invalid access token

403

Forbidden

404

Invalid resource identifier

429

Rate limited

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

Request samples

curl
Node.js
Python

curl -i -X DELETE \
  'https://app.launchdarkly.com/api/v2/projects/{projectKey}/environments/{environmentKey}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

{"code": "unauthorized",
"message": "invalid key"
}

Reset environment SDK key

Reset an environment's SDK key with an optional expiry time for the old key.

SecurityApiKey

Request

path Parameters

projectKey required	string <string> The project key
environmentKey required	string <string> The environment key

query Parameters

expiry

integer <int64>

The time at which you want the old SDK key to expire, in UNIX milliseconds. By default, the key expires immediately.

Responses

200

Successful environment response

400

Invalid request

401

Invalid access token

403

Forbidden

404

Invalid resource identifier

429

Rate limited

post/api/v2/projects/{projectKey}/environments/{environmentKey}/apiKey

Request samples

curl
Node.js
Python

curl -i -X POST \
  'https://app.launchdarkly.com/api/v2/projects/{projectKey}/environments/{environmentKey}/apiKey' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

{"_links": {"self": {"href": "/api/v2/projects/my-project/environments/my-environment",
"type": "application/json"
}
},
"_id": "57be1db38b75bf0772d11384",
"key": "my-environment",
"name": "My Environment",
"apiKey": "XYZ",
"mobileKey": "XYZ",
"color": "F5A623",
"defaultTtl": 5,
"secureMode": true,
"defaultTrackEvents": false,
"requireComments": true,
"confirmChanges": true,
"tags": ["ops"
],
"approvalSettings": {"required": true,
"bypassApprovalsForPendingChanges": false,
"minNumApprovals": 1,
"canReviewOwnRequest": false,
"canApplyDeclinedChanges": true,
"serviceKind": "launchdarkly",
"serviceConfig": { },
"requiredApprovalTags": ["require-approval"
]
}
}

Reset environment mobile SDK key

Reset an environment's mobile key. The optional expiry for the old key is deprecated for this endpoint, so the old key will always expire immediately.

SecurityApiKey

Request

path Parameters

projectKey required	string <string> The project key
environmentKey required	string <string> The environment key

Responses

200

Successful environment response

400

Invalid request

401

Invalid access token

403

Forbidden

404

Invalid resource identifier

429

Rate limited

post/api/v2/projects/{projectKey}/environments/{environmentKey}/mobileKey

Request samples

curl
Node.js
Python

curl -i -X POST \
  'https://app.launchdarkly.com/api/v2/projects/{projectKey}/environments/{environmentKey}/mobileKey' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

{"_links": {"self": {"href": "/api/v2/projects/my-project/environments/my-environment",
"type": "application/json"
}
},
"_id": "57be1db38b75bf0772d11384",
"key": "my-environment",
"name": "My Environment",
"apiKey": "XYZ",
"mobileKey": "XYZ",
"color": "F5A623",
"defaultTtl": 5,
"secureMode": true,
"defaultTrackEvents": false,
"requireComments": true,
"confirmChanges": true,
"tags": ["ops"
],
"approvalSettings": {"required": true,
"bypassApprovalsForPendingChanges": false,
"minNumApprovals": 1,
"canReviewOwnRequest": false,
"canApplyDeclinedChanges": true,
"serviceKind": "launchdarkly",
"serviceConfig": { },
"requiredApprovalTags": ["require-approval"
]
}
}

➔ Next to Experiments (beta)