Feature flags

Creating a migration flag

When you create a migration flag, the variations are pre-determined based on the number of stages in the migration.

To create a migration flag, omit the variations and defaults information. Instead, provide a purpose of migration, and migrationSettings. If you create a migration flag with six stages, contextKind is required. Otherwise, it should be omitted.

Here's an example:

{
  "key": "flag-key-123",
  "purpose": "migration",
  "migrationSettings": {
    "stageCount": 6,
    "contextKind": "account"
  }
}

To learn more, read Migration Flags.

These instructions require the environmentKey parameter.

turnFlagOff

Sets the flag's targeting state to Off.

Here's an example:

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

turnFlagOn

Sets the flag's targeting state to On.

Here's an example:

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

These instructions require the environmentKey parameter.

Several of the instructions for working with targeting and variations require flag rule IDs, variation IDs, or clause IDs as parameters. Each of these are returned as part of the Get feature flag response. The flag rule ID is the _id field of each element in the rules array within each environment listed in the environments object. The variation ID is the _id field in each element of the variations array. The clause ID is the _id field of each element of the clauses array within the rules array within each environment listed in the environments object.

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 contextKind (string), attribute (string), op (string), negate (boolean), and values (array of strings, numbers, or dates) properties. The contextKind, attribute, and values are case sensitive. The op must be lower-case.

Here's an example:

{
    "environmentKey": "environment-key-123abc",
    "instructions": [{
        "kind": "addClauses",
        "ruleId": "a902ef4a-2faf-4eaf-88e1-ecc356708a29",
        "clauses": [{
            "contextKind": "user",
            "attribute": "country",
            "op": "in",
            "negate": false,
            "values": ["USA", "Canada"]
        }]
    }]
}

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.

Here's an example:

{
    "environmentKey": "environment-key-123abc",
    "instructions": [{
        "kind": "addPrerequisite",
        "key": "example-prereq-flag-key",
        "variationId": "2f43f67c-3e4e-4945-a18a-26559378ca00"
    }]
}

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, rolloutBucketBy, and rolloutContextKind 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 contextKind (string), attribute (string), op (string), negate (boolean), and values (array of strings, numbers, or dates) properties. The contextKind, attribute, and values are case sensitive. The op must be lower-case.

• beforeRuleId: (Optional) ID of a flag rule.

• Either

  • variationId: ID of a variation of the flag.

  or

  • rolloutWeights: (Optional) Map of variationId to weight, in thousandths of a percent (0-100000).
  • rolloutBucketBy: (Optional) Context attribute available in the specified rolloutContextKind.
  • rolloutContextKind: (Optional) Context kind, defaults to user

Here's an example that uses a variationId:

{
  "environmentKey": "environment-key-123abc",
  "instructions": [{
    "kind": "addRule",
    "variationId": "2f43f67c-3e4e-4945-a18a-26559378ca00",
    "clauses": [{
      "contextKind": "organization",
      "attribute": "located_in",
      "op": "in",
      "negate": false,
      "values": ["Sweden", "Norway"]
    }]
  }]
}

Here's an example that uses a percentage rollout:

{
  "environmentKey": "environment-key-123abc",
  "instructions": [{
    "kind": "addRule",
    "clauses": [{
      "contextKind": "organization",
      "attribute": "located_in",
      "op": "in",
      "negate": false,
      "values": ["Sweden", "Norway"]
    }],
    "rolloutContextKind": "organization",
    "rolloutWeights": {
      "2f43f67c-3e4e-4945-a18a-26559378ca00": 15000, // serve 15% this variation
      "e5830889-1ec5-4b0c-9cc9-c48790090c43": 85000  // serve 85% this variation
    }
  }]
}

addTargets

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

Parameters

• values: List of context keys.
• contextKind: (Optional) Context kind to target, defaults to user
• variationId: ID of a variation on the flag.

Here's an example:

{
    "environmentKey": "environment-key-123abc",
    "instructions": [{
        "kind": "addTargets",
        "values": ["context-key-123abc", "context-key-456def"],
        "variationId": "2f43f67c-3e4e-4945-a18a-26559378ca00"
    }]
}

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. If you are working with contexts, use addTargets instead of this instruction.

Parameters

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

Here's an example:

{
    "environmentKey": "environment-key-123abc",
    "instructions": [{
        "kind": "addUserTargets",
        "values": ["user-key-123abc", "user-key-456def"],
        "variationId": "2f43f67c-3e4e-4945-a18a-26559378ca00"
    }]
}

addValuesToClause

Adds values to the values of the clause that ruleId and clauseId indicate. Does not update the context kind, attribute, or operator.

Parameters

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

Here's an example:

{
    "environmentKey": "environment-key-123abc",
    "instructions": [{
        "kind": "addValuesToClause",
        "ruleId": "a902ef4a-2faf-4eaf-88e1-ecc356708a29",
        "clauseId": "10a58772-3121-400f-846b-b8a04e8944ed",
        "values": ["beta_testers"]
    }]
}

addVariation

Adds a variation to the flag.

Parameters

• value: The variation value.
• name: (Optional) The variation name.
• description: (Optional) A description for the variation.

Here's an example:

{
    "instructions": [ { "kind": "addVariation", "value": 20, "name": "New variation" } ]
}

clearTargets

Removes all individual targets from the variation that variationId specifies. This includes both user and non-user targets.

Parameters

• variationId: ID of a variation on the flag.

Here's an example:

{
  "environmentKey": "environment-key-123abc",
  "instructions": [ { "kind": "clearTargets", "variationId": "2f43f67c-3e4e-4945-a18a-26559378ca00" } ]
}

clearUserTargets

Removes all individual user targets from the variation that variationId specifies. If you are working with contexts, use clearTargets instead of this instruction.

Parameters

• variationId: ID of a variation on the flag.

Here's an example:

{
  "environmentKey": "environment-key-123abc",
  "instructions": [ { "kind": "clearUserTargets", "variationId": "2f43f67c-3e4e-4945-a18a-26559378ca00" } ]
}

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.

Here's an example:

{
    "environmentKey": "environment-key-123abc",
    "instructions": [{
        "kind": "removeClauses",
        "ruleId": "a902ef4a-2faf-4eaf-88e1-ecc356708a29",
        "clauseIds": ["10a58772-3121-400f-846b-b8a04e8944ed", "36a461dc-235e-4b08-97b9-73ce9365873e"]
    }]
}

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.

Here's an example:

{
  "environmentKey": "environment-key-123abc",
  "instructions": [ { "kind": "removePrerequisite", "key": "prereq-flag-key-123abc" } ]
}

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.

Here's an example:

{
  "environmentKey": "environment-key-123abc",
  "instructions": [ { "kind": "removeRule", "ruleId": "a902ef4a-2faf-4eaf-88e1-ecc356708a29" } ]
}

removeTargets

Removes context keys from the individual context targets for the context kind that contextKind specifies and the variation that variationId specifies. Does nothing if the flag does not target the context keys.

Parameters

• values: List of context keys.
• contextKind: (Optional) Context kind to target, defaults to user
• variationId: ID of a flag variation.

Here's an example:

{
    "environmentKey": "environment-key-123abc",
    "instructions": [{
        "kind": "removeTargets",
        "values": ["context-key-123abc", "context-key-456def"],
        "variationId": "2f43f67c-3e4e-4945-a18a-26559378ca00"
    }]
}

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. If you are working with contexts, use removeTargets instead of this instruction.

Parameters

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

Here's an example:

{
    "environmentKey": "environment-key-123abc",
    "instructions": [{
        "kind": "removeUserTargets",
        "values": ["user-key-123abc", "user-key-456def"],
        "variationId": "2f43f67c-3e4e-4945-a18a-26559378ca00"
    }]
}

removeValuesFromClause

Removes values from the values of the clause indicated by ruleId and clauseId. Does not update the context kind, attribute, or operator.

Parameters

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

Here's an example:

{
    "environmentKey": "environment-key-123abc",
    "instructions": [{
        "kind": "removeValuesFromClause",
        "ruleId": "a902ef4a-2faf-4eaf-88e1-ecc356708a29",
        "clauseId": "10a58772-3121-400f-846b-b8a04e8944ed",
        "values": ["beta_testers"]
    }]
}

removeVariation

Removes a variation from the flag.

Parameters

• variationId: ID of a variation of the flag to remove.

Here's an example:

{
    "instructions": [ { "kind": "removeVariation", "variationId": "2f43f67c-3e4e-4945-a18a-26559378ca00" } ]
}

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.

Here's an example:

{
    "environmentKey": "environment-key-123abc",
    "instructions": [{
        "kind": "reorderRules",
        "ruleIds": ["a902ef4a-2faf-4eaf-88e1-ecc356708a29", "63c238d1-835d-435e-8f21-c8d5e40b2a3d"]
    }]
}

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.

Here's an example:

{
  "environmentKey": "environment-key-123abc",
  "instructions": [
    {
      "kind": "replacePrerequisites",
      "prerequisites": [
        {
          "key": "prereq-flag-key-123abc",
          "variationId": "10a58772-3121-400f-846b-b8a04e8944ed"
        },
        {
          "key": "another-prereq-flag-key-456def",
          "variationId": "e5830889-1ec5-4b0c-9cc9-c48790090c43"
        }
      ]
    }
  ]
}

replaceRules

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

Parameters

• rules: A list of rules.

Here's an example:

{
  "environmentKey": "environment-key-123abc",
  "instructions": [
    {
      "kind": "replaceRules",
      "rules": [
        {
          "variationId": "2f43f67c-3e4e-4945-a18a-26559378ca00",
          "description": "My new rule",
          "clauses": [
            {
              "contextKind": "user",
              "attribute": "segmentMatch",
              "op": "segmentMatch",
              "values": ["test"]
            }
          ],
          "trackEvents": true
        }
      ]
    }
  ]
}

replaceTargets

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

Parameters

• targets: A list of context targeting. Each item in the list includes an optional contextKind that defaults to user, a required variationId, and a required list of values.

Here's an example:

{
  "environmentKey": "environment-key-123abc",
  "instructions": [
    {
      "kind": "replaceTargets",
      "targets": [
        {
          "contextKind": "user",
          "variationId": "2f43f67c-3e4e-4945-a18a-26559378ca00",
          "values": ["user-key-123abc"]
        },
        {
          "contextKind": "device",
          "variationId": "e5830889-1ec5-4b0c-9cc9-c48790090c43",
          "values": ["device-key-456def"]
        }
      ]
    }    
  ]
}

replaceUserTargets

Removes all existing user targeting and replaces it with the list of targets you provide. In the list of targets, you must include a target for each of the flag's variations. If you are working with contexts, use replaceTargets instead of this instruction.

Parameters

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

Here's an example:

{
  "environmentKey": "environment-key-123abc",
  "instructions": [
    {
      "kind": "replaceUserTargets",
      "targets": [
        {
          "variationId": "2f43f67c-3e4e-4945-a18a-26559378ca00",
          "values": ["user-key-123abc", "user-key-456def"]
        },
        {
          "variationId": "e5830889-1ec5-4b0c-9cc9-c48790090c43",
          "values": ["user-key-789ghi"]
        }
      ]
    }
  ]
}

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 contextKind (string), attribute (string), op (string), negate (boolean), and values (array of strings, numbers, or dates) properties. The contextKind, attribute, and values are case sensitive. The op must be lower-case.

Here's an example:

{
  "environmentKey": "environment-key-123abc",
  "instructions": [{
    "kind": "updateClause",
    "ruleId": "a902ef4a-2faf-4eaf-88e1-ecc356708a29",
    "clauseId": "10c7462a-2062-45ba-a8bb-dfb3de0f8af5",
    "clause": {
      "contextKind": "user",
      "attribute": "country",
      "op": "in",
      "negate": false,
      "values": ["Mexico", "Canada"]
    }
  }]
}

updateDefaultVariation

Updates the default on or off variation of the flag.

Parameters

• onVariationValue: (Optional) The value of the variation of the new on variation.
• offVariationValue: (Optional) The value of the variation of the new off variation

Here's an example:

{
    "instructions": [ { "kind": "updateDefaultVariation", "OnVariationValue": true, "OffVariationValue": false } ]
}

updateFallthroughVariationOrRollout

Updates the default or "fallthrough" rule for the flag, which the flag serves when a context matches none of the targeting rules. The rule can serve either the variation that variationId indicates, or a percentage 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) Context attribute available in the specified rolloutContextKind.
• rolloutContextKind: (Optional) Context kind, defaults to user

Here's an example that uses a variationId:

{
    "environmentKey": "environment-key-123abc",
    "instructions": [{
        "kind": "updateFallthroughVariationOrRollout",
        "variationId": "2f43f67c-3e4e-4945-a18a-26559378ca00"
    }]
}

Here's an example that uses a percentage rollout:

{
    "environmentKey": "environment-key-123abc",
    "instructions": [{
        "kind": "updateFallthroughVariationOrRollout",
        "rolloutContextKind": "user",
        "rolloutWeights": {
            "2f43f67c-3e4e-4945-a18a-26559378ca00": 15000, // serve 15% this variation
            "e5830889-1ec5-4b0c-9cc9-c48790090c43": 85000  // serve 85% this variation
        }
    }]
}

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.

Here's an example:

{
  "environmentKey": "environment-key-123abc",
  "instructions": [ { "kind": "updateOffVariation", "variationId": "2f43f67c-3e4e-4945-a18a-26559378ca00" } ]
}

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.

Here's an example:

{
    "environmentKey": "environment-key-123abc",
    "instructions": [{
        "kind": "updatePrerequisite",
        "key": "example-prereq-flag-key",
        "variationId": "2f43f67c-3e4e-4945-a18a-26559378ca00"
    }]
}

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.

Here's an example:

{
    "environmentKey": "environment-key-123abc",
    "instructions": [{
        "kind": "updateRuleDescription",
        "description": "New rule description",
        "ruleId": "a902ef4a-2faf-4eaf-88e1-ecc356708a29"
    }]
}

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.

Here's an example:

{
    "environmentKey": "environment-key-123abc",
    "instructions": [{
        "kind": "updateRuleTrackEvents",
        "ruleId": "a902ef4a-2faf-4eaf-88e1-ecc356708a29",
        "trackEvents": true
    }]
}

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) Context attribute available in the specified rolloutContextKind.

• rolloutContextKind: (Optional) Context kind, defaults to user

Here's an example:

{
    "environmentKey": "environment-key-123abc",
    "instructions": [{
        "kind": "updateRuleVariationOrRollout",
        "ruleId": "a902ef4a-2faf-4eaf-88e1-ecc356708a29",
        "variationId": "2f43f67c-3e4e-4945-a18a-26559378ca00"
    }]
}

updateTrackEvents

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

Parameters

• trackEvents: Whether or not events are tracked.

Here's an example:

{
  "environmentKey": "environment-key-123abc",
  "instructions": [ { "kind": "updateTrackEvents", "trackEvents": true } ]
}

updateTrackEventsFallthrough

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

Parameters

• trackEvents: Whether or not events are tracked.

Here's an example:

{
  "environmentKey": "environment-key-123abc",
  "instructions": [ { "kind": "updateTrackEventsFallthrough", "trackEvents": true } ]
}

updateVariation

Updates a variation of the flag.

Parameters

• variationId: The ID of the variation to update.
• name: (Optional) The updated variation name.
• value: (Optional) The updated variation value.
• description: (Optional) The updated variation description.

Here's an example:

{
    "instructions": [ { "kind": "updateVariation", "variationId": "2f43f67c-3e4e-4945-a18a-26559378ca00", "value": 20 } ]
}

These instructions do not require the environmentKey parameter. They make changes that apply to the flag across all environments.

addCustomProperties

Adds a new custom property to the feature flag. Custom properties are used to associate feature flags with LaunchDarkly integrations. For example, if you create an integration with an issue tracking service, you may want to associate a flag with a list of issues related to a feature's development.

Parameters

• key: The custom property key.
• name: The custom property name.
• values: A list of the associated values for the custom property.

Here's an example:

{
    "instructions": [{
        "kind": "addCustomProperties",
        "key": "example-custom-property",
        "name": "Example custom property",
        "values": ["value1", "value2"]
    }]
}

addTags

Adds tags to the feature flag.

Parameters

• values: A list of tags to add.

Here's an example:

{
  "instructions": [ { "kind": "addTags", "values": ["tag1", "tag2"] } ]
}

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

Here's an example:

{
  "instructions": [ { "kind": "makeFlagPermanent" } ]
}

makeFlagTemporary

Marks the feature flag as temporary.

Here's an example:

{
  "instructions": [ { "kind": "makeFlagTemporary" } ]
}

removeCustomProperties

Removes the associated values from a custom property. If all the associated values are removed, this instruction also removes the custom property.

Parameters

• key: The custom property key.
• values: A list of the associated values to remove from the custom property.

{
    "instructions": [{
        "kind": "replaceCustomProperties",
        "key": "example-custom-property",
        "values": ["value1", "value2"]
    }]
}

removeMaintainer

Removes the flag's maintainer. To set a new maintainer, use the updateMaintainerMember or updateMaintainerTeam instructions.

Here's an example:

{
  "instructions": [ { "kind": "removeMaintainer" } ]
}

removeTags

Removes tags from the feature flag.