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

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

Go API client for ldapi

Overview

Authentication

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

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

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

Keep your access tokens and SDK keys private

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

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

Via request header

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

Manage personal access tokens from the Account Settings page.

Via session cookie

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

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

Modifying the Origin header causes an error

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

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

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

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

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

Representations

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

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

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

Summary and detailed representations

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

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

Links and addressability

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

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

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

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

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

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

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

Updates

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

Updates via JSON Patch

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

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

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

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

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

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

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

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

Updates via JSON Merge Patch

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

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

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

Updates with comments

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

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

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

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

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

Updates via semantic patches

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

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

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

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

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

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

Here is another example. In this feature flag configuration:

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

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

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

Supported semantic patch API endpoints

Update feature flag

Update expiring user targets on feature flag

Update expiring user target for flags

Update expiring user targets on segment

Errors

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

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

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

HTTP Status - Error Response Codes

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

CORS

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

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

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

Rate limiting

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

Rate limiting and SDKs

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

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

Global rate limits

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

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

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

Route-level rate limits

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

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

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

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

IP-based rate limiting

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

OpenAPI (Swagger)

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

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

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

Client libraries

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

Method Overriding

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

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

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

Beta resources

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

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

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

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

This feature is in beta

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

Using beta resources

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

Use this header:

LD-API-Version: beta

Versioning

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

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

Setting the API version per request

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

LD-API-Version: 20210729

The header value is the version number of the API version you'd like to request. The number for each version corresponds to the date the version was released in yyyymmdd format. In the example above the version 20210729 corresponds to July 29, 2021.

Setting the API version per access token

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

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

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

Best practice: Set the header for every client or integration

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

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

API version changelog

Version	Changes
`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.
`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, users, audit logs, members, users, custom roles, segments, usage, streams, events, and data export.
`20160426`	Initial versioning of API. Tokens created before versioning have their version set to this.

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

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

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/oauth2
go get golang.org/x/net/context

Put the package under your project folder and add the following in import:

import sw "./ldapi"

To use a proxy, set the environment variable HTTP_PROXY:

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

Configuration of Server URL

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

Select Server Configuration

For using other server than the one defined on index 0 set context value sw.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), sw.ContextServerIndex, 1)

Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value sw.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), sw.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using sw.ContextOperationServerIndices and sw.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), sw.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), sw.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

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 member to teams
AccountMembersApi	PostMembers	Post /api/v2/members	Invite new members
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	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	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
ApprovalsApi	DeleteApprovalRequest	Delete /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests/{id}	Delete approval request
ApprovalsApi	GetApproval	Get /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests/{id}	Get approval request
ApprovalsApi	GetApprovals	Get /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests	List all approval requests
ApprovalsApi	PostApprovalRequest	Post /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests	Create approval request
ApprovalsApi	PostApprovalRequestApplyRequest	Post /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests/{id}/apply	Apply approval request
ApprovalsApi	PostApprovalRequestReview	Post /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests/{id}/reviews	Review approval request
ApprovalsApi	PostFlagCopyConfigApprovalRequest	Post /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests-flag-copy	Create approval request to copy flag configurations across environments
AuditLogApi	GetAuditLogEntries	Get /api/v2/auditlog	List audit log feature flag entries
AuditLogApi	GetAuditLogEntry	Get /api/v2/auditlog/{id}	Get audit log entry
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 number of code references 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
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	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
ExperimentsBetaApi	GetExperiment	Get /api/v2/flags/{projectKey}/{featureFlagKey}/experiments/{environmentKey}/{metricKey}	Get experiment results
ExperimentsBetaApi	ResetExperiment	Delete /api/v2/flags/{projectKey}/{featureFlagKey}/experiments/{environmentKey}/{metricKey}/results	Reset experiment results
FeatureFlagsApi	CopyFeatureFlag	Post /api/v2/flags/{projectKey}/{featureFlagKey}/copy	Copy feature flag
FeatureFlagsApi	DeleteFeatureFlag	Delete /api/v2/flags/{projectKey}/{featureFlagKey}	Delete 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	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
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
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
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
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	GetProject	Get /api/v2/projects/{projectKey}	Get project
ProjectsApi	GetProjects	Get /api/v2/projects	List projects
ProjectsApi	PatchProject	Patch /api/v2/projects/{projectKey}	Update project
ProjectsApi	PostProject	Post /api/v2/projects	Create 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
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	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	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	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	UpdateBigSegmentTargets	Post /api/v2/segments/{projectKey}/{environmentKey}/{segmentKey}/users	Update 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
TeamsBetaApi	DeleteTeam	Delete /api/v2/teams/{teamKey}	Delete team
TeamsBetaApi	GetTeam	Get /api/v2/teams/{teamKey}	Get team
TeamsBetaApi	GetTeamMaintainers	Get /api/v2/teams/{teamKey}/maintainers	Get team maintainers
TeamsBetaApi	GetTeamRoles	Get /api/v2/teams/{teamKey}/roles	Get team custom roles
TeamsBetaApi	GetTeams	Get /api/v2/teams	List teams
TeamsBetaApi	PatchTeam	Patch /api/v2/teams/{teamKey}	Update team
TeamsBetaApi	PostTeam	Post /api/v2/teams	Create team
TeamsBetaApi	PostTeamMembers	Post /api/v2/teams/{teamKey}/members	Add members to team
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
WorkflowsBetaApi	DeleteWorkflow	Delete /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/workflows/{workflowId}	Delete workflow
WorkflowsBetaApi	GetCustomWorkflow	Get /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/workflows/{workflowId}	Get custom workflow
WorkflowsBetaApi	GetWorkflows	Get /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/workflows	Get workflows
WorkflowsBetaApi	PostWorkflow	Post /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/workflows	Create workflow

Documentation For Models

Documentation For Authorization

ApiKey

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

Note, each API key must be added to a map of map[string]APIKey where the key is: Authorization and passed in as the auth context for each request.

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

PtrBool
PtrInt
PtrInt32
PtrInt64
PtrFloat
PtrFloat32
PtrFloat64
PtrString
PtrTime

Author

[email protected]

Sample Code

package main

import (
	"context"
	"fmt"
	"os"

	ldapi "github.com/launchdarkly/api-client-go"
)

func main() {
	apiKey := os.Getenv("LD_API_KEY")
	if apiKey == "" {
		panic("LD_API_KEY env var was empty!")
	}
	client := ldapi.NewAPIClient(ldapi.NewConfiguration())

	auth := make(map[string]ldapi.APIKey)
	auth["ApiKey"] = ldapi.APIKey{
		Key: apiKey,
	}

	ctx := context.WithValue(context.Background(), ldapi.ContextAPIKeys, auth)

	flagName := "Test Flag Go"
	flagKey := "test-go"
	// Create a multi-variate feature flag
	valOneVal := []int{1, 2}
	valOne := map[string]interface{}{"one": valOneVal}
	valTwoVal := []int{4, 5}
	valTwo := map[string]interface{}{"two": valTwoVal}
	body := ldapi.FeatureFlagBody{
		Name: flagName,
		Key:  flagKey,
		Variations: &[]ldapi.Variation{
			{Value: &valOne},
			{Value: &valTwo},
		},
	}
	flag, resp, err := client.FeatureFlagsApi.PostFeatureFlag(ctx, "openapi").FeatureFlagBody(body).Execute()
	if err != nil {
		if resp.StatusCode != 409 {
			panic(fmt.Errorf("create failed: %s", err))
		} else {
			if _, err := client.FeatureFlagsApi.DeleteFeatureFlag(ctx, "openapi", body.Key).Execute(); err != nil {
				panic(fmt.Errorf("delete failed: %s", err))
			}
			flag, resp, err = client.FeatureFlagsApi.PostFeatureFlag(ctx, "openapi").FeatureFlagBody(body).Execute()
			if err != nil {
				panic(fmt.Errorf("create failed: %s", err))
			}
		}
	}
	fmt.Printf("Created flag: %+v\n", flag)
	// Clean up new flag
	defer func() {
		if _, err := client.FeatureFlagsApi.DeleteFeatureFlag(ctx, "openapi", body.Key).Execute(); err != nil {
			panic(fmt.Errorf("delete failed: %s", err))
		}
	}()
}

func intfPtr(i interface{}) *interface{} {
	return &i
}

# README

Go API client for ldapi

Overview

Authentication

Keep your access tokens and SDK keys private

Via request header

Via session cookie

Modifying the Origin header causes an error

Representations

Summary and detailed representations

Links and addressability

Updates

Updates via JSON Patch

Updates via JSON Merge Patch

Updates with comments

Updates via semantic patches

Supported semantic patch API endpoints

Errors

HTTP Status - Error Response Codes

CORS

Rate limiting

Rate limiting and SDKs

Global rate limits

Route-level rate limits

IP-based rate limiting

OpenAPI (Swagger)

Client libraries

Method Overriding

Beta resources

This feature is in beta

Using beta resources

Versioning

Setting the API version per request

Setting the API version per access token

Best practice: Set the header for every client or integration

API version changelog

Overview

Installation

Configuration of Server URL

Select Server Configuration

Templated Server URL

URLs Configuration per Operation

Documentation for API Endpoints

Documentation For Models

Documentation For Authorization

ApiKey

Documentation for Utility Methods

Author

Sample Code

# Packages