🚀 Big News: Socket Acquires Coana to Bring Reachability Analysis to Every Appsec Team.Learn more →
Socket
Sign inDemoInstall
Socket
Sign inDemoInstall

launchdarkly_api

Package Overview
Dependencies
Maintainers
1
Alerts
File Explorer

Advanced tools

License
Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

launchdarkly_api

17.2.0
Rubygems
Version published
Maintainers
1
Created
Source

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.

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.

This client library is only compatible with the latest version of our REST API. Previous versions of this client library are compatible with earlier versions of our REST API. When you create an access token, you can set the REST API version associated with the token. By default, API requests you send using the token will use the specified API version. To learn more, read Versioning. View our sample code for example usage.

launchdarkly_api

LaunchDarklyApi - the Ruby gem for the LaunchDarkly REST API

This documentation describes LaunchDarkly's REST API.

To access the complete OpenAPI spec directly, use Get OpenAPI spec.

Authentication

LaunchDarkly's REST API uses the HTTPS protocol with a minimum TLS version of 1.2.

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 Authorization page in the LaunchDarkly UI.

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

Auth mechanismAllowed resourcesUse cases
Personal or service access tokensCan be customized on a per-token basisBuilding scripts, custom integrations, data export.
SDK keysCan only access read-only resources specific to server-side SDKs. Restricted to a single environment.Server-side SDKs
Mobile keysCan only access read-only resources specific to mobile SDKs, and only for flags marked available to mobile keys. Restricted to a single environment.Mobile SDKs
Client-side IDCan only access read-only resources specific to JavaScript-based client-side SDKs, and only for flags marked available to client-side. Restricted to a single environment.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 Authorization page.

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

Authentication using 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 Authorization page.

Authentication using session cookie

For testing purposes, you can make API calls directly from your web browser. If you are logged in to the LaunchDarkly 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 also send a JSON body. To learn more about the error format of the API, read Errors.

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

In addition, request bodies for PATCH, POST, and PUT 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, such as a single feature flag, you receive a detailed representation 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.

Expanding responses

Sometimes the detailed representation of a resource does not include all of the attributes of the resource by default. If this is the case, the request method will clearly document this and describe which attributes you can include in an expanded response.

To include the additional attributes, append the expand request parameter to your request and add a comma-separated list of the attributes to include. For example, when you append ?expand=members,maintainers to the Get team endpoint, the expanded response includes both of these attributes.

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, which contains the URL
  • A type, which describes 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. Most resources support the JSON patch format. Some resources also support the JSON merge patch format, and some resources support the semantic patch format, which is a way to specify the modifications to perform as a set of executable instructions. Each resource supports optional comments that you can submit with updates. Comments appear in outgoing webhooks, the audit log, and other integrations.

When a resource supports both JSON patch and semantic patch, we document both in the request method. However, the specific request body fields and descriptions included in our documentation only match one type of patch or the other.

Updates using JSON patch

JSON patch is a way to specify the modifications to perform on a resource. 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. JSON patch documents are always arrays, where each element contains an operation, a path to the field to update, and the new value.

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\" }]

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 are not editable, such as a resource's _links, have names that start with an underscore.

Updates using JSON merge patch

JSON merge patch is another format for specifying the modifications to perform on a resource. JSON merge patch is less expressive than JSON patch. However, 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 using semantic patch

Some resources support 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.

Semantic patch allows you to be explicit about intent using precise, custom instructions. In many cases, you can define semantic patch instructions independently of the current state of the resource. This can be useful when defining a change that may be applied at a future date.

To make a semantic patch request, you must append domain-model=launchdarkly.semanticpatch to your Content-Type header.

Here's how:

Content-Type: application/json; domain-model=launchdarkly.semanticpatch

If you call a semantic patch resource without this header, you will receive a 400 response because your semantic patch will be interpreted as a JSON patch.

The body of a semantic patch request takes the following properties:

  • comment (string): (Optional) A description of the update.
  • environmentKey (string): (Required for some resources only) The environment key.
  • instructions (array): (Required) A list of actions the update should perform. Each action in the list must be an object with a kind property that indicates the instruction. If the instruction requires parameters, you must include those parameters as additional fields in the object. The documentation for each resource that supports semantic patch includes the available instructions and any additional parameters.

For example:

{
  \"comment\": \"optional comment\",
  \"instructions\": [ {\"kind\": \"turnFlagOn\"} ]
}

Semantic patches are not applied partially; either all of the instructions are applied or none of them are. If any instruction is invalid, the endpoint returns an error and will not change the resource. If all instructions are valid, the request succeeds and the resources are updated if necessary, or left unchanged if they are already in the state you request.

Updates with comments

You can submit optional comments with PATCH changes.

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\" }
}

To submit a comment along with a semantic patch, use the following format:

{
  \"comment\": \"This is a comment string\",
  \"instructions\": [ {\"kind\": \"turnFlagOn\"} ]
}

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 code indicates the general class of error. 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

CodeDefinitionDescriptionPossible Solution
400Invalid requestThe request cannot be understood.Ensure JSON syntax in request body is correct.
401Invalid access tokenRequestor is unauthorized or does not have permission for this API call.Ensure your API access token is valid and has the appropriate permissions.
403ForbiddenRequestor does not have access to this resource.Ensure that the account member or access token has proper permissions set.
404Invalid resource identifierThe requested resource is not valid.Ensure that the resource is correctly identified by ID or key.
405Method not allowedThe request method is not allowed on this resource.Ensure that the HTTP verb is correct.
409ConflictThe API request can not be completed because it conflicts with a concurrent API request.Retry your request.
422Unprocessable entityThe API request can not be completed because the update description can not be understood.Ensure that the request body is correct for the type of patch you are using, either JSON patch or semantic patch.
429Too many requestsRead 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 the request returns a wildcard, Access-Control-Allow-Origin: *. For more information on CORS, read 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 are using session authentication, you should set the withCredentials property for your xhr request to true. You should never expose your access tokens to untrusted entities.

Rate limiting

We use several rate limiting strategies to ensure the availability of our APIs. Rate-limited calls to our APIs return a 429 status code. Calls to our APIs 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.

Global rate limits

Authenticated requests are subject to a global limit. This is the maximum number of calls that your account can make to the API per ten seconds. All service and 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 may return the headers below:

Header nameDescription
X-Ratelimit-Global-RemainingThe maximum number of requests the account is permitted to make per ten seconds.
X-Ratelimit-ResetThe 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 service or personal 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 return the headers below:

Header nameDescription
X-Ratelimit-Route-RemainingThe maximum number of requests to the current route the account is permitted to make per ten seconds.
X-Ratelimit-ResetThe 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 an account can make 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) and client libraries

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

We auto-generate multiple client libraries based on our OpenAPI specification. To learn more, visit the collection of client libraries on GitHub. You can also use this specification to generate client libraries to interact with our REST API in your language of choice.

Our OpenAPI specification is supported by several API-based tools such as Postman and Insomnia. In many cases, you can directly import our specification to explore our APIs.

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 DELETE, PATCH, and PUT verbs are inaccessible.

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

For example, to call a PATCH endpoint using 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.

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

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 receive a 403 response.

Use this header:

LD-API-Version: beta

Federal environments

The version of LaunchDarkly that is available on domains controlled by the United States government is different from the version of LaunchDarkly available to the general public. If you are an employee or contractor for a United States federal agency and use LaunchDarkly in your work, you likely use the federal instance of LaunchDarkly.

If you are working in the federal instance of LaunchDarkly, the base URI for each request is https://app.launchdarkly.us.

To learn more, read LaunchDarkly in federal environments.

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: 20240415

The header value is the version number of the API version you would like to request. The number for each version corresponds to the date the version was released in yyyymmdd format. In the example above the version 20240415 corresponds to April 15, 2024.

Setting the API version per access token

When you create 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, which is the version of the API that existed before the current versioning scheme, 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.

API version changelog

VersionChangesEnd of life (EOL)
`20240415`
  • Changed several endpoints from unpaginated to paginated. Use the `limit` and `offset` query parameters to page through the results.
  • Changed the [list access tokens](https://launchdarkly.com/docs/api/access-tokens/get-tokens) endpoint:
    • Response is now paginated with a default limit of `25`
  • Changed the [list account members](https://launchdarkly.com/docs/api/account-members/get-members) endpoint:
    • The `accessCheck` filter is no longer available
  • Changed the [list custom roles](https://launchdarkly.com/docs/api/custom-roles/get-custom-roles) endpoint:
    • Response is now paginated with a default limit of `20`
  • Changed the [list feature flags](https://launchdarkly.com/docs/api/feature-flags/get-feature-flags) endpoint:
    • Response is now paginated with a default limit of `20`
    • The `environments` field is now only returned if the request is filtered by environment, using the `filterEnv` query parameter
    • The `followerId`, `hasDataExport`, `status`, `contextKindTargeted`, and `segmentTargeted` filters are no longer available
    • The `compare` query parameter is no longer available
  • Changed the [list segments](https://launchdarkly.com/docs/api/segments/get-segments) endpoint:
    • Response is now paginated with a default limit of `20`
  • Changed the [list teams](https://launchdarkly.com/docs/api/teams/get-teams) endpoint:
    • The `expand` parameter no longer supports including `projects` or `roles`
    • In paginated results, the maximum page size is now 100
  • Changed the [get workflows](https://launchdarkly.com/docs/api/workflows/get-workflows) endpoint:
    • Response is now paginated with a default limit of `20`
    • The `_conflicts` field in the response is no longer available
Current
`20220603`
  • Changed the [list projects](https://launchdarkly.com/docs/api/projects/get-projects) return value:
    • Response is now paginated with a default limit of `20`.
    • Added support for filter and sort.
    • The project `environments` field is now expandable. This field is omitted by default.
  • Changed the [get project](https://launchdarkly.com/docs/api/projects/get-project) return value:
    • The `environments` field is now expandable. This field is omitted by default.
2025-04-15
`20210729`
  • Changed the [create approval request](https://launchdarkly.com/docs/api/approvals/post-approval-request) return value. It now returns HTTP Status Code `201` instead of `200`.
  • Changed the [get user](https://launchdarkly.com/docs/api/users/get-user) return value. It now returns a user record, not a user.
  • Added additional optional fields to environment, segments, flags, members, and segments, including the ability to create big segments.
  • Added default values for flag variations when new environments are created.
  • Added filtering and pagination for getting flags and members, including `limit`, `number`, `filter`, and `sort` query parameters.
  • Added endpoints for expiring user targets for flags and segments, scheduled changes, access tokens, Relay Proxy configuration, integrations and subscriptions, and approvals.
2023-06-03
`20191212`
  • [List feature flags](https://launchdarkly.com/docs/api/feature-flags/get-feature-flags) now defaults to sending summaries of feature flag configurations, equivalent to setting the query parameter `summary=true`. Summaries omit flag targeting rules and individual user targets from the payload.
  • Added endpoints for flags, flag status, projects, environments, audit logs, members, users, custom roles, segments, usage, streams, events, and data export.
2022-07-29
`20160426`
  • Initial versioning of API. Tokens created before versioning have their version set to this.
2020-12-12

To learn more about how EOL is determined, read LaunchDarkly's End of Life (EOL) Policy.

This SDK is automatically generated by the OpenAPI Generator project:

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

Installation

Build a gem

To build the Ruby code into a gem:

gem build launchdarkly_api.gemspec

Then either install the gem locally:

gem install ./launchdarkly_api-17.2.0.gem

(for development, run gem install --dev ./launchdarkly_api-17.2.0.gem to install the development dependencies)

or publish the gem to a gem hosting service, e.g. RubyGems.

Finally add this to the Gemfile:

gem 'launchdarkly_api', '~> 17.2.0'

Install from Git

If the Ruby gem is hosted at a git repository: https://github.com/launchdarkly/api-client-ruby, then add the following in the Gemfile:

gem 'launchdarkly_api', :git => 'https://github.com/launchdarkly/api-client-ruby.git'

Include the Ruby code directly

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Getting Started

Please follow the installation procedure and then run the following code:

# Load the gem
require 'launchdarkly_api'

# Setup authorization
LaunchDarklyApi.configure do |config|
  # Configure API key authorization: ApiKey
  config.api_key['ApiKey'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['ApiKey'] = 'Bearer'
end

api_instance = LaunchDarklyApi::AIConfigsBetaApi.new
ld_api_version = 'beta' # String | Version of the endpoint.
project_key = 'default' # String | 
config_key = 'config_key_example' # String | 

begin
  #Delete AI Config
  api_instance.delete_ai_config(ld_api_version, project_key, config_key)
rescue LaunchDarklyApi::ApiError => e
  puts "Exception when calling AIConfigsBetaApi->delete_ai_config: #{e}"
end

Documentation for API Endpoints

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

ClassMethodHTTP requestDescription
LaunchDarklyApi::AIConfigsBetaApidelete_ai_configDELETE /api/v2/projects/{projectKey}/ai-configs/{configKey}Delete AI Config
LaunchDarklyApi::AIConfigsBetaApidelete_ai_config_variationDELETE /api/v2/projects/{projectKey}/ai-configs/{configKey}/variations/{variationKey}Delete AI Config variation
LaunchDarklyApi::AIConfigsBetaApidelete_model_configDELETE /api/v2/projects/{projectKey}/ai-configs/model-configs/{modelConfigKey}Delete an AI model config
LaunchDarklyApi::AIConfigsBetaApiget_ai_configGET /api/v2/projects/{projectKey}/ai-configs/{configKey}Get AI Config
LaunchDarklyApi::AIConfigsBetaApiget_ai_config_metricsGET /api/v2/projects/{projectKey}/ai-configs/{configKey}/metricsGet AI Config metrics
LaunchDarklyApi::AIConfigsBetaApiget_ai_config_metrics_by_variationGET /api/v2/projects/{projectKey}/ai-configs/{configKey}/metrics-by-variationGet AI Config metrics by variation
LaunchDarklyApi::AIConfigsBetaApiget_ai_config_variationGET /api/v2/projects/{projectKey}/ai-configs/{configKey}/variations/{variationKey}Get AI Config variation
LaunchDarklyApi::AIConfigsBetaApiget_ai_configsGET /api/v2/projects/{projectKey}/ai-configsList AI Configs
LaunchDarklyApi::AIConfigsBetaApiget_model_configGET /api/v2/projects/{projectKey}/ai-configs/model-configs/{modelConfigKey}Get AI model config
LaunchDarklyApi::AIConfigsBetaApilist_model_configsGET /api/v2/projects/{projectKey}/ai-configs/model-configsList AI model configs
LaunchDarklyApi::AIConfigsBetaApipatch_ai_configPATCH /api/v2/projects/{projectKey}/ai-configs/{configKey}Update AI Config
LaunchDarklyApi::AIConfigsBetaApipatch_ai_config_variationPATCH /api/v2/projects/{projectKey}/ai-configs/{configKey}/variations/{variationKey}Update AI Config variation
LaunchDarklyApi::AIConfigsBetaApipost_ai_configPOST /api/v2/projects/{projectKey}/ai-configsCreate new AI Config
LaunchDarklyApi::AIConfigsBetaApipost_ai_config_variationPOST /api/v2/projects/{projectKey}/ai-configs/{configKey}/variationsCreate AI Config variation
LaunchDarklyApi::AIConfigsBetaApipost_model_configPOST /api/v2/projects/{projectKey}/ai-configs/model-configsCreate an AI model config
LaunchDarklyApi::AccessTokensApidelete_tokenDELETE /api/v2/tokens/{id}Delete access token
LaunchDarklyApi::AccessTokensApiget_tokenGET /api/v2/tokens/{id}Get access token
LaunchDarklyApi::AccessTokensApiget_tokensGET /api/v2/tokensList access tokens
LaunchDarklyApi::AccessTokensApipatch_tokenPATCH /api/v2/tokens/{id}Patch access token
LaunchDarklyApi::AccessTokensApipost_tokenPOST /api/v2/tokensCreate access token
LaunchDarklyApi::AccessTokensApireset_tokenPOST /api/v2/tokens/{id}/resetReset access token
LaunchDarklyApi::AccountMembersApidelete_memberDELETE /api/v2/members/{id}Delete account member
LaunchDarklyApi::AccountMembersApiget_memberGET /api/v2/members/{id}Get account member
LaunchDarklyApi::AccountMembersApiget_membersGET /api/v2/membersList account members
LaunchDarklyApi::AccountMembersApipatch_memberPATCH /api/v2/members/{id}Modify an account member
LaunchDarklyApi::AccountMembersApipost_member_teamsPOST /api/v2/members/{id}/teamsAdd a member to teams
LaunchDarklyApi::AccountMembersApipost_membersPOST /api/v2/membersInvite new members
LaunchDarklyApi::AccountMembersBetaApipatch_membersPATCH /api/v2/membersModify account members
LaunchDarklyApi::AccountUsageBetaApiget_data_export_events_usageGET /api/v2/usage/data-export-eventsGet data export events usage
LaunchDarklyApi::AccountUsageBetaApiget_evaluations_usageGET /api/v2/usage/evaluations/{projectKey}/{environmentKey}/{featureFlagKey}Get evaluations usage
LaunchDarklyApi::AccountUsageBetaApiget_events_usageGET /api/v2/usage/events/{type}Get events usage
LaunchDarklyApi::AccountUsageBetaApiget_experimentation_keys_usageGET /api/v2/usage/experimentation-keysGet experimentation keys usage
LaunchDarklyApi::AccountUsageBetaApiget_experimentation_units_usageGET /api/v2/usage/experimentation-unitsGet experimentation units usage
LaunchDarklyApi::AccountUsageBetaApiget_mau_sdks_by_typeGET /api/v2/usage/mau/sdksGet MAU SDKs by type
LaunchDarklyApi::AccountUsageBetaApiget_mau_usageGET /api/v2/usage/mauGet MAU usage
LaunchDarklyApi::AccountUsageBetaApiget_mau_usage_by_categoryGET /api/v2/usage/mau/bycategoryGet MAU usage by category
LaunchDarklyApi::AccountUsageBetaApiget_service_connection_usageGET /api/v2/usage/service-connectionsGet service connection usage
LaunchDarklyApi::AccountUsageBetaApiget_stream_usageGET /api/v2/usage/streams/{source}Get stream usage
LaunchDarklyApi::AccountUsageBetaApiget_stream_usage_by_sdk_versionGET /api/v2/usage/streams/{source}/bysdkversionGet stream usage by SDK version
LaunchDarklyApi::AccountUsageBetaApiget_stream_usage_sdkversionGET /api/v2/usage/streams/{source}/sdkversionsGet stream usage SDK versions
LaunchDarklyApi::AnnouncementsApicreate_announcement_publicPOST /api/v2/announcementsCreate an announcement
LaunchDarklyApi::AnnouncementsApidelete_announcement_publicDELETE /api/v2/announcements/{announcementId}Delete an announcement
LaunchDarklyApi::AnnouncementsApiget_announcements_publicGET /api/v2/announcementsGet announcements
LaunchDarklyApi::AnnouncementsApiupdate_announcement_publicPATCH /api/v2/announcements/{announcementId}Update an announcement
LaunchDarklyApi::ApplicationsBetaApidelete_applicationDELETE /api/v2/applications/{applicationKey}Delete application
LaunchDarklyApi::ApplicationsBetaApidelete_application_versionDELETE /api/v2/applications/{applicationKey}/versions/{versionKey}Delete application version
LaunchDarklyApi::ApplicationsBetaApiget_applicationGET /api/v2/applications/{applicationKey}Get application by key
LaunchDarklyApi::ApplicationsBetaApiget_application_versionsGET /api/v2/applications/{applicationKey}/versionsGet application versions by application key
LaunchDarklyApi::ApplicationsBetaApiget_applicationsGET /api/v2/applicationsGet applications
LaunchDarklyApi::ApplicationsBetaApipatch_applicationPATCH /api/v2/applications/{applicationKey}Update application
LaunchDarklyApi::ApplicationsBetaApipatch_application_versionPATCH /api/v2/applications/{applicationKey}/versions/{versionKey}Update application version
LaunchDarklyApi::ApprovalsApidelete_approval_requestDELETE /api/v2/approval-requests/{id}Delete approval request
LaunchDarklyApi::ApprovalsApidelete_approval_request_for_flagDELETE /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests/{id}Delete approval request for a flag
LaunchDarklyApi::ApprovalsApiget_approval_for_flagGET /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests/{id}Get approval request for a flag
LaunchDarklyApi::ApprovalsApiget_approval_requestGET /api/v2/approval-requests/{id}Get approval request
LaunchDarklyApi::ApprovalsApiget_approval_requestsGET /api/v2/approval-requestsList approval requests
LaunchDarklyApi::ApprovalsApiget_approvals_for_flagGET /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requestsList approval requests for a flag
LaunchDarklyApi::ApprovalsApipost_approval_requestPOST /api/v2/approval-requestsCreate approval request
LaunchDarklyApi::ApprovalsApipost_approval_request_applyPOST /api/v2/approval-requests/{id}/applyApply approval request
LaunchDarklyApi::ApprovalsApipost_approval_request_apply_for_flagPOST /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests/{id}/applyApply approval request for a flag
LaunchDarklyApi::ApprovalsApipost_approval_request_for_flagPOST /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requestsCreate approval request for a flag
LaunchDarklyApi::ApprovalsApipost_approval_request_reviewPOST /api/v2/approval-requests/{id}/reviewsReview approval request
LaunchDarklyApi::ApprovalsApipost_approval_request_review_for_flagPOST /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests/{id}/reviewsReview approval request for a flag
LaunchDarklyApi::ApprovalsApipost_flag_copy_config_approval_requestPOST /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests-flag-copyCreate approval request to copy flag configurations across environments
LaunchDarklyApi::ApprovalsBetaApipatch_approval_requestPATCH /api/v2/approval-requests/{id}Update approval request
LaunchDarklyApi::ApprovalsBetaApipatch_flag_config_approval_requestPATCH /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests/{id}Update flag approval request
LaunchDarklyApi::AuditLogApiget_audit_log_entriesGET /api/v2/auditlogList audit log entries
LaunchDarklyApi::AuditLogApiget_audit_log_entryGET /api/v2/auditlog/{id}Get audit log entry
LaunchDarklyApi::AuditLogApipost_audit_log_entriesPOST /api/v2/auditlogSearch audit log entries
LaunchDarklyApi::CodeReferencesApidelete_branchesPOST /api/v2/code-refs/repositories/{repo}/branch-delete-tasksDelete branches
LaunchDarklyApi::CodeReferencesApidelete_repositoryDELETE /api/v2/code-refs/repositories/{repo}Delete repository
LaunchDarklyApi::CodeReferencesApiget_branchGET /api/v2/code-refs/repositories/{repo}/branches/{branch}Get branch
LaunchDarklyApi::CodeReferencesApiget_branchesGET /api/v2/code-refs/repositories/{repo}/branchesList branches
LaunchDarklyApi::CodeReferencesApiget_extinctionsGET /api/v2/code-refs/extinctionsList extinctions
LaunchDarklyApi::CodeReferencesApiget_repositoriesGET /api/v2/code-refs/repositoriesList repositories
LaunchDarklyApi::CodeReferencesApiget_repositoryGET /api/v2/code-refs/repositories/{repo}Get repository
LaunchDarklyApi::CodeReferencesApiget_root_statisticGET /api/v2/code-refs/statisticsGet links to code reference repositories for each project
LaunchDarklyApi::CodeReferencesApiget_statisticsGET /api/v2/code-refs/statistics/{projectKey}Get code references statistics for flags
LaunchDarklyApi::CodeReferencesApipatch_repositoryPATCH /api/v2/code-refs/repositories/{repo}Update repository
LaunchDarklyApi::CodeReferencesApipost_extinctionPOST /api/v2/code-refs/repositories/{repo}/branches/{branch}/extinction-eventsCreate extinction
LaunchDarklyApi::CodeReferencesApipost_repositoryPOST /api/v2/code-refs/repositoriesCreate repository
LaunchDarklyApi::CodeReferencesApiput_branchPUT /api/v2/code-refs/repositories/{repo}/branches/{branch}Upsert branch
LaunchDarklyApi::ContextSettingsApiput_context_flag_settingPUT /api/v2/projects/{projectKey}/environments/{environmentKey}/contexts/{contextKind}/{contextKey}/flags/{featureFlagKey}Update flag settings for context
LaunchDarklyApi::ContextsApidelete_context_instancesDELETE /api/v2/projects/{projectKey}/environments/{environmentKey}/context-instances/{id}Delete context instances
LaunchDarklyApi::ContextsApievaluate_context_instancePOST /api/v2/projects/{projectKey}/environments/{environmentKey}/flags/evaluateEvaluate flags for context instance
LaunchDarklyApi::ContextsApiget_context_attribute_namesGET /api/v2/projects/{projectKey}/environments/{environmentKey}/context-attributesGet context attribute names
LaunchDarklyApi::ContextsApiget_context_attribute_valuesGET /api/v2/projects/{projectKey}/environments/{environmentKey}/context-attributes/{attributeName}Get context attribute values
LaunchDarklyApi::ContextsApiget_context_instancesGET /api/v2/projects/{projectKey}/environments/{environmentKey}/context-instances/{id}Get context instances
LaunchDarklyApi::ContextsApiget_context_kinds_by_project_keyGET /api/v2/projects/{projectKey}/context-kindsGet context kinds
LaunchDarklyApi::ContextsApiget_contextsGET /api/v2/projects/{projectKey}/environments/{environmentKey}/contexts/{kind}/{key}Get contexts
LaunchDarklyApi::ContextsApiput_context_kindPUT /api/v2/projects/{projectKey}/context-kinds/{key}Create or update context kind
LaunchDarklyApi::ContextsApisearch_context_instancesPOST /api/v2/projects/{projectKey}/environments/{environmentKey}/context-instances/searchSearch for context instances
LaunchDarklyApi::ContextsApisearch_contextsPOST /api/v2/projects/{projectKey}/environments/{environmentKey}/contexts/searchSearch for contexts
LaunchDarklyApi::CustomRolesApidelete_custom_roleDELETE /api/v2/roles/{customRoleKey}Delete custom role
LaunchDarklyApi::CustomRolesApiget_custom_roleGET /api/v2/roles/{customRoleKey}Get custom role
LaunchDarklyApi::CustomRolesApiget_custom_rolesGET /api/v2/rolesList custom roles
LaunchDarklyApi::CustomRolesApipatch_custom_rolePATCH /api/v2/roles/{customRoleKey}Update custom role
LaunchDarklyApi::CustomRolesApipost_custom_rolePOST /api/v2/rolesCreate custom role
LaunchDarklyApi::DataExportDestinationsApidelete_destinationDELETE /api/v2/destinations/{projectKey}/{environmentKey}/{id}Delete Data Export destination
LaunchDarklyApi::DataExportDestinationsApiget_destinationGET /api/v2/destinations/{projectKey}/{environmentKey}/{id}Get destination
LaunchDarklyApi::DataExportDestinationsApiget_destinationsGET /api/v2/destinationsList destinations
LaunchDarklyApi::DataExportDestinationsApipatch_destinationPATCH /api/v2/destinations/{projectKey}/{environmentKey}/{id}Update Data Export destination
LaunchDarklyApi::DataExportDestinationsApipost_destinationPOST /api/v2/destinations/{projectKey}/{environmentKey}Create Data Export destination
LaunchDarklyApi::DataExportDestinationsApipost_generate_warehouse_destination_key_pairPOST /api/v2/destinations/generate-warehouse-destination-key-pairGenerate Snowflake destination key pair
LaunchDarklyApi::EnvironmentsApidelete_environmentDELETE /api/v2/projects/{projectKey}/environments/{environmentKey}Delete environment
LaunchDarklyApi::EnvironmentsApiget_environmentGET /api/v2/projects/{projectKey}/environments/{environmentKey}Get environment
LaunchDarklyApi::EnvironmentsApiget_environments_by_projectGET /api/v2/projects/{projectKey}/environmentsList environments
LaunchDarklyApi::EnvironmentsApipatch_environmentPATCH /api/v2/projects/{projectKey}/environments/{environmentKey}Update environment
LaunchDarklyApi::EnvironmentsApipost_environmentPOST /api/v2/projects/{projectKey}/environmentsCreate environment
LaunchDarklyApi::EnvironmentsApireset_environment_mobile_keyPOST /api/v2/projects/{projectKey}/environments/{environmentKey}/mobileKeyReset environment mobile SDK key
LaunchDarklyApi::EnvironmentsApireset_environment_sdk_keyPOST /api/v2/projects/{projectKey}/environments/{environmentKey}/apiKeyReset environment SDK key
LaunchDarklyApi::ExperimentsApicreate_experimentPOST /api/v2/projects/{projectKey}/environments/{environmentKey}/experimentsCreate experiment
LaunchDarklyApi::ExperimentsApicreate_iterationPOST /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey}/iterationsCreate iteration
LaunchDarklyApi::ExperimentsApiget_experimentGET /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey}Get experiment
LaunchDarklyApi::ExperimentsApiget_experiment_resultsGET /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey}/metrics/{metricKey}/resultsGet experiment results (Deprecated)
LaunchDarklyApi::ExperimentsApiget_experiment_results_for_metric_groupGET /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey}/metric-groups/{metricGroupKey}/resultsGet experiment results for metric group (Deprecated)
LaunchDarklyApi::ExperimentsApiget_experimentation_settingsGET /api/v2/projects/{projectKey}/experimentation-settingsGet experimentation settings
LaunchDarklyApi::ExperimentsApiget_experimentsGET /api/v2/projects/{projectKey}/environments/{environmentKey}/experimentsGet experiments
LaunchDarklyApi::ExperimentsApipatch_experimentPATCH /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey}Patch experiment
LaunchDarklyApi::ExperimentsApiput_experimentation_settingsPUT /api/v2/projects/{projectKey}/experimentation-settingsUpdate experimentation settings
LaunchDarklyApi::FeatureFlagsApicopy_feature_flagPOST /api/v2/flags/{projectKey}/{featureFlagKey}/copyCopy feature flag
LaunchDarklyApi::FeatureFlagsApidelete_feature_flagDELETE /api/v2/flags/{projectKey}/{featureFlagKey}Delete feature flag
LaunchDarklyApi::FeatureFlagsApiget_expiring_context_targetsGET /api/v2/flags/{projectKey}/{featureFlagKey}/expiring-targets/{environmentKey}Get expiring context targets for feature flag
LaunchDarklyApi::FeatureFlagsApiget_expiring_user_targetsGET /api/v2/flags/{projectKey}/{featureFlagKey}/expiring-user-targets/{environmentKey}Get expiring user targets for feature flag
LaunchDarklyApi::FeatureFlagsApiget_feature_flagGET /api/v2/flags/{projectKey}/{featureFlagKey}Get feature flag
LaunchDarklyApi::FeatureFlagsApiget_feature_flag_statusGET /api/v2/flag-statuses/{projectKey}/{environmentKey}/{featureFlagKey}Get feature flag status
LaunchDarklyApi::FeatureFlagsApiget_feature_flag_status_across_environmentsGET /api/v2/flag-status/{projectKey}/{featureFlagKey}Get flag status across environments
LaunchDarklyApi::FeatureFlagsApiget_feature_flag_statusesGET /api/v2/flag-statuses/{projectKey}/{environmentKey}List feature flag statuses
LaunchDarklyApi::FeatureFlagsApiget_feature_flagsGET /api/v2/flags/{projectKey}List feature flags
LaunchDarklyApi::FeatureFlagsApipatch_expiring_targetsPATCH /api/v2/flags/{projectKey}/{featureFlagKey}/expiring-targets/{environmentKey}Update expiring context targets on feature flag
LaunchDarklyApi::FeatureFlagsApipatch_expiring_user_targetsPATCH /api/v2/flags/{projectKey}/{featureFlagKey}/expiring-user-targets/{environmentKey}Update expiring user targets on feature flag
LaunchDarklyApi::FeatureFlagsApipatch_feature_flagPATCH /api/v2/flags/{projectKey}/{featureFlagKey}Update feature flag
LaunchDarklyApi::FeatureFlagsApipost_feature_flagPOST /api/v2/flags/{projectKey}Create a feature flag
LaunchDarklyApi::FeatureFlagsApipost_migration_safety_issuesPOST /api/v2/projects/{projectKey}/flags/{flagKey}/environments/{environmentKey}/migration-safety-issuesGet migration safety issues
LaunchDarklyApi::FeatureFlagsBetaApiget_dependent_flagsGET /api/v2/flags/{projectKey}/{featureFlagKey}/dependent-flagsList dependent feature flags
LaunchDarklyApi::FeatureFlagsBetaApiget_dependent_flags_by_envGET /api/v2/flags/{projectKey}/{environmentKey}/{featureFlagKey}/dependent-flagsList dependent feature flags by environment
LaunchDarklyApi::FlagImportConfigurationsBetaApicreate_flag_import_configurationPOST /api/v2/integration-capabilities/flag-import/{projectKey}/{integrationKey}Create a flag import configuration
LaunchDarklyApi::FlagImportConfigurationsBetaApidelete_flag_import_configurationDELETE /api/v2/integration-capabilities/flag-import/{projectKey}/{integrationKey}/{integrationId}Delete a flag import configuration
LaunchDarklyApi::FlagImportConfigurationsBetaApiget_flag_import_configurationGET /api/v2/integration-capabilities/flag-import/{projectKey}/{integrationKey}/{integrationId}Get a single flag import configuration
LaunchDarklyApi::FlagImportConfigurationsBetaApiget_flag_import_configurationsGET /api/v2/integration-capabilities/flag-importList all flag import configurations
LaunchDarklyApi::FlagImportConfigurationsBetaApipatch_flag_import_configurationPATCH /api/v2/integration-capabilities/flag-import/{projectKey}/{integrationKey}/{integrationId}Update a flag import configuration
LaunchDarklyApi::FlagImportConfigurationsBetaApitrigger_flag_import_jobPOST /api/v2/integration-capabilities/flag-import/{projectKey}/{integrationKey}/{integrationId}/triggerTrigger a single flag import run
LaunchDarklyApi::FlagLinksBetaApicreate_flag_linkPOST /api/v2/flag-links/projects/{projectKey}/flags/{featureFlagKey}Create flag link
LaunchDarklyApi::FlagLinksBetaApidelete_flag_linkDELETE /api/v2/flag-links/projects/{projectKey}/flags/{featureFlagKey}/{id}Delete flag link
LaunchDarklyApi::FlagLinksBetaApiget_flag_linksGET /api/v2/flag-links/projects/{projectKey}/flags/{featureFlagKey}List flag links
LaunchDarklyApi::FlagLinksBetaApiupdate_flag_linkPATCH /api/v2/flag-links/projects/{projectKey}/flags/{featureFlagKey}/{id}Update flag link
LaunchDarklyApi::FlagTriggersApicreate_trigger_workflowPOST /api/v2/flags/{projectKey}/{featureFlagKey}/triggers/{environmentKey}Create flag trigger
LaunchDarklyApi::FlagTriggersApidelete_trigger_workflowDELETE /api/v2/flags/{projectKey}/{featureFlagKey}/triggers/{environmentKey}/{id}Delete flag trigger
LaunchDarklyApi::FlagTriggersApiget_trigger_workflow_by_idGET /api/v2/flags/{projectKey}/{featureFlagKey}/triggers/{environmentKey}/{id}Get flag trigger by ID
LaunchDarklyApi::FlagTriggersApiget_trigger_workflowsGET /api/v2/flags/{projectKey}/{featureFlagKey}/triggers/{environmentKey}List flag triggers
LaunchDarklyApi::FlagTriggersApipatch_trigger_workflowPATCH /api/v2/flags/{projectKey}/{featureFlagKey}/triggers/{environmentKey}/{id}Update flag trigger
LaunchDarklyApi::FollowFlagsApidelete_flag_followerDELETE /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/followers/{memberId}Remove a member as a follower of a flag in a project and environment
LaunchDarklyApi::FollowFlagsApiget_flag_followersGET /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/followersGet followers of a flag in a project and environment
LaunchDarklyApi::FollowFlagsApiget_followers_by_proj_envGET /api/v2/projects/{projectKey}/environments/{environmentKey}/followersGet followers of all flags in a given project and environment
LaunchDarklyApi::FollowFlagsApiput_flag_followerPUT /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/followers/{memberId}Add a member as a follower of a flag in a project and environment
LaunchDarklyApi::HoldoutsBetaApiget_all_holdoutsGET /api/v2/projects/{projectKey}/environments/{environmentKey}/holdoutsGet all holdouts
LaunchDarklyApi::HoldoutsBetaApiget_holdoutGET /api/v2/projects/{projectKey}/environments/{environmentKey}/holdouts/{holdoutKey}Get holdout
LaunchDarklyApi::HoldoutsBetaApiget_holdout_by_idGET /api/v2/projects/{projectKey}/environments/{environmentKey}/holdouts/id/{holdoutId}Get Holdout by Id
LaunchDarklyApi::HoldoutsBetaApipatch_holdoutPATCH /api/v2/projects/{projectKey}/environments/{environmentKey}/holdouts/{holdoutKey}Patch holdout
LaunchDarklyApi::HoldoutsBetaApipost_holdoutPOST /api/v2/projects/{projectKey}/environments/{environmentKey}/holdoutsCreate holdout
LaunchDarklyApi::InsightsChartsBetaApiget_deployment_frequency_chartGET /api/v2/engineering-insights/charts/deployments/frequencyGet deployment frequency chart data
LaunchDarklyApi::InsightsChartsBetaApiget_flag_status_chartGET /api/v2/engineering-insights/charts/flags/statusGet flag status chart data
LaunchDarklyApi::InsightsChartsBetaApiget_lead_time_chartGET /api/v2/engineering-insights/charts/lead-timeGet lead time chart data
LaunchDarklyApi::InsightsChartsBetaApiget_release_frequency_chartGET /api/v2/engineering-insights/charts/releases/frequencyGet release frequency chart data
LaunchDarklyApi::InsightsChartsBetaApiget_stale_flags_chartGET /api/v2/engineering-insights/charts/flags/staleGet stale flags chart data
LaunchDarklyApi::InsightsDeploymentsBetaApicreate_deployment_eventPOST /api/v2/engineering-insights/deployment-eventsCreate deployment event
LaunchDarklyApi::InsightsDeploymentsBetaApiget_deploymentGET /api/v2/engineering-insights/deployments/{deploymentID}Get deployment
LaunchDarklyApi::InsightsDeploymentsBetaApiget_deploymentsGET /api/v2/engineering-insights/deploymentsList deployments
LaunchDarklyApi::InsightsDeploymentsBetaApiupdate_deploymentPATCH /api/v2/engineering-insights/deployments/{deploymentID}Update deployment
LaunchDarklyApi::InsightsFlagEventsBetaApiget_flag_eventsGET /api/v2/engineering-insights/flag-eventsList flag events
LaunchDarklyApi::InsightsPullRequestsBetaApiget_pull_requestsGET /api/v2/engineering-insights/pull-requestsList pull requests
LaunchDarklyApi::InsightsRepositoriesBetaApiassociate_repositories_and_projectsPUT /api/v2/engineering-insights/repositories/projectsAssociate repositories with projects
LaunchDarklyApi::InsightsRepositoriesBetaApidelete_repository_projectDELETE /api/v2/engineering-insights/repositories/{repositoryKey}/projects/{projectKey}Remove repository project association
LaunchDarklyApi::InsightsRepositoriesBetaApiget_insights_repositoriesGET /api/v2/engineering-insights/repositoriesList repositories
LaunchDarklyApi::InsightsScoresBetaApicreate_insight_groupPOST /api/v2/engineering-insights/insights/groupCreate insight group
LaunchDarklyApi::InsightsScoresBetaApidelete_insight_groupDELETE /api/v2/engineering-insights/insights/groups/{insightGroupKey}Delete insight group
LaunchDarklyApi::InsightsScoresBetaApiget_insight_groupGET /api/v2/engineering-insights/insights/groups/{insightGroupKey}Get insight group
LaunchDarklyApi::InsightsScoresBetaApiget_insight_groupsGET /api/v2/engineering-insights/insights/groupsList insight groups
LaunchDarklyApi::InsightsScoresBetaApiget_insights_scoresGET /api/v2/engineering-insights/insights/scoresGet insight scores
LaunchDarklyApi::InsightsScoresBetaApipatch_insight_groupPATCH /api/v2/engineering-insights/insights/groups/{insightGroupKey}Patch insight group
LaunchDarklyApi::IntegrationAuditLogSubscriptionsApicreate_subscriptionPOST /api/v2/integrations/{integrationKey}Create audit log subscription
LaunchDarklyApi::IntegrationAuditLogSubscriptionsApidelete_subscriptionDELETE /api/v2/integrations/{integrationKey}/{id}Delete audit log subscription
LaunchDarklyApi::IntegrationAuditLogSubscriptionsApiget_subscription_by_idGET /api/v2/integrations/{integrationKey}/{id}Get audit log subscription by ID
LaunchDarklyApi::IntegrationAuditLogSubscriptionsApiget_subscriptionsGET /api/v2/integrations/{integrationKey}Get audit log subscriptions by integration
LaunchDarklyApi::IntegrationAuditLogSubscriptionsApiupdate_subscriptionPATCH /api/v2/integrations/{integrationKey}/{id}Update audit log subscription
LaunchDarklyApi::IntegrationDeliveryConfigurationsBetaApicreate_integration_delivery_configurationPOST /api/v2/integration-capabilities/featureStore/{projectKey}/{environmentKey}/{integrationKey}Create delivery configuration
LaunchDarklyApi::IntegrationDeliveryConfigurationsBetaApidelete_integration_delivery_configurationDELETE /api/v2/integration-capabilities/featureStore/{projectKey}/{environmentKey}/{integrationKey}/{id}Delete delivery configuration
LaunchDarklyApi::IntegrationDeliveryConfigurationsBetaApiget_integration_delivery_configuration_by_environmentGET /api/v2/integration-capabilities/featureStore/{projectKey}/{environmentKey}Get delivery configurations by environment
LaunchDarklyApi::IntegrationDeliveryConfigurationsBetaApiget_integration_delivery_configuration_by_idGET /api/v2/integration-capabilities/featureStore/{projectKey}/{environmentKey}/{integrationKey}/{id}Get delivery configuration by ID
LaunchDarklyApi::IntegrationDeliveryConfigurationsBetaApiget_integration_delivery_configurationsGET /api/v2/integration-capabilities/featureStoreList all delivery configurations
LaunchDarklyApi::IntegrationDeliveryConfigurationsBetaApipatch_integration_delivery_configurationPATCH /api/v2/integration-capabilities/featureStore/{projectKey}/{environmentKey}/{integrationKey}/{id}Update delivery configuration
LaunchDarklyApi::IntegrationDeliveryConfigurationsBetaApivalidate_integration_delivery_configurationPOST /api/v2/integration-capabilities/featureStore/{projectKey}/{environmentKey}/{integrationKey}/{id}/validateValidate delivery configuration
LaunchDarklyApi::IntegrationsBetaApicreate_integration_configurationPOST /api/v2/integration-configurations/keys/{integrationKey}Create integration configuration
LaunchDarklyApi::IntegrationsBetaApidelete_integration_configurationDELETE /api/v2/integration-configurations/{integrationConfigurationId}Delete integration configuration
LaunchDarklyApi::IntegrationsBetaApiget_all_integration_configurationsGET /api/v2/integration-configurations/keys/{integrationKey}Get all configurations for the integration
LaunchDarklyApi::IntegrationsBetaApiget_integration_configurationGET /api/v2/integration-configurations/{integrationConfigurationId}Get an integration configuration
LaunchDarklyApi::IntegrationsBetaApiupdate_integration_configurationPATCH /api/v2/integration-configurations/{integrationConfigurationId}Update integration configuration
LaunchDarklyApi::LayersApicreate_layerPOST /api/v2/projects/{projectKey}/layersCreate layer
LaunchDarklyApi::LayersApiget_layersGET /api/v2/projects/{projectKey}/layersGet layers
LaunchDarklyApi::LayersApiupdate_layerPATCH /api/v2/projects/{projectKey}/layers/{layerKey}Update layer
LaunchDarklyApi::MetricsApidelete_metricDELETE /api/v2/metrics/{projectKey}/{metricKey}Delete metric
LaunchDarklyApi::MetricsApiget_metricGET /api/v2/metrics/{projectKey}/{metricKey}Get metric
LaunchDarklyApi::MetricsApiget_metricsGET /api/v2/metrics/{projectKey}List metrics
LaunchDarklyApi::MetricsApipatch_metricPATCH /api/v2/metrics/{projectKey}/{metricKey}Update metric
LaunchDarklyApi::MetricsApipost_metricPOST /api/v2/metrics/{projectKey}Create metric
LaunchDarklyApi::MetricsBetaApicreate_metric_groupPOST /api/v2/projects/{projectKey}/metric-groupsCreate metric group
LaunchDarklyApi::MetricsBetaApidelete_metric_groupDELETE /api/v2/projects/{projectKey}/metric-groups/{metricGroupKey}Delete metric group
LaunchDarklyApi::MetricsBetaApiget_metric_groupGET /api/v2/projects/{projectKey}/metric-groups/{metricGroupKey}Get metric group
LaunchDarklyApi::MetricsBetaApiget_metric_groupsGET /api/v2/projects/{projectKey}/metric-groupsList metric groups
LaunchDarklyApi::MetricsBetaApipatch_metric_groupPATCH /api/v2/projects/{projectKey}/metric-groups/{metricGroupKey}Patch metric group
LaunchDarklyApi::OAuth2ClientsApicreate_o_auth2_clientPOST /api/v2/oauth/clientsCreate a LaunchDarkly OAuth 2.0 client
LaunchDarklyApi::OAuth2ClientsApidelete_o_auth_clientDELETE /api/v2/oauth/clients/{clientId}Delete OAuth 2.0 client
LaunchDarklyApi::OAuth2ClientsApiget_o_auth_client_by_idGET /api/v2/oauth/clients/{clientId}Get client by ID
LaunchDarklyApi::OAuth2ClientsApiget_o_auth_clientsGET /api/v2/oauth/clientsGet clients
LaunchDarklyApi::OAuth2ClientsApipatch_o_auth_clientPATCH /api/v2/oauth/clients/{clientId}Patch client by ID
LaunchDarklyApi::OtherApiget_caller_identityGET /api/v2/caller-identityIdentify the caller
LaunchDarklyApi::OtherApiget_ipsGET /api/v2/public-ip-listGets the public IP list
LaunchDarklyApi::OtherApiget_openapi_specGET /api/v2/openapi.jsonGets the OpenAPI spec in json
LaunchDarklyApi::OtherApiget_rootGET /api/v2Root resource
LaunchDarklyApi::OtherApiget_versionsGET /api/v2/versionsGet version information
LaunchDarklyApi::PersistentStoreIntegrationsBetaApicreate_big_segment_store_integrationPOST /api/v2/integration-capabilities/big-segment-store/{projectKey}/{environmentKey}/{integrationKey}Create big segment store integration
LaunchDarklyApi::PersistentStoreIntegrationsBetaApidelete_big_segment_store_integrationDELETE /api/v2/integration-capabilities/big-segment-store/{projectKey}/{environmentKey}/{integrationKey}/{integrationId}Delete big segment store integration
LaunchDarklyApi::PersistentStoreIntegrationsBetaApiget_big_segment_store_integrationGET /api/v2/integration-capabilities/big-segment-store/{projectKey}/{environmentKey}/{integrationKey}/{integrationId}Get big segment store integration by ID
LaunchDarklyApi::PersistentStoreIntegrationsBetaApiget_big_segment_store_integrationsGET /api/v2/integration-capabilities/big-segment-storeList all big segment store integrations
LaunchDarklyApi::PersistentStoreIntegrationsBetaApipatch_big_segment_store_integrationPATCH /api/v2/integration-capabilities/big-segment-store/{projectKey}/{environmentKey}/{integrationKey}/{integrationId}Update big segment store integration
LaunchDarklyApi::ProjectsApidelete_projectDELETE /api/v2/projects/{projectKey}Delete project
LaunchDarklyApi::ProjectsApiget_flag_defaults_by_projectGET /api/v2/projects/{projectKey}/flag-defaultsGet flag defaults for project
LaunchDarklyApi::ProjectsApiget_projectGET /api/v2/projects/{projectKey}Get project
LaunchDarklyApi::ProjectsApiget_projectsGET /api/v2/projectsList projects
LaunchDarklyApi::ProjectsApipatch_flag_defaults_by_projectPATCH /api/v2/projects/{projectKey}/flag-defaultsUpdate flag default for project
LaunchDarklyApi::ProjectsApipatch_projectPATCH /api/v2/projects/{projectKey}Update project
LaunchDarklyApi::ProjectsApipost_projectPOST /api/v2/projectsCreate project
LaunchDarklyApi::ProjectsApiput_flag_defaults_by_projectPUT /api/v2/projects/{projectKey}/flag-defaultsCreate or update flag defaults for project
LaunchDarklyApi::RelayProxyConfigurationsApidelete_relay_auto_configDELETE /api/v2/account/relay-auto-configs/{id}Delete Relay Proxy config by ID
LaunchDarklyApi::RelayProxyConfigurationsApiget_relay_proxy_configGET /api/v2/account/relay-auto-configs/{id}Get Relay Proxy config
LaunchDarklyApi::RelayProxyConfigurationsApiget_relay_proxy_configsGET /api/v2/account/relay-auto-configsList Relay Proxy configs
LaunchDarklyApi::RelayProxyConfigurationsApipatch_relay_auto_configPATCH /api/v2/account/relay-auto-configs/{id}Update a Relay Proxy config
LaunchDarklyApi::RelayProxyConfigurationsApipost_relay_auto_configPOST /api/v2/account/relay-auto-configsCreate a new Relay Proxy config
LaunchDarklyApi::RelayProxyConfigurationsApireset_relay_auto_configPOST /api/v2/account/relay-auto-configs/{id}/resetReset Relay Proxy configuration key
LaunchDarklyApi::ReleasePipelinesBetaApidelete_release_pipelineDELETE /api/v2/projects/{projectKey}/release-pipelines/{pipelineKey}Delete release pipeline
LaunchDarklyApi::ReleasePipelinesBetaApiget_all_release_pipelinesGET /api/v2/projects/{projectKey}/release-pipelinesGet all release pipelines
LaunchDarklyApi::ReleasePipelinesBetaApiget_all_release_progressions_for_release_pipelineGET /api/v2/projects/{projectKey}/release-pipelines/{pipelineKey}/releasesGet release progressions for release pipeline
LaunchDarklyApi::ReleasePipelinesBetaApiget_release_pipeline_by_keyGET /api/v2/projects/{projectKey}/release-pipelines/{pipelineKey}Get release pipeline by key
LaunchDarklyApi::ReleasePipelinesBetaApipost_release_pipelinePOST /api/v2/projects/{projectKey}/release-pipelinesCreate a release pipeline
LaunchDarklyApi::ReleasePipelinesBetaApiput_release_pipelinePUT /api/v2/projects/{projectKey}/release-pipelines/{pipelineKey}Update a release pipeline
LaunchDarklyApi::ReleasesBetaApicreate_release_for_flagPUT /api/v2/projects/{projectKey}/flags/{flagKey}/releaseCreate a new release for flag
LaunchDarklyApi::ReleasesBetaApidelete_release_by_flag_keyDELETE /api/v2/flags/{projectKey}/{flagKey}/releaseDelete a release for flag
LaunchDarklyApi::ReleasesBetaApiget_release_by_flag_keyGET /api/v2/flags/{projectKey}/{flagKey}/releaseGet release for flag
LaunchDarklyApi::ReleasesBetaApipatch_release_by_flag_keyPATCH /api/v2/flags/{projectKey}/{flagKey}/releasePatch release for flag
LaunchDarklyApi::ReleasesBetaApiupdate_phase_statusPUT /api/v2/projects/{projectKey}/flags/{flagKey}/release/phases/{phaseId}Update phase status for release
LaunchDarklyApi::ScheduledChangesApidelete_flag_config_scheduled_changesDELETE /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/scheduled-changes/{id}Delete scheduled changes workflow
LaunchDarklyApi::ScheduledChangesApiget_feature_flag_scheduled_changeGET /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/scheduled-changes/{id}Get a scheduled change
LaunchDarklyApi::ScheduledChangesApiget_flag_config_scheduled_changesGET /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/scheduled-changesList scheduled changes
LaunchDarklyApi::ScheduledChangesApipatch_flag_config_scheduled_changePATCH /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/scheduled-changes/{id}Update scheduled changes workflow
LaunchDarklyApi::ScheduledChangesApipost_flag_config_scheduled_changesPOST /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/scheduled-changesCreate scheduled changes workflow
LaunchDarklyApi::SegmentsApicreate_big_segment_exportPOST /api/v2/segments/{projectKey}/{environmentKey}/{segmentKey}/exportsCreate big segment export
LaunchDarklyApi::SegmentsApicreate_big_segment_importPOST /api/v2/segments/{projectKey}/{environmentKey}/{segmentKey}/importsCreate big segment import
LaunchDarklyApi::SegmentsApidelete_segmentDELETE /api/v2/segments/{projectKey}/{environmentKey}/{segmentKey}Delete segment
LaunchDarklyApi::SegmentsApiget_big_segment_exportGET /api/v2/segments/{projectKey}/{environmentKey}/{segmentKey}/exports/{exportID}Get big segment export
LaunchDarklyApi::SegmentsApiget_big_segment_importGET /api/v2/segments/{projectKey}/{environmentKey}/{segmentKey}/imports/{importID}Get big segment import
LaunchDarklyApi::SegmentsApiget_context_instance_segments_membership_by_envPOST /api/v2/projects/{projectKey}/environments/{environmentKey}/segments/evaluateList segment memberships for context instance
LaunchDarklyApi::SegmentsApiget_expiring_targets_for_segmentGET /api/v2/segments/{projectKey}/{segmentKey}/expiring-targets/{environmentKey}Get expiring targets for segment
LaunchDarklyApi::SegmentsApiget_expiring_user_targets_for_segmentGET /api/v2/segments/{projectKey}/{segmentKey}/expiring-user-targets/{environmentKey}Get expiring user targets for segment
LaunchDarklyApi::SegmentsApiget_segmentGET /api/v2/segments/{projectKey}/{environmentKey}/{segmentKey}Get segment
LaunchDarklyApi::SegmentsApiget_segment_membership_for_contextGET /api/v2/segments/{projectKey}/{environmentKey}/{segmentKey}/contexts/{contextKey}Get big segment membership for context
LaunchDarklyApi::SegmentsApiget_segment_membership_for_userGET /api/v2/segments/{projectKey}/{environmentKey}/{segmentKey}/users/{userKey}Get big segment membership for user
LaunchDarklyApi::SegmentsApiget_segmentsGET /api/v2/segments/{projectKey}/{environmentKey}List segments
LaunchDarklyApi::SegmentsApipatch_expiring_targets_for_segmentPATCH /api/v2/segments/{projectKey}/{segmentKey}/expiring-targets/{environmentKey}Update expiring targets for segment
LaunchDarklyApi::SegmentsApipatch_expiring_user_targets_for_segmentPATCH /api/v2/segments/{projectKey}/{segmentKey}/expiring-user-targets/{environmentKey}Update expiring user targets for segment
LaunchDarklyApi::SegmentsApipatch_segmentPATCH /api/v2/segments/{projectKey}/{environmentKey}/{segmentKey}Patch segment
LaunchDarklyApi::SegmentsApipost_segmentPOST /api/v2/segments/{projectKey}/{environmentKey}Create segment
LaunchDarklyApi::SegmentsApiupdate_big_segment_context_targetsPOST /api/v2/segments/{projectKey}/{environmentKey}/{segmentKey}/contextsUpdate context targets on a big segment
LaunchDarklyApi::SegmentsApiupdate_big_segment_targetsPOST /api/v2/segments/{projectKey}/{environmentKey}/{segmentKey}/usersUpdate user context targets on a big segment
LaunchDarklyApi::TagsApiget_tagsGET /api/v2/tagsList tags
LaunchDarklyApi::TeamsApidelete_teamDELETE /api/v2/teams/{teamKey}Delete team
LaunchDarklyApi::TeamsApiget_teamGET /api/v2/teams/{teamKey}Get team
LaunchDarklyApi::TeamsApiget_team_maintainersGET /api/v2/teams/{teamKey}/maintainersGet team maintainers
LaunchDarklyApi::TeamsApiget_team_rolesGET /api/v2/teams/{teamKey}/rolesGet team custom roles
LaunchDarklyApi::TeamsApiget_teamsGET /api/v2/teamsList teams
LaunchDarklyApi::TeamsApipatch_teamPATCH /api/v2/teams/{teamKey}Update team
LaunchDarklyApi::TeamsApipost_teamPOST /api/v2/teamsCreate team
LaunchDarklyApi::TeamsApipost_team_membersPOST /api/v2/teams/{teamKey}/membersAdd multiple members to team
LaunchDarklyApi::TeamsBetaApipatch_teamsPATCH /api/v2/teamsUpdate teams
LaunchDarklyApi::UserSettingsApiget_expiring_flags_for_userGET /api/v2/users/{projectKey}/{userKey}/expiring-user-targets/{environmentKey}Get expiring dates on flags for user
LaunchDarklyApi::UserSettingsApiget_user_flag_settingGET /api/v2/users/{projectKey}/{environmentKey}/{userKey}/flags/{featureFlagKey}Get flag setting for user
LaunchDarklyApi::UserSettingsApiget_user_flag_settingsGET /api/v2/users/{projectKey}/{environmentKey}/{userKey}/flagsList flag settings for user
LaunchDarklyApi::UserSettingsApipatch_expiring_flags_for_userPATCH /api/v2/users/{projectKey}/{userKey}/expiring-user-targets/{environmentKey}Update expiring user target for flags
LaunchDarklyApi::UserSettingsApiput_flag_settingPUT /api/v2/users/{projectKey}/{environmentKey}/{userKey}/flags/{featureFlagKey}Update flag settings for user
LaunchDarklyApi::UsersApidelete_userDELETE /api/v2/users/{projectKey}/{environmentKey}/{userKey}Delete user
LaunchDarklyApi::UsersApiget_search_usersGET /api/v2/user-search/{projectKey}/{environmentKey}Find users
LaunchDarklyApi::UsersApiget_userGET /api/v2/users/{projectKey}/{environmentKey}/{userKey}Get user
LaunchDarklyApi::UsersApiget_usersGET /api/v2/users/{projectKey}/{environmentKey}List users
LaunchDarklyApi::UsersBetaApiget_user_attribute_namesGET /api/v2/user-attributes/{projectKey}/{environmentKey}Get user attribute names
LaunchDarklyApi::WebhooksApidelete_webhookDELETE /api/v2/webhooks/{id}Delete webhook
LaunchDarklyApi::WebhooksApiget_all_webhooksGET /api/v2/webhooksList webhooks
LaunchDarklyApi::WebhooksApiget_webhookGET /api/v2/webhooks/{id}Get webhook
LaunchDarklyApi::WebhooksApipatch_webhookPATCH /api/v2/webhooks/{id}Update webhook
LaunchDarklyApi::WebhooksApipost_webhookPOST /api/v2/webhooksCreates a webhook
LaunchDarklyApi::WorkflowTemplatesApicreate_workflow_templatePOST /api/v2/templatesCreate workflow template
LaunchDarklyApi::WorkflowTemplatesApidelete_workflow_templateDELETE /api/v2/templates/{templateKey}Delete workflow template
LaunchDarklyApi::WorkflowTemplatesApiget_workflow_templatesGET /api/v2/templatesGet workflow templates
LaunchDarklyApi::WorkflowsApidelete_workflowDELETE /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/workflows/{workflowId}Delete workflow
LaunchDarklyApi::WorkflowsApiget_custom_workflowGET /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/workflows/{workflowId}Get custom workflow
LaunchDarklyApi::WorkflowsApiget_workflowsGET /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/workflowsGet workflows
LaunchDarklyApi::WorkflowsApipost_workflowPOST /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/workflowsCreate workflow

Documentation for Models

Documentation for Authorization

ApiKey

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

Sample Code

# Load the gem
require 'launchdarkly_api'
require 'launchdarkly_api/models/variation'

# Setup authorization
LaunchDarklyApi.configure do |config|
  config.api_key['ApiKey'] = ENV['LD_API_KEY']
  config.debugging = true
end

api_instance = LaunchDarklyApi::FeatureFlagsApi.new

project_key = "openapi"
flag_key = "test-ruby"

# Create a flag with a json variations
body = LaunchDarklyApi::FeatureFlagBody.new(
  name: "test-ruby",
  key: flag_key,
  variations: [
    LaunchDarklyApi::Variation.new({value: [1,2]}),
    LaunchDarklyApi::Variation.new({value: [3,4]}),
    LaunchDarklyApi::Variation.new({value: [5]}),
  ])

begin
  result = api_instance.post_feature_flag(project_key, body)
  p result
rescue LaunchDarklyApi::ApiError => e
  puts "Exception creating feature flag: #{e}"
end

# Clean up new flag
begin
  result = api_instance.delete_feature_flag(project_key, flag_key)
  p result
rescue LaunchDarklyApi::ApiError => e
  puts "Exception deleting feature flag: #{e}"
end

FAQs

Package last updated on 04 Apr 2025

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

Malicious Koishi Chatbot Plugin Exfiltrates Messages Triggered by 8-Character Hex Strings

Research

Security News

Malicious Koishi Chatbot Plugin Exfiltrates Messages Triggered by 8-Character Hex Strings

Malicious Koishi plugin silently exfiltrates messages with hex strings to a hardcoded QQ account, exposing secrets in chatbots across platforms.

By Kirill Boychenko  -  May 19, 2025