Skip to content

moirazz/api-client-ruby

BranchesTags
 
 

Repository files navigation

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

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

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.

launchdarkly_api

LaunchDarklyApi - the Ruby gem for the LaunchDarkly REST API

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, 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.

In most cases, the detailed representation contains all of the attributes of the resource. In a few cases, the detailed representation contains many, but not all, of the attributes of the resource. Typically this happens when an attribute of the requested resource is itself paginated. You can request that the response include a particular attribute by using the expand request parameter.

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.

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,roles to the Get team endpoint, the expanded response includes both of these attributes.

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.

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 aren't editable, like 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 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 using semantic patch

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.

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 action 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.

Supported semantic patch API endpoints

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 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 Description Possible Solution
400 Invalid request The request cannot be understood. Ensure JSON syntax in request body is correct.
401 Invalid access token User 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 User does not have access to this resource. Ensure that the user 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 conflicted 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 (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, 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.

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

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 20220603 corresponds to June 03, 2022.

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

<div style="width:75px">Version Changes
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.
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.

This SDK is automatically generated by the OpenAPI Generator project:

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

Installation

Build a gem

To build the Ruby code into a gem:

gem build launchdarkly_api.gemspec

Then either install the gem locally:

gem install ./launchdarkly_api-10.0.0.gem

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

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

Finally add this to the Gemfile:

gem 'launchdarkly_api', '~> 10.0.0'

Install from Git

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

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

Include the Ruby code directly

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Getting Started

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

# Load the gem
require 'launchdarkly_api'

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

api_instance = LaunchDarklyApi::AccessTokensApi.new
id = 'id_example' # String | The ID of the access token to update

begin
  #Delete access token
  api_instance.delete_token(id)
rescue LaunchDarklyApi::ApiError => e
  puts "Exception when calling AccessTokensApi->delete_token: #{e}"
end

Documentation for API Endpoints

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

Class Method HTTP request Description
LaunchDarklyApi::AccessTokensApi delete_token DELETE /api/v2/tokens/{id} Delete access token
LaunchDarklyApi::AccessTokensApi get_token GET /api/v2/tokens/{id} Get access token
LaunchDarklyApi::AccessTokensApi get_tokens GET /api/v2/tokens List access tokens
LaunchDarklyApi::AccessTokensApi patch_token PATCH /api/v2/tokens/{id} Patch access token
LaunchDarklyApi::AccessTokensApi post_token POST /api/v2/tokens Create access token
LaunchDarklyApi::AccessTokensApi reset_token POST /api/v2/tokens/{id}/reset Reset access token
LaunchDarklyApi::AccountMembersApi delete_member DELETE /api/v2/members/{id} Delete account member
LaunchDarklyApi::AccountMembersApi get_member GET /api/v2/members/{id} Get account member
LaunchDarklyApi::AccountMembersApi get_members GET /api/v2/members List account members
LaunchDarklyApi::AccountMembersApi patch_member PATCH /api/v2/members/{id} Modify an account member
LaunchDarklyApi::AccountMembersApi post_member_teams POST /api/v2/members/{id}/teams Add a member to teams
LaunchDarklyApi::AccountMembersApi post_members POST /api/v2/members Invite new members
LaunchDarklyApi::AccountUsageBetaApi get_evaluations_usage GET /api/v2/usage/evaluations/{projectKey}/{environmentKey}/{featureFlagKey} Get evaluations usage
LaunchDarklyApi::AccountUsageBetaApi get_events_usage GET /api/v2/usage/events/{type} Get events usage
LaunchDarklyApi::AccountUsageBetaApi get_mau_sdks_by_type GET /api/v2/usage/mau/sdks Get MAU SDKs by type
LaunchDarklyApi::AccountUsageBetaApi get_mau_usage GET /api/v2/usage/mau Get MAU usage
LaunchDarklyApi::AccountUsageBetaApi get_mau_usage_by_category GET /api/v2/usage/mau/bycategory Get MAU usage by category
LaunchDarklyApi::AccountUsageBetaApi get_stream_usage GET /api/v2/usage/streams/{source} Get stream usage
LaunchDarklyApi::AccountUsageBetaApi get_stream_usage_by_sdk_version GET /api/v2/usage/streams/{source}/bysdkversion Get stream usage by SDK version
LaunchDarklyApi::AccountUsageBetaApi get_stream_usage_sdkversion GET /api/v2/usage/streams/{source}/sdkversions Get stream usage SDK versions
LaunchDarklyApi::ApprovalsApi delete_approval_request DELETE /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests/{id} Delete approval request
LaunchDarklyApi::ApprovalsApi get_approval GET /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests/{id} Get approval request
LaunchDarklyApi::ApprovalsApi get_approvals GET /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests List all approval requests
LaunchDarklyApi::ApprovalsApi post_approval_request POST /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests Create approval request
LaunchDarklyApi::ApprovalsApi post_approval_request_apply_request POST /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests/{id}/apply Apply approval request
LaunchDarklyApi::ApprovalsApi post_approval_request_review POST /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests/{id}/reviews Review approval request
LaunchDarklyApi::ApprovalsApi post_flag_copy_config_approval_request POST /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests-flag-copy Create approval request to copy flag configurations across environments
LaunchDarklyApi::AuditLogApi get_audit_log_entries GET /api/v2/auditlog List audit log feature flag entries
LaunchDarklyApi::AuditLogApi get_audit_log_entry GET /api/v2/auditlog/{id} Get audit log entry
LaunchDarklyApi::CodeReferencesApi delete_branches POST /api/v2/code-refs/repositories/{repo}/branch-delete-tasks Delete branches
LaunchDarklyApi::CodeReferencesApi delete_repository DELETE /api/v2/code-refs/repositories/{repo} Delete repository
LaunchDarklyApi::CodeReferencesApi get_branch GET /api/v2/code-refs/repositories/{repo}/branches/{branch} Get branch
LaunchDarklyApi::CodeReferencesApi get_branches GET /api/v2/code-refs/repositories/{repo}/branches List branches
LaunchDarklyApi::CodeReferencesApi get_extinctions GET /api/v2/code-refs/extinctions List extinctions
LaunchDarklyApi::CodeReferencesApi get_repositories GET /api/v2/code-refs/repositories List repositories
LaunchDarklyApi::CodeReferencesApi get_repository GET /api/v2/code-refs/repositories/{repo} Get repository
LaunchDarklyApi::CodeReferencesApi get_root_statistic GET /api/v2/code-refs/statistics Get links to code reference repositories for each project
LaunchDarklyApi::CodeReferencesApi get_statistics GET /api/v2/code-refs/statistics/{projectKey} Get code references statistics for flags
LaunchDarklyApi::CodeReferencesApi patch_repository PATCH /api/v2/code-refs/repositories/{repo} Update repository
LaunchDarklyApi::CodeReferencesApi post_extinction POST /api/v2/code-refs/repositories/{repo}/branches/{branch}/extinction-events Create extinction
LaunchDarklyApi::CodeReferencesApi post_repository POST /api/v2/code-refs/repositories Create repository
LaunchDarklyApi::CodeReferencesApi put_branch PUT /api/v2/code-refs/repositories/{repo}/branches/{branch} Upsert branch
LaunchDarklyApi::CustomRolesApi delete_custom_role DELETE /api/v2/roles/{customRoleKey} Delete custom role
LaunchDarklyApi::CustomRolesApi get_custom_role GET /api/v2/roles/{customRoleKey} Get custom role
LaunchDarklyApi::CustomRolesApi get_custom_roles GET /api/v2/roles List custom roles
LaunchDarklyApi::CustomRolesApi patch_custom_role PATCH /api/v2/roles/{customRoleKey} Update custom role
LaunchDarklyApi::CustomRolesApi post_custom_role POST /api/v2/roles Create custom role
LaunchDarklyApi::DataExportDestinationsApi delete_destination DELETE /api/v2/destinations/{projectKey}/{environmentKey}/{id} Delete Data Export destination
LaunchDarklyApi::DataExportDestinationsApi get_destination GET /api/v2/destinations/{projectKey}/{environmentKey}/{id} Get destination
LaunchDarklyApi::DataExportDestinationsApi get_destinations GET /api/v2/destinations List destinations
LaunchDarklyApi::DataExportDestinationsApi patch_destination PATCH /api/v2/destinations/{projectKey}/{environmentKey}/{id} Update Data Export destination
LaunchDarklyApi::DataExportDestinationsApi post_destination POST /api/v2/destinations/{projectKey}/{environmentKey} Create Data Export destination
LaunchDarklyApi::EnvironmentsApi delete_environment DELETE /api/v2/projects/{projectKey}/environments/{environmentKey} Delete environment
LaunchDarklyApi::EnvironmentsApi get_environment GET /api/v2/projects/{projectKey}/environments/{environmentKey} Get environment
LaunchDarklyApi::EnvironmentsApi get_environments_by_project GET /api/v2/projects/{projectKey}/environments List environments
LaunchDarklyApi::EnvironmentsApi patch_environment PATCH /api/v2/projects/{projectKey}/environments/{environmentKey} Update environment
LaunchDarklyApi::EnvironmentsApi post_environment POST /api/v2/projects/{projectKey}/environments Create environment
LaunchDarklyApi::EnvironmentsApi reset_environment_mobile_key POST /api/v2/projects/{projectKey}/environments/{environmentKey}/mobileKey Reset environment mobile SDK key
LaunchDarklyApi::EnvironmentsApi reset_environment_sdk_key POST /api/v2/projects/{projectKey}/environments/{environmentKey}/apiKey Reset environment SDK key
LaunchDarklyApi::ExperimentsBetaApi create_experiment POST /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments Create experiment
LaunchDarklyApi::ExperimentsBetaApi create_iteration POST /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey}/iterations Create iteration
LaunchDarklyApi::ExperimentsBetaApi get_experiment GET /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey} Get experiment
LaunchDarklyApi::ExperimentsBetaApi get_experiment_results GET /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey}/metrics/{metricKey}/results Get experiment results
LaunchDarklyApi::ExperimentsBetaApi get_experiments GET /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments Get experiments
LaunchDarklyApi::ExperimentsBetaApi get_legacy_experiment_results GET /api/v2/flags/{projectKey}/{featureFlagKey}/experiments/{environmentKey}/{metricKey} Get legacy experiment results (deprecated)
LaunchDarklyApi::ExperimentsBetaApi patch_experiment PATCH /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey} Patch experiment
LaunchDarklyApi::ExperimentsBetaApi reset_experiment DELETE /api/v2/flags/{projectKey}/{featureFlagKey}/experiments/{environmentKey}/{metricKey}/results Reset experiment results
LaunchDarklyApi::FeatureFlagsApi copy_feature_flag POST /api/v2/flags/{projectKey}/{featureFlagKey}/copy Copy feature flag
LaunchDarklyApi::FeatureFlagsApi delete_feature_flag DELETE /api/v2/flags/{projectKey}/{featureFlagKey} Delete feature flag
LaunchDarklyApi::FeatureFlagsApi get_expiring_user_targets GET /api/v2/flags/{projectKey}/{featureFlagKey}/expiring-user-targets/{environmentKey} Get expiring user targets for feature flag
LaunchDarklyApi::FeatureFlagsApi get_feature_flag GET /api/v2/flags/{projectKey}/{featureFlagKey} Get feature flag
LaunchDarklyApi::FeatureFlagsApi get_feature_flag_status GET /api/v2/flag-statuses/{projectKey}/{environmentKey}/{featureFlagKey} Get feature flag status
LaunchDarklyApi::FeatureFlagsApi get_feature_flag_status_across_environments GET /api/v2/flag-status/{projectKey}/{featureFlagKey} Get flag status across environments
LaunchDarklyApi::FeatureFlagsApi get_feature_flag_statuses GET /api/v2/flag-statuses/{projectKey}/{environmentKey} List feature flag statuses
LaunchDarklyApi::FeatureFlagsApi get_feature_flags GET /api/v2/flags/{projectKey} List feature flags
LaunchDarklyApi::FeatureFlagsApi patch_expiring_user_targets PATCH /api/v2/flags/{projectKey}/{featureFlagKey}/expiring-user-targets/{environmentKey} Update expiring user targets on feature flag
LaunchDarklyApi::FeatureFlagsApi patch_feature_flag PATCH /api/v2/flags/{projectKey}/{featureFlagKey} Update feature flag
LaunchDarklyApi::FeatureFlagsApi post_feature_flag POST /api/v2/flags/{projectKey} Create a feature flag
LaunchDarklyApi::FeatureFlagsBetaApi get_dependent_flags GET /api/v2/flags/{projectKey}/{featureFlagKey}/dependent-flags List dependent feature flags
LaunchDarklyApi::FeatureFlagsBetaApi get_dependent_flags_by_env GET /api/v2/flags/{projectKey}/{environmentKey}/{featureFlagKey}/dependent-flags List dependent feature flags by environment
LaunchDarklyApi::FlagLinksBetaApi create_flag_link POST /api/v2/flag-links/projects/{projectKey}/flags/{featureFlagKey} Create flag link
LaunchDarklyApi::FlagLinksBetaApi delete_flag_link DELETE /api/v2/flag-links/projects/{projectKey}/flags/{featureFlagKey}/{id} Delete flag link
LaunchDarklyApi::FlagLinksBetaApi get_flag_links GET /api/v2/flag-links/projects/{projectKey}/flags/{featureFlagKey} List flag links
LaunchDarklyApi::FlagLinksBetaApi update_flag_link PATCH /api/v2/flag-links/projects/{projectKey}/flags/{featureFlagKey}/{id} Update flag link
LaunchDarklyApi::FlagTriggersApi create_trigger_workflow POST /api/v2/flags/{projectKey}/{featureFlagKey}/triggers/{environmentKey} Create flag trigger
LaunchDarklyApi::FlagTriggersApi delete_trigger_workflow DELETE /api/v2/flags/{projectKey}/{featureFlagKey}/triggers/{environmentKey}/{id} Delete flag trigger
LaunchDarklyApi::FlagTriggersApi get_trigger_workflow_by_id GET /api/v2/flags/{projectKey}/{featureFlagKey}/triggers/{environmentKey}/{id} Get flag trigger by ID
LaunchDarklyApi::FlagTriggersApi get_trigger_workflows GET /api/v2/flags/{projectKey}/{featureFlagKey}/triggers/{environmentKey} List flag triggers
LaunchDarklyApi::FlagTriggersApi patch_trigger_workflow PATCH /api/v2/flags/{projectKey}/{featureFlagKey}/triggers/{environmentKey}/{id} Update flag trigger
LaunchDarklyApi::FollowFlagsApi delete_flag_followers 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
LaunchDarklyApi::FollowFlagsApi get_flag_followers GET /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/followers Get followers of a flag in a project and environment
LaunchDarklyApi::FollowFlagsApi get_followers_by_proj_env GET /api/v2/projects/{projectKey}/environments/{environmentKey}/followers Get followers of all flags in a given project and environment
LaunchDarklyApi::FollowFlagsApi put_flag_followers 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
LaunchDarklyApi::IntegrationAuditLogSubscriptionsApi create_subscription POST /api/v2/integrations/{integrationKey} Create audit log subscription
LaunchDarklyApi::IntegrationAuditLogSubscriptionsApi delete_subscription DELETE /api/v2/integrations/{integrationKey}/{id} Delete audit log subscription
LaunchDarklyApi::IntegrationAuditLogSubscriptionsApi get_subscription_by_id GET /api/v2/integrations/{integrationKey}/{id} Get audit log subscription by ID
LaunchDarklyApi::IntegrationAuditLogSubscriptionsApi get_subscriptions GET /api/v2/integrations/{integrationKey} Get audit log subscriptions by integration
LaunchDarklyApi::IntegrationAuditLogSubscriptionsApi update_subscription PATCH /api/v2/integrations/{integrationKey}/{id} Update audit log subscription
LaunchDarklyApi::IntegrationDeliveryConfigurationsBetaApi create_integration_delivery_configuration POST /api/v2/integration-capabilities/featureStore/{projectKey}/{environmentKey}/{integrationKey} Create delivery configuration
LaunchDarklyApi::IntegrationDeliveryConfigurationsBetaApi delete_integration_delivery_configuration DELETE /api/v2/integration-capabilities/featureStore/{projectKey}/{environmentKey}/{integrationKey}/{id} Delete delivery configuration
LaunchDarklyApi::IntegrationDeliveryConfigurationsBetaApi get_integration_delivery_configuration_by_environment GET /api/v2/integration-capabilities/featureStore/{projectKey}/{environmentKey} Get delivery configurations by environment
LaunchDarklyApi::IntegrationDeliveryConfigurationsBetaApi get_integration_delivery_configuration_by_id GET /api/v2/integration-capabilities/featureStore/{projectKey}/{environmentKey}/{integrationKey}/{id} Get delivery configuration by ID
LaunchDarklyApi::IntegrationDeliveryConfigurationsBetaApi get_integration_delivery_configurations GET /api/v2/integration-capabilities/featureStore List all delivery configurations
LaunchDarklyApi::IntegrationDeliveryConfigurationsBetaApi patch_integration_delivery_configuration PATCH /api/v2/integration-capabilities/featureStore/{projectKey}/{environmentKey}/{integrationKey}/{id} Update delivery configuration
LaunchDarklyApi::IntegrationDeliveryConfigurationsBetaApi validate_integration_delivery_configuration POST /api/v2/integration-capabilities/featureStore/{projectKey}/{environmentKey}/{integrationKey}/{id}/validate Validate delivery configuration
LaunchDarklyApi::MetricsApi delete_metric DELETE /api/v2/metrics/{projectKey}/{metricKey} Delete metric
LaunchDarklyApi::MetricsApi get_metric GET /api/v2/metrics/{projectKey}/{metricKey} Get metric
LaunchDarklyApi::MetricsApi get_metrics GET /api/v2/metrics/{projectKey} List metrics
LaunchDarklyApi::MetricsApi patch_metric PATCH /api/v2/metrics/{projectKey}/{metricKey} Update metric
LaunchDarklyApi::MetricsApi post_metric POST /api/v2/metrics/{projectKey} Create metric
LaunchDarklyApi::OAuth2ClientsBetaApi create_o_auth2_client POST /api/v2/oauth/clients Create a LaunchDarkly OAuth 2.0 client
LaunchDarklyApi::OAuth2ClientsBetaApi delete_o_auth_client DELETE /api/v2/oauth/clients/{clientId} Delete OAuth 2.0 client
LaunchDarklyApi::OAuth2ClientsBetaApi get_o_auth_client_by_id GET /api/v2/oauth/clients/{clientId} Get client by ID
LaunchDarklyApi::OAuth2ClientsBetaApi get_o_auth_clients GET /api/v2/oauth/clients Get clients
LaunchDarklyApi::OAuth2ClientsBetaApi patch_o_auth_client PATCH /api/v2/oauth/clients/{clientId} Patch client by ID
LaunchDarklyApi::OtherApi get_ips GET /api/v2/public-ip-list Gets the public IP list
LaunchDarklyApi::OtherApi get_openapi_spec GET /api/v2/openapi.json Gets the OpenAPI spec in json
LaunchDarklyApi::OtherApi get_root GET /api/v2 Root resource
LaunchDarklyApi::OtherApi get_versions GET /api/v2/versions Get version information
LaunchDarklyApi::ProjectsApi delete_project DELETE /api/v2/projects/{projectKey} Delete project
LaunchDarklyApi::ProjectsApi get_project GET /api/v2/projects/{projectKey} Get project
LaunchDarklyApi::ProjectsApi get_projects GET /api/v2/projects List projects
LaunchDarklyApi::ProjectsApi patch_project PATCH /api/v2/projects/{projectKey} Update project
LaunchDarklyApi::ProjectsApi post_project POST /api/v2/projects Create project
LaunchDarklyApi::RelayProxyConfigurationsApi delete_relay_auto_config DELETE /api/v2/account/relay-auto-configs/{id} Delete Relay Proxy config by ID
LaunchDarklyApi::RelayProxyConfigurationsApi get_relay_proxy_config GET /api/v2/account/relay-auto-configs/{id} Get Relay Proxy config
LaunchDarklyApi::RelayProxyConfigurationsApi get_relay_proxy_configs GET /api/v2/account/relay-auto-configs List Relay Proxy configs
LaunchDarklyApi::RelayProxyConfigurationsApi patch_relay_auto_config PATCH /api/v2/account/relay-auto-configs/{id} Update a Relay Proxy config
LaunchDarklyApi::RelayProxyConfigurationsApi post_relay_auto_config POST /api/v2/account/relay-auto-configs Create a new Relay Proxy config
LaunchDarklyApi::RelayProxyConfigurationsApi reset_relay_auto_config POST /api/v2/account/relay-auto-configs/{id}/reset Reset Relay Proxy configuration key
LaunchDarklyApi::ScheduledChangesApi delete_flag_config_scheduled_changes DELETE /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/scheduled-changes/{id} Delete scheduled changes workflow
LaunchDarklyApi::ScheduledChangesApi get_feature_flag_scheduled_change GET /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/scheduled-changes/{id} Get a scheduled change
LaunchDarklyApi::ScheduledChangesApi get_flag_config_scheduled_changes GET /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/scheduled-changes List scheduled changes
LaunchDarklyApi::ScheduledChangesApi patch_flag_config_scheduled_change PATCH /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/scheduled-changes/{id} Update scheduled changes workflow
LaunchDarklyApi::ScheduledChangesApi post_flag_config_scheduled_changes POST /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/scheduled-changes Create scheduled changes workflow
LaunchDarklyApi::SegmentsApi delete_segment DELETE /api/v2/segments/{projectKey}/{environmentKey}/{segmentKey} Delete segment
LaunchDarklyApi::SegmentsApi get_expiring_user_targets_for_segment GET /api/v2/segments/{projectKey}/{segmentKey}/expiring-user-targets/{environmentKey} Get expiring user targets for segment
LaunchDarklyApi::SegmentsApi get_segment GET /api/v2/segments/{projectKey}/{environmentKey}/{segmentKey} Get segment
LaunchDarklyApi::SegmentsApi get_segment_membership_for_user GET /api/v2/segments/{projectKey}/{environmentKey}/{segmentKey}/users/{userKey} Get Big Segment membership for user
LaunchDarklyApi::SegmentsApi get_segments GET /api/v2/segments/{projectKey}/{environmentKey} List segments
LaunchDarklyApi::SegmentsApi patch_expiring_user_targets_for_segment PATCH /api/v2/segments/{projectKey}/{segmentKey}/expiring-user-targets/{environmentKey} Update expiring user targets for segment
LaunchDarklyApi::SegmentsApi patch_segment PATCH /api/v2/segments/{projectKey}/{environmentKey}/{segmentKey} Patch segment
LaunchDarklyApi::SegmentsApi post_segment POST /api/v2/segments/{projectKey}/{environmentKey} Create segment
LaunchDarklyApi::SegmentsApi update_big_segment_targets POST /api/v2/segments/{projectKey}/{environmentKey}/{segmentKey}/users Update targets on a Big Segment
LaunchDarklyApi::SegmentsBetaApi create_big_segment_export POST /api/v2/segments/{projectKey}/{environmentKey}/{segmentKey}/exports Create Big Segment export
LaunchDarklyApi::SegmentsBetaApi create_big_segment_import POST /api/v2/segments/{projectKey}/{environmentKey}/{segmentKey}/imports Create Big Segment import
LaunchDarklyApi::SegmentsBetaApi get_big_segment_export GET /api/v2/segments/{projectKey}/{environmentKey}/{segmentKey}/exports/{exportID} Get Big Segment export
LaunchDarklyApi::SegmentsBetaApi get_big_segment_import GET /api/v2/segments/{projectKey}/{environmentKey}/{segmentKey}/imports/{importID} Get Big Segment import
LaunchDarklyApi::TagsApi get_tags GET /api/v2/tags List tags
LaunchDarklyApi::TeamsApi delete_team DELETE /api/v2/teams/{teamKey} Delete team
LaunchDarklyApi::TeamsApi get_team GET /api/v2/teams/{teamKey} Get team
LaunchDarklyApi::TeamsApi get_team_maintainers GET /api/v2/teams/{teamKey}/maintainers Get team maintainers
LaunchDarklyApi::TeamsApi get_team_roles GET /api/v2/teams/{teamKey}/roles Get team custom roles
LaunchDarklyApi::TeamsApi get_teams GET /api/v2/teams List teams
LaunchDarklyApi::TeamsApi patch_team PATCH /api/v2/teams/{teamKey} Update team
LaunchDarklyApi::TeamsApi post_team POST /api/v2/teams Create team
LaunchDarklyApi::TeamsApi post_team_members POST /api/v2/teams/{teamKey}/members Add multiple members to team
LaunchDarklyApi::UserSettingsApi get_expiring_flags_for_user GET /api/v2/users/{projectKey}/{userKey}/expiring-user-targets/{environmentKey} Get expiring dates on flags for user
LaunchDarklyApi::UserSettingsApi get_user_flag_setting GET /api/v2/users/{projectKey}/{environmentKey}/{userKey}/flags/{featureFlagKey} Get flag setting for user
LaunchDarklyApi::UserSettingsApi get_user_flag_settings GET /api/v2/users/{projectKey}/{environmentKey}/{userKey}/flags List flag settings for user
LaunchDarklyApi::UserSettingsApi patch_expiring_flags_for_user PATCH /api/v2/users/{projectKey}/{userKey}/expiring-user-targets/{environmentKey} Update expiring user target for flags
LaunchDarklyApi::UserSettingsApi put_flag_setting PUT /api/v2/users/{projectKey}/{environmentKey}/{userKey}/flags/{featureFlagKey} Update flag settings for user
LaunchDarklyApi::UsersApi delete_user DELETE /api/v2/users/{projectKey}/{environmentKey}/{userKey} Delete user
LaunchDarklyApi::UsersApi get_search_users GET /api/v2/user-search/{projectKey}/{environmentKey} Find users
LaunchDarklyApi::UsersApi get_user GET /api/v2/users/{projectKey}/{environmentKey}/{userKey} Get user
LaunchDarklyApi::UsersApi get_users GET /api/v2/users/{projectKey}/{environmentKey} List users
LaunchDarklyApi::UsersBetaApi get_user_attribute_names GET /api/v2/user-attributes/{projectKey}/{environmentKey} Get user attribute names
LaunchDarklyApi::WebhooksApi delete_webhook DELETE /api/v2/webhooks/{id} Delete webhook
LaunchDarklyApi::WebhooksApi get_all_webhooks GET /api/v2/webhooks List webhooks
LaunchDarklyApi::WebhooksApi get_webhook GET /api/v2/webhooks/{id} Get webhook
LaunchDarklyApi::WebhooksApi patch_webhook PATCH /api/v2/webhooks/{id} Update webhook
LaunchDarklyApi::WebhooksApi post_webhook POST /api/v2/webhooks Creates a webhook
LaunchDarklyApi::WorkflowsBetaApi delete_workflow DELETE /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/workflows/{workflowId} Delete workflow
LaunchDarklyApi::WorkflowsBetaApi get_custom_workflow GET /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/workflows/{workflowId} Get custom workflow
LaunchDarklyApi::WorkflowsBetaApi get_workflows GET /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/workflows Get workflows
LaunchDarklyApi::WorkflowsBetaApi post_workflow 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

Sample Code

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

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

api_instance = LaunchDarklyApi::FeatureFlagsApi.new

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

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

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

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

About

LaunchDarkly API Client for Ruby

Resources

Readme

License

View license
Activity

Stars

0 stars

Watchers

0 watching

Forks

0 forks
Report repository

Releases

52 tags

Packages

No packages published

Languages

  • Ruby 100.0%