Skip to content

launchdarkly/api-client-javascript

BranchesTags

Repository files navigation

This repository contains a client library for LaunchDarkly's REST API. This client was automatically generated from our OpenAPI specification using a code generation library. View our sample code for example usage.

This REST API is for custom integrations, data export, or automating your feature flag workflows. DO NOT use this client library to include feature flags in your web or mobile application. To integrate feature flags with your application, read the SDK documentation.

launchdarkly-api

LaunchDarklyApi - JavaScript client for launchdarkly-api

Authentication

All REST API resources are authenticated with either personal or service access tokens, or session cookies. Other authentication mechanisms are not supported. You can manage personal access tokens on your Account settings page.

LaunchDarkly also has SDK keys, mobile keys, and client-side IDs that are used by our server-side SDKs, mobile SDKs, and client-side SDKs, respectively. These keys cannot be used to access our REST API. These keys are environment-specific, and can only perform read-only operations (fetching feature flag settings).

Auth mechanism Allowed resources Use cases
Personal access tokens Can be customized on a per-token basis Building scripts, custom integrations, data export
SDK keys Can only access read-only SDK-specific resources and the firehose, restricted to a single environment Server-side SDKs, Firehose API
Mobile keys Can only access read-only mobile SDK-specific resources, restricted to a single environment Mobile SDKs
Client-side ID Single environment, only flags marked available to client-side Client-side JavaScript

Keep your access tokens and SDK keys private

Access tokens should never be exposed in untrusted contexts. Never put an access token in client-side JavaScript, or embed it in a mobile application. LaunchDarkly has special mobile keys that you can embed in mobile apps. If you accidentally expose an access token or SDK key, you can reset it from your Account Settings page.

The client-side ID is safe to embed in untrusted contexts. It's designed for use in client-side JavaScript.

Via request header

The preferred way to authenticate with the API is by adding an Authorization header containing your access token to your requests. The value of the Authorization header must be your access token.

Manage personal access tokens from the Account Settings page.

Via session cookie

For testing purposes, you can make API calls directly from your web browser. If you're logged in to the application, the API will use your existing session to authenticate calls.

If you have a role other than Admin, or have a custom role defined, you may not have permission to perform some API calls. You will receive a 401 response code in that case.

Modifying the Origin header causes an error

LaunchDarkly validates that the Origin header for any API request authenticated by a session cookie matches the expected Origin header. The expected Origin header is https://app.launchdarkly.com.

If the Origin header does not match what's expected, LaunchDarkly returns an error. This error can prevent the LaunchDarkly app from working correctly.

Any browser extension that intentionally changes the Origin header can cause this problem. For example, the Allow-Control-Allow-Origin: * Chrome extension changes the Origin header to http://evil.com and causes the app to fail.

To prevent this error, do not modify your Origin header.

LaunchDarkly does not require origin matching when authenticating with an access token, so this issue does not affect normal API usage.

Representations

All resources expect and return JSON response bodies. Error responses will also send a JSON body. Read Errors for a more detailed description of the error format used by the API.

In practice this means that you always get a response with a Content-Type header set to application/json.

In addition, request bodies for PUT, POST, REPORT and PATCH requests must be encoded as JSON with a Content-Type header set to application/json.

Summary and detailed representations

When you fetch a list of resources, the response includes only the most important attributes of each resource. This is a summary representation of the resource. When you fetch an individual resource (for example, a single feature flag), you receive a detailed representation containing all of the attributes of the resource.

The best way to find a detailed representation is to follow links. Every summary representation includes a link to its detailed representation.

Links and addressability

The best way to navigate the API is by following links. These are attributes in representations that link to other resources. The API always uses the same format for links:

  • Links to other resources within the API are encapsulated in a _links object.
  • If the resource has a corresponding link to HTML content on the site, it is stored in a special _site link.

Each link has two attributes: an href (the URL) and a type (the content type). For example, a feature resource might return the following:

{
  \"_links\": {
    \"parent\": {
      \"href\": \"/api/features\",
      \"type\": \"application/json\"
    },
    \"self\": {
      \"href\": \"/api/features/sort.order\",
      \"type\": \"application/json\"
    }
  },
  \"_site\": {
    \"href\": \"/features/sort.order\",
    \"type\": \"text/html\"
  }
}

From this, you can navigate to the parent collection of features by following the parent link, or navigate to the site page for the feature by following the _site link.

Collections are always represented as a JSON object with an items attribute containing an array of representations. Like all other representations, collections have _links defined at the top level.

Paginated collections include first, last, next, and prev links containing a URL with the respective set of elements in the collection.

Updates

Resources that accept partial updates use the PATCH verb, and support the JSON Patch format. Some resources also support the JSON Merge Patch format. In addition, some resources support optional comments that can be submitted with updates. Comments appear in outgoing webhooks, the audit log, and other integrations.

Updates via JSON Patch

JSON Patch is a way to specify the modifications to perform on a resource. For example, in this feature flag representation:

{
    \"name\": \"New recommendations engine\",
    \"key\": \"engine.enable\",
    \"description\": \"This is the description\",
    ...
}

You can change the feature flag's description with the following patch document:

[{ \"op\": \"replace\", \"path\": \"/description\", \"value\": \"This is the new description\" }]

JSON Patch documents are always arrays. You can specify multiple modifications to perform in a single request. You can also test that certain preconditions are met before applying the patch:

[
  { \"op\": \"test\", \"path\": \"/version\", \"value\": 10 },
  { \"op\": \"replace\", \"path\": \"/description\", \"value\": \"The new description\" }
]

The above patch request tests whether the feature flag's version is 10, and if so, changes the feature flag's description.

Attributes that aren't editable, like a resource's _links, have names that start with an underscore.

Updates via JSON Merge Patch

The API also supports the JSON Merge Patch format, as well as the Update feature flag resource.

JSON Merge Patch is less expressive than JSON Patch but in many cases, it is simpler to construct a merge patch document. For example, you can change a feature flag's description with the following merge patch document:

{
  \"description\": \"New flag description\"
}

Updates with comments

You can submit optional comments with PATCH changes. The Update feature flag resource supports comments.

To submit a comment along with a JSON Patch document, use the following format:

{
  \"comment\": \"This is a comment string\",
  \"patch\": [{ \"op\": \"replace\", \"path\": \"/description\", \"value\": \"The new description\" }]
}

To submit a comment along with a JSON Merge Patch document, use the following format:

{
  \"comment\": \"This is a comment string\",
  \"merge\": { \"description\": \"New flag description\" }
}

Updates via semantic patches

The API also supports the Semantic patch format. A semantic PATCH is a way to specify the modifications to perform on a resource as a set of executable instructions.

JSON Patch uses paths and a limited set of operations to describe how to transform the current state of the resource into a new state. Semantic patch allows you to be explicit about intent using precise, custom instructions. In many cases, semantic patch instructions can also be defined independently of the current state of the resource. This can be useful when defining a change that may be applied at a future date.

For example, in this feature flag configuration in environment Production:

{
    \"name\": \"Alternate sort order\",
    \"kind\": \"boolean\",
    \"key\": \"sort.order\",
   ...
    \"environments\": {
        \"production\": {
            \"on\": true,
            \"archived\": false,
            \"salt\": \"c29ydC5vcmRlcg==\",
            \"sel\": \"8de1085cb7354b0ab41c0e778376dfd3\",
            \"lastModified\": 1469131558260,
            \"version\": 81,
            \"targets\": [
                {
                    \"values\": [
                        \"Gerhard.Little@yahoo.com\"
                    ],
                    \"variation\": 0
                },
                {
                    \"values\": [
                        \"1461797806429-33-861961230\",
                        \"438580d8-02ee-418d-9eec-0085cab2bdf0\"
                    ],
                    \"variation\": 1
                }
            ],
            \"rules\": [],
            \"fallthrough\": {
                \"variation\": 0
            },
            \"offVariation\": 1,
            \"prerequisites\": [],
            \"_site\": {
                \"href\": \"/default/production/features/sort.order\",
                \"type\": \"text/html\"
            }
       }
    }
}

You can add a date you want a user to be removed from the feature flag's user targets. For example, “remove user 1461797806429-33-861961230 from the user target for variation 0 on the Alternate sort order flag in the production environment on Wed Jul 08 2020 at 15:27:41 pm”. This is done using the following:

{
  \"comment\": \"update expiring user targets\",
  \"instructions\": [
    {
      \"kind\": \"removeExpireUserTargetDate\",
      \"userKey\": \"userKey\",
      \"variationId\": \"978d53f9-7fe3-4a63-992d-97bcb4535dc8\"
    },
    {
      \"kind\": \"updateExpireUserTargetDate\",
      \"userKey\": \"userKey2\",
      \"variationId\": \"978d53f9-7fe3-4a63-992d-97bcb4535dc8\",
      \"value\": 1587582000000
    },
    {
      \"kind\": \"addExpireUserTargetDate\",
      \"userKey\": \"userKey3\",
      \"variationId\": \"978d53f9-7fe3-4a63-992d-97bcb4535dc8\",
      \"value\": 1594247266386
    }
  ]
}

Here is another example. In this feature flag configuration:

{
  \"name\": \"New recommendations engine\",
  \"key\": \"engine.enable\",
  \"environments\": {
    \"test\": {
      \"on\": true
    }
  }
}

You can change the feature flag's description with the following patch document as a set of executable instructions. For example, “add user X to targets for variation Y and remove user A from targets for variation B for test flag”:

{
  \"comment\": \"\",
  \"instructions\": [
    {
      \"kind\": \"removeUserTargets\",
      \"values\": [\"438580d8-02ee-418d-9eec-0085cab2bdf0\"],
      \"variationId\": \"852cb784-54ff-46b9-8c35-5498d2e4f270\"
    },
    {
      \"kind\": \"addUserTargets\",
      \"values\": [\"438580d8-02ee-418d-9eec-0085cab2bdf0\"],
      \"variationId\": \"1bb18465-33b6-49aa-a3bd-eeb6650b33ad\"
    }
  ]
}

Supported semantic patch API endpoints

Errors

The API always returns errors in a common format. Here's an example:

{
  \"code\": \"invalid_request\",
  \"message\": \"A feature with that key already exists\",
  \"id\": \"30ce6058-87da-11e4-b116-123b93f75cba\"
}

The general class of error is indicated by the code. The message is a human-readable explanation of what went wrong. The id is a unique identifier. Use it when you're working with LaunchDarkly support to debug a problem with a specific API call.

HTTP Status - Error Response Codes

Code Definition Desc. Possible Solution
400 Bad Request A request that fails may return this HTTP response code. Ensure JSON syntax in request body is correct.
401 Unauthorized User doesn't have permission to an API call. Ensure your SDK key is good.
403 Forbidden User does not have permission for operation. Ensure that the user or access token has proper permissions set.
409 Conflict The API request could not be completed because it conflicted with a concurrent API request. Retry your request.
429 Too many requests See Rate limiting. Wait and try again later.

CORS

The LaunchDarkly API supports Cross Origin Resource Sharing (CORS) for AJAX requests from any origin. If an Origin header is given in a request, it will be echoed as an explicitly allowed origin. Otherwise, a wildcard is returned: Access-Control-Allow-Origin: *. For more information on CORS, see the CORS W3C Recommendation. Example CORS headers might look like:

Access-Control-Allow-Headers: Accept, Content-Type, Content-Length, Accept-Encoding, Authorization
Access-Control-Allow-Methods: OPTIONS, GET, DELETE, PATCH
Access-Control-Allow-Origin: *
Access-Control-Max-Age: 300

You can make authenticated CORS calls just as you would make same-origin calls, using either token or session-based authentication. If you’re using session auth, you should set the withCredentials property for your xhr request to true. You should never expose your access tokens to untrusted users.

Rate limiting

We use several rate limiting strategies to ensure the availability of our APIs. Rate-limited calls to our APIs will return a 429 status code. Calls to our APIs will include headers indicating the current rate limit status. The specific headers returned depend on the API route being called. The limits differ based on the route, authentication mechanism, and other factors. Routes that are not rate limited may not contain any of the headers described below.

Rate limiting and SDKs

LaunchDarkly SDKs are never rate limited and do not use the API endpoints defined here. LaunchDarkly uses a different set of approaches, including streaming/server-sent events and a global CDN, to ensure availability to the routes used by LaunchDarkly SDKs.

The client-side ID is safe to embed in untrusted contexts. It's designed for use in client-side JavaScript.

Global rate limits

Authenticated requests are subject to a global limit. This is the maximum number of calls that can be made to the API per ten seconds. All personal access tokens on the account share this limit, so exceeding the limit with one access token will impact other tokens. Calls that are subject to global rate limits will return the headers below:

Header name Description
X-Ratelimit-Global-Remaining The maximum number of requests the account is permitted to make per ten seconds.
X-Ratelimit-Reset The time at which the current rate limit window resets in epoch milliseconds.

We do not publicly document the specific number of calls that can be made globally. This limit may change, and we encourage clients to program against the specification, relying on the two headers defined above, rather than hardcoding to the current limit.

Route-level rate limits

Some authenticated routes have custom rate limits. These also reset every ten seconds. Any access tokens hitting the same route share this limit, so exceeding the limit with one access token may impact other tokens. Calls that are subject to route-level rate limits will return the headers below:

Header name Description
X-Ratelimit-Route-Remaining The maximum number of requests to the current route the account is permitted to make per ten seconds.
X-Ratelimit-Reset The time at which the current rate limit window resets in epoch milliseconds.

A route represents a specific URL pattern and verb. For example, the Delete environment endpoint is considered a single route, and each call to delete an environment counts against your route-level rate limit for that route.

We do not publicly document the specific number of calls that can be made to each endpoint per ten seconds. These limits may change, and we encourage clients to program against the specification, relying on the two headers defined above, rather than hardcoding to the current limits.

IP-based rate limiting

We also employ IP-based rate limiting on some API routes. If you hit an IP-based rate limit, your API response will include a Retry-After header indicating how long to wait before re-trying the call. Clients must wait at least Retry-After seconds before making additional calls to our API, and should employ jitter and backoff strategies to avoid triggering rate limits again.

OpenAPI (Swagger)

We have a complete OpenAPI (Swagger) specification for our API.

You can use this specification to generate client libraries to interact with our REST API in your language of choice.

This specification is supported by several API-based tools such as Postman and Insomnia. In many cases, you can directly import our specification to ease use in navigating the APIs in the tooling.

Client libraries

We auto-generate multiple client libraries based on our OpenAPI specification. To learn more, visit GitHub.

Method Overriding

Some firewalls and HTTP clients restrict the use of verbs other than GET and POST. In those environments, our API endpoints that use PUT, PATCH, and DELETE verbs will be inaccessible.

To avoid this issue, our API supports the X-HTTP-Method-Override header, allowing clients to "tunnel" PUT, PATCH, and DELETE requests via a POST request.

For example, if you wish to call one of our PATCH resources via a POST request, you can include X-HTTP-Method-Override:PATCH as a header.

Beta resources

We sometimes release new API resources in beta status before we release them with general availability.

Resources that are in beta are still undergoing testing and development. They may change without notice, including becoming backwards incompatible.

We try to promote resources into general availability as quickly as possible. This happens after sufficient testing and when we're satisfied that we no longer need to make backwards-incompatible changes.

We mark beta resources with a "Beta" callout in our documentation, pictured below:

This feature is in beta

To use this feature, pass in a header including the LD-API-Version key with value set to beta. Use this header with each call. To learn more, read Beta resources.

Using beta resources

To use a beta resource, you must include a header in the request. If you call a beta resource without this header, you'll receive a 403 response.

Use this header:

LD-API-Version: beta

Versioning

We try hard to keep our REST API backwards compatible, but we occasionally have to make backwards-incompatible changes in the process of shipping new features. These breaking changes can cause unexpected behavior if you don't prepare for them accordingly.

Updates to our REST API include support for the latest features in LaunchDarkly. We also release a new version of our REST API every time we make a breaking change. We provide simultaneous support for multiple API versions so you can migrate from your current API version to a new version at your own pace.

Setting the API version per request

You can set the API version on a specific request by sending an LD-API-Version header, as shown in the example below:

LD-API-Version: 20191212

The header value is the version number of the API version you'd like to request. The number for each version corresponds to the date the version was released. In the example above the version 20191212 corresponds to December 12, 2019.

Setting the API version per access token

When creating an access token, you must specify a specific version of the API to use. This ensures that integrations using this token cannot be broken by version changes.

Tokens created before versioning was released have their version set to 20160426 (the version of the API that existed before versioning) so that they continue working the same way they did before versioning.

If you would like to upgrade your integration to use a new API version, you can explicitly set the header described above.

Best practice: Set the header for every client or integration

We recommend that you set the API version header explicitly in any client or integration you build.

Only rely on the access token API version during manual testing.

This SDK is automatically generated by the OpenAPI Generator project:

  • API version: 2.0
  • Package version: 6.0.0
  • Build package: org.openapitools.codegen.languages.JavascriptClientCodegen For more information, please visit https://support.launchdarkly.com

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install launchdarkly-api --save

Finally, you need to build the module:

npm run build
Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

To use the link you just defined in your project, switch to the directory you want to use your launchdarkly-api from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

git

If the library is hosted at a git repository, e.g.https://github.com/launchdarkly/api-client-javascript then install it via:

    npm install launchdarkly/api-client-javascript --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var LaunchDarklyApi = require('launchdarkly-api');

var defaultClient = LaunchDarklyApi.ApiClient.instance;
// Configure API key authorization: ApiKey
var 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['Authorization'] = "Token"

var api = new LaunchDarklyApi.AccessTokensApi()
var id = "id_example"; // {String} The ID of the access token to update
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteToken(id, callback);

Documentation for API Endpoints

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

Class Method HTTP request Description
LaunchDarklyApi.AccessTokensApi deleteToken DELETE /api/v2/tokens/{id} Delete access token
LaunchDarklyApi.AccessTokensApi getToken GET /api/v2/tokens/{id} Get access token
LaunchDarklyApi.AccessTokensApi getTokens GET /api/v2/tokens List access tokens
LaunchDarklyApi.AccessTokensApi patchToken PATCH /api/v2/tokens/{id} Patch access token
LaunchDarklyApi.AccessTokensApi postToken POST /api/v2/tokens Create access token
LaunchDarklyApi.AccessTokensApi resetToken POST /api/v2/tokens/{id}/reset Reset access token
LaunchDarklyApi.AccountMembersApi deleteMember DELETE /api/v2/members/{id} Delete account member
LaunchDarklyApi.AccountMembersApi getMember GET /api/v2/members/{id} Get account member
LaunchDarklyApi.AccountMembersApi getMembers GET /api/v2/members List account members
LaunchDarklyApi.AccountMembersApi patchMember PATCH /api/v2/members/{id} Modify an account member
LaunchDarklyApi.AccountMembersApi postMembers POST /api/v2/members Invite new members
LaunchDarklyApi.AccountUsageBetaApi getEvaluationsUsage GET /api/v2/usage/evaluations/{projKey}/{envKey}/{flagKey} Get evaluations usage
LaunchDarklyApi.AccountUsageBetaApi getEventsUsage GET /api/v2/usage/events/{type} Get events usage
LaunchDarklyApi.AccountUsageBetaApi getMauSdksByType GET /api/v2/usage/mau/sdks Get MAU SDKs by type
LaunchDarklyApi.AccountUsageBetaApi getMauUsage GET /api/v2/usage/mau Get MAU usage
LaunchDarklyApi.AccountUsageBetaApi getMauUsageByCategory GET /api/v2/usage/mau/bycategory Get MAU usage by category
LaunchDarklyApi.AccountUsageBetaApi getStreamUsage GET /api/v2/usage/streams/{source} Get stream usage
LaunchDarklyApi.AccountUsageBetaApi getStreamUsageBySdkVersion GET /api/v2/usage/streams/{source}/bysdkversion Get stream usage by SDK version
LaunchDarklyApi.AccountUsageBetaApi getStreamUsageSdkversion GET /api/v2/usage/streams/{source}/sdkversions Get stream usage SDK versions
LaunchDarklyApi.ApprovalsApi deleteApprovalRequest DELETE /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests/{id} Delete approval request
LaunchDarklyApi.ApprovalsApi getApproval GET /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests/{id} Get approval request
LaunchDarklyApi.ApprovalsApi getApprovals GET /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests List all approval requests
LaunchDarklyApi.ApprovalsApi postApprovalRequest POST /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests Create approval request
LaunchDarklyApi.ApprovalsApi postApprovalRequestApplyRequest POST /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests/{id}/apply Apply approval request
LaunchDarklyApi.ApprovalsApi postApprovalRequestReview POST /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests/{id}/reviews Review approval request
LaunchDarklyApi.ApprovalsApi postFlagCopyConfigApprovalRequest POST /api/v2/projects/{projectKey}/flags/{featureFlagKey}/copy/environments/{environmentKey}/approval-requests-flag-copy Create approval request to copy flag configurations across environments
LaunchDarklyApi.AuditLogApi getAuditLogEntries GET /api/v2/auditlog List audit log feature flag entries
LaunchDarklyApi.AuditLogApi getAuditLogEntry GET /api/v2/auditlog/{id} Get audit log entry
LaunchDarklyApi.CodeReferencesApi deleteBranches POST /api/v2/code-refs/repositories/{repo}/branch-delete-tasks Delete branches
LaunchDarklyApi.CodeReferencesApi deleteRepository DELETE /api/v2/code-refs/repositories/{repo} Delete repository
LaunchDarklyApi.CodeReferencesApi getBranch GET /api/v2/code-refs/repositories/{repo}/branches/{branch} Get branch
LaunchDarklyApi.CodeReferencesApi getBranches GET /api/v2/code-refs/repositories/{repo}/branches List branches
LaunchDarklyApi.CodeReferencesApi getExtinctions GET /api/v2/code-refs/extinctions List extinctions
LaunchDarklyApi.CodeReferencesApi getRepositories GET /api/v2/code-refs/repositories List repositories
LaunchDarklyApi.CodeReferencesApi getRepository GET /api/v2/code-refs/repositories/{repo} Get repository
LaunchDarklyApi.CodeReferencesApi getRootStatistic GET /api/v2/code-refs/statistics Get number of code references for flags
LaunchDarklyApi.CodeReferencesApi getStatistics GET /api/v2/code-refs/statistics/{projKey} Get number of code references for flags
LaunchDarklyApi.CodeReferencesApi patchRepository PATCH /api/v2/code-refs/repositories/{repo} Update repository
LaunchDarklyApi.CodeReferencesApi postExtinction POST /api/v2/code-refs/repositories/{repo}/branches/{branch} Create extinction
LaunchDarklyApi.CodeReferencesApi postRepository POST /api/v2/code-refs/repositories Create repository
LaunchDarklyApi.CodeReferencesApi putBranch PUT /api/v2/code-refs/repositories/{repo}/branches/{branch} Upsert branch
LaunchDarklyApi.CustomRolesApi deleteCustomRole DELETE /api/v2/roles/{key} Delete custom role
LaunchDarklyApi.CustomRolesApi getCustomRole GET /api/v2/roles/{key} Get custom role
LaunchDarklyApi.CustomRolesApi getCustomRoles GET /api/v2/roles List custom roles
LaunchDarklyApi.CustomRolesApi patchCustomRole PATCH /api/v2/roles/{key} Update custom role
LaunchDarklyApi.CustomRolesApi postCustomRole POST /api/v2/roles Create custom role
LaunchDarklyApi.DataExportDestinationsApi deleteDestination DELETE /api/v2/destinations/{projKey}/{envKey}/{id} Delete Data Export destination
LaunchDarklyApi.DataExportDestinationsApi getDestination GET /api/v2/destinations/{projKey}/{envKey}/{id} Get destination
LaunchDarklyApi.DataExportDestinationsApi getDestinations GET /api/v2/destinations List destinations
LaunchDarklyApi.DataExportDestinationsApi patchDestination PATCH /api/v2/destinations/{projKey}/{envKey}/{id} Update Data Export destination
LaunchDarklyApi.DataExportDestinationsApi postDestination POST /api/v2/destinations/{projKey}/{envKey} Create data export destination
LaunchDarklyApi.EnvironmentsApi deleteEnvironment DELETE /api/v2/projects/{projectKey}/environments/{environmentKey} Delete environment
LaunchDarklyApi.EnvironmentsApi getEnvironment GET /api/v2/projects/{projectKey}/environments/{environmentKey} Get environment
LaunchDarklyApi.EnvironmentsApi patchEnvironment PATCH /api/v2/projects/{projectKey}/environments/{environmentKey} Update environment
LaunchDarklyApi.EnvironmentsApi postEnvironment POST /api/v2/projects/{projectKey}/environments Create environment
LaunchDarklyApi.EnvironmentsApi resetEnvironmentMobileKey POST /api/v2/projects/{projectKey}/environments/{envKey}/mobileKey Reset environment mobile SDK key
LaunchDarklyApi.EnvironmentsApi resetEnvironmentSDKKey POST /api/v2/projects/{projectKey}/environments/{envKey}/apiKey Reset environment SDK key
LaunchDarklyApi.ExperimentsBetaApi getExperiment GET /api/v2/flags/{projKey}/{flagKey}/experiments/{envKey}/{metricKey} Get experiment results
LaunchDarklyApi.ExperimentsBetaApi resetExperiment DELETE /api/v2/flags/{projKey}/{flagKey}/experiments/{envKey}/{metricKey}/results Reset experiment results
LaunchDarklyApi.FeatureFlagsApi copyFeatureFlag POST /api/v2/flags/{projKey}/{featureFlagKey}/copy Copy feature flag
LaunchDarklyApi.FeatureFlagsApi deleteFeatureFlag DELETE /api/v2/flags/{projKey}/{key} Delete feature flag
LaunchDarklyApi.FeatureFlagsApi getExpiringUserTargets GET /api/v2/flags/{projKey}/{flagKey}/expiring-user-targets/{envKey} Get expiring user targets for feature flag
LaunchDarklyApi.FeatureFlagsApi getFeatureFlag GET /api/v2/flags/{projKey}/{key} Get feature flag
LaunchDarklyApi.FeatureFlagsApi getFeatureFlagStatus GET /api/v2/flag-statuses/{projKey}/{envKey}/{key} Get feature flag status
LaunchDarklyApi.FeatureFlagsApi getFeatureFlagStatusAcrossEnvironments GET /api/v2/flag-status/{projKey}/{key} Get flag status across environments
LaunchDarklyApi.FeatureFlagsApi getFeatureFlagStatuses GET /api/v2/flag-statuses/{projKey}/{envKey} List feature flag statuses
LaunchDarklyApi.FeatureFlagsApi getFeatureFlags GET /api/v2/flags/{projKey} List feature flags
LaunchDarklyApi.FeatureFlagsApi patchExpiringUserTargets PATCH /api/v2/flags/{projKey}/{flagKey}/expiring-user-targets/{envKey} Update expiring user targets on feature flag
LaunchDarklyApi.FeatureFlagsApi patchFeatureFlag PATCH /api/v2/flags/{projKey}/{key} Update feature flag
LaunchDarklyApi.FeatureFlagsApi postFeatureFlag POST /api/v2/flags/{projKey} Create a feature flag
LaunchDarklyApi.FeatureFlagsBetaApi getDependentFlags GET /api/v2/flags/{projKey}/{flagKey}/dependent-flags List dependent feature flags
LaunchDarklyApi.FeatureFlagsBetaApi getDependentFlagsByEnv GET /api/v2/flags/{projKey}/{envKey}/{flagKey}/dependent-flags List dependent feature flags by environment
LaunchDarklyApi.MetricsApi deleteMetric DELETE /api/v2/metrics/{projectKey}/{key} Delete metric
LaunchDarklyApi.MetricsApi getMetric GET /api/v2/metrics/{projectKey}/{key} Get metric
LaunchDarklyApi.MetricsApi getMetrics GET /api/v2/metrics/{projectKey} List metrics
LaunchDarklyApi.MetricsApi patchMetric PATCH /api/v2/metrics/{projectKey}/{key} Update metric
LaunchDarklyApi.MetricsApi postMetric POST /api/v2/metrics/{projectKey} Create metric
LaunchDarklyApi.OtherApi getIps GET /api/v2/public-ip-list Gets the public IP list
LaunchDarklyApi.OtherApi getOpenapiSpec GET /api/v2/openapi.json Gets the OpenAPI spec in json
LaunchDarklyApi.OtherApi getRoot GET /api/v2 Root resource
LaunchDarklyApi.OtherApi getVersions GET /api/v2/versions Get version information
LaunchDarklyApi.ProjectsApi deleteProject DELETE /api/v2/projects/{projectKey} Delete project
LaunchDarklyApi.ProjectsApi getProject GET /api/v2/projects/{projectKey} Get project
LaunchDarklyApi.ProjectsApi getProjects GET /api/v2/projects List projects
LaunchDarklyApi.ProjectsApi patchProject PATCH /api/v2/projects/{projectKey} Update project
LaunchDarklyApi.ProjectsApi postProject POST /api/v2/projects Create project
LaunchDarklyApi.RelayProxyConfigurationsApi deleteRelayAutoConfig DELETE /api/v2/account/relay-auto-configs/{id} Delete Relay Proxy config by ID
LaunchDarklyApi.RelayProxyConfigurationsApi getRelayProxyConfig GET /api/v2/account/relay-auto-configs/{id} Get Relay Proxy config
LaunchDarklyApi.RelayProxyConfigurationsApi getRelayProxyConfigs GET /api/v2/account/relay-auto-configs List Relay Proxy configs
LaunchDarklyApi.RelayProxyConfigurationsApi patchRelayAutoConfig PATCH /api/v2/account/relay-auto-configs/{id} Update a Relay Proxy config
LaunchDarklyApi.RelayProxyConfigurationsApi postRelayAutoConfig POST /api/v2/account/relay-auto-configs Create a new Relay Proxy config
LaunchDarklyApi.RelayProxyConfigurationsApi resetRelayAutoConfig POST /api/v2/account/relay-auto-configs/{id}/reset Reset Relay Proxy configuration key
LaunchDarklyApi.ScheduledChangesApi deleteFlagConfigScheduledChanges DELETE /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/scheduled-changes/{id} Delete scheduled changes workflow
LaunchDarklyApi.ScheduledChangesApi getFeatureFlagScheduledChange GET /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/scheduled-changes/{id} Get a scheduled change
LaunchDarklyApi.ScheduledChangesApi getFlagConfigScheduledChanges GET /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/scheduled-changes List scheduled changes
LaunchDarklyApi.ScheduledChangesApi patchFlagConfigScheduledChange PATCH /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/scheduled-changes/{id} Update scheduled changes workflow
LaunchDarklyApi.ScheduledChangesApi postFlagConfigScheduledChanges POST /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/scheduled-changes Create scheduled changes workflow
LaunchDarklyApi.SegmentsApi deleteSegment DELETE /api/v2/segments/{projKey}/{envKey}/{key} Delete segment
LaunchDarklyApi.SegmentsApi getExpiringUserTargetsForSegment GET /api/v2/segments/{projKey}/{segmentKey}/expiring-user-targets/{envKey} Get expiring user targets for segment
LaunchDarklyApi.SegmentsApi getSegment GET /api/v2/segments/{projKey}/{envKey}/{key} Get segment
LaunchDarklyApi.SegmentsApi getSegmentMembershipForUser GET /api/v2/segments/{projKey}/{envKey}/{key}/users/{userKey} Get Big Segment membership for user
LaunchDarklyApi.SegmentsApi getSegments GET /api/v2/segments/{projKey}/{envKey} List segments
LaunchDarklyApi.SegmentsApi patchExpiringUserTargetsForSegment PATCH /api/v2/segments/{projKey}/{segmentKey}/expiring-user-targets/{envKey} Update expiring user targets for segment
LaunchDarklyApi.SegmentsApi patchSegment PATCH /api/v2/segments/{projKey}/{envKey}/{key} Patch segment
LaunchDarklyApi.SegmentsApi postSegment POST /api/v2/segments/{projKey}/{envKey} Create segment
LaunchDarklyApi.SegmentsApi updateBigSegmentTargets POST /api/v2/segments/{projKey}/{envKey}/{key}/users Update targets on a Big Segment
LaunchDarklyApi.UserSettingsApi getExpiringFlagsForUser GET /api/v2/users/{projKey}/{userKey}/expiring-user-targets/{envKey} Get expiring dates on flags for user
LaunchDarklyApi.UserSettingsApi getUserFlagSetting GET /api/v2/users/{projKey}/{envKey}/{key}/flags/{featureKey} Get flag setting for user
LaunchDarklyApi.UserSettingsApi getUserFlagSettings GET /api/v2/users/{projKey}/{envKey}/{key}/flags List flag settings for user
LaunchDarklyApi.UserSettingsApi patchExpiringFlagsForUser PATCH /api/v2/users/{projKey}/{userKey}/expiring-user-targets/{envKey} Update expiring user target for flags
LaunchDarklyApi.UserSettingsApi putFlagSetting PUT /api/v2/users/{projKey}/{envKey}/{key}/flags/{featureKey} Update flag settings for user
LaunchDarklyApi.UsersApi deleteUser DELETE /api/v2/users/{projKey}/{envKey}/{key} Delete user
LaunchDarklyApi.UsersApi getSearchUsers GET /api/v2/user-search/{projKey}/{envKey} Find users
LaunchDarklyApi.UsersApi getUser GET /api/v2/users/{projKey}/{envKey}/{key} Get user
LaunchDarklyApi.UsersApi getUsers GET /api/v2/users/{projKey}/{envKey} List users
LaunchDarklyApi.UsersBetaApi getUserAttributeNames GET /api/v2/user-attributes/{projectKey}/{environmentKey} Get user attribute names
LaunchDarklyApi.WebhooksApi deleteWebhook DELETE /api/v2/webhooks/{id} Delete webhook
LaunchDarklyApi.WebhooksApi getAllWebhooks GET /api/v2/webhooks List webhooks
LaunchDarklyApi.WebhooksApi getWebhook GET /api/v2/webhooks/{id} Get webhook
LaunchDarklyApi.WebhooksApi patchWebhook PATCH /api/v2/webhooks/{id} Update webhook
LaunchDarklyApi.WebhooksApi postWebhook POST /api/v2/webhooks Creates a webhook

Documentation for Models

Documentation for Authorization

ApiKey

  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header

Sample Code

var LaunchDarklyApi = require('launchdarkly-api');

var defaultClient = LaunchDarklyApi.ApiClient.instance;

var Token = defaultClient.authentications['ApiKey'];
Token.apiKey = process.env.LD_API_KEY;

var apiInstance = new LaunchDarklyApi.FeatureFlagsApi();

const projectName = "openapi";
const keyName = "test-javascript";

var callback = function(error, data) {
  if (error) {
    console.error(error);
    process.exit(1);
  } else {
    console.log('API called successfully. Returned data: ' + JSON.stringify(data));
  }
};

var postCallback = function(error, data) {
  callback(error, data);

  if (!error) {
    // Clean up
    apiInstance.deleteFeatureFlag(projectName, keyName, callback);
  }
};

apiInstance.postFeatureFlag(projectName,
  {
    name: "Test Flag Javascript",
    key: keyName,
    variations: [{value: [1, 2]}, {value: [3, 4]}, {value: [5]}]
  }, {}, postCallback);

About

LaunchDarkly API Client for JavaScript

Topics

javascript js api-client feature-flags feature-toggles open-api launchdarkly launchdarkly-api managed-by-terraform

Resources

Readme

License

View license
Activity
Custom properties

Stars

4 stars

Watchers

42 watching

Forks

3 forks
Report repository

Releases 20

v17.2.0 Latest
Apr 4, 2025
+ 19 releases

Packages

No packages published

Contributors 2

  •  
  •  

Languages