LaunchDarklyApi.EnvironmentsApi

All URIs are relative to https://app.launchdarkly.com

Method	HTTP request	Description
deleteEnvironment	DELETE /api/v2/projects/{projectKey}/environments/{environmentKey}	Delete environment
getEnvironment	GET /api/v2/projects/{projectKey}/environments/{environmentKey}	Get environment
getEnvironmentsByProject	GET /api/v2/projects/{projectKey}/environments	List environments
patchEnvironment	PATCH /api/v2/projects/{projectKey}/environments/{environmentKey}	Update environment
postEnvironment	POST /api/v2/projects/{projectKey}/environments	Create environment
resetEnvironmentMobileKey	POST /api/v2/projects/{projectKey}/environments/{environmentKey}/mobileKey	Reset environment mobile SDK key
resetEnvironmentSDKKey	POST /api/v2/projects/{projectKey}/environments/{environmentKey}/apiKey	Reset environment SDK key

deleteEnvironment

deleteEnvironment(projectKey, environmentKey)

Delete environment

Delete a environment by key.

Example

import LaunchDarklyApi from 'launchdarkly-api';
let defaultClient = LaunchDarklyApi.ApiClient.instance;
// Configure API key authorization: ApiKey
let ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix = 'Token';

let apiInstance = new LaunchDarklyApi.EnvironmentsApi();
let projectKey = "projectKey_example"; // String | The project key
let environmentKey = "environmentKey_example"; // String | The environment key
apiInstance.deleteEnvironment(projectKey, environmentKey, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});

Parameters

Name	Type	Description	Notes
projectKey	String	The project key
environmentKey	String	The environment key

Return type

null (empty response body)

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

getEnvironment

Environment getEnvironment(projectKey, environmentKey)

Get environment

> ### Approval settings > > The `approvalSettings` key is only returned when approvals for flags or segments are enabled. Get an environment given a project and key.

Example

import LaunchDarklyApi from 'launchdarkly-api';
let defaultClient = LaunchDarklyApi.ApiClient.instance;
// Configure API key authorization: ApiKey
let ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix = 'Token';

let apiInstance = new LaunchDarklyApi.EnvironmentsApi();
let projectKey = "projectKey_example"; // String | The project key
let environmentKey = "environmentKey_example"; // String | The environment key
apiInstance.getEnvironment(projectKey, environmentKey, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name	Type	Description	Notes
projectKey	String	The project key
environmentKey	String	The environment key

Return type

Environment

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

getEnvironmentsByProject

Environments getEnvironmentsByProject(projectKey, opts)

List environments

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.

Example

import LaunchDarklyApi from 'launchdarkly-api';
let defaultClient = LaunchDarklyApi.ApiClient.instance;
// Configure API key authorization: ApiKey
let ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix = 'Token';

let apiInstance = new LaunchDarklyApi.EnvironmentsApi();
let projectKey = "projectKey_example"; // String | The project key
let opts = {
  'limit': 789, // Number | The number of environments to return in the response. Defaults to 20.
  'offset': 789, // Number | 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': "filter_example", // String | A comma-separated list of filters. Each filter is of the form `field:value`.
  'sort': "sort_example" // String | A comma-separated list of fields to sort by. Fields prefixed by a dash ( - ) sort in descending order.
};
apiInstance.getEnvironmentsByProject(projectKey, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name	Type	Description	Notes
projectKey	String	The project key
limit	Number	The number of environments to return in the response. Defaults to 20.	[optional]
offset	Number	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`.	[optional]
filter	String	A comma-separated list of filters. Each filter is of the form `field:value`.	[optional]
sort	String	A comma-separated list of fields to sort by. Fields prefixed by a dash ( - ) sort in descending order.	[optional]

Return type

Environments

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

patchEnvironment

Environment patchEnvironment(projectKey, environmentKey, patchOperation)

Update environment

Update an environment. Updating an environment uses a JSON patch representation of the desired changes. To learn more, read Updates. 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 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.

Example

import LaunchDarklyApi from 'launchdarkly-api';
let defaultClient = LaunchDarklyApi.ApiClient.instance;
// Configure API key authorization: ApiKey
let ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix = 'Token';

let apiInstance = new LaunchDarklyApi.EnvironmentsApi();
let projectKey = "projectKey_example"; // String | The project key
let environmentKey = "environmentKey_example"; // String | The environment key
let patchOperation = [{"op":"replace","path":"/requireComments","value":true}]; // [PatchOperation] | 
apiInstance.patchEnvironment(projectKey, environmentKey, patchOperation, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name	Type	Description
projectKey	String	The project key
environmentKey	String	The environment key
patchOperation	[PatchOperation]

Return type

Environment

Authorization

ApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

postEnvironment

Environment postEnvironment(projectKey, environmentPost)

Create environment

> ### Approval settings > > The `approvalSettings` key is only returned when the approvals feature is enabled. > > You cannot update approval settings when creating new environments. Update approval settings with the [https://launchdarkly.com/docs/api/environments/patch-environment). Create a new environment in a specified project with a given name, key, swatch color, and default TTL.

Example

import LaunchDarklyApi from 'launchdarkly-api';
let defaultClient = LaunchDarklyApi.ApiClient.instance;
// Configure API key authorization: ApiKey
let ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix = 'Token';

let apiInstance = new LaunchDarklyApi.EnvironmentsApi();
let projectKey = "projectKey_example"; // String | The project key
let environmentPost = {"color":"DADBEE","key":"environment-key-123abc","name":"My Environment"}; // EnvironmentPost | 
apiInstance.postEnvironment(projectKey, environmentPost, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name	Type	Description	Notes
projectKey	String	The project key
environmentPost	EnvironmentPost

Return type

Environment

Authorization

ApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

resetEnvironmentMobileKey

Environment resetEnvironmentMobileKey(projectKey, environmentKey)

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.

Example

import LaunchDarklyApi from 'launchdarkly-api';
let defaultClient = LaunchDarklyApi.ApiClient.instance;
// Configure API key authorization: ApiKey
let ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix = 'Token';

let apiInstance = new LaunchDarklyApi.EnvironmentsApi();
let projectKey = "projectKey_example"; // String | The project key
let environmentKey = "environmentKey_example"; // String | The environment key
apiInstance.resetEnvironmentMobileKey(projectKey, environmentKey, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name	Type	Description	Notes
projectKey	String	The project key
environmentKey	String	The environment key

Return type

Environment

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

resetEnvironmentSDKKey

Environment resetEnvironmentSDKKey(projectKey, environmentKey, opts)

Reset environment SDK key

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

Example

import LaunchDarklyApi from 'launchdarkly-api';
let defaultClient = LaunchDarklyApi.ApiClient.instance;
// Configure API key authorization: ApiKey
let ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix = 'Token';

let apiInstance = new LaunchDarklyApi.EnvironmentsApi();
let projectKey = "projectKey_example"; // String | The project key
let environmentKey = "environmentKey_example"; // String | The environment key
let opts = {
  'expiry': 789 // Number | The time at which you want the old SDK key to expire, in UNIX milliseconds. By default, the key expires immediately. During the period between this call and the time when the old SDK key expires, both the old SDK key and the new SDK key will work.
};
apiInstance.resetEnvironmentSDKKey(projectKey, environmentKey, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name	Type	Description	Notes
projectKey	String	The project key
environmentKey	String	The environment key
expiry	Number	The time at which you want the old SDK key to expire, in UNIX milliseconds. By default, the key expires immediately. During the period between this call and the time when the old SDK key expires, both the old SDK key and the new SDK key will work.	[optional]

Return type

Environment

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

FilesExpand file tree

EnvironmentsApi.md

Latest commit

History

EnvironmentsApi.md

File metadata and controls

LaunchDarklyApi.EnvironmentsApi

deleteEnvironment

Example

Parameters

Return type

Authorization

HTTP request headers

getEnvironment

Example

Parameters

Return type

Authorization

HTTP request headers

getEnvironmentsByProject

Example

Parameters

Return type

Authorization

HTTP request headers

patchEnvironment

Example

Parameters

Return type

Authorization

HTTP request headers

postEnvironment

Example

Parameters

Return type

Authorization

HTTP request headers

resetEnvironmentMobileKey

Example

Parameters

Return type

Authorization

HTTP request headers

resetEnvironmentSDKKey

Example

Parameters

Return type

Authorization

HTTP request headers