Skip to content

Latest commit

 

History

History
1257 lines (1076 loc) · 107 KB

README.md

File metadata and controls

1257 lines (1076 loc) · 107 KB
Raw

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, version 20220603. Previous versions of this client library, prior to version 10.0.0, are only 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.

api-client

LaunchDarkly REST API

  • API version: 2.0
    • Build date: 2024-10-14T10:32:25.406590Z[Etc/UTC]

Overview

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 mechanism Allowed resources Use cases
Personal or service access tokens Can be customized on a per-token basis Building scripts, custom integrations, data export.
SDK keys Can only access read-only resources specific to server-side SDKs. Restricted to a single environment. Server-side SDKs
Mobile keys Can 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 ID Can 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\"} ]
}

If any instruction in the patch encounters an error, the endpoint returns an error and will not change the resource. In general, each instruction silently does nothing if the resource is 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

Code Definition Description Possible Solution
400 Invalid request The request cannot be understood. Ensure JSON syntax in request body is correct.
401 Invalid access token Requestor is unauthorized or does not have permission for this API call. Ensure your API access token is valid and has the appropriate permissions.
403 Forbidden Requestor does not have access to this resource. Ensure that the account member or access token has proper permissions set.
404 Invalid resource identifier The requested resource is not valid. Ensure that the resource is correctly identified by ID or key.
405 Method not allowed The request method is not allowed on this resource. Ensure that the HTTP verb is correct.
409 Conflict The API request can not be completed because it conflicts with a concurrent API request. Retry your request.
422 Unprocessable entity The 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.
429 Too many requests Read 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 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 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 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 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. In the "Try it" sandbox for each request, click the request path to view the complete resource path for the federal environment.

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

<div style="width:75px">Version Changes End 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 endpoint:
    • Response is now paginated with a default limit of 25
  • Changed the list account members endpoint:
    • The accessCheck filter is no longer available
  • Changed the list custom roles endpoint:
    • Response is now paginated with a default limit of 20
  • Changed the list 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 filterEnv query parameter supports a maximum of three environments
    • The followerId, hasDataExport, status, contextKindTargeted, and segmentTargeted filters are no longer available
  • Changed the list segments endpoint:
    • Response is now paginated with a default limit of 20
  • Changed the list 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 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 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 return value:
    • The environments field is now expandable. This field is omitted by default.
 2025-04-15
20210729
  • Changed the create approval request return value. It now returns HTTP Status Code 201 instead of 200.
  • Changed the get users 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 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.

For more information, please visit https://support.launchdarkly.com

Automatically generated by the OpenAPI Generator

Requirements

Building the API client library requires:

  1. Java 1.8+
  2. Maven (3.8.3+)/Gradle (7.2+)

Installation

To install the API client library to your local Maven repository, simply execute:

mvn clean install

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

mvn clean deploy

Refer to the OSSRH Guide for more information.

Maven users

Add this dependency to your project's POM:

<dependency>
  <groupId>com.launchdarkly</groupId>
  <artifactId>api-client</artifactId>
  <version>17.0.0</version>
  <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

  repositories {
    mavenCentral()     // Needed if the 'api-client' jar has been published to maven central.
    mavenLocal()       // Needed if the 'api-client' jar has been published to the local maven repo.
  }

  dependencies {
     implementation "com.launchdarkly:api-client:17.0.0"
  }

Others

At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

  • target/api-client-17.0.0.jar
  • target/lib/*.jar

Getting Started

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

// Import classes:
import com.launchdarkly.api.ApiClient;
import com.launchdarkly.api.ApiException;
import com.launchdarkly.api.Configuration;
import com.launchdarkly.api.auth.*;
import com.launchdarkly.api.models.*;
import com.launchdarkly.api.api.AccessTokensApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://app.launchdarkly.com");
    
    // Configure API key authorization: ApiKey
    ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
    ApiKey.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //ApiKey.setApiKeyPrefix("Token");

    AccessTokensApi apiInstance = new AccessTokensApi(defaultClient);
    String id = "id_example"; // String | The ID of the access token to update
    try {
      apiInstance.deleteToken(id);
    } catch (ApiException e) {
      System.err.println("Exception when calling AccessTokensApi#deleteToken");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Documentation for API Endpoints

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

Class Method HTTP request Description
AccessTokensApi deleteToken DELETE /api/v2/tokens/{id} Delete access token
AccessTokensApi getToken GET /api/v2/tokens/{id} Get access token
AccessTokensApi getTokens GET /api/v2/tokens List access tokens
AccessTokensApi patchToken PATCH /api/v2/tokens/{id} Patch access token
AccessTokensApi postToken POST /api/v2/tokens Create access token
AccessTokensApi resetToken POST /api/v2/tokens/{id}/reset Reset access token
AccountMembersApi deleteMember DELETE /api/v2/members/{id} Delete account member
AccountMembersApi getMember GET /api/v2/members/{id} Get account member
AccountMembersApi getMembers GET /api/v2/members List account members
AccountMembersApi patchMember PATCH /api/v2/members/{id} Modify an account member
AccountMembersApi postMemberTeams POST /api/v2/members/{id}/teams Add a member to teams
AccountMembersApi postMembers POST /api/v2/members Invite new members
AccountMembersBetaApi patchMembers PATCH /api/v2/members Modify account members
AccountUsageBetaApi getDataExportEventsUsage GET /api/v2/usage/data-export-events Get data export events usage
AccountUsageBetaApi getEvaluationsUsage GET /api/v2/usage/evaluations/{projectKey}/{environmentKey}/{featureFlagKey} Get evaluations usage
AccountUsageBetaApi getEventsUsage GET /api/v2/usage/events/{type} Get events usage
AccountUsageBetaApi getExperimentationKeysUsage GET /api/v2/usage/experimentation-keys Get experimentation keys usage
AccountUsageBetaApi getExperimentationUnitsUsage GET /api/v2/usage/experimentation-units Get experimentation units usage
AccountUsageBetaApi getMauSdksByType GET /api/v2/usage/mau/sdks Get MAU SDKs by type
AccountUsageBetaApi getMauUsage GET /api/v2/usage/mau Get MAU usage
AccountUsageBetaApi getMauUsageByCategory GET /api/v2/usage/mau/bycategory Get MAU usage by category
AccountUsageBetaApi getServiceConnectionUsage GET /api/v2/usage/service-connections Get service connection usage
AccountUsageBetaApi getStreamUsage GET /api/v2/usage/streams/{source} Get stream usage
AccountUsageBetaApi getStreamUsageBySdkVersion GET /api/v2/usage/streams/{source}/bysdkversion Get stream usage by SDK version
AccountUsageBetaApi getStreamUsageSdkversion GET /api/v2/usage/streams/{source}/sdkversions Get stream usage SDK versions
ApplicationsBetaApi deleteApplication DELETE /api/v2/applications/{applicationKey} Delete application
ApplicationsBetaApi deleteApplicationVersion DELETE /api/v2/applications/{applicationKey}/versions/{versionKey} Delete application version
ApplicationsBetaApi getApplication GET /api/v2/applications/{applicationKey} Get application by key
ApplicationsBetaApi getApplicationVersions GET /api/v2/applications/{applicationKey}/versions Get application versions by application key
ApplicationsBetaApi getApplications GET /api/v2/applications Get applications
ApplicationsBetaApi patchApplication PATCH /api/v2/applications/{applicationKey} Update application
ApplicationsBetaApi patchApplicationVersion PATCH /api/v2/applications/{applicationKey}/versions/{versionKey} Update application version
ApprovalsApi deleteApprovalRequest DELETE /api/v2/approval-requests/{id} Delete approval request
ApprovalsApi deleteApprovalRequestForFlag DELETE /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests/{id} Delete approval request for a flag
ApprovalsApi getApprovalForFlag GET /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests/{id} Get approval request for a flag
ApprovalsApi getApprovalRequest GET /api/v2/approval-requests/{id} Get approval request
ApprovalsApi getApprovalRequests GET /api/v2/approval-requests List approval requests
ApprovalsApi getApprovalsForFlag GET /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests List approval requests for a flag
ApprovalsApi postApprovalRequest POST /api/v2/approval-requests Create approval request
ApprovalsApi postApprovalRequestApply POST /api/v2/approval-requests/{id}/apply Apply approval request
ApprovalsApi postApprovalRequestApplyForFlag POST /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests/{id}/apply Apply approval request for a flag
ApprovalsApi postApprovalRequestForFlag POST /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests Create approval request for a flag
ApprovalsApi postApprovalRequestReview POST /api/v2/approval-requests/{id}/reviews Review approval request
ApprovalsApi postApprovalRequestReviewForFlag POST /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests/{id}/reviews Review approval request for a flag
ApprovalsApi postFlagCopyConfigApprovalRequest POST /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests-flag-copy Create approval request to copy flag configurations across environments
ApprovalsBetaApi patchApprovalRequest PATCH /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests/{id} Update approval request
AuditLogApi getAuditLogEntries GET /api/v2/auditlog List audit log entries
AuditLogApi getAuditLogEntry GET /api/v2/auditlog/{id} Get audit log entry
AuditLogApi postAuditLogEntries POST /api/v2/auditlog Search audit log entries
CodeReferencesApi deleteBranches POST /api/v2/code-refs/repositories/{repo}/branch-delete-tasks Delete branches
CodeReferencesApi deleteRepository DELETE /api/v2/code-refs/repositories/{repo} Delete repository
CodeReferencesApi getBranch GET /api/v2/code-refs/repositories/{repo}/branches/{branch} Get branch
CodeReferencesApi getBranches GET /api/v2/code-refs/repositories/{repo}/branches List branches
CodeReferencesApi getExtinctions GET /api/v2/code-refs/extinctions List extinctions
CodeReferencesApi getRepositories GET /api/v2/code-refs/repositories List repositories
CodeReferencesApi getRepository GET /api/v2/code-refs/repositories/{repo} Get repository
CodeReferencesApi getRootStatistic GET /api/v2/code-refs/statistics Get links to code reference repositories for each project
CodeReferencesApi getStatistics GET /api/v2/code-refs/statistics/{projectKey} Get code references statistics for flags
CodeReferencesApi patchRepository PATCH /api/v2/code-refs/repositories/{repo} Update repository
CodeReferencesApi postExtinction POST /api/v2/code-refs/repositories/{repo}/branches/{branch}/extinction-events Create extinction
CodeReferencesApi postRepository POST /api/v2/code-refs/repositories Create repository
CodeReferencesApi putBranch PUT /api/v2/code-refs/repositories/{repo}/branches/{branch} Upsert branch
ContextSettingsApi putContextFlagSetting PUT /api/v2/projects/{projectKey}/environments/{environmentKey}/contexts/{contextKind}/{contextKey}/flags/{featureFlagKey} Update flag settings for context
ContextsApi deleteContextInstances DELETE /api/v2/projects/{projectKey}/environments/{environmentKey}/context-instances/{id} Delete context instances
ContextsApi evaluateContextInstance POST /api/v2/projects/{projectKey}/environments/{environmentKey}/flags/evaluate Evaluate flags for context instance
ContextsApi getContextAttributeNames GET /api/v2/projects/{projectKey}/environments/{environmentKey}/context-attributes Get context attribute names
ContextsApi getContextAttributeValues GET /api/v2/projects/{projectKey}/environments/{environmentKey}/context-attributes/{attributeName} Get context attribute values
ContextsApi getContextInstances GET /api/v2/projects/{projectKey}/environments/{environmentKey}/context-instances/{id} Get context instances
ContextsApi getContextKindsByProjectKey GET /api/v2/projects/{projectKey}/context-kinds Get context kinds
ContextsApi getContexts GET /api/v2/projects/{projectKey}/environments/{environmentKey}/contexts/{kind}/{key} Get contexts
ContextsApi putContextKind PUT /api/v2/projects/{projectKey}/context-kinds/{key} Create or update context kind
ContextsApi searchContextInstances POST /api/v2/projects/{projectKey}/environments/{environmentKey}/context-instances/search Search for context instances
ContextsApi searchContexts POST /api/v2/projects/{projectKey}/environments/{environmentKey}/contexts/search Search for contexts
CustomRolesApi deleteCustomRole DELETE /api/v2/roles/{customRoleKey} Delete custom role
CustomRolesApi getCustomRole GET /api/v2/roles/{customRoleKey} Get custom role
CustomRolesApi getCustomRoles GET /api/v2/roles List custom roles
CustomRolesApi patchCustomRole PATCH /api/v2/roles/{customRoleKey} Update custom role
CustomRolesApi postCustomRole POST /api/v2/roles Create custom role
DataExportDestinationsApi deleteDestination DELETE /api/v2/destinations/{projectKey}/{environmentKey}/{id} Delete Data Export destination
DataExportDestinationsApi getDestination GET /api/v2/destinations/{projectKey}/{environmentKey}/{id} Get destination
DataExportDestinationsApi getDestinations GET /api/v2/destinations List destinations
DataExportDestinationsApi patchDestination PATCH /api/v2/destinations/{projectKey}/{environmentKey}/{id} Update Data Export destination
DataExportDestinationsApi postDestination POST /api/v2/destinations/{projectKey}/{environmentKey} Create Data Export destination
EnvironmentsApi deleteEnvironment DELETE /api/v2/projects/{projectKey}/environments/{environmentKey} Delete environment
EnvironmentsApi getEnvironment GET /api/v2/projects/{projectKey}/environments/{environmentKey} Get environment
EnvironmentsApi getEnvironmentsByProject GET /api/v2/projects/{projectKey}/environments List environments
EnvironmentsApi patchEnvironment PATCH /api/v2/projects/{projectKey}/environments/{environmentKey} Update environment
EnvironmentsApi postEnvironment POST /api/v2/projects/{projectKey}/environments Create environment
EnvironmentsApi resetEnvironmentMobileKey POST /api/v2/projects/{projectKey}/environments/{environmentKey}/mobileKey Reset environment mobile SDK key
EnvironmentsApi resetEnvironmentSDKKey POST /api/v2/projects/{projectKey}/environments/{environmentKey}/apiKey Reset environment SDK key
ExperimentsApi createExperiment POST /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments Create experiment
ExperimentsApi createIteration POST /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey}/iterations Create iteration
ExperimentsApi getExperiment GET /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey} Get experiment
ExperimentsApi getExperimentResults GET /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey}/metrics/{metricKey}/results Get experiment results
ExperimentsApi getExperimentResultsForMetricGroup GET /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey}/metric-groups/{metricGroupKey}/results Get experiment results for metric group
ExperimentsApi getExperimentationSettings GET /api/v2/projects/{projectKey}/experimentation-settings Get experimentation settings
ExperimentsApi getExperiments GET /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments Get experiments
ExperimentsApi getLegacyExperimentResults GET /api/v2/flags/{projectKey}/{featureFlagKey}/experiments/{environmentKey}/{metricKey} Get legacy experiment results (deprecated)
ExperimentsApi patchExperiment PATCH /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey} Patch experiment
ExperimentsApi putExperimentationSettings PUT /api/v2/projects/{projectKey}/experimentation-settings Update experimentation settings
FeatureFlagsApi copyFeatureFlag POST /api/v2/flags/{projectKey}/{featureFlagKey}/copy Copy feature flag
FeatureFlagsApi deleteFeatureFlag DELETE /api/v2/flags/{projectKey}/{featureFlagKey} Delete feature flag
FeatureFlagsApi getExpiringContextTargets GET /api/v2/flags/{projectKey}/{featureFlagKey}/expiring-targets/{environmentKey} Get expiring context targets for feature flag
FeatureFlagsApi getExpiringUserTargets GET /api/v2/flags/{projectKey}/{featureFlagKey}/expiring-user-targets/{environmentKey} Get expiring user targets for feature flag
FeatureFlagsApi getFeatureFlag GET /api/v2/flags/{projectKey}/{featureFlagKey} Get feature flag
FeatureFlagsApi getFeatureFlagStatus GET /api/v2/flag-statuses/{projectKey}/{environmentKey}/{featureFlagKey} Get feature flag status
FeatureFlagsApi getFeatureFlagStatusAcrossEnvironments GET /api/v2/flag-status/{projectKey}/{featureFlagKey} Get flag status across environments
FeatureFlagsApi getFeatureFlagStatuses GET /api/v2/flag-statuses/{projectKey}/{environmentKey} List feature flag statuses
FeatureFlagsApi getFeatureFlags GET /api/v2/flags/{projectKey} List feature flags
FeatureFlagsApi patchExpiringTargets PATCH /api/v2/flags/{projectKey}/{featureFlagKey}/expiring-targets/{environmentKey} Update expiring context targets on feature flag
FeatureFlagsApi patchExpiringUserTargets PATCH /api/v2/flags/{projectKey}/{featureFlagKey}/expiring-user-targets/{environmentKey} Update expiring user targets on feature flag
FeatureFlagsApi patchFeatureFlag PATCH /api/v2/flags/{projectKey}/{featureFlagKey} Update feature flag
FeatureFlagsApi postFeatureFlag POST /api/v2/flags/{projectKey} Create a feature flag
FeatureFlagsApi postMigrationSafetyIssues POST /api/v2/projects/{projectKey}/flags/{flagKey}/environments/{environmentKey}/migration-safety-issues Get migration safety issues
FeatureFlagsBetaApi getDependentFlags GET /api/v2/flags/{projectKey}/{featureFlagKey}/dependent-flags List dependent feature flags
FeatureFlagsBetaApi getDependentFlagsByEnv GET /api/v2/flags/{projectKey}/{environmentKey}/{featureFlagKey}/dependent-flags List dependent feature flags by environment
FlagLinksBetaApi createFlagLink POST /api/v2/flag-links/projects/{projectKey}/flags/{featureFlagKey} Create flag link
FlagLinksBetaApi deleteFlagLink DELETE /api/v2/flag-links/projects/{projectKey}/flags/{featureFlagKey}/{id} Delete flag link
FlagLinksBetaApi getFlagLinks GET /api/v2/flag-links/projects/{projectKey}/flags/{featureFlagKey} List flag links
FlagLinksBetaApi updateFlagLink PATCH /api/v2/flag-links/projects/{projectKey}/flags/{featureFlagKey}/{id} Update flag link
FlagTriggersApi createTriggerWorkflow POST /api/v2/flags/{projectKey}/{featureFlagKey}/triggers/{environmentKey} Create flag trigger
FlagTriggersApi deleteTriggerWorkflow DELETE /api/v2/flags/{projectKey}/{featureFlagKey}/triggers/{environmentKey}/{id} Delete flag trigger
FlagTriggersApi getTriggerWorkflowById GET /api/v2/flags/{projectKey}/{featureFlagKey}/triggers/{environmentKey}/{id} Get flag trigger by ID
FlagTriggersApi getTriggerWorkflows GET /api/v2/flags/{projectKey}/{featureFlagKey}/triggers/{environmentKey} List flag triggers
FlagTriggersApi patchTriggerWorkflow PATCH /api/v2/flags/{projectKey}/{featureFlagKey}/triggers/{environmentKey}/{id} Update flag trigger
FollowFlagsApi deleteFlagFollower DELETE /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/followers/{memberId} Remove a member as a follower of a flag in a project and environment
FollowFlagsApi getFlagFollowers GET /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/followers Get followers of a flag in a project and environment
FollowFlagsApi getFollowersByProjEnv GET /api/v2/projects/{projectKey}/environments/{environmentKey}/followers Get followers of all flags in a given project and environment
FollowFlagsApi putFlagFollower PUT /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/followers/{memberId} Add a member as a follower of a flag in a project and environment
HoldoutsBetaApi getAllHoldouts GET /api/v2/projects/{projectKey}/environments/{environmentKey}/holdouts Get all holdouts
HoldoutsBetaApi getHoldout GET /api/v2/projects/{projectKey}/environments/{environmentKey}/holdouts/{holdoutKey} Get holdout
HoldoutsBetaApi getHoldoutById GET /api/v2/projects/{projectKey}/environments/{environmentKey}/holdouts/id/{holdoutId} Get Holdout by Id
HoldoutsBetaApi patchHoldout PATCH /api/v2/projects/{projectKey}/environments/{environmentKey}/holdouts/{holdoutKey} Patch holdout
HoldoutsBetaApi postHoldout POST /api/v2/projects/{projectKey}/environments/{environmentKey}/holdouts Create holdout
InsightsChartsBetaApi getDeploymentFrequencyChart GET /api/v2/engineering-insights/charts/deployments/frequency Get deployment frequency chart data
InsightsChartsBetaApi getFlagStatusChart GET /api/v2/engineering-insights/charts/flags/status Get flag status chart data
InsightsChartsBetaApi getLeadTimeChart GET /api/v2/engineering-insights/charts/lead-time Get lead time chart data
InsightsChartsBetaApi getReleaseFrequencyChart GET /api/v2/engineering-insights/charts/releases/frequency Get release frequency chart data
InsightsChartsBetaApi getStaleFlagsChart GET /api/v2/engineering-insights/charts/flags/stale Get stale flags chart data
InsightsDeploymentsBetaApi createDeploymentEvent POST /api/v2/engineering-insights/deployment-events Create deployment event
InsightsDeploymentsBetaApi getDeployment GET /api/v2/engineering-insights/deployments/{deploymentID} Get deployment
InsightsDeploymentsBetaApi getDeployments GET /api/v2/engineering-insights/deployments List deployments
InsightsDeploymentsBetaApi updateDeployment PATCH /api/v2/engineering-insights/deployments/{deploymentID} Update deployment
InsightsFlagEventsBetaApi getFlagEvents GET /api/v2/engineering-insights/flag-events List flag events
InsightsPullRequestsBetaApi getPullRequests GET /api/v2/engineering-insights/pull-requests List pull requests
InsightsRepositoriesBetaApi associateRepositoriesAndProjects PUT /api/v2/engineering-insights/repositories/projects Associate repositories with projects
InsightsRepositoriesBetaApi deleteRepositoryProject DELETE /api/v2/engineering-insights/repositories/{repositoryKey}/projects/{projectKey} Remove repository project association
InsightsRepositoriesBetaApi getInsightsRepositories GET /api/v2/engineering-insights/repositories List repositories
InsightsScoresBetaApi createInsightGroup POST /api/v2/engineering-insights/insights/group Create insight group
InsightsScoresBetaApi deleteInsightGroup DELETE /api/v2/engineering-insights/insights/groups/{insightGroupKey} Delete insight group
InsightsScoresBetaApi getInsightGroup GET /api/v2/engineering-insights/insights/groups/{insightGroupKey} Get insight group
InsightsScoresBetaApi getInsightGroups GET /api/v2/engineering-insights/insights/groups List insight groups
InsightsScoresBetaApi getInsightsScores GET /api/v2/engineering-insights/insights/scores Get insight scores
InsightsScoresBetaApi patchInsightGroup PATCH /api/v2/engineering-insights/insights/groups/{insightGroupKey} Patch insight group
IntegrationAuditLogSubscriptionsApi createSubscription POST /api/v2/integrations/{integrationKey} Create audit log subscription
IntegrationAuditLogSubscriptionsApi deleteSubscription DELETE /api/v2/integrations/{integrationKey}/{id} Delete audit log subscription
IntegrationAuditLogSubscriptionsApi getSubscriptionByID GET /api/v2/integrations/{integrationKey}/{id} Get audit log subscription by ID
IntegrationAuditLogSubscriptionsApi getSubscriptions GET /api/v2/integrations/{integrationKey} Get audit log subscriptions by integration
IntegrationAuditLogSubscriptionsApi updateSubscription PATCH /api/v2/integrations/{integrationKey}/{id} Update audit log subscription
IntegrationDeliveryConfigurationsBetaApi createIntegrationDeliveryConfiguration POST /api/v2/integration-capabilities/featureStore/{projectKey}/{environmentKey}/{integrationKey} Create delivery configuration
IntegrationDeliveryConfigurationsBetaApi deleteIntegrationDeliveryConfiguration DELETE /api/v2/integration-capabilities/featureStore/{projectKey}/{environmentKey}/{integrationKey}/{id} Delete delivery configuration
IntegrationDeliveryConfigurationsBetaApi getIntegrationDeliveryConfigurationByEnvironment GET /api/v2/integration-capabilities/featureStore/{projectKey}/{environmentKey} Get delivery configurations by environment
IntegrationDeliveryConfigurationsBetaApi getIntegrationDeliveryConfigurationById GET /api/v2/integration-capabilities/featureStore/{projectKey}/{environmentKey}/{integrationKey}/{id} Get delivery configuration by ID
IntegrationDeliveryConfigurationsBetaApi getIntegrationDeliveryConfigurations GET /api/v2/integration-capabilities/featureStore List all delivery configurations
IntegrationDeliveryConfigurationsBetaApi patchIntegrationDeliveryConfiguration PATCH /api/v2/integration-capabilities/featureStore/{projectKey}/{environmentKey}/{integrationKey}/{id} Update delivery configuration
IntegrationDeliveryConfigurationsBetaApi validateIntegrationDeliveryConfiguration POST /api/v2/integration-capabilities/featureStore/{projectKey}/{environmentKey}/{integrationKey}/{id}/validate Validate delivery configuration
IntegrationsBetaApi createBigSegmentStoreIntegration POST /api/v2/integration-capabilities/big-segment-store/{projectKey}/{environmentKey}/{integrationKey} Create big segment store integration
IntegrationsBetaApi createFlagImportConfiguration POST /api/v2/integration-capabilities/flag-import/{projectKey}/{integrationKey} Create a flag import configuration
IntegrationsBetaApi deleteBigSegmentStoreIntegration DELETE /api/v2/integration-capabilities/big-segment-store/{projectKey}/{environmentKey}/{integrationKey}/{integrationId} Delete big segment store integration
IntegrationsBetaApi deleteFlagImportConfiguration DELETE /api/v2/integration-capabilities/flag-import/{projectKey}/{integrationKey}/{integrationId} Delete a flag import configuration
IntegrationsBetaApi getBigSegmentStoreIntegration GET /api/v2/integration-capabilities/big-segment-store/{projectKey}/{environmentKey}/{integrationKey}/{integrationId} Get big segment store integration by ID
IntegrationsBetaApi getBigSegmentStoreIntegrations GET /api/v2/integration-capabilities/big-segment-store List all big segment store integrations
IntegrationsBetaApi getFlagImportConfiguration GET /api/v2/integration-capabilities/flag-import/{projectKey}/{integrationKey}/{integrationId} Get a single flag import configuration
IntegrationsBetaApi getFlagImportConfigurations GET /api/v2/integration-capabilities/flag-import List all flag import configurations
IntegrationsBetaApi patchBigSegmentStoreIntegration PATCH /api/v2/integration-capabilities/big-segment-store/{projectKey}/{environmentKey}/{integrationKey}/{integrationId} Update big segment store integration
IntegrationsBetaApi patchFlagImportConfiguration PATCH /api/v2/integration-capabilities/flag-import/{projectKey}/{integrationKey}/{integrationId} Update a flag import configuration
IntegrationsBetaApi triggerFlagImportJob POST /api/v2/integration-capabilities/flag-import/{projectKey}/{integrationKey}/{integrationId}/trigger Trigger a single flag import run
LayersBetaApi createLayer POST /api/v2/projects/{projectKey}/layers Create layer
LayersBetaApi getLayers GET /api/v2/projects/{projectKey}/layers Get layers
LayersBetaApi updateLayer PATCH /api/v2/projects/{projectKey}/layers/{layerKey} Update layer
MetricsApi deleteMetric DELETE /api/v2/metrics/{projectKey}/{metricKey} Delete metric
MetricsApi getMetric GET /api/v2/metrics/{projectKey}/{metricKey} Get metric
MetricsApi getMetrics GET /api/v2/metrics/{projectKey} List metrics
MetricsApi patchMetric PATCH /api/v2/metrics/{projectKey}/{metricKey} Update metric
MetricsApi postMetric POST /api/v2/metrics/{projectKey} Create metric
MetricsBetaApi createMetricGroup POST /api/v2/projects/{projectKey}/metric-groups Create metric group
MetricsBetaApi deleteMetricGroup DELETE /api/v2/projects/{projectKey}/metric-groups/{metricGroupKey} Delete metric group
MetricsBetaApi getMetricGroup GET /api/v2/projects/{projectKey}/metric-groups/{metricGroupKey} Get metric group
MetricsBetaApi getMetricGroups GET /api/v2/projects/{projectKey}/metric-groups List metric groups
MetricsBetaApi patchMetricGroup PATCH /api/v2/projects/{projectKey}/metric-groups/{metricGroupKey} Patch metric group
OAuth2ClientsApi createOAuth2Client POST /api/v2/oauth/clients Create a LaunchDarkly OAuth 2.0 client
OAuth2ClientsApi deleteOAuthClient DELETE /api/v2/oauth/clients/{clientId} Delete OAuth 2.0 client
OAuth2ClientsApi getOAuthClientById GET /api/v2/oauth/clients/{clientId} Get client by ID
OAuth2ClientsApi getOAuthClients GET /api/v2/oauth/clients Get clients
OAuth2ClientsApi patchOAuthClient PATCH /api/v2/oauth/clients/{clientId} Patch client by ID
OtherApi getCallerIdentity GET /api/v2/caller-identity Identify the caller
OtherApi getIps GET /api/v2/public-ip-list Gets the public IP list
OtherApi getOpenapiSpec GET /api/v2/openapi.json Gets the OpenAPI spec in json
OtherApi getRoot GET /api/v2 Root resource
OtherApi getVersions GET /api/v2/versions Get version information
ProjectsApi deleteProject DELETE /api/v2/projects/{projectKey} Delete project
ProjectsApi getFlagDefaultsByProject GET /api/v2/projects/{projectKey}/flag-defaults Get flag defaults for project
ProjectsApi getProject GET /api/v2/projects/{projectKey} Get project
ProjectsApi getProjects GET /api/v2/projects List projects
ProjectsApi patchFlagDefaultsByProject PATCH /api/v2/projects/{projectKey}/flag-defaults Update flag default for project
ProjectsApi patchProject PATCH /api/v2/projects/{projectKey} Update project
ProjectsApi postProject POST /api/v2/projects Create project
ProjectsApi putFlagDefaultsByProject PUT /api/v2/projects/{projectKey}/flag-defaults Create or update flag defaults for project
RelayProxyConfigurationsApi deleteRelayAutoConfig DELETE /api/v2/account/relay-auto-configs/{id} Delete Relay Proxy config by ID
RelayProxyConfigurationsApi getRelayProxyConfig GET /api/v2/account/relay-auto-configs/{id} Get Relay Proxy config
RelayProxyConfigurationsApi getRelayProxyConfigs GET /api/v2/account/relay-auto-configs List Relay Proxy configs
RelayProxyConfigurationsApi patchRelayAutoConfig PATCH /api/v2/account/relay-auto-configs/{id} Update a Relay Proxy config
RelayProxyConfigurationsApi postRelayAutoConfig POST /api/v2/account/relay-auto-configs Create a new Relay Proxy config
RelayProxyConfigurationsApi resetRelayAutoConfig POST /api/v2/account/relay-auto-configs/{id}/reset Reset Relay Proxy configuration key
ReleasePipelinesBetaApi deleteReleasePipeline DELETE /api/v2/projects/{projectKey}/release-pipelines/{pipelineKey} Delete release pipeline
ReleasePipelinesBetaApi getAllReleasePipelines GET /api/v2/projects/{projectKey}/release-pipelines Get all release pipelines
ReleasePipelinesBetaApi getAllReleaseProgressionsForReleasePipeline GET /api/v2/projects/{projectKey}/release-pipelines/{pipelineKey}/releases Get release progressions for release pipeline
ReleasePipelinesBetaApi getReleasePipelineByKey GET /api/v2/projects/{projectKey}/release-pipelines/{pipelineKey} Get release pipeline by key
ReleasePipelinesBetaApi patchReleasePipeline PATCH /api/v2/projects/{projectKey}/release-pipelines/{pipelineKey} Update a release pipeline
ReleasePipelinesBetaApi postReleasePipeline POST /api/v2/projects/{projectKey}/release-pipelines Create a release pipeline
ReleasesBetaApi createReleaseForFlag PUT /api/v2/projects/{projectKey}/flags/{flagKey}/release Create a new release for flag
ReleasesBetaApi deleteReleaseByFlagKey DELETE /api/v2/flags/{projectKey}/{flagKey}/release Delete a release for flag
ReleasesBetaApi getReleaseByFlagKey GET /api/v2/flags/{projectKey}/{flagKey}/release Get release for flag
ReleasesBetaApi patchReleaseByFlagKey PATCH /api/v2/flags/{projectKey}/{flagKey}/release Patch release for flag
ReleasesBetaApi updatePhaseStatus PUT /api/v2/projects/{projectKey}/flags/{flagKey}/release/phases/{phaseId} Update phase status for release
ScheduledChangesApi deleteFlagConfigScheduledChanges DELETE /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/scheduled-changes/{id} Delete scheduled changes workflow
ScheduledChangesApi getFeatureFlagScheduledChange GET /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/scheduled-changes/{id} Get a scheduled change
ScheduledChangesApi getFlagConfigScheduledChanges GET /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/scheduled-changes List scheduled changes
ScheduledChangesApi patchFlagConfigScheduledChange PATCH /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/scheduled-changes/{id} Update scheduled changes workflow
ScheduledChangesApi postFlagConfigScheduledChanges POST /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/scheduled-changes Create scheduled changes workflow
SegmentsApi deleteSegment DELETE /api/v2/segments/{projectKey}/{environmentKey}/{segmentKey} Delete segment
SegmentsApi getContextInstanceSegmentsMembershipByEnv POST /api/v2/projects/{projectKey}/environments/{environmentKey}/segments/evaluate List segment memberships for context instance
SegmentsApi getExpiringTargetsForSegment GET /api/v2/segments/{projectKey}/{segmentKey}/expiring-targets/{environmentKey} Get expiring targets for segment
SegmentsApi getExpiringUserTargetsForSegment GET /api/v2/segments/{projectKey}/{segmentKey}/expiring-user-targets/{environmentKey} Get expiring user targets for segment
SegmentsApi getSegment GET /api/v2/segments/{projectKey}/{environmentKey}/{segmentKey} Get segment
SegmentsApi getSegmentMembershipForContext GET /api/v2/segments/{projectKey}/{environmentKey}/{segmentKey}/contexts/{contextKey} Get big segment membership for context
SegmentsApi getSegmentMembershipForUser GET /api/v2/segments/{projectKey}/{environmentKey}/{segmentKey}/users/{userKey} Get big segment membership for user
SegmentsApi getSegments GET /api/v2/segments/{projectKey}/{environmentKey} List segments
SegmentsApi patchExpiringTargetsForSegment PATCH /api/v2/segments/{projectKey}/{segmentKey}/expiring-targets/{environmentKey} Update expiring targets for segment
SegmentsApi patchExpiringUserTargetsForSegment PATCH /api/v2/segments/{projectKey}/{segmentKey}/expiring-user-targets/{environmentKey} Update expiring user targets for segment
SegmentsApi patchSegment PATCH /api/v2/segments/{projectKey}/{environmentKey}/{segmentKey} Patch segment
SegmentsApi postSegment POST /api/v2/segments/{projectKey}/{environmentKey} Create segment
SegmentsApi updateBigSegmentContextTargets POST /api/v2/segments/{projectKey}/{environmentKey}/{segmentKey}/contexts Update context targets on a big segment
SegmentsApi updateBigSegmentTargets POST /api/v2/segments/{projectKey}/{environmentKey}/{segmentKey}/users Update user context targets on a big segment
SegmentsBetaApi createBigSegmentExport POST /api/v2/segments/{projectKey}/{environmentKey}/{segmentKey}/exports Create big segment export
SegmentsBetaApi createBigSegmentImport POST /api/v2/segments/{projectKey}/{environmentKey}/{segmentKey}/imports Create big segment import
SegmentsBetaApi getBigSegmentExport GET /api/v2/segments/{projectKey}/{environmentKey}/{segmentKey}/exports/{exportID} Get big segment export
SegmentsBetaApi getBigSegmentImport GET /api/v2/segments/{projectKey}/{environmentKey}/{segmentKey}/imports/{importID} Get big segment import
TagsApi getTags GET /api/v2/tags List tags
TeamsApi deleteTeam DELETE /api/v2/teams/{teamKey} Delete team
TeamsApi getTeam GET /api/v2/teams/{teamKey} Get team
TeamsApi getTeamMaintainers GET /api/v2/teams/{teamKey}/maintainers Get team maintainers
TeamsApi getTeamRoles GET /api/v2/teams/{teamKey}/roles Get team custom roles
TeamsApi getTeams GET /api/v2/teams List teams
TeamsApi patchTeam PATCH /api/v2/teams/{teamKey} Update team
TeamsApi postTeam POST /api/v2/teams Create team
TeamsApi postTeamMembers POST /api/v2/teams/{teamKey}/members Add multiple members to team
TeamsBetaApi patchTeams PATCH /api/v2/teams Update teams
UserSettingsApi getExpiringFlagsForUser GET /api/v2/users/{projectKey}/{userKey}/expiring-user-targets/{environmentKey} Get expiring dates on flags for user
UserSettingsApi getUserFlagSetting GET /api/v2/users/{projectKey}/{environmentKey}/{userKey}/flags/{featureFlagKey} Get flag setting for user
UserSettingsApi getUserFlagSettings GET /api/v2/users/{projectKey}/{environmentKey}/{userKey}/flags List flag settings for user
UserSettingsApi patchExpiringFlagsForUser PATCH /api/v2/users/{projectKey}/{userKey}/expiring-user-targets/{environmentKey} Update expiring user target for flags
UserSettingsApi putFlagSetting PUT /api/v2/users/{projectKey}/{environmentKey}/{userKey}/flags/{featureFlagKey} Update flag settings for user
UsersApi deleteUser DELETE /api/v2/users/{projectKey}/{environmentKey}/{userKey} Delete user
UsersApi getSearchUsers GET /api/v2/user-search/{projectKey}/{environmentKey} Find users
UsersApi getUser GET /api/v2/users/{projectKey}/{environmentKey}/{userKey} Get user
UsersApi getUsers GET /api/v2/users/{projectKey}/{environmentKey} List users
UsersBetaApi getUserAttributeNames GET /api/v2/user-attributes/{projectKey}/{environmentKey} Get user attribute names
WebhooksApi deleteWebhook DELETE /api/v2/webhooks/{id} Delete webhook
WebhooksApi getAllWebhooks GET /api/v2/webhooks List webhooks
WebhooksApi getWebhook GET /api/v2/webhooks/{id} Get webhook
WebhooksApi patchWebhook PATCH /api/v2/webhooks/{id} Update webhook
WebhooksApi postWebhook POST /api/v2/webhooks Creates a webhook
WorkflowTemplatesApi createWorkflowTemplate POST /api/v2/templates Create workflow template
WorkflowTemplatesApi deleteWorkflowTemplate DELETE /api/v2/templates/{templateKey} Delete workflow template
WorkflowTemplatesApi getWorkflowTemplates GET /api/v2/templates Get workflow templates
WorkflowsApi deleteWorkflow DELETE /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/workflows/{workflowId} Delete workflow
WorkflowsApi getCustomWorkflow GET /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/workflows/{workflowId} Get custom workflow
WorkflowsApi getWorkflows GET /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/workflows Get workflows
WorkflowsApi postWorkflow POST /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/workflows Create workflow

Documentation for Models

Documentation for Authorization

Authentication schemes defined for the API:

ApiKey

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

Recommendation

It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.

Author

[email protected]