LaunchDarkly

Usage Instructions

Integrate LaunchDarkly into your workflow. List, create, update, toggle, and delete feature flags. Manage projects, environments, segments, members, and audit logs. Requires API Key.

Tools

`launchdarkly_create_flag`

Create a new feature flag in a LaunchDarkly project.

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	LaunchDarkly API key
`projectKey`	string	Yes	The project key to create the flag in
`name`	string	Yes	Human-readable name for the feature flag
`key`	string	Yes	Unique key for the feature flag (used in code)
`description`	string	No	Description of the feature flag
`tags`	string	No	Comma-separated list of tags
`temporary`	boolean	No	Whether the flag is temporary (default true)

Output

Parameter	Type	Description
`key`	string	The unique key of the feature flag
`name`	string	The human-readable name of the feature flag
`kind`	string	The type of flag (boolean or multivariate)
`description`	string	Description of the feature flag
`temporary`	boolean	Whether the flag is temporary
`archived`	boolean	Whether the flag is archived
`deprecated`	boolean	Whether the flag is deprecated
`creationDate`	number	Unix timestamp in milliseconds when the flag was created
`tags`	array	Tags applied to the flag
`variations`	array	The variations for this feature flag
`maintainerId`	string	The ID of the member who maintains this flag
`maintainerEmail`	string	The email of the member who maintains this flag

`launchdarkly_delete_flag`

Delete a feature flag from a LaunchDarkly project.

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	LaunchDarkly API key
`projectKey`	string	Yes	The project key
`flagKey`	string	Yes	The feature flag key to delete

Output

Parameter	Type	Description
`deleted`	boolean	Whether the flag was successfully deleted

`launchdarkly_get_audit_log`

List audit log entries from your LaunchDarkly account.

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	LaunchDarkly API key
`limit`	number	No	Maximum number of entries to return (default 10, max 20)
`spec`	string	No	Resource specifier filter (e.g. "proj/:env/:flag/*" for all flag changes, or "proj/default:env/production:flag/my-flag" for one flag in one environment)

Output

Parameter	Type	Description
`entries`	array	List of audit log entries
`totalCount`	number	Total number of audit log entries

`launchdarkly_get_flag`

Get a single feature flag by key from a LaunchDarkly project.

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	LaunchDarkly API key
`projectKey`	string	Yes	The project key
`flagKey`	string	Yes	The feature flag key
`environmentKey`	string	No	Filter flag configuration to a specific environment

Output

Parameter	Type	Description
`key`	string	The unique key of the feature flag
`name`	string	The human-readable name of the feature flag
`kind`	string	The type of flag (boolean or multivariate)
`description`	string	Description of the feature flag
`temporary`	boolean	Whether the flag is temporary
`archived`	boolean	Whether the flag is archived
`deprecated`	boolean	Whether the flag is deprecated
`creationDate`	number	Unix timestamp in milliseconds when the flag was created
`tags`	array	Tags applied to the flag
`variations`	array	The variations for this feature flag
`maintainerId`	string	The ID of the member who maintains this flag
`maintainerEmail`	string	The email of the member who maintains this flag
`on`	boolean	Whether the flag is on in the requested environment (null when the flag spans multiple environments and no environment key was provided)

`launchdarkly_get_flag_status`

Get the status of a feature flag across environments (active, inactive, launched, etc.).

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	LaunchDarkly API key
`projectKey`	string	Yes	The project key
`flagKey`	string	Yes	The feature flag key
`environmentKey`	string	Yes	The environment key

Output

Parameter	Type	Description
`name`	string	The flag status (new, active, inactive, launched)
`lastRequested`	string	Timestamp of the last evaluation
`defaultVal`	string	The default variation value

`launchdarkly_list_environments`

List environments in a LaunchDarkly project.

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	LaunchDarkly API key
`projectKey`	string	Yes	The project key to list environments for
`limit`	number	No	Maximum number of environments to return (default 20)

Output

Parameter	Type	Description
`environments`	array	List of environments
`totalCount`	number	Total number of environments

`launchdarkly_list_flags`

List feature flags in a LaunchDarkly project.

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	LaunchDarkly API key
`projectKey`	string	Yes	The project key to list flags for
`environmentKey`	string	No	Filter flag configurations to a specific environment
`tag`	string	No	Filter flags by tag name
`limit`	number	No	Maximum number of flags to return (default 20)

Output

Parameter	Type	Description
`flags`	array	List of feature flags
`totalCount`	number	Total number of flags

`launchdarkly_list_members`

List account members in your LaunchDarkly organization.

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	LaunchDarkly API key
`limit`	number	No	Maximum number of members to return (default 20)

Output

Parameter	Type	Description
`members`	array	List of account members
`totalCount`	number	Total number of members

`launchdarkly_list_projects`

List all projects in your LaunchDarkly account.

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	LaunchDarkly API key
`limit`	number	No	Maximum number of projects to return (default 20)

Output

Parameter	Type	Description
`projects`	array	List of projects
`totalCount`	number	Total number of projects

`launchdarkly_list_segments`

List user segments in a LaunchDarkly project and environment.

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	LaunchDarkly API key
`projectKey`	string	Yes	The project key
`environmentKey`	string	Yes	The environment key
`limit`	number	No	Maximum number of segments to return (default 20)

Output

Parameter	Type	Description
`segments`	array	List of user segments
`totalCount`	number	Total number of segments

`launchdarkly_toggle_flag`

Toggle a feature flag on or off in a specific LaunchDarkly environment.

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	LaunchDarkly API key
`projectKey`	string	Yes	The project key
`flagKey`	string	Yes	The feature flag key to toggle
`environmentKey`	string	Yes	The environment key to toggle the flag in
`enabled`	boolean	Yes	Whether to turn the flag on (true) or off (false)

Output

Parameter	Type	Description
`key`	string	The unique key of the feature flag
`name`	string	The human-readable name of the feature flag
`kind`	string	The type of flag (boolean or multivariate)
`description`	string	Description of the feature flag
`temporary`	boolean	Whether the flag is temporary
`archived`	boolean	Whether the flag is archived
`deprecated`	boolean	Whether the flag is deprecated
`creationDate`	number	Unix timestamp in milliseconds when the flag was created
`tags`	array	Tags applied to the flag
`variations`	array	The variations for this feature flag
`maintainerId`	string	The ID of the member who maintains this flag
`maintainerEmail`	string	The email of the member who maintains this flag
`on`	boolean	Whether the flag is now on in the target environment

`launchdarkly_update_flag`

Update feature flag metadata (name, description, tags, temporary, archived) using semantic patch.

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	LaunchDarkly API key
`projectKey`	string	Yes	The project key
`flagKey`	string	Yes	The feature flag key to update
`updateName`	string	No	New name for the flag
`updateDescription`	string	No	New description for the flag
`addTags`	string	No	Comma-separated tags to add
`removeTags`	string	No	Comma-separated tags to remove
`archive`	boolean	No	Set to true to archive, false to restore
`comment`	string	No	Optional comment explaining the update

Output

Parameter	Type	Description
`key`	string	The unique key of the feature flag
`name`	string	The human-readable name of the feature flag
`kind`	string	The type of flag (boolean or multivariate)
`description`	string	Description of the feature flag
`temporary`	boolean	Whether the flag is temporary
`archived`	boolean	Whether the flag is archived
`deprecated`	boolean	Whether the flag is deprecated
`creationDate`	number	Unix timestamp in milliseconds when the flag was created
`tags`	array	Tags applied to the flag
`variations`	array	The variations for this feature flag
`maintainerId`	string	The ID of the member who maintains this flag
`maintainerEmail`	string	The email of the member who maintains this flag

Notes

Category: tools
Type: launchdarkly

LaunchDarkly

On this page