flagLaunchDarkly

Procedures and concepts for the LaunchDarkly integration.

circle-info

The following documentation is for LaunchDarkly v1.0.3 (BDK).

Overview

LaunchDarkly is a feature management platform that enables teams to deploy code safely and control feature releases through feature flags. This integration allows automated feature flag management, user targeting, and deployment workflow automation. Enhance development velocity and reduce deployment risks through controlled feature rollouts.

Prerequisites

1. Required Books

The following Book(s) need to be added to your agent so it can learn and understand the automation procedures defined within them:

  • LaunchDarkly

How to Add the Book(s)

  1. Go to BooksAll Books.

  2. Search for the name of the book and click on it.

  3. Click on Install or Add Connection to add the book to your agent.

  4. If adding a connection, you'll be prompted for connectivity details.

Connectivity

This section outlines the available methods for connecting to the Book, along with the required configuration details for each.

This books supports the connectivity methods described in this section.In here you will find information about what information is required in order to employ each method.

Connect using Access Token

Creates a client with the provided access token

Label
Description
Type

Access Token

a Launch Darkly API access token

sensitive

Procedures

to create a flag in a project

Create a new feature flag within a given project.

Input Concepts

Concept
Description
Type
Required
Default Value

the project in which the new flag will be created

launch darkly project

Yes

(no default)

the flag object containing the configuration for the new feature flag

launch darkly flag

Yes

(no default)

Output Concepts

Concept
Description
Type

the newly created feature flag

launch darkly flag

Examples

to get some (flag's status)

Get the status of a feature flag in a specific environment.

Input Concepts

Concept
Description
Type
Required
Default Value

the feature flag whose status will be retrieved

launch darkly flag

Yes

(no default)

the environment in which to check the flag's status

launch darkly environment

Yes

(no default)

Output Concepts

Concept
Description
Type

a flag status indicating whether the flag is enabled (on) or disabled (off)

launch darkly flag status

Examples

to get some (project's environments)

FILTER - CAPABLE

Get the environments of a project

Input Concepts

Concept
Description
Type
Required
Default Value

a Launch Darkly project

launch darkly project

Yes

(no default)

Output Concepts

Concept
Description
Type

a list of retrieved environments

launch darkly environment

Examples

Get a single environment with name Test. It can also be filtered by environment key.

to get some (project's flags)

FILTER - CAPABLE

Get the flags of a project

Input Concepts

Concept
Description
Type
Required
Default Value

a Launch Darkly project

launch darkly project

Yes

(no default)

Output Concepts

Concept
Description
Type

a list of retrieved flags

launch darkly flag

Examples

Get a single flag with key new-test-flag. It can also be filtered by flag name.

to get some (projects)

FILTER - CAPABLE

Get the projects in Launch Darkly

Output Concepts

Concept
Description
Type

a list of retrieved projects

launch darkly project

Examples

Get a single project with name "Kognitos - Test Project". It can also be filtered by project key.

to toggle some flag

Toggle the state of a feature flag in a specific environment.

Input Concepts

Concept
Description
Type
Required
Default Value

the feature flag to be toggled

launch darkly flag

Yes

(no default)

the environment in which to toggle the flag

launch darkly environment

Yes

(no default)

on

a boolean indicating the desired state; True to enable the flag, False to disable it

boolean

Yes

(no default)

Output Concepts

Concept
Description
Type

the updated status of the feature flag

launch darkly flag status

Examples

Concepts

Launch darkly project

A project in Launch Darkly

Field Name
Description
Type

id

The unique identifier of the project.

text

name

The human-readable name of the project.

text

key

The project key used to reference it in API calls and configurations.

text

Launch darkly flag

A feature flag in a Launch Darkly project

Field Name
Description
Type

name

The human-readable name of the flag.

text

key

The unique key used to reference the flag.

text

description

A description of what the flag does or is used for.

optional[text]

project_key

The key of the project this flag belongs to. May be None if not yet assigned.

optional[text]

Launch darkly environment

An environment in a Launch Darkly project

Field Name
Description
Type

id

The unique identifier of the environment.

text

name

The human-readable name of the environment.

text

key

The environment key used in API calls and feature flag configuration.

text

project_key

The key of the project this environment belongs to.

text

Launch darkly flag status

The status of a feature flag in a certain environment

Field Name
Description
Type

environment

The environment in which the flag status is evaluated.

json

flag

The feature flag whose status is being represented.

json

is_on

Indicates whether the flag is currently enabled (True) or disabled (False).

boolean

Last updated

Was this helpful?