Feature flags

Anatomy of a feature flag

The feature flag API allows you to control percentage rollouts, target specific users, or even toggle off a feature programmatically. By looking at the representation of a feature flag, we can see how to do any of these tasks.

Sample feature flag representation

Every feature flag has a set of top-level attributes, as well as an environments map containing the flag rollout and targeting rules specific to each environment. Top-level attributes include things like the flag's name, description, tags, and creation date. To learn more, read Using feature flags.

For reference, here's a complete feature flag representation. Below we break this down and explain each attribute in detail.

{
  "name": "Alternate product page",
  "kind": "boolean",
  "description": "This is a description",
  "key": "alternate.page",
  "creationDate": 1418684722483,
  "includeInSnippet": true,
  "variations": [
    {
      "value": true,
      "name": "true"
    },
    {
      "value": false,
      "name": "false"
    }
  ],
  "defaults": {
    "onVariation": 0,
    "offVariation": 1
  },
  "temporary": false,
  "tags": ["ops", "experiments"],
  "_links": {
    "parent": {
      "href": "/api/v2/flags/default",
      "type": "application/json"
    },
    "self": {
      "href": "/api/v2/flags/default/alternate.page",
      "type": "application/json"
    }
  },
  "maintainerId": "548f6741c1efad40031b18ae",
  "_maintainer": {
    "_links": {
      "parent": {
        "href": "/internal/account/members",
        "type": "application/json"
      },
      "self": {
        "href": "/internal/account/members/548f6741c1efad40031b18ae",
        "type": "application/json"
      }
    },
    "_id": "548f6741c1efad40031b18ae",
    "firstName": "Reese",
    "lastName": "App",
    "role": "owner",
    "email": "refapp@launchdarkly.com",
    "_pendingInvite": false,
    "isBeta": false,
    "customRoles": []
  },
  "goalIds": [],
  "environments": {
    "production": {
      "on": true,
      "archived": false,
      "salt": "YWx0ZXJuYXRlLnBhZ2U=",
      "sel": "45501b9314dc4641841af774cb038b96",
      "lastModified": 1469326565348,
      "version": 61,
      "targets": [
        {
          "values": ["1461797806427-7-115540266"],
          "variation": 0
        },
        {
          "values": ["Gerhard.Little@yahoo.com"],
          "variation": 1
        }
      ],
      "rules": [
        {
          "variation": 0,
          "clauses": [
            {
              "attribute": "groups",
              "op": "in",
              "values": ["Top Customers"],
              "negate": false
            },
            {
              "attribute": "email",
              "op": "endsWith",
              "values": ["gmail.com"],
              "negate": false
            }
          ]
        }
      ],
      "fallthrough": {
        "rollout": {
          "variations": [
            {
              "variation": 0,
              "weight": 60000
            },
            {
              "variation": 1,
              "weight": 40000
            }
          ]
        }
      },
      "offVariation": 1,
      "prerequisites": [],
      "_site": {
        "href": "/default/production/features/alternate.page",
        "type": "text/html"
      }
    },
    "test": {
      "on": true,
      "archived": false,
      "salt": "YWx0ZXJuYXRlLnBhZ2U=",
      "sel": "76c63094d35949bb9dc9bd5c570bacf5",
      "lastModified": 1455145480896,
      "version": 37,
      "targets": [
        {
          "values": [],
          "variation": 0
        },
        {
          "values": [],
          "variation": 1
        }
      ],
      "rules": [],
      "fallthrough": {
        "rollout": {
          "variations": [
            {
              "variation": 0,
              "weight": 49000
            },
            {
              "variation": 1,
              "weight": 51000
            }
          ]
        }
      },
      "prerequisites": [],
      "_site": {
        "href": "/default/tester/features/alternate.page",
        "type": "text/html"
      }
    }
  }
}

Top-level attributes

Most of the top-level attributes have a straightforward interpretation. For example, to change the name of a feature, update the feature flag with the name attribute set to the new name:

[
    { "op": "replace", "path": "/name", "value": "New name" }
]

The variations array represents the different variation values that a feature flag has. For a boolean flag, there are two variations: true and false. Multivariate flags have more variation values, and those values could be any JSON type: numbers, strings, objects, or arrays. In targeting rules, the variations are referred to by their index into this array. Below are some specific examples.

Per-environment configurations

Each entry in the environments map contains a JSON object that represents the environment-specific flag configuration data available in the flag's Targeting tab. For example, to toggle off a feature flag in your production environment, use the following JSON patch operation:

[
    { "op": "replace", "path": "/environments/production/on", "value": false }
]

To learn more, read Targeting users.

Each section of the Targeting tab corresponds to a different attribute of the per-environment configuration data, as shown here:

Individual user targets

The targets array in the per-environment configuration data represents the individual user targeting rules on the Targeting tab. To learn more, read Targeting users.

Each object in the targets array represents a list of user keys assigned to a particular variation. For example:

{
    ...
    "environments" : {
        "production" : {
            ...
            "targets": [
                {
                    "values": ["foo@example.com"],
                    "variation: 0
                }
            ]
        }
    }
}

This targets array here means that user foo@example.com receives the first variation listed in the variations array. Recall that the variations are stored at the top level of the flag JSON in an array, and the per-environment configuration rules point to indexes into this array. If this is a boolean flag, foo@example.com is receiving the true variation.

Targeting rules

The rules array corresponds to the custom targeting rules section of the Targeting tab. This is where you can express complex rules on attributes with conditions and operators. For example, a rule like "roll out the true variation to 80% of users whose email address ends with gmail.com could be expressed here. To learn more, read Creating targeting rules.

The fallthrough rule

The fallthrough object is a special rule that contains no conditions. It is the rollout strategy that is applied when none of the individual or custom targeting rules match.

The off variation

The off variation represents the variation to serve if the feature flag is turned off, meaning the on attribute is false. For boolean flags, this is usually false. For multivariate flags, set the off variation to whatever variation represents the control or baseline behavior for your application. If you don't set the off variation, LaunchDarkly will serve the fallback value defined in your code.

Percentage rollouts

The weight attribute defines the percentage rollout for each variation. Weights range from 0 (a 0% rollout) to 100000 (a 100% rollout). The weights are scaled by a factor of 1000 so that fractions of a percent can be represented without using floating-point. For example, a weight of 50000 means that 50% of users that don't otherwise match any targets will see that variation. The sum of weights across all variations should be 100%.

Get flag status across environments

Get the status for a particular feature flag across environments.

Request
path Parameters
projectKey
required
string <string>

The project key

featureFlagKey
required
string <string>

The feature flag key

query Parameters
env
string <string>

Optional environment filter

Responses
200

Flag status across environments response

401

Invalid access token

403

Forbidden

404

Invalid resource identifier

429

Rate limited

get/api/v2/flag-status/{projectKey}/{featureFlagKey}
Request samples
Response samples
application/json
{
  • "environments": {
    },
  • "key": "my-flag",
  • "_links": {
    }
}

List feature flag statuses

Get a list of statuses for all feature flags. The status includes the last time the feature flag was requested, as well as a state, which is one of the following:

  • new: the feature flag was created within the last seven days, and has not been requested yet
  • active: the feature flag was requested by your servers or clients within the last seven days
  • inactive: the feature flag was created more than seven days ago, and hasn't been requested by your servers or clients within the past seven days
  • launched: one variation of the feature flag has been rolled out to all your users for at least 7 days
Request
path Parameters
projectKey
required
string <string>

The project key

environmentKey
required
string <string>

The environment key

Responses
200

Flag Statuses collection response

401

Invalid access token

403

Forbidden

404

Invalid resource identifier

429

Rate limited

get/api/v2/flag-statuses/{projectKey}/{environmentKey}
Request samples
Response samples
application/json
{
  • "_links": {
    },
  • "items": [
    ]
}

Get feature flag status

Get the status for a particular feature flag.

Request
path Parameters
projectKey
required
string <string>

The project key

environmentKey
required
string <string>

The environment key

featureFlagKey
required
string <string>

The feature flag key

Responses
200

Flag status response

401

Invalid access token

403

Forbidden

404

Invalid resource identifier

429

Rate limited

get/api/v2/flag-statuses/{projectKey}/{environmentKey}/{featureFlagKey}
Request samples
Response samples
application/json
{
  • "_links": {
    },
  • "name": "inactive",
  • "lastRequested": "2020-02-05T18:17:01.514Z",
  • "default": null
}

List feature flags

Get a list of all features in the given project. By default, each feature includes configurations for each environment. You can filter environments with the env query parameter. For example, setting env=production restricts the returned configurations to just your production environment. You can also filter feature flags by tag with the tag query parameter.

You can filter on certain fields using the filter query parameter. For example, setting filter=query:dark-mode,tags:beta+test matches flags with the string dark-mode in their key or name, ignoring case, which also have the tags beta and test.

The filter query parameter supports the following arguments:

  • query is a string that matches against the flags' keys and names. It is not case sensitive.
  • archived is a boolean with values of true or false that filters the list to archived flags. Setting the value to true returns only archived flags. When this is absent, only unarchived flags are returned.
  • type is a string allowing filtering to temporary or permanent flags.
  • status is a string allowing filtering to new, inactive, active, or launched flags in the specified environment. This filter also requires a filterEnv field to be set to a valid environment. For example: filter=status:active,filterEnv:production.
  • tags is a + separated list of tags. It filters the list to members who have all of the tags in the list. For example: filter=tags:beta+test.
  • hasExperiment is a boolean with values of true or false that returns any flags that have an attached metric.
  • hasDataExport is a boolean with values of true or false that returns any flags that are exporting data in the specified environment. This includes flags that are exporting data from Experimentation. This filter also requires that you set a filterEnv field to a valid environment key. For example: filter=hasDataExport:true,filterEnv:production
  • evaluated is an object that contains a key of after and a value in Unix time in milliseconds. This returns all flags that have been evaluated since the time you specify in the environment provided. This filter also requires you to set a filterEnv field to a valid environment. For example: filter=evaluated:{"after": 1590768455282},filterEnv:production.
  • filterEnv is a string with the key of a valid environment. You can use the filterEnv field for filters that are environment-specific. If there are multiple environment-specific filters, you should only declare this parameter once. For example: filter=evaluated:{"after": 1590768455282},filterEnv:production,status:active.

By default, this returns all flags. You can page through the list with the limit parameter and by following the first, prev, next, and last links in the returned _links field. These links will not be present if the pages they refer to don't exist. For example, the first and prev links will be missing from the response on the first page.

Request
path Parameters
projectKey
required
string <string>

The project key

query Parameters
env
string <string>

Filter configurations by environment

tag
string <string>

Filter feature flags by tag

limit
integer <int64>

The number of feature flags to return. Defaults to -1, which returns all flags

offset
integer <int64>

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 <boolean>

A boolean to filter the list to archived flags. When this is absent, only unarchived flags will be returned

summary
boolean <boolean>

By default in API version >= 1, flags will not include their list of prerequisites, targets or rules. Set summary=0 to include these fields for each flag returned

filter
string <string>

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 <string>

A comma-separated list of fields to sort by. Fields prefixed by a dash ( - ) sort in descending order

compare
boolean <boolean>

A boolean to filter results by only flags that have differences between environments

Responses
200

Global flags collection response

400

Invalid request

401

Invalid access token

403

Forbidden

404

Invalid resource identifier

429

Rate limited

get/api/v2/flags/{projectKey}
Request samples
Response samples
application/json
{
  • "items": [
    ],
  • "_links": {
    },
  • "totalCount": 1,
  • "totalCountWithDifferences": 0
}

Create a feature flag

Create a feature flag with the given name, key, and variations.

Request
path Parameters
projectKey
required
string <string>

The project key

query Parameters
clone
string <string>

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.

Request Body schema: application/json
name
required
string

A human-friendly name for the feature flag

key
required
string

A unique key used to reference the flag in your code

description
string

Description of the feature flag. Defaults to an empty string.

includeInSnippet
boolean

Deprecated, use clientSideAvailability. Whether this flag should be made available to the client-side JavaScript SDK. Defaults to false.

object (ClientSideAvailabilityPost)
Array of objects (Variation)

An array of possible variations for the flag. The variation values must be unique. If omitted, two boolean variations of true and false will be used.

temporary
boolean

Whether the flag is a temporary flag. Defaults to true.

tags
Array of strings

Tags for the feature flag. Defaults to an empty array.

object (CustomProperties)
object (Defaults)
Responses
201

Global flag response

400

Invalid request

401

Invalid access token

409

Status conflict

429

Rate limited

post/api/v2/flags/{projectKey}
Request samples
application/json
{
  • "clientSideAvailability": {
    },
  • "key": "my-flag",
  • "name": "My Flag"
}
Response samples
application/json
{
  • "name": "My Flag",
  • "kind": "boolean",
  • "description": "This flag controls the example widgets",
  • "key": "my-flag",
  • "_version": 1,
  • "creationDate": 0,
  • "includeInSnippet": true,
  • "clientSideAvailability": {
    },
  • "variations": [
    ],
  • "temporary": true,
  • "tags": [
    ],
  • "_links": {
    },
  • "maintainerId": "569f183514f4432160000007",
  • "_maintainer": {
    },
  • "goalIds": [ ],
  • "experiments": {
    },
  • "customProperties": {
    },
  • "archived": false,
  • "archivedDate": 0,
  • "defaults": {
    },
  • "environments": {
    }
}

Get feature flag

Get a single feature flag by key. By default, this returns the configurations for all environments. You can filter environments with the env query parameter. For example, setting env=production restricts the returned configurations to just the production environment.

Request
path Parameters
projectKey
required
string <string>

The project key

featureFlagKey
required
string <string>

The feature flag key

query Parameters
env
string <string>

Filter configurations by environment

Responses
200

Global flag response

401

Invalid access token

403

Forbidden

404

Invalid resource identifier

429

Rate limited

get/api/v2/flags/{projectKey}/{featureFlagKey}
Request samples
Response samples
application/json
{
  • "name": "My Flag",
  • "kind": "boolean",
  • "description": "This flag controls the example widgets",
  • "key": "my-flag",
  • "_version": 1,
  • "creationDate": 0,
  • "includeInSnippet": true,
  • "clientSideAvailability": {
    },
  • "variations": [
    ],
  • "temporary": true,
  • "tags": [
    ],
  • "_links": {
    },
  • "maintainerId": "569f183514f4432160000007",
  • "_maintainer": {
    },
  • "goalIds": [ ],
  • "experiments": {
    },
  • "customProperties": {
    },
  • "archived": false,
  • "archivedDate": 0,
  • "defaults": {
    },
  • "environments": {
    }
}

Update feature flag

Perform a partial update to a feature flag. The request body must be a valid semantic patch or JSON patch.

Using semantic patches on a feature flag

To make a semantic patch request, you must append domain-model=launchdarkly.semanticpatch to your Content-Type header. To learn more, read Updates using semantic patch.

The body of a semantic patch request for updating feature flags requires an environmentKey in addition to instructions and an optional comment. The body of the request takes the following properties:

  • comment (string): (Optional) A description of the update.
  • environmentKey (string): (Required) The key of the LaunchDarkly environment.
  • 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.

Instructions

Semantic patch requests support the following kind instructions for updating feature flags.

Click to expand instructions for turning flags on and off

turnFlagOff

Sets the flag's targeting state to Off.

For example, to turn a flag off, use this request body:

{
  "environmentKey": "example-environment-key",
  "instructions": [ { "kind": "turnFlagOff" } ]
}

turnFlagOn

Sets the flag's targeting state to On.

For example, to turn a flag on, use this request body:

{
  "environmentKey": "example-environment-key",
  "instructions": [ { "kind": "turnFlagOn" } ]
}

Click to expand instructions for working with targeting and variations

addClauses

Adds the given clauses to the rule indicated by ruleId.

Parameters
  • ruleId: ID of a rule in the flag.
  • clauses: Array of clause objects, with attribute (string), op (string), negate (boolean), and values (array of strings, numbers, or dates) properties.

addPrerequisite

Adds the flag indicated by key with variation variationId as a prerequisite to the flag in the path parameter.

Parameters
  • key: Flag key of the prerequisite flag.
  • variationId: ID of a variation of the prerequisite flag.

addRule

Adds a new targeting rule to the flag. The rule may contain clauses and serve the variation that variationId indicates, or serve a percentage rollout that rolloutWeights and rolloutBucketBy indicate.

If you set beforeRuleId, this adds the new rule before the indicated rule. Otherwise, adds the new rule to the end of the list.

Parameters
  • clauses: Array of clause objects, with attribute (string), op (string), negate (boolean), and values (array of strings, numbers, or dates) properties.
  • beforeRuleId: (Optional) ID of a flag rule.
  • variationId: ID of a variation of the flag.
  • rolloutWeights: Map of variationId to weight, in thousandths of a percent (0-100000).
  • rolloutBucketBy: (Optional) User attribute.

addUserTargets

Adds user keys to the individual user targets for the variation that variationId specifies. Returns an error if this causes the flag to target the same user key in multiple variations.

Parameters
  • values: List of user keys.
  • variationId: ID of a variation on the flag.

addValuesToClause

Adds values to the values of the clause that ruleId and clauseId indicate.

Parameters
  • ruleId: ID of a rule in the flag.
  • clauseId: ID of a clause in that rule.
  • values: Array of strings.

clearUserTargets

Removes all individual user targets from the variation that variationId specifies.

Parameters
  • variationId: ID of a variation on the flag.

removeClauses

Removes the clauses specified by clauseIds from the rule indicated by ruleId.

Parameters
  • ruleId: ID of a rule in the flag.
  • clauseIds: Array of IDs of clauses in the rule.

removePrerequisite

Removes the prerequisite flag indicated by key. Does nothing if this prerequisite does not exist.

Parameters
  • key: Flag key of an existing prerequisite flag.

removeRule

Removes the targeting rule specified by ruleId. Does nothing if the rule does not exist.

Parameters
  • ruleId: ID of a rule in the flag.

removeUserTargets

Removes user keys from the individual user targets for the variation that variationId specifies. Does nothing if the flag does not target the user keys.

Parameters
  • values: List of user keys.
  • variationId: ID of a flag variation.

removeValuesFromClause

Removes values from the values of the clause indicated by ruleId and clauseId.

Parameters
  • ruleId: ID of a rule in the flag.
  • clauseId: ID of a clause in that rule.
  • values: Array of strings.

reorderRules

Rearranges the rules to match the order given in ruleIds. Returns an error if ruleIds does not match the current set of rules on the flag.

Parameters
  • ruleIds: Array of IDs of all rules in the flag.

replacePrerequisites

Removes all existing prerequisites and replaces them with the list you provide.

Parameters
  • prerequisites: A list of prerequisites. Each item in the list must include a flag key and variationId.

For example, to replace prerequisites, use this request body:

{
  "environmentKey": "example-environment-key",
  "instructions": [
    {
      "kind": "replacePrerequisites",
      "prerequisites": [
        {
          "key": "prereq-flag-key",
          "variationId": "variation-1"
        },
        {
          "key": "another-prereq-flag-key",
          "variationId": "variation-2"
        }
      ]
    }
  ]
}

replaceRules

Removes all targeting rules for the flag and replaces them with the list you provide.

Parameters
  • rules: A list of rules.

For example, to replace rules, use this request body:

{
  "environmentKey": "example-environment-key",
  "instructions": [
    {
      "kind": "replaceRules",
      "rules": [
        {
          "variationId": "variation-1",
          "description": "myRule",
          "clauses": [
            {
              "attribute": "segmentMatch",
              "op": "segmentMatch",
              "values": ["test"]
            }
          ],
          "trackEvents": true
        }
      ]
    }
  ]
}

replaceUserTargets

Removes all existing user targeting and replaces it with the list of targets you provide.

Parameters
  • targets: A list of user targeting. Each item in the list must include a variationId and a list of values.

For example, to replace user targets, use this request body:

{
  "environmentKey": "example-environment-key",
  "instructions": [
    {
      "kind": "replaceUserTargets",
      "targets": [
        {
          "variationId": "variation-1",
          "values": ["blah", "foo", "bar"]
        },
        {
          "variationId": "variation-2",
          "values": ["abc", "def"]
        }
      ]
    }    
  ]
}

updateClause

Replaces the clause indicated by ruleId and clauseId with clause.

Parameters
  • ruleId: ID of a rule in the flag.
  • clauseId: ID of a clause in that rule.
  • clause: New clause object, with attribute (string), op (string), negate (boolean), and values (array of strings, numbers, or dates) properties.

updateFallthroughVariationOrRollout

Updates the default or "fallthrough" rule for the flag, which the flag serves when a user matches none of the targeting rules. The rule can serve either the variation that variationId indicates, or a percent rollout that rolloutWeights and rolloutBucketBy indicate.

Parameters
  • variationId: ID of a variation of the flag. or
  • rolloutWeights: Map of variationId to weight, in thousandths of a percent (0-100000).
  • rolloutBucketBy: Optional user attribute.

updateOffVariation

Updates the default off variation to variationId. The flag serves the default off variation when the flag's targeting is Off.

Parameters
  • variationId: ID of a variation of the flag.

updatePrerequisite

Changes the prerequisite flag that key indicates to use the variation that variationId indicates. Returns an error if this prerequisite does not exist.

Parameters
  • key: Flag key of an existing prerequisite flag.
  • variationId: ID of a variation of the prerequisite flag.

updateRuleDescription

Updates the description of the feature flag rule.

Parameters
  • description: The new human-readable description for this rule.
  • ruleId: The ID of the rule. You can retrieve this by making a GET request for the flag.

updateRuleTrackEvents

Updates whether or not LaunchDarkly tracks events for the feature flag associated with this rule.

Parameters
  • ruleId: The ID of the rule. You can retrieve this by making a GET request for the flag.
  • trackEvents: Whether or not events are tracked.

updateRuleVariationOrRollout

Updates what ruleId serves when its clauses evaluate to true. The rule can serve either the variation that variationId indicates, or a percent rollout that rolloutWeights and rolloutBucketBy indicate.

Parameters
  • ruleId: ID of a rule in the flag.

  • variationId: ID of a variation of the flag.

    or

  • rolloutWeights: Map of variationId to weight, in thousandths of a percent (0-100000).

  • rolloutBucketBy: Optional user attribute.

updateTrackEvents

Updates whether or not LaunchDarkly tracks events for the feature flag, for all rules.

Parameters
  • trackEvents: Whether or not events are tracked.

updateTrackEventsFallthrough

Updates whether or not LaunchDarkly tracks events for the feature flag, for the default rule.

Parameters
  • trackEvents: Whether or not events are tracked.

Click to expand instructions for updating flag settings

addTags

Adds tags to the feature flag.

Parameters
  • values: A list of tags to add.

makeFlagPermanent

Marks the feature flag as permanent. LaunchDarkly does not prompt you to remove permanent flags, even if one variation is rolled out to all your users.

makeFlagTemporary

Marks the feature flag as temporary.

removeMaintainer

Removes the flag's maintainer. To set a new maintainer, use the flag's Settings tab in the LaunchDarkly user interface.

removeTags

Removes tags from the feature flag.

Parameters
  • values: A list of tags to remove.

turnOffClientSideAvailability

Turns off client-side SDK availability for the flag. This is equivalent to unchecking the SDKs using Mobile Key and/or SDKs using client-side ID boxes for the flag. If you're using a client-side or mobile SDK, you must expose your feature flags in order for the client-side or mobile SDKs to evaluate them.

Parameters
  • value: Use "usingMobileKey" to turn on availability for mobile SDKs. Use "usingEnvironmentId" to turn on availability for client-side SDKs.

turnOnClientSideAvailability

Turns on client-side SDK availability for the flag. This is equivalent to unchecking the SDKs using Mobile Key and/or SDKs using client-side ID boxes for the flag. If you're using a client-side or mobile SDK, you must expose your feature flags in order for the client-side or mobile SDKs to evaluate them.

Parameters
  • value: Use "usingMobileKey" to turn on availability for mobile SDKs. Use "usingEnvironmentId" to turn on availability for client-side SDKs.

updateDescription

Updates the feature flag description.

Parameters
  • value: The new description.

updateName

Updates the feature flag name.

Parameters
  • value: The new name.

Click to expand instructions for updating the flag lifecycle

archiveFlag

Archives the feature flag. This retires it from LaunchDarkly without deleting it. You cannot archive a flag that is a prerequisite of other flags.

deleteFlag

Deletes the feature flag and its rules. You cannot restore a deleted flag. If this flag is requested again, the flag value defined in code will be returned for all users.

restoreFlag

Restores the feature flag if it was previously archived.

Example

The body of a single semantic patch can contain many different instructions.

Click to expand example semantic patch request body
{
  "environmentKey": "production",
  "instructions": [
    {
      "kind": "turnFlagOn"
    },
    {
      "kind": "turnFlagOff"
    },
    {
      "kind": "addUserTargets",
      "variationId": "8bfb304e-d516-47e5-8727-e7f798e8992d",
      "values": ["userId", "userId2"]
    },
    {
      "kind": "removeUserTargets",
      "variationId": "8bfb304e-d516-47e5-8727-e7f798e8992d",
      "values": ["userId3", "userId4"]
    },
    {
      "kind": "updateFallthroughVariationOrRollout",
      "rolloutWeights": {
        "variationId": 50000,
        "variationId2": 50000
      },
      "rolloutBucketBy": null
    },
    {
      "kind": "addRule",
      "clauses": [
        {
          "attribute": "segmentMatch",
          "negate": false,
          "values": ["test-segment"]
        }
      ],
      "variationId": null,
      "rolloutWeights": {
        "variationId": 50000,
        "variationId2": 50000
      },
      "rolloutBucketBy": "key"
    },
    {
      "kind": "removeRule",
      "ruleId": "99f12464-a429-40fc-86cc-b27612188955"
    },
    {
      "kind": "reorderRules",
      "ruleIds": ["2f72974e-de68-4243-8dd3-739582147a1f", "8bfb304e-d516-47e5-8727-e7f798e8992d"]
    },
    {
      "kind": "addClauses",
      "ruleId": "1134",
      "clauses": [
        {
          "attribute": "email",
          "op": "in",
          "negate": false,
          "values": ["test@test.com"]
        }
      ]
    },
    {
      "kind": "removeClauses",
      "ruleId": "1242529",
      "clauseIds": ["8bfb304e-d516-47e5-8727-e7f798e8992d"]
    },
    {
      "kind": "updateClause",
      "ruleId": "2f72974e-de68-4243-8dd3-739582147a1f",
      "clauseId": "309845",
      "clause": {
        "attribute": "segmentMatch",
        "negate": false,
        "values": ["test-segment"]
      }
    },
    {
      "kind": "updateRuleVariationOrRollout",
      "ruleId": "2342",
      "rolloutWeights": null,
      "rolloutBucketBy": null
    },
    {
      "kind": "updateOffVariation",
      "variationId": "3242453"
    },
    {
      "kind": "addPrerequisite",
      "variationId": "234235",
      "key": "flagKey2"
    },
    {
      "kind": "updatePrerequisite",
      "variationId": "234235",
      "key": "flagKey2"
    },
    {
      "kind": "removePrerequisite",
      "key": "flagKey"
    }
  ]
}

Using JSON Patches on a feature flag

If you do not include the header described above, you can use JSON patch.

When using the update feature flag endpoint to add individual users to a specific variation, there are two different patch documents, depending on whether users are already being individually targeted for the variation.

If a flag variation already has users individually targeted, the path for the JSON Patch operation is:

{
  "op": "add",
  "path": "/environments/devint/targets/0/values/-",
  "value": "TestClient10"
}

If a flag variation does not already have users individually targeted, the path for the JSON Patch operation is:

[
  {
    "op": "add",
    "path": "/environments/devint/targets/-",
    "value": { "variation": 0, "values": ["TestClient10"] }
  }
]

Required approvals

If a request attempts to alter a flag configuration in an environment where approvals are required for the flag, the request will fail with a 405. Changes to the flag configuration in that environment will require creating an approval request or a workflow.

Conflicts

If a flag configuration change made through this endpoint would cause a pending scheduled change or approval request to fail, this endpoint will return a 400. You can ignore this check by adding an ignoreConflicts query parameter set to true.

Request
path Parameters
projectKey
required
string <string>

The project key

featureFlagKey
required
string <string>

The feature flag key. The key identifies the flag in your code.

Request Body schema: application/json
required
Array of objects (JSONPatch)
comment
string

Optional comment

Responses
200

Global flag response

400

Invalid request

401

Invalid access token

404

Invalid resource identifier

405

Approval is required to make this request

409

Status conflict

429

Rate limited

patch/api/v2/flags/{projectKey}/{featureFlagKey}
Request samples
application/json
{
  • "patch": [
    ]
}
Response samples
application/json
{
  • "name": "My Flag",
  • "kind": "boolean",
  • "description": "This flag controls the example widgets",
  • "key": "my-flag",
  • "_version": 1,
  • "creationDate": 0,
  • "includeInSnippet": true,
  • "clientSideAvailability": {
    },
  • "variations": [
    ],
  • "temporary": true,
  • "tags": [
    ],
  • "_links": {
    },
  • "maintainerId": "569f183514f4432160000007",
  • "_maintainer": {
    },
  • "goalIds": [ ],
  • "experiments": {
    },
  • "customProperties": {
    },
  • "archived": false,
  • "archivedDate": 0,
  • "defaults": {
    },
  • "environments": {
    }
}

Delete feature flag

Delete a feature flag in all environments. Use with caution: only delete feature flags your application no longer uses.

Request
path Parameters
projectKey
required
string <string>

The project key

featureFlagKey
required
string <string>

The feature flag key. The key identifies the flag in your code.

Responses
204

Action succeeded

401

Invalid access token

404

Invalid resource identifier

409

Status conflict

429

Rate limited

delete/api/v2/flags/{projectKey}/{featureFlagKey}
Request samples
Response samples
application/json
{
  • "code": "unauthorized",
  • "message": "Invalid access token"
}

Copy feature flag

Copying flag settings is an Enterprise feature

Copying flag settings is available to customers on an Enterprise plan. To learn more, read about our pricing. To upgrade your plan, contact Sales.

Copy flag settings from a source environment to a target environment.

By default, this operation copies the entire flag configuration. You can use the includedActions or excludedActions to specify that only part of the flag configuration is copied.

If you provide the optional currentVersion of a flag, this operation tests to ensure that the current flag version in the environment matches the version you've specified. The operation rejects attempts to copy flag settings if the environment's current version of the flag does not match the version you've specified. You can use this to enforce optimistic locking on copy attempts.

Request
path Parameters
projectKey
required
string <string>

The project key

featureFlagKey
required
string <string>

The feature flag key. The key identifies the flag in your code.

Request Body schema: application/json
required
object (FlagCopyConfigEnvironment)
required
object (FlagCopyConfigEnvironment)
comment
string

Optional comment

includedActions
Array of strings

Optional list of the flag changes to copy from the source environment to the target environment. You may include either includedActions or excludedActions, but not both. If you include neither, then all flag changes will be copied.

Items Enum: "updateOn" "updateRules" "updateFallthrough" "updateOffVariation" "updatePrerequisites" "updateTargets"
excludedActions
Array of strings

Optional list of the flag changes NOT to copy from the source environment to the target environment. You may include either includedActions or excludedActions, but not both. If you include neither, then all flag changes will be copied.

Items Enum: "updateOn" "updateRules" "updateFallthrough" "updateOffVariation" "updatePrerequisites" "updateTargets"
Responses
201

Global flag response

400

Invalid request

401

Invalid access token

405

Method not allowed

409

Status conflict

429

Rate limited

post/api/v2/flags/{projectKey}/{featureFlagKey}/copy
Request samples
application/json
{
  • "comment": "optional comment",
  • "source": {
    },
  • "target": {
    }
}
Response samples
application/json
{
  • "name": "My Flag",
  • "kind": "boolean",
  • "description": "This flag controls the example widgets",
  • "key": "my-flag",
  • "_version": 1,
  • "creationDate": 0,
  • "includeInSnippet": true,
  • "clientSideAvailability": {
    },
  • "variations": [
    ],
  • "temporary": true,
  • "tags": [
    ],
  • "_links": {
    },
  • "maintainerId": "569f183514f4432160000007",
  • "_maintainer": {
    },
  • "goalIds": [ ],
  • "experiments": {
    },
  • "customProperties": {
    },
  • "archived": false,
  • "archivedDate": 0,
  • "defaults": {
    },
  • "environments": {
    }
}

Get expiring user targets for feature flag

Get a list of user targets on a feature flag that are scheduled for removal.

Request
path Parameters
projectKey
required
string <string>

The project key

environmentKey
required
string <string>

The environment key

featureFlagKey
required
string <string>

The feature flag key

Responses
200

Expiring user target response

401

Invalid access token

403

Forbidden

404

Invalid resource identifier

429

Rate limited

get/api/v2/flags/{projectKey}/{featureFlagKey}/expiring-user-targets/{environmentKey}
Request samples
Response samples
application/json
{
  • "items": [
    ],
  • "_links": {
    }
}

Update expiring user targets on feature flag

Schedule a user for removal from individual targeting on a feature flag. The flag must already individually target the user.

You can add, update, or remove a scheduled removal date. You can only schedule a user for removal on a single variation per flag.

This request only supports semantic patches. To make a semantic patch request, you must append domain-model=launchdarkly.semanticpatch to your Content-Type header. To learn more, read Updates using semantic patch.

Instructions

addExpireUserTargetDate

Adds a date and time that LaunchDarkly will remove the user from the flag's individual targeting.

Parameters
  • value: The time, in Unix milliseconds, when LaunchDarkly should remove the user from individual targeting for this flag
  • variationId: The version of the flag variation to update. You can retrieve this by making a GET request for the flag.
  • userKey: The user key for the user to remove from individual targeting

updateExpireUserTargetDate

Updates the date and time that LaunchDarkly will remove the user from the flag's individual targeting.

Parameters
  • value: The time, in Unix milliseconds, when LaunchDarkly should remove the user from individual targeting for this flag
  • variationId: The version of the flag variation to update. You can retrieve this by making a GET request for the flag.
  • userKey: The user key for the user to remove from individual targeting

removeExpireUserTargetDate

Removes the scheduled removal of the user from the flag's individual targeting. The user will remain part of the flag's individual targeting until you explicitly remove them, or until you schedule another removal.

Parameters
  • variationId: The version of the flag variation to update. You can retrieve this by making a GET request for the flag.
  • userKey: The user key for the user to remove from individual targeting
Request
path Parameters
projectKey
required
string <string>

The project key

environmentKey
required
string <string>

The environment key

featureFlagKey
required
string <string>

The feature flag key

Request Body schema: application/json
comment
string

Optional comment describing the change

required
Array of objects (Instruction)

The instructions to perform when updating

Responses
200

Expiring user target response

400

Invalid request

401

Invalid access token

403

Forbidden

404

Invalid resource identifier

429

Rate limited

patch/api/v2/flags/{projectKey}/{featureFlagKey}/expiring-user-targets/{environmentKey}
Request samples
application/json
{
  • "comment": "optional comment",
  • "instructions": [
    ]
}
Response samples
application/json
{
  • "items": [
    ],
  • "_links": {
    },
  • "totalInstructions": 1,
  • "successfulInstructions": 1,
  • "failedInstructions": 0,
  • "errors": [
    ]
}