/launchdarkly-flags | Type: Application | PCID required: Yes
Tools
launchdarkly_flags_copy_feature_flag
Copy feature flag Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
featureFlagKey | string | Yes | — | The feature flag key. The key identifies the flag in your code. |
comment | string | No | — | Optional comment |
excludedActions | string[] | No | — | Optional list of the flag changes NOT to copy from the source environment to the target environment. You may include either <code>includedActions</code> or <code>excludedActions</code>, but not both. If you include neither, then all flag changes will be copied. |
includedActions | string[] | No | — | Optional list of the flag changes to copy from the source environment to the target environment. You may include either <code>includedActions</code> or <code>excludedActions</code>, but not both. If you include neither, then all flag changes will be copied. |
source | object | Yes | — | The source value |
target | object | Yes | — | The target value |
launchdarkly_flags_create_flag_link
Create flag link Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
featureFlagKey | string | Yes | — | The feature flag key |
deepLink | string | No | — | The URL for the external resource you are linking the flag to |
description | string | No | — | The description of the flag link |
integrationKey | string | No | — | The integration key for an integration whose <code>manifest.json</code> includes the <code>flagLink</code> capability, if this is a flag link for an existing integration. Do not include for URL flag links. |
key | string | No | — | The flag link key |
metadata | object | No | — | The metadata required by this integration in order to create a flag link, if this is a flag link for an existing integration. Defined in the integration’s <code>manifest.json</code> file under <code>flagLink</code>. |
timestamp | integer | No | — | The timestamp value |
title | string | No | — | The title of the flag link |
launchdarkly_flags_create_trigger_workflow
Create flag trigger Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
environmentKey | string | Yes | — | The environment key |
featureFlagKey | string | Yes | — | The feature flag key |
comment | string | No | — | Optional comment describing the trigger |
instructions | object[] | No | — | The action to perform when triggering. This should be an array with a single object that looks like <code>{“kind”: “flag_action”}</code>. Supported flag actions are <code>turnFlagOn</code> and <code>turnFlagOff</code>. |
integrationKey | string | Yes | — | The unique identifier of the integration for your trigger. Use <code>generic-trigger</code> for integrations not explicitly supported. |
launchdarkly_flags_delete_feature_flag
Delete feature flag Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
featureFlagKey | string | Yes | — | The feature flag key. The key identifies the flag in your code. |
launchdarkly_flags_delete_flag_config_scheduled_changes
Delete scheduled changes workflow Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
featureFlagKey | string | Yes | — | The feature flag key |
environmentKey | string | Yes | — | The environment key |
id | string | Yes | — | The scheduled change id |
launchdarkly_flags_delete_flag_follower
Remove a member as a follower of a flag in a project and environment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
featureFlagKey | string | Yes | — | The feature flag key |
environmentKey | string | Yes | — | The environment key |
memberId | string | Yes | — | The memberId of the member to remove as a follower of the flag. Reader roles can only remove themselves. |
launchdarkly_flags_delete_flag_link
Delete flag link Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
featureFlagKey | string | Yes | — | The feature flag key |
id | string | Yes | — | The flag link ID or Key |
launchdarkly_flags_delete_trigger_workflow
Delete flag trigger Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
environmentKey | string | Yes | — | The environment key |
featureFlagKey | string | Yes | — | The feature flag key |
id | string | Yes | — | The flag trigger ID |
launchdarkly_flags_get_dependent_flags
List dependent feature flags Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
featureFlagKey | string | Yes | — | The feature flag key |
launchdarkly_flags_get_dependent_flags_by_env
List dependent feature flags by environment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
environmentKey | string | Yes | — | The environment key |
featureFlagKey | string | Yes | — | The feature flag key |
launchdarkly_flags_get_expiring_context_targets
Get expiring context targets for feature flag Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
environmentKey | string | Yes | — | The environment key |
featureFlagKey | string | Yes | — | The feature flag key |
launchdarkly_flags_get_expiring_user_targets
Get expiring user targets for feature flag Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
environmentKey | string | Yes | — | The environment key |
featureFlagKey | string | Yes | — | The feature flag key |
launchdarkly_flags_get_feature_flag
Get feature flag Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
featureFlagKey | string | Yes | — | The feature flag key |
env | string | No | — | Filter configurations by environment |
expand | string | No | — | A comma-separated list of fields to expand in the response. Supported fields are explained above. |
launchdarkly_flags_get_feature_flag_scheduled_change
Get a scheduled change Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
featureFlagKey | string | Yes | — | The feature flag key |
environmentKey | string | Yes | — | The environment key |
id | string | Yes | — | The scheduled change id |
launchdarkly_flags_get_feature_flag_status
Get feature flag status Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
environmentKey | string | Yes | — | The environment key |
featureFlagKey | string | Yes | — | The feature flag key |
launchdarkly_flags_get_feature_flag_status_across_environments
Get flag status across environments Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
featureFlagKey | string | Yes | — | The feature flag key |
env | string | No | — | Optional environment filter |
launchdarkly_flags_get_feature_flag_statuses
List feature flag statuses Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
environmentKey | string | Yes | — | The environment key |
launchdarkly_flags_get_feature_flags
List feature flags Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
env | string | No | — | Filter configurations by environment |
tag | string | No | — | Filter feature flags by tag |
limit | integer | No | — | The number of feature flags to return. Defaults to 20. |
offset | integer | No | — | Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query limit. |
archived | boolean | No | — | Deprecated, use filter=archived:true instead. A boolean to filter the list to archived flags. When this is absent, only unarchived flags will be returned |
summary | boolean | No | — | By default, flags do not include their lists of prerequisites, targets, or rules for each environment. Set summary=0 and include the env query parameter to include these fields for each flag returned. |
filter | string | No | — | A comma-separated list of filters. Each filter is of the form field:value. Read the endpoint description for a full list of available filter fields. |
sort | string | No | — | A comma-separated list of fields to sort by. Fields prefixed by a dash ( - ) sort in descending order. Read the endpoint description for a full list of available sort fields. |
compare | boolean | No | — | Deprecated, unavailable in API version 20240415. A boolean to filter results by only flags that have differences between environments. |
expand | string | No | — | A comma-separated list of fields to expand in the response. Supported fields are explained above. |
launchdarkly_flags_get_flag_config_scheduled_changes
List scheduled changes Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
featureFlagKey | string | Yes | — | The feature flag key |
environmentKey | string | Yes | — | The environment key |
launchdarkly_flags_get_flag_followers
Get followers of a flag in a project and environment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
featureFlagKey | string | Yes | — | The feature flag key |
environmentKey | string | Yes | — | The environment key |
launchdarkly_flags_get_flag_links
List flag links Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
featureFlagKey | string | Yes | — | The feature flag key |
launchdarkly_flags_get_followers_by_proj_env
Get followers of all flags in a given project and environment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
environmentKey | string | Yes | — | The environment key |
launchdarkly_flags_get_tags
List tags Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
kind | string[] | No | — | Fetch tags associated with the specified resource type. Options are flag, project, environment, segment, metric, metric-data-source, aiconfig, and view. Returns all types by default. |
pre | string | No | — | Return tags with the specified prefix |
archived | boolean | No | — | Whether or not to return archived flags |
limit | integer | No | — | The number of tags to return. Maximum is 1000. |
offset | integer | No | — | The index of the first tag to return. Default is 0. |
asOf | string | No | — | The time to retrieve tags as of. Default is the current time. |
launchdarkly_flags_get_trigger_workflow_by_id
Get flag trigger by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
featureFlagKey | string | Yes | — | The feature flag key |
environmentKey | string | Yes | — | The environment key |
id | string | Yes | — | The flag trigger ID |
launchdarkly_flags_get_trigger_workflows
List flag triggers Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
environmentKey | string | Yes | — | The environment key |
featureFlagKey | string | Yes | — | The feature flag key |
launchdarkly_flags_patch_expiring_targets
Update expiring context targets on feature flag Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
environmentKey | string | Yes | — | The environment key |
featureFlagKey | string | Yes | — | The feature flag key |
comment | string | No | — | Optional comment describing the change |
instructions | object[] | Yes | — | The instructions to perform when updating |
launchdarkly_flags_patch_expiring_user_targets
Update expiring user targets on feature flag Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
environmentKey | string | Yes | — | The environment key |
featureFlagKey | string | Yes | — | The feature flag key |
comment | string | No | — | Optional comment describing the change |
instructions | object[] | Yes | — | The instructions to perform when updating |
launchdarkly_flags_patch_feature_flag
Update feature flag Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
featureFlagKey | string | Yes | — | The feature flag key. The key identifies the flag in your code. |
ignoreConflicts | boolean | No | — | If true, the patch will be applied even if it causes a pending scheduled change or approval request to fail. |
dryRun | boolean | No | — | If true, the patch will be validated but not persisted. Returns a preview of the flag after the patch is applied. |
comment | string | No | — | Optional comment |
patch | object[] | Yes | — | The patch value |
launchdarkly_flags_patch_flag_config_scheduled_change
Update scheduled changes workflow Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
featureFlagKey | string | Yes | — | The feature flag key |
environmentKey | string | Yes | — | The environment key |
id | string | Yes | — | The scheduled change ID |
ignoreConflicts | boolean | No | — | Whether to succeed (true) or fail (false) when these new instructions conflict with existing scheduled changes |
comment | string | No | — | Optional comment describing the update to the scheduled changes |
instructions | object[] | Yes | — | The instructions value |
launchdarkly_flags_patch_trigger_workflow
Update flag trigger Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
environmentKey | string | Yes | — | The environment key |
featureFlagKey | string | Yes | — | The feature flag key |
id | string | Yes | — | The flag trigger ID |
comment | string | No | — | Optional comment describing the update |
instructions | object[] | No | — | The instructions to perform when updating. This should be an array with objects that look like <code>{“kind”: “trigger_action”}</code>. |
launchdarkly_flags_post_feature_flag
Create a feature flag Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
clone | string | No | — | The key of the feature flag to be cloned. The key identifies the flag in your code. For example, setting clone=flagKey copies the full targeting configuration for all environments, including on/off state, from the original flag to the new flag. |
clientSideAvailability | object | No | — | Client Side Availability |
customProperties | object | No | — | Custom Properties |
defaults | object | No | — | The defaults value |
description | string | No | — | Description of the feature flag. Defaults to an empty string. |
includeInSnippet | boolean | No | — | Deprecated, use <code>clientSideAvailability</code>. Whether this flag should be made available to the client-side JavaScript SDK. Defaults to <code>false</code>. |
initialPrerequisites | object[] | No | — | Initial set of prerequisite flags for all environments |
isFlagOn | boolean | No | — | Whether to automatically turn the flag on across all environments at creation. Defaults to <code>false</code>. |
key | string | Yes | — | A unique key used to reference the flag in your code |
maintainerId | string | No | — | The ID of the member who maintains this feature flag |
maintainerTeamKey | string | No | — | The key of the team that maintains this feature flag |
migrationSettings | object | No | — | Migration Settings |
name | string | Yes | — | A human-friendly name for the feature flag |
purpose | string | No | — | Purpose of the flag |
tags | string[] | No | — | Tags for the feature flag. Defaults to an empty array. |
temporary | boolean | No | — | Whether the flag is a temporary flag. Defaults to <code>true</code>. |
variations | object[] | No | — | An array of possible variations for the flag. The variation values must be unique. If omitted, two boolean variations of <code>true</code> and <code>false</code> will be used. |
launchdarkly_flags_post_flag_config_scheduled_changes
Create scheduled changes workflow Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
featureFlagKey | string | Yes | — | The feature flag key |
environmentKey | string | Yes | — | The environment key |
ignoreConflicts | boolean | No | — | Whether to succeed (true) or fail (false) when these instructions conflict with existing scheduled changes |
comment | string | No | — | Optional comment describing the scheduled changes |
executionDate | integer | Yes | — | Execution Date |
instructions | object[] | Yes | — | The instructions value |
launchdarkly_flags_post_migration_safety_issues
Get migration safety issues Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
flagKey | string | Yes | — | The migration flag key |
environmentKey | string | Yes | — | The environment key |
comment | string | No | — | The comment value |
instructions | object[] | Yes | — | The instructions value |
launchdarkly_flags_put_flag_follower
Add a member as a follower of a flag in a project and environment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
featureFlagKey | string | Yes | — | The feature flag key |
environmentKey | string | Yes | — | The environment key |
memberId | string | Yes | — | The memberId of the member to add as a follower of the flag. Reader roles can only add themselves. |
launchdarkly_flags_update_flag_link
Update flag link Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectKey | string | Yes | — | The project key |
featureFlagKey | string | Yes | — | The feature flag key |
id | string | Yes | — | The flag link ID |
body | object[] | Yes | — | Request body |

