> ## Documentation Index
> Fetch the complete documentation index at: https://launchdarkly-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.
# Update feature flag
> > For the complete documentation index, see [llms.txt](https://launchdarkly-preview.mintlify.app/llms.txt). For the full documentation snapshot, see [llms-full.txt](https://launchdarkly-preview.mintlify.app/llms-full.txt).
Perform a partial update to a feature flag. The request body must be a valid semantic patch, JSON patch, or JSON merge patch. To learn more the different formats, read [Updates](https://launchdarkly.com/docs/api#updates).
### 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](https://launchdarkly.com/docs/api#updates-using-semantic-patch).
The body of a semantic patch request for updating feature flags takes the following properties:
* `comment` (string): (Optional) A description of the update.
* `environmentKey` (string): (Required for some instructions only) 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. The body of a single semantic patch can contain many different instructions.
### Instructions
Semantic patch requests support the following `kind` instructions for updating feature flags.
Click to expand instructions for turning flags on and off
These instructions require the `environmentKey` parameter.
#### turnFlagOff
Sets the flag's targeting state to **Off**.
Here's an example:
```json
{
"environmentKey": "environment-key-123abc",
"instructions": [ { "kind": "turnFlagOff" } ]
}
```
#### turnFlagOn
Sets the flag's targeting state to **On**.
Here's an example:
```json
{
"environmentKey": "environment-key-123abc",
"instructions": [ { "kind": "turnFlagOn" } ]
}
```
Click to expand instructions for working with targeting and variations
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](https://launchdarkly.com/docs/api/feature-flags/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:
```json
{
"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:
```json
{
"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`:
```json
{
"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:
```json
{
"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:
```json
{
"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:
```json
{
"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:
```json
{
"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:
```json
{
"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:
```json
{
"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:
```json
{
"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:
```json
{
"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:
```json
{
"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:
```json
{
"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:
```json
{
"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:
```json
{
"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:
```json
{
"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:
```json
{
"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:
```json
{
"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:
```json
{
"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:
```json
{
"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:
```json
{
"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:
```json
{
"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:
```json
{
"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:
```json
{
"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`:
```json
{
"environmentKey": "environment-key-123abc",
"instructions": [{
"kind": "updateFallthroughVariationOrRollout",
"variationId": "2f43f67c-3e4e-4945-a18a-26559378ca00"
}]
}
```
Here's an example that uses a percentage rollout:
```json
{
"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:
```json
{
"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:
```json
{
"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:
```json
{
"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:
```json
{
"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:
```json
{
"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:
```json
{
"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:
```json
{
"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:
```json
{
"instructions": [ { "kind": "updateVariation", "variationId": "2f43f67c-3e4e-4945-a18a-26559378ca00", "value": 20 } ]
}
```
Click to expand instructions for updating flag settings
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:
```json
{
"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:
```json
{
"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:
```json
{
"instructions": [ { "kind": "makeFlagPermanent" } ]
}
```
#### makeFlagTemporary
Marks the feature flag as temporary.
Here's an example:
```json
{
"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.
```json
{
"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:
```json
{
"instructions": [ { "kind": "removeMaintainer" } ]
}
```
#### removeTags
Removes tags from the feature flag.
##### Parameters
- `values`: A list of tags to remove.
Here's an example:
```json
{
"instructions": [ { "kind": "removeTags", "values": ["tag1", "tag2"] } ]
}
```
#### replaceCustomProperties
Replaces the existing associated values for a custom property with the new values.
##### Parameters
- `key`: The custom property key.
- `name`: The custom property name.
- `values`: A list of the new associated values for the custom property.
Here's an example:
```json
{
"instructions": [{
"kind": "replaceCustomProperties",
"key": "example-custom-property",
"name": "Example custom property",
"values": ["value1", "value2"]
}]
}
```
#### 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 off availability for mobile SDKs. Use "usingEnvironmentId" to turn on availability for client-side SDKs.
Here's an example:
```json
{
"instructions": [ { "kind": "turnOffClientSideAvailability", "value": "usingMobileKey" } ]
}
```
#### turnOnClientSideAvailability
Turns on client-side SDK availability for the flag. This is equivalent to checking 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.
Here's an example:
```json
{
"instructions": [ { "kind": "turnOnClientSideAvailability", "value": "usingMobileKey" } ]
}
```
#### updateDescription
Updates the feature flag description.
##### Parameters
- `value`: The new description.
Here's an example:
```json
{
"instructions": [ { "kind": "updateDescription", "value": "Updated flag description" } ]
}
```
#### updateMaintainerMember
Updates the maintainer of the flag to an existing member and removes the existing maintainer.
##### Parameters
- `value`: The ID of the member.
Here's an example:
```json
{
"instructions": [ { "kind": "updateMaintainerMember", "value": "61e9b714fd47591727db558a" } ]
}
```
#### updateMaintainerTeam
Updates the maintainer of the flag to an existing team and removes the existing maintainer.
##### Parameters
- `value`: The key of the team.
Here's an example:
```json
{
"instructions": [ { "kind": "updateMaintainerTeam", "value": "example-team-key" } ]
}
```
#### updateName
Updates the feature flag name.
##### Parameters
- `value`: The new name.
Here's an example:
```json
{
"instructions": [ { "kind": "updateName", "value": "Updated flag name" } ]
}
```
Click to expand instructions for updating the flag lifecycle
These instructions do not require the `environmentKey` parameter. They make changes that apply to the flag across all environments.
#### 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.
```json
{
"instructions": [ { "kind": "archiveFlag" } ]
}
```
#### 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 contexts.
Here's an example:
```json
{
"instructions": [ { "kind": "deleteFlag" } ]
}
```
#### deprecateFlag
Deprecates the feature flag. This hides it from the live flags list without archiving or deleting it.
Here's an example:
```json
{
"instructions": [ { "kind": "deprecateFlag" } ]
}
```
#### restoreDeprecatedFlag
Restores the feature flag if it was previously deprecated.
Here's an example:
```json
{
"instructions": [ { "kind": "restoreDeprecatedFlag" } ]
}
```
#### restoreFlag
Restores the feature flag if it was previously archived.
Here's an example:
```json
{
"instructions": [ { "kind": "restoreFlag" } ]
}
```
### Using JSON patches on a feature flag
If you do not include the semantic patch header described above, you can use a [JSON patch](https://launchdarkly.com/docs/api#updates-using-json-patch) or [JSON merge patch](https://datatracker.ietf.org/doc/html/rfc7386) representation of the desired changes.
In the JSON patch representation, use a JSON pointer in the `path` element to describe what field to change. Use the [Get feature flag](https://launchdarkly.com/docs/api/feature-flags/get-feature-flag) endpoint to find the field you want to update.
There are a few special cases to keep in mind when determining the value of the `path` element:
* To add an individual target to a specific variation if the flag variation already has individual targets, the path for the JSON patch operation is:
```json
[
{
"op": "add",
"path": "/environments/devint/targets/0/values/-",
"value": "TestClient10"
}
]
```
* To add an individual target to a specific variation if the flag variation does not already have individual targets, the path for the JSON patch operation is:
```json
[
{
"op": "add",
"path": "/environments/devint/targets/-",
"value": { "variation": 0, "values": ["TestClient10"] }
}
]
```
* To add a flag to a release pipeline, the path for the JSON patch operation is:
```json
[
{
"op": "add",
"path": "/releasePipelineKey",
"value": "example-release-pipeline-key"
}
]
```
### 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](https://launchdarkly.com/docs/api/approvals).
### 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`.
### Migration flags
For migration flags, the cohort information is included in the `rules` property of a flag's response. You can update cohorts by updating `rules`. Default cohort information is included in the `fallthrough` property of a flag's response. You can update the default cohort by updating `fallthrough`.
When you update the rollout for a cohort or the default cohort through the API, provide a rollout instead of a single `variationId`.
To learn more, read [Migration flags](https://launchdarkly.com/docs/home/flags/migration).
## OpenAPI
````yaml /openapi/launchdarkly-api.json patch /api/v2/flags/{projectKey}/{featureFlagKey}
openapi: 3.0.3
info:
title: LaunchDarkly REST API
description: >
> For the complete documentation index, see
https://launchdarkly-preview.mintlify.app/llms.txt.
> For the full documentation snapshot, see
https://launchdarkly-preview.mintlify.app/llms-full.txt.
This is the LaunchDarkly REST API. It lets you build custom integrations,
automate your workflow, and manage feature flags and other LaunchDarkly
resources programmatically.
For authentication, rate limits, pagination, versioning, JSON Patch and
semantic patches, beta resources, and the full SDK End-of-Life table, read
the [REST API overview](https://launchdarkly-preview.mintlify.app/api).
To fetch the complete OpenAPI spec, use [Get OpenAPI
spec](https://launchdarkly.com/docs/api/other/get-openapi-spec).
contact:
name: LaunchDarkly Technical Support Team
url: https://support.launchdarkly.com
email: support@launchdarkly.com
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0
version: '2.0'
servers:
- url: https://app.launchdarkly.com
description: ' Default'
- url: https://app.launchdarkly.us
description: ' Federal'
security:
- ApiKey:
- read
- write
tags:
- name: Access tokens
description: >-
The access tokens API allows you to list, create, modify, and delete
access tokens programmatically.
- name: Account members
description: >-
The account members API allows you to invite new members to an account by
making a `POST` request to `/api/v2/members`. When you invite a new member
to an account, an invitation is sent to the email you provided.
- name: Account usage (beta)
description: >-
> ### This feature is in beta > > To use this feature, pass in a header
including the `LD-API-Version` key with value set to `beta`. Use this
header with each call.
- name: AI Configs
description: >-
The AI Configs API allows you to create, retrieve, and edit AI Configs, AI
Config variations, and AI model configurations.
- name: Announcements
description: >-
The announcements API lets you create and update a custom announcement
banner that appears in the LaunchDarkly user interface for everyone in
your organization.
- name: Applications (beta)
description: >-
> ### This feature is in beta > > To use this feature, pass in a header
including the `LD-API-Version` key with value set to `beta`. Use this
header with each call.
- name: Approvals
description: >-
An account member can request approval on changes to a flag or AI Config's
targeting or variations, or to a segment's targeting. Members may be
required to request approval depending on the settings in their
LaunchDarkly project.
- name: Approvals (beta)
description: >-
> ### This feature is in beta > > To use this feature, pass in a header
including the `LD-API-Version` key with value set to `beta`. Use this
header with each call.
- name: Audit log
description: >-
LaunchDarkly maintains a record of all the changes made to any resource in
the system. You can access this history using the audit log API, including
filtering by timestamps, or using a custom policy to select which entries
to receive.
- name: Code references
description: >-
> ### Code references is an Enterprise feature > > Code references is
available to customers on an Enterprise plan. To learn more, [read about
our pricing](https://launchdarkly.com/pricing/).
- name: Context settings
description: >-
You can use the context settings API to assign a context to a specific
variation for any feature flag. To learn more, read [View and manage
contexts](https://launchdarkly.com/docs/home/observability/context-attributes#view-and-manage-contexts).
- name: Contexts
description: >-
Contexts are people, services, machines, or other resources that encounter
feature flags in your product. Contexts are identified by their `kind`,
which describes the type of resources encountering flags, and by their
`key`.
- name: Custom roles
description: >-
> ### Custom roles is an Enterprise feature > > Custom roles is available
to customers on an Enterprise plan. To learn more, [read about our
pricing](https://launchdarkly.com/pricing/).
- name: Data Export destinations
description: >-
> ### Data Export is an add-on feature > > Data Export is available as an
add-on for customers on a Foundation or Enterprise plan. To learn more,
[read about our pricing](https://launchdarkly.com/pricing/).
- name: Environments
description: >-
Environments allow you to maintain separate rollout rules in different
contexts, from local development to QA, staging, and production. With the
LaunchDarkly Environments API, you can programmatically list, create, and
manage environments.
- name: Experiments
description: >-
> ### Available for subscription customers > > Experimentation is
available to all customers on a Developer, Foundation, or Enterprise
subscription. If you're on an older Pro or Enterprise plan,
Experimentation is available as an add-on.
- name: Feature flags
description: >-
The feature flags API allows you to list, create, and modify feature flags
and their targeting. For example, you can control percentage rollouts,
target specific contexts, or even toggle off a feature flag
programmatically.
- name: Feature flags (beta)
description: >-
> ### This feature is in beta > > To use this feature, pass in a header
including the `LD-API-Version` key with value set to `beta`. Use this
header with each call.
- name: Flag import configurations (beta)
description: >-
> ### This feature is in beta > > To use this feature, pass in a header
including the `LD-API-Version` key with value set to `beta`. Use this
header with each call.
- name: Flag links (beta)
description: >-
> ### This feature is in beta > > To use this feature, pass in a header
including the `LD-API-Version` key with value set to `beta`. Use this
header with each call.
- name: Flag triggers
description: >-
> ### Flag triggers is an Enterprise feature > > Flag triggers is
available to customers on an Enterprise plan. To learn more, [read about
our pricing](https://launchdarkly.com/pricing/).
- name: Follow flags
description: >-
Follow flags to receive email updates about targeting changes to a flag in
a project and environment.
- name: Holdouts (beta)
description: >-
> ### Available for customers using Experimentation > > Holdouts are
available to customers using
[Experimentation](https://launchdarkly.com/docs/api/experiments).
- name: Insights charts (beta)
description: >-
> ### This feature is in beta > > To use this feature, pass in a header
including the `LD-API-Version` key with value set to `beta`. Use this
header with each call.
- name: Insights deployments (beta)
description: >-
> ### This feature is in beta > > To use this feature, pass in a header
including the `LD-API-Version` key with value set to `beta`. Use this
header with each call.
- name: Insights flag events (beta)
description: >-
> ### This feature is in beta > > To use this feature, pass in a header
including the `LD-API-Version` key with value set to `beta`. Use this
header with each call.
- name: Insights pull requests (beta)
description: >-
> ### This feature is in beta > > To use this feature, pass in a header
including the `LD-API-Version` key with value set to `beta`. Use this
header with each call.
- name: Insights repositories (beta)
description: >-
> ### This feature is in beta > > To use this feature, pass in a header
including the `LD-API-Version` key with value set to `beta`. Use this
header with each call.
- name: Insights scores (beta)
description: >-
> ### This feature is in beta > > To use this feature, pass in a header
including the `LD-API-Version` key with value set to `beta`. Use this
header with each call.
- name: Integration audit log subscriptions
description: >-
Audit log integration subscriptions allow you to send audit log events
hooks to one of dozens of external tools. For example, you can send flag
change event webhooks to external third party software.
- name: Integration delivery configurations (beta)
description: >-
> ### This feature is in beta > > To use this feature, pass in a header
including the `LD-API-Version` key with value set to `beta`. Use this
header with each call.
- name: Integrations (beta)
description: >-
> ### This feature is in beta > > To use this feature, pass in a header
including the `LD-API-Version` key with value set to `beta`. Use this
header with each call.
- name: Layers
description: >-
> ### Available for customers using Experimentation > > Layers are
available to customers using
[Experimentation](https://launchdarkly.com/docs/api/experiments).
- name: Metrics
description: >-
Metrics track flag behavior over time when an experiment is running. The
data generated from experiments gives you more insight into the impact of
a particular flag.
- name: Metrics (beta)
description: >-
> ### This feature is in beta > > To use this feature, pass in a header
including the `LD-API-Version` key with value set to `beta`. Use this
header with each call.
- name: OAuth2 Clients
description: >-
The OAuth2 client API allows you to register a LaunchDarkly OAuth client
for use in your own custom integrations.
- name: Persistent store integrations (beta)
description: >-
> ### This feature is in beta > > To use this feature, pass in a header
including the `LD-API-Version` key with value set to `beta`. Use this
header with each call.
- name: Projects
description: >-
Projects allow you to manage multiple different software projects under
one LaunchDarkly account. Each project has its own unique set of
environments and feature flags.
- name: Relay Proxy configurations
description: >-
> ### Relay Proxy automatic configuration is an Enterprise feature > >
Relay Proxy automatic configuration is available to customers on an
Enterprise plan. To learn more, [read about our
pricing](https://launchdarkly.com/pricing/).
- name: Release pipelines (beta)
description: >-
> ### This feature is in beta > > To use this feature, pass in a header
including the `LD-API-Version` key with value set to `beta`. Use this
header with each call.
- name: Release policies (beta)
description: >-
> ### This feature is in beta > > To use this feature, pass in a header
including the `LD-API-Version` key with value set to `beta`. Use this
header with each call.
- name: Releases (beta)
description: >-
> ### This feature is in beta > > To use this feature, pass in a header
including the `LD-API-Version` key with value set to `beta`. Use this
header with each call.
- name: Scheduled changes
description: >-
> ### Scheduled flag changes is an Enterprise feature > > Scheduled flag
changes is available to customers on an Enterprise plan. To learn more,
[read about our pricing](https://launchdarkly.com/pricing/).
- name: Segments
description: >-
> ### Synced segments and larger list-based segments are an Enterprise
feature > > This section documents endpoints for rule-based, list-based,
and synced segments.
- name: Tags
description: >-
Tags are simple strings that you can attach to most resources in
LaunchDarkly. Tags are useful for grouping resources into a set that you
can name in a resource specifier.
- name: Teams
description: >-
> ### Teams is an Enterprise feature > > Teams is available to customers
on an Enterprise plan. To learn more, [read about our
pricing](https://launchdarkly.com/pricing/).
- name: Teams (beta)
description: >-
> ### This feature is in beta > > To use this feature, pass in a header
including the `LD-API-Version` key with value set to `beta`. Use this
header with each call.
- name: User settings
description: >-
> ### Contexts are now available > > After you have upgraded your
LaunchDarkly SDK to use contexts instead of users, you should use
[Contexts](https://launchdarkly.com/docs/api/contexts) instead of the user
settings API.
- name: Users
description: >-
> ### Contexts are now available > > After you have upgraded your
LaunchDarkly SDK to use contexts instead of users, you should use
[Contexts](https://launchdarkly.com/docs/api/contexts) instead of these
endpoints.
- name: Users (beta)
description: >-
> ### Contexts are now available > > After you have upgraded your
LaunchDarkly SDK to use contexts instead of users, you should use
[Contexts](https://launchdarkly.com/docs/api/contexts) instead of these
endpoints.
- name: Views (beta)
description: >-
> ### This feature is in beta > > To use this feature, pass in a header
including the `LD-API-Version` key with value set to `beta`. Use this
header with each call.
- name: Webhooks
description: >-
The webhooks API lets you build your own integrations that subscribe to
activities in LaunchDarkly. When you generate an activity in LaunchDarkly,
such as when you change a flag or you create a project, LaunchDarkly sends
an HTTP POST payload to the...
- name: Workflow templates
description: >-
> ### Workflows are in maintenance mode > > The workflows feature is in
maintenance mode, and is planned for future deprecation at a date not yet
specified.
- name: Workflows
description: >-
> ### Workflows are in maintenance mode > > The workflows feature is in
maintenance mode, and is planned for future deprecation at a date not yet
specified.
- name: Other
description: Other requests available in the LaunchDarkly API.
paths:
/api/v2/flags/{projectKey}/{featureFlagKey}:
patch:
tags:
- Feature flags
summary: Update feature flag
description: "> For the complete documentation index, see [llms.txt](https://launchdarkly-preview.mintlify.app/llms.txt). For the full documentation snapshot, see [llms-full.txt](https://launchdarkly-preview.mintlify.app/llms-full.txt).\n\nPerform a partial update to a feature flag. The request body must be a valid semantic patch, JSON patch, or JSON merge patch. To learn more the different formats, read [Updates](https://launchdarkly.com/docs/api#updates).\n\n### Using semantic patches on a feature flag\n\nTo 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](https://launchdarkly.com/docs/api#updates-using-semantic-patch).\n\nThe body of a semantic patch request for updating feature flags takes the following properties:\n\n* `comment` (string): (Optional) A description of the update.\n* `environmentKey` (string): (Required for some instructions only) The key of the LaunchDarkly environment.\n* `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. The body of a single semantic patch can contain many different instructions.\n\n### Instructions\n\nSemantic patch requests support the following `kind` instructions for updating feature flags.\n\n\nClick to expand instructions for turning flags on and off
\n\nThese instructions require the `environmentKey` parameter.\n\n#### turnFlagOff\n\nSets the flag's targeting state to **Off**.\n\nHere's an example:\n\n```json\n{\n \"environmentKey\": \"environment-key-123abc\",\n \"instructions\": [ { \"kind\": \"turnFlagOff\" } ]\n}\n```\n\n#### turnFlagOn\n\nSets the flag's targeting state to **On**.\n\nHere's an example:\n\n```json\n{\n \"environmentKey\": \"environment-key-123abc\",\n \"instructions\": [ { \"kind\": \"turnFlagOn\" } ]\n}\n```\n\n
\n\n\nClick to expand instructions for working with targeting and variations
\n\nThese instructions require the `environmentKey` parameter.\n\nSeveral 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](https://launchdarkly.com/docs/api/feature-flags/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.\n\n#### addClauses\n\nAdds the given clauses to the rule indicated by `ruleId`.\n\n##### Parameters\n\n- `ruleId`: ID of a rule in the flag.\n- `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.\n\nHere's an example:\n\n```json\n{\n\t\"environmentKey\": \"environment-key-123abc\",\n\t\"instructions\": [{\n\t\t\"kind\": \"addClauses\",\n\t\t\"ruleId\": \"a902ef4a-2faf-4eaf-88e1-ecc356708a29\",\n\t\t\"clauses\": [{\n\t\t\t\"contextKind\": \"user\",\n\t\t\t\"attribute\": \"country\",\n\t\t\t\"op\": \"in\",\n\t\t\t\"negate\": false,\n\t\t\t\"values\": [\"USA\", \"Canada\"]\n\t\t}]\n\t}]\n}\n```\n\n#### addPrerequisite\n\nAdds the flag indicated by `key` with variation `variationId` as a prerequisite to the flag in the path parameter.\n\n##### Parameters\n\n- `key`: Flag key of the prerequisite flag.\n- `variationId`: ID of a variation of the prerequisite flag.\n\nHere's an example:\n\n```json\n{\n\t\"environmentKey\": \"environment-key-123abc\",\n\t\"instructions\": [{\n\t\t\"kind\": \"addPrerequisite\",\n\t\t\"key\": \"example-prereq-flag-key\",\n\t\t\"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\"\n\t}]\n}\n```\n\n#### addRule\n\nAdds 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.\n\nIf you set `beforeRuleId`, this adds the new rule before the indicated rule. Otherwise, adds the new rule to the end of the list.\n\n##### Parameters\n\n- `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.\n- `beforeRuleId`: (Optional) ID of a flag rule.\n- Either\n - `variationId`: ID of a variation of the flag.\n\n or\n\n - `rolloutWeights`: (Optional) Map of `variationId` to weight, in thousandths of a percent (0-100000).\n - `rolloutBucketBy`: (Optional) Context attribute available in the specified `rolloutContextKind`.\n - `rolloutContextKind`: (Optional) Context kind, defaults to `user`\n\nHere's an example that uses a `variationId`:\n\n```json\n{\n \"environmentKey\": \"environment-key-123abc\",\n \"instructions\": [{\n \"kind\": \"addRule\",\n \"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\",\n \"clauses\": [{\n \"contextKind\": \"organization\",\n \"attribute\": \"located_in\",\n \"op\": \"in\",\n \"negate\": false,\n \"values\": [\"Sweden\", \"Norway\"]\n }]\n }]\n}\n```\n\nHere's an example that uses a percentage rollout:\n\n```json\n{\n \"environmentKey\": \"environment-key-123abc\",\n \"instructions\": [{\n \"kind\": \"addRule\",\n \"clauses\": [{\n \"contextKind\": \"organization\",\n \"attribute\": \"located_in\",\n \"op\": \"in\",\n \"negate\": false,\n \"values\": [\"Sweden\", \"Norway\"]\n }],\n \"rolloutContextKind\": \"organization\",\n \"rolloutWeights\": {\n \"2f43f67c-3e4e-4945-a18a-26559378ca00\": 15000, // serve 15% this variation\n \"e5830889-1ec5-4b0c-9cc9-c48790090c43\": 85000 // serve 85% this variation\n }\n }]\n}\n```\n\n#### addTargets\n\nAdds 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.\n\n##### Parameters\n\n- `values`: List of context keys.\n- `contextKind`: (Optional) Context kind to target, defaults to `user`\n- `variationId`: ID of a variation on the flag.\n\nHere's an example:\n\n```json\n{\n\t\"environmentKey\": \"environment-key-123abc\",\n\t\"instructions\": [{\n\t\t\"kind\": \"addTargets\",\n\t\t\"values\": [\"context-key-123abc\", \"context-key-456def\"],\n\t\t\"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\"\n\t}]\n}\n```\n\n#### addUserTargets\n\nAdds 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.\n\n##### Parameters\n\n- `values`: List of user keys.\n- `variationId`: ID of a variation on the flag.\n\nHere's an example:\n\n```json\n{\n\t\"environmentKey\": \"environment-key-123abc\",\n\t\"instructions\": [{\n\t\t\"kind\": \"addUserTargets\",\n\t\t\"values\": [\"user-key-123abc\", \"user-key-456def\"],\n\t\t\"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\"\n\t}]\n}\n```\n\n#### addValuesToClause\n\nAdds `values` to the values of the clause that `ruleId` and `clauseId` indicate. Does not update the context kind, attribute, or operator.\n\n##### Parameters\n\n- `ruleId`: ID of a rule in the flag.\n- `clauseId`: ID of a clause in that rule.\n- `values`: Array of strings, case sensitive.\n\nHere's an example:\n\n```json\n{\n\t\"environmentKey\": \"environment-key-123abc\",\n\t\"instructions\": [{\n\t\t\"kind\": \"addValuesToClause\",\n\t\t\"ruleId\": \"a902ef4a-2faf-4eaf-88e1-ecc356708a29\",\n\t\t\"clauseId\": \"10a58772-3121-400f-846b-b8a04e8944ed\",\n\t\t\"values\": [\"beta_testers\"]\n\t}]\n}\n```\n\n#### addVariation\n\nAdds a variation to the flag.\n\n##### Parameters\n\n- `value`: The variation value.\n- `name`: (Optional) The variation name.\n- `description`: (Optional) A description for the variation.\n\nHere's an example:\n\n```json\n{\n\t\"instructions\": [ { \"kind\": \"addVariation\", \"value\": 20, \"name\": \"New variation\" } ]\n}\n```\n\n#### clearTargets\n\nRemoves all individual targets from the variation that `variationId` specifies. This includes both user and non-user targets.\n\n##### Parameters\n\n- `variationId`: ID of a variation on the flag.\n\nHere's an example:\n\n```json\n{\n \"environmentKey\": \"environment-key-123abc\",\n \"instructions\": [ { \"kind\": \"clearTargets\", \"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\" } ]\n}\n```\n\n#### clearUserTargets\n\nRemoves all individual user targets from the variation that `variationId` specifies. If you are working with contexts, use `clearTargets` instead of this instruction.\n\n##### Parameters\n\n- `variationId`: ID of a variation on the flag.\n\nHere's an example:\n\n```json\n{\n \"environmentKey\": \"environment-key-123abc\",\n \"instructions\": [ { \"kind\": \"clearUserTargets\", \"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\" } ]\n}\n```\n\n#### removeClauses\n\nRemoves the clauses specified by `clauseIds` from the rule indicated by `ruleId`.\n\n##### Parameters\n\n- `ruleId`: ID of a rule in the flag.\n- `clauseIds`: Array of IDs of clauses in the rule.\n\nHere's an example:\n\n```json\n{\n\t\"environmentKey\": \"environment-key-123abc\",\n\t\"instructions\": [{\n\t\t\"kind\": \"removeClauses\",\n\t\t\"ruleId\": \"a902ef4a-2faf-4eaf-88e1-ecc356708a29\",\n\t\t\"clauseIds\": [\"10a58772-3121-400f-846b-b8a04e8944ed\", \"36a461dc-235e-4b08-97b9-73ce9365873e\"]\n\t}]\n}\n```\n\n#### removePrerequisite\n\nRemoves the prerequisite flag indicated by `key`. Does nothing if this prerequisite does not exist.\n\n##### Parameters\n\n- `key`: Flag key of an existing prerequisite flag.\n\nHere's an example:\n\n```json\n{\n \"environmentKey\": \"environment-key-123abc\",\n \"instructions\": [ { \"kind\": \"removePrerequisite\", \"key\": \"prereq-flag-key-123abc\" } ]\n}\n```\n\n#### removeRule\n\nRemoves the targeting rule specified by `ruleId`. Does nothing if the rule does not exist.\n\n##### Parameters\n\n- `ruleId`: ID of a rule in the flag.\n\nHere's an example:\n\n```json\n{\n \"environmentKey\": \"environment-key-123abc\",\n \"instructions\": [ { \"kind\": \"removeRule\", \"ruleId\": \"a902ef4a-2faf-4eaf-88e1-ecc356708a29\" } ]\n}\n```\n\n#### removeTargets\n\nRemoves 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.\n\n##### Parameters\n\n- `values`: List of context keys.\n- `contextKind`: (Optional) Context kind to target, defaults to `user`\n- `variationId`: ID of a flag variation.\n\nHere's an example:\n\n```json\n{\n\t\"environmentKey\": \"environment-key-123abc\",\n\t\"instructions\": [{\n\t\t\"kind\": \"removeTargets\",\n\t\t\"values\": [\"context-key-123abc\", \"context-key-456def\"],\n\t\t\"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\"\n\t}]\n}\n```\n\n#### removeUserTargets\n\nRemoves 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.\n\n##### Parameters\n\n- `values`: List of user keys.\n- `variationId`: ID of a flag variation.\n\nHere's an example:\n\n```json\n{\n\t\"environmentKey\": \"environment-key-123abc\",\n\t\"instructions\": [{\n\t\t\"kind\": \"removeUserTargets\",\n\t\t\"values\": [\"user-key-123abc\", \"user-key-456def\"],\n\t\t\"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\"\n\t}]\n}\n```\n\n#### removeValuesFromClause\n\nRemoves `values` from the values of the clause indicated by `ruleId` and `clauseId`. Does not update the context kind, attribute, or operator.\n\n##### Parameters\n\n- `ruleId`: ID of a rule in the flag.\n- `clauseId`: ID of a clause in that rule.\n- `values`: Array of strings, case sensitive.\n\nHere's an example:\n\n```json\n{\n\t\"environmentKey\": \"environment-key-123abc\",\n\t\"instructions\": [{\n\t\t\"kind\": \"removeValuesFromClause\",\n\t\t\"ruleId\": \"a902ef4a-2faf-4eaf-88e1-ecc356708a29\",\n\t\t\"clauseId\": \"10a58772-3121-400f-846b-b8a04e8944ed\",\n\t\t\"values\": [\"beta_testers\"]\n\t}]\n}\n```\n\n#### removeVariation\n\nRemoves a variation from the flag.\n\n##### Parameters\n\n- `variationId`: ID of a variation of the flag to remove.\n\nHere's an example:\n\n```json\n{\n\t\"instructions\": [ { \"kind\": \"removeVariation\", \"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\" } ]\n}\n```\n\n#### reorderRules\n\nRearranges 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.\n\n##### Parameters\n\n- `ruleIds`: Array of IDs of all rules in the flag.\n\nHere's an example:\n\n```json\n{\n\t\"environmentKey\": \"environment-key-123abc\",\n\t\"instructions\": [{\n\t\t\"kind\": \"reorderRules\",\n\t\t\"ruleIds\": [\"a902ef4a-2faf-4eaf-88e1-ecc356708a29\", \"63c238d1-835d-435e-8f21-c8d5e40b2a3d\"]\n\t}]\n}\n```\n\n#### replacePrerequisites\n\nRemoves all existing prerequisites and replaces them with the list you provide.\n\n##### Parameters\n\n- `prerequisites`: A list of prerequisites. Each item in the list must include a flag `key` and `variationId`.\n\nHere's an example:\n\n```json\n{\n \"environmentKey\": \"environment-key-123abc\",\n \"instructions\": [\n {\n \"kind\": \"replacePrerequisites\",\n \"prerequisites\": [\n {\n \"key\": \"prereq-flag-key-123abc\",\n \"variationId\": \"10a58772-3121-400f-846b-b8a04e8944ed\"\n },\n {\n \"key\": \"another-prereq-flag-key-456def\",\n \"variationId\": \"e5830889-1ec5-4b0c-9cc9-c48790090c43\"\n }\n ]\n }\n ]\n}\n```\n\n#### replaceRules\n\nRemoves all targeting rules for the flag and replaces them with the list you provide.\n\n##### Parameters\n\n- `rules`: A list of rules.\n\nHere's an example:\n\n```json\n{\n \"environmentKey\": \"environment-key-123abc\",\n \"instructions\": [\n {\n \"kind\": \"replaceRules\",\n \"rules\": [\n {\n \"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\",\n \"description\": \"My new rule\",\n \"clauses\": [\n {\n \"contextKind\": \"user\",\n \"attribute\": \"segmentMatch\",\n \"op\": \"segmentMatch\",\n \"values\": [\"test\"]\n }\n ],\n \"trackEvents\": true\n }\n ]\n }\n ]\n}\n```\n\n#### replaceTargets\n\nRemoves all existing targeting and replaces it with the list of targets you provide.\n\n##### Parameters\n\n- `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`.\n\nHere's an example:\n\n```json\n{\n \"environmentKey\": \"environment-key-123abc\",\n \"instructions\": [\n {\n \"kind\": \"replaceTargets\",\n \"targets\": [\n {\n \"contextKind\": \"user\",\n \"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\",\n \"values\": [\"user-key-123abc\"]\n },\n {\n \"contextKind\": \"device\",\n \"variationId\": \"e5830889-1ec5-4b0c-9cc9-c48790090c43\",\n \"values\": [\"device-key-456def\"]\n }\n ]\n } \n ]\n}\n```\n\n#### replaceUserTargets\n\nRemoves 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.\n\n##### Parameters\n\n- `targets`: A list of user targeting. Each item in the list must include a `variationId` and a list of `values`.\n\nHere's an example:\n\n```json\n{\n \"environmentKey\": \"environment-key-123abc\",\n \"instructions\": [\n {\n \"kind\": \"replaceUserTargets\",\n \"targets\": [\n {\n \"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\",\n \"values\": [\"user-key-123abc\", \"user-key-456def\"]\n },\n {\n \"variationId\": \"e5830889-1ec5-4b0c-9cc9-c48790090c43\",\n \"values\": [\"user-key-789ghi\"]\n }\n ]\n }\n ]\n}\n```\n\n#### updateClause\n\nReplaces the clause indicated by `ruleId` and `clauseId` with `clause`.\n\n##### Parameters\n\n- `ruleId`: ID of a rule in the flag.\n- `clauseId`: ID of a clause in that rule.\n- `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.\n\nHere's an example:\n\n```json\n{\n \"environmentKey\": \"environment-key-123abc\",\n \"instructions\": [{\n \"kind\": \"updateClause\",\n \"ruleId\": \"a902ef4a-2faf-4eaf-88e1-ecc356708a29\",\n \"clauseId\": \"10c7462a-2062-45ba-a8bb-dfb3de0f8af5\",\n \"clause\": {\n \"contextKind\": \"user\",\n \"attribute\": \"country\",\n \"op\": \"in\",\n \"negate\": false,\n \"values\": [\"Mexico\", \"Canada\"]\n }\n }]\n}\n```\n\n#### updateDefaultVariation\n\nUpdates the default on or off variation of the flag.\n\n##### Parameters\n\n- `onVariationValue`: (Optional) The value of the variation of the new on variation.\n- `offVariationValue`: (Optional) The value of the variation of the new off variation\n\nHere's an example:\n\n```json\n{\n\t\"instructions\": [ { \"kind\": \"updateDefaultVariation\", \"OnVariationValue\": true, \"OffVariationValue\": false } ]\n}\n```\n\n#### updateFallthroughVariationOrRollout\n\nUpdates 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.\n\n##### Parameters\n\n- `variationId`: ID of a variation of the flag.\n\nor\n\n- `rolloutWeights`: Map of `variationId` to weight, in thousandths of a percent (0-100000).\n- `rolloutBucketBy`: (Optional) Context attribute available in the specified `rolloutContextKind`.\n- `rolloutContextKind`: (Optional) Context kind, defaults to `user`\n\nHere's an example that uses a `variationId`:\n\n```json\n{\n\t\"environmentKey\": \"environment-key-123abc\",\n\t\"instructions\": [{\n\t\t\"kind\": \"updateFallthroughVariationOrRollout\",\n\t\t\"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\"\n\t}]\n}\n```\n\nHere's an example that uses a percentage rollout:\n\n```json\n{\n\t\"environmentKey\": \"environment-key-123abc\",\n\t\"instructions\": [{\n\t\t\"kind\": \"updateFallthroughVariationOrRollout\",\n\t\t\"rolloutContextKind\": \"user\",\n\t\t\"rolloutWeights\": {\n\t\t\t\"2f43f67c-3e4e-4945-a18a-26559378ca00\": 15000, // serve 15% this variation\n\t\t\t\"e5830889-1ec5-4b0c-9cc9-c48790090c43\": 85000 // serve 85% this variation\n\t\t}\n\t}]\n}\n```\n\n#### updateOffVariation\n\nUpdates the default off variation to `variationId`. The flag serves the default off variation when the flag's targeting is **Off**.\n\n##### Parameters\n\n- `variationId`: ID of a variation of the flag.\n\nHere's an example:\n\n```json\n{\n \"environmentKey\": \"environment-key-123abc\",\n \"instructions\": [ { \"kind\": \"updateOffVariation\", \"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\" } ]\n}\n```\n\n#### updatePrerequisite\n\nChanges the prerequisite flag that `key` indicates to use the variation that `variationId` indicates. Returns an error if this prerequisite does not exist.\n\n##### Parameters\n\n- `key`: Flag key of an existing prerequisite flag.\n- `variationId`: ID of a variation of the prerequisite flag.\n\nHere's an example:\n\n```json\n{\n\t\"environmentKey\": \"environment-key-123abc\",\n\t\"instructions\": [{\n\t\t\"kind\": \"updatePrerequisite\",\n\t\t\"key\": \"example-prereq-flag-key\",\n\t\t\"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\"\n\t}]\n}\n```\n\n#### updateRuleDescription\n\nUpdates the description of the feature flag rule.\n\n##### Parameters\n\n- `description`: The new human-readable description for this rule.\n- `ruleId`: The ID of the rule. You can retrieve this by making a GET request for the flag.\n\nHere's an example:\n\n```json\n{\n\t\"environmentKey\": \"environment-key-123abc\",\n\t\"instructions\": [{\n\t\t\"kind\": \"updateRuleDescription\",\n\t\t\"description\": \"New rule description\",\n\t\t\"ruleId\": \"a902ef4a-2faf-4eaf-88e1-ecc356708a29\"\n\t}]\n}\n```\n\n#### updateRuleTrackEvents\n\nUpdates whether or not LaunchDarkly tracks events for the feature flag associated with this rule.\n\n##### Parameters\n\n- `ruleId`: The ID of the rule. You can retrieve this by making a GET request for the flag.\n- `trackEvents`: Whether or not events are tracked.\n\nHere's an example:\n\n```json\n{\n\t\"environmentKey\": \"environment-key-123abc\",\n\t\"instructions\": [{\n\t\t\"kind\": \"updateRuleTrackEvents\",\n\t\t\"ruleId\": \"a902ef4a-2faf-4eaf-88e1-ecc356708a29\",\n\t\t\"trackEvents\": true\n\t}]\n}\n```\n\n#### updateRuleVariationOrRollout\n\nUpdates 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.\n\n##### Parameters\n\n- `ruleId`: ID of a rule in the flag.\n- `variationId`: ID of a variation of the flag.\n\n or\n\n- `rolloutWeights`: Map of `variationId` to weight, in thousandths of a percent (0-100000).\n- `rolloutBucketBy`: (Optional) Context attribute available in the specified `rolloutContextKind`.\n- `rolloutContextKind`: (Optional) Context kind, defaults to `user`\n\nHere's an example:\n\n```json\n{\n\t\"environmentKey\": \"environment-key-123abc\",\n\t\"instructions\": [{\n\t\t\"kind\": \"updateRuleVariationOrRollout\",\n\t\t\"ruleId\": \"a902ef4a-2faf-4eaf-88e1-ecc356708a29\",\n\t\t\"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\"\n\t}]\n}\n```\n\n#### updateTrackEvents\n\nUpdates whether or not LaunchDarkly tracks events for the feature flag, for all rules.\n\n##### Parameters\n\n- `trackEvents`: Whether or not events are tracked.\n\nHere's an example:\n\n```json\n{\n \"environmentKey\": \"environment-key-123abc\",\n \"instructions\": [ { \"kind\": \"updateTrackEvents\", \"trackEvents\": true } ]\n}\n```\n\n#### updateTrackEventsFallthrough\n\nUpdates whether or not LaunchDarkly tracks events for the feature flag, for the default rule.\n\n##### Parameters\n\n- `trackEvents`: Whether or not events are tracked.\n\nHere's an example:\n\n```json\n{\n \"environmentKey\": \"environment-key-123abc\",\n \"instructions\": [ { \"kind\": \"updateTrackEventsFallthrough\", \"trackEvents\": true } ]\n}\n```\n\n#### updateVariation\n\nUpdates a variation of the flag.\n\n##### Parameters\n\n- `variationId`: The ID of the variation to update.\n- `name`: (Optional) The updated variation name.\n- `value`: (Optional) The updated variation value.\n- `description`: (Optional) The updated variation description.\n\nHere's an example:\n\n```json\n{\n\t\"instructions\": [ { \"kind\": \"updateVariation\", \"variationId\": \"2f43f67c-3e4e-4945-a18a-26559378ca00\", \"value\": 20 } ]\n}\n```\n\n
\n\n\nClick to expand instructions for updating flag settings
\n\nThese instructions do not require the `environmentKey` parameter. They make changes that apply to the flag across all environments.\n\n#### addCustomProperties\n\nAdds 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.\n\n##### Parameters\n\n - `key`: The custom property key.\n - `name`: The custom property name.\n - `values`: A list of the associated values for the custom property.\n\nHere's an example:\n\n```json\n{\n\t\"instructions\": [{\n\t\t\"kind\": \"addCustomProperties\",\n\t\t\"key\": \"example-custom-property\",\n\t\t\"name\": \"Example custom property\",\n\t\t\"values\": [\"value1\", \"value2\"]\n\t}]\n}\n```\n\n#### addTags\n\nAdds tags to the feature flag.\n\n##### Parameters\n\n- `values`: A list of tags to add.\n\nHere's an example:\n\n```json\n{\n \"instructions\": [ { \"kind\": \"addTags\", \"values\": [\"tag1\", \"tag2\"] } ]\n}\n```\n\n#### makeFlagPermanent\n\nMarks 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.\n\nHere's an example:\n\n```json\n{\n \"instructions\": [ { \"kind\": \"makeFlagPermanent\" } ]\n}\n```\n\n#### makeFlagTemporary\n\nMarks the feature flag as temporary.\n\nHere's an example:\n\n```json\n{\n \"instructions\": [ { \"kind\": \"makeFlagTemporary\" } ]\n}\n```\n\n#### removeCustomProperties\n\nRemoves the associated values from a custom property. If all the associated values are removed, this instruction also removes the custom property.\n\n##### Parameters\n\n - `key`: The custom property key.\n - `values`: A list of the associated values to remove from the custom property.\n\n```json\n{\n\t\"instructions\": [{\n\t\t\"kind\": \"replaceCustomProperties\",\n\t\t\"key\": \"example-custom-property\",\n\t\t\"values\": [\"value1\", \"value2\"]\n\t}]\n}\n```\n\n#### removeMaintainer\n\nRemoves the flag's maintainer. To set a new maintainer, use the `updateMaintainerMember` or `updateMaintainerTeam` instructions.\n\nHere's an example:\n\n```json\n{\n \"instructions\": [ { \"kind\": \"removeMaintainer\" } ]\n}\n```\n\n#### removeTags\n\nRemoves tags from the feature flag.\n\n##### Parameters\n\n- `values`: A list of tags to remove.\n\nHere's an example:\n\n```json\n{\n \"instructions\": [ { \"kind\": \"removeTags\", \"values\": [\"tag1\", \"tag2\"] } ]\n}\n```\n\n#### replaceCustomProperties\n\nReplaces the existing associated values for a custom property with the new values.\n\n##### Parameters\n\n - `key`: The custom property key.\n - `name`: The custom property name.\n - `values`: A list of the new associated values for the custom property.\n\nHere's an example:\n\n```json\n{\n \"instructions\": [{\n \"kind\": \"replaceCustomProperties\",\n \"key\": \"example-custom-property\",\n \"name\": \"Example custom property\",\n \"values\": [\"value1\", \"value2\"]\n }]\n}\n```\n\n#### turnOffClientSideAvailability\n\nTurns 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.\n\n##### Parameters\n\n- `value`: Use \"usingMobileKey\" to turn off availability for mobile SDKs. Use \"usingEnvironmentId\" to turn on availability for client-side SDKs.\n\nHere's an example:\n\n```json\n{\n \"instructions\": [ { \"kind\": \"turnOffClientSideAvailability\", \"value\": \"usingMobileKey\" } ]\n}\n```\n\n#### turnOnClientSideAvailability\n\nTurns on client-side SDK availability for the flag. This is equivalent to checking 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.\n\n##### Parameters\n\n- `value`: Use \"usingMobileKey\" to turn on availability for mobile SDKs. Use \"usingEnvironmentId\" to turn on availability for client-side SDKs.\n\nHere's an example:\n\n```json\n{\n \"instructions\": [ { \"kind\": \"turnOnClientSideAvailability\", \"value\": \"usingMobileKey\" } ]\n}\n```\n\n#### updateDescription\n\nUpdates the feature flag description.\n\n##### Parameters\n\n- `value`: The new description.\n\nHere's an example:\n\n```json\n{\n \"instructions\": [ { \"kind\": \"updateDescription\", \"value\": \"Updated flag description\" } ]\n}\n```\n#### updateMaintainerMember\n\nUpdates the maintainer of the flag to an existing member and removes the existing maintainer.\n\n##### Parameters\n\n- `value`: The ID of the member.\n\nHere's an example:\n\n```json\n{\n \"instructions\": [ { \"kind\": \"updateMaintainerMember\", \"value\": \"61e9b714fd47591727db558a\" } ]\n}\n```\n\n#### updateMaintainerTeam\n\nUpdates the maintainer of the flag to an existing team and removes the existing maintainer.\n\n##### Parameters\n\n- `value`: The key of the team.\n\nHere's an example:\n\n```json\n{\n \"instructions\": [ { \"kind\": \"updateMaintainerTeam\", \"value\": \"example-team-key\" } ]\n}\n```\n\n#### updateName\n\nUpdates the feature flag name.\n\n##### Parameters\n\n- `value`: The new name.\n\nHere's an example:\n\n```json\n{\n \"instructions\": [ { \"kind\": \"updateName\", \"value\": \"Updated flag name\" } ]\n}\n```\n\n
\n\n\nClick to expand instructions for updating the flag lifecycle
\n\nThese instructions do not require the `environmentKey` parameter. They make changes that apply to the flag across all environments.\n\n#### archiveFlag\n\nArchives the feature flag. This retires it from LaunchDarkly without deleting it. You cannot archive a flag that is a prerequisite of other flags.\n\n```json\n{\n \"instructions\": [ { \"kind\": \"archiveFlag\" } ]\n}\n```\n\n#### deleteFlag\n\nDeletes 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 contexts.\n\nHere's an example:\n\n```json\n{\n \"instructions\": [ { \"kind\": \"deleteFlag\" } ]\n}\n```\n\n#### deprecateFlag\n\nDeprecates the feature flag. This hides it from the live flags list without archiving or deleting it.\n\nHere's an example:\n\n```json\n{\n \"instructions\": [ { \"kind\": \"deprecateFlag\" } ]\n}\n```\n\n#### restoreDeprecatedFlag\n\nRestores the feature flag if it was previously deprecated.\n\nHere's an example:\n\n```json\n{\n \"instructions\": [ { \"kind\": \"restoreDeprecatedFlag\" } ]\n}\n```\n\n#### restoreFlag\n\nRestores the feature flag if it was previously archived.\n\nHere's an example:\n\n```json\n{\n \"instructions\": [ { \"kind\": \"restoreFlag\" } ]\n}\n```\n\n \n\n### Using JSON patches on a feature flag\n\nIf you do not include the semantic patch header described above, you can use a [JSON patch](https://launchdarkly.com/docs/api#updates-using-json-patch) or [JSON merge patch](https://datatracker.ietf.org/doc/html/rfc7386) representation of the desired changes.\n\nIn the JSON patch representation, use a JSON pointer in the `path` element to describe what field to change. Use the [Get feature flag](https://launchdarkly.com/docs/api/feature-flags/get-feature-flag) endpoint to find the field you want to update.\n\nThere are a few special cases to keep in mind when determining the value of the `path` element:\n\n * To add an individual target to a specific variation if the flag variation already has individual targets, the path for the JSON patch operation is:\n\n ```json\n [\n {\n \"op\": \"add\",\n \"path\": \"/environments/devint/targets/0/values/-\",\n \"value\": \"TestClient10\"\n }\n ]\n ```\n\n * To add an individual target to a specific variation if the flag variation does not already have individual targets, the path for the JSON patch operation is:\n\n ```json\n [\n {\n \"op\": \"add\",\n \"path\": \"/environments/devint/targets/-\",\n \"value\": { \"variation\": 0, \"values\": [\"TestClient10\"] }\n }\n ]\n ```\n\n * To add a flag to a release pipeline, the path for the JSON patch operation is:\n\n ```json\n [\n {\n \"op\": \"add\",\n \"path\": \"/releasePipelineKey\",\n \"value\": \"example-release-pipeline-key\"\n }\n ]\n ```\n\n### Required approvals\nIf 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](https://launchdarkly.com/docs/api/approvals).\n\n### Conflicts\nIf 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`.\n\n### Migration flags\nFor migration flags, the cohort information is included in the `rules` property of a flag's response. You can update cohorts by updating `rules`. Default cohort information is included in the `fallthrough` property of a flag's response. You can update the default cohort by updating `fallthrough`.\nWhen you update the rollout for a cohort or the default cohort through the API, provide a rollout instead of a single `variationId`.\nTo learn more, read [Migration flags](https://launchdarkly.com/docs/home/flags/migration).\n"
operationId: patchFeatureFlag
parameters:
- name: projectKey
in: path
description: The project key
required: true
schema:
type: string
format: string
description: The project key
- name: featureFlagKey
in: path
description: The feature flag key. The key identifies the flag in your code.
required: true
schema:
type: string
format: string
description: The feature flag key. The key identifies the flag in your code.
- name: ignoreConflicts
in: query
description: >-
If true, the patch will be applied even if it causes a pending
scheduled change or approval request to fail.
schema:
type: boolean
description: >-
If true, the patch will be applied even if it causes a pending
scheduled change or approval request to fail.
- name: dryRun
in: query
description: >-
If true, the patch will be validated but not persisted. Returns a
preview of the flag after the patch is applied.
schema:
type: boolean
description: >-
If true, the patch will be validated but not persisted. Returns a
preview of the flag after the patch is applied.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchWithComment'
example:
patch:
- op: replace
path: /description
value: New description for this flag
required: true
responses:
'200':
description: Global flag response
content:
application/json:
schema:
$ref: '#/components/schemas/FeatureFlag'
'400':
description: Invalid request
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestErrorRep'
'401':
description: Invalid access token
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedErrorRep'
'404':
description: Invalid resource identifier
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundErrorRep'
'405':
description: Approval is required to make this request
content:
application/json:
schema:
$ref: '#/components/schemas/MethodNotAllowedErrorRep'
'409':
description: Status conflict
content:
application/json:
schema:
$ref: '#/components/schemas/StatusConflictErrorRep'
'429':
description: Rate limited
content:
application/json:
schema:
$ref: '#/components/schemas/RateLimitedErrorRep'
components:
schemas:
PatchWithComment:
type: object
required:
- patch
properties:
patch:
$ref: '#/components/schemas/JSONPatch'
description: A JSON patch representation of the change to make
comment:
type: string
description: Optional comment
FeatureFlag:
type: object
required:
- name
- kind
- key
- _version
- creationDate
- variations
- temporary
- tags
- _links
- experiments
- customProperties
- archived
properties:
name:
type: string
description: A human-friendly name for the feature flag
example: My Flag
kind:
type: string
description: Kind of feature flag
example: boolean
enum:
- boolean
- multivariate
description:
type: string
description: Description of the feature flag
example: This flag controls the example widgets
key:
type: string
description: A unique key used to reference the flag in your code
example: flag-key-123abc
_version:
type: integer
description: Version of the feature flag
example: 1
creationDate:
$ref: '#/components/schemas/UnixMillis'
description: Timestamp of flag creation date
example: '1494437420312'
includeInSnippet:
type: boolean
description: >-
Deprecated, use clientSideAvailability. Whether this
flag should be made available to the client-side JavaScript SDK
example: true
deprecated: true
clientSideAvailability:
$ref: '#/components/schemas/ClientSideAvailability'
description: Which type of client-side SDKs the feature flag is available to
example: '{"usingMobileKey":true,"usingEnvironmentId":false}'
variations:
type: array
description: An array of possible variations for the flag
items:
$ref: '#/components/schemas/Variation'
example:
- _id: e432f62b-55f6-49dd-a02f-eb24acf39d05
value: true
- _id: a00bf58d-d252-476c-b915-15a74becacb4
value: false
temporary:
type: boolean
description: Whether the flag is a temporary flag
example: true
tags:
type: array
description: Tags for the feature flag
items:
type: string
example:
- example-tag
_links:
type: object
additionalProperties:
$ref: '#/components/schemas/Link'
description: The location and content type of related resources
example:
parent:
href: /api/v2/flags/my-project
type: application/json
self:
href: /api/v2/flags/my-project/my-flag
type: application/json
maintainerId:
type: string
description: Associated maintainerId for the feature flag
example: 569f183514f4432160000007
_maintainer:
$ref: '#/components/schemas/MemberSummary'
description: Associated maintainer member info for the feature flag
maintainerTeamKey:
type: string
description: The key of the associated team that maintains this feature flag
example: team-1
_maintainerTeam:
$ref: '#/components/schemas/MaintainerTeam'
description: Associated maintainer team info for the feature flag
goalIds:
type: array
description: Deprecated, use experiments instead
items:
type: string
example: []
deprecated: true
experiments:
$ref: '#/components/schemas/ExperimentInfoRep'
description: Experimentation data for the feature flag
example: '{"baselineIdx": 0,"items": []}'
customProperties:
$ref: '#/components/schemas/CustomProperties'
description: >-
Metadata attached to the feature flag, in the form of the property
key associated with a name and array of values for the metadata to
associate with this flag. Typically used to store data related to an
integration.
example: '{"jira.issues":{"name":"Jira issues","value":["is-123","is-456"]}}'
archived:
type: boolean
description: Boolean indicating if the feature flag is archived
example: false
archivedDate:
$ref: '#/components/schemas/UnixMillis'
description: If archived is true, date of archive
example: '1494437420312'
deprecated:
type: boolean
description: Boolean indicating if the feature flag is deprecated
example: false
deprecatedDate:
$ref: '#/components/schemas/UnixMillis'
description: If deprecated is true, date of deprecation
example: '1494437420312'
defaults:
$ref: '#/components/schemas/Defaults'
description: >-
The indices, from the array of variations, for the variations to
serve by default when targeting is on and when targeting is off.
These variations will be used for this flag in new environments. If
omitted, the first and last variation will be used.
example: '{"onVariation":0,"offVariation":1}'
_purpose:
type: string
migrationSettings:
$ref: '#/components/schemas/FlagMigrationSettingsRep'
description: Migration-related settings for the flag
environments:
type: object
additionalProperties:
$ref: '#/components/schemas/FeatureFlagConfig'
description: >-
Details on the environments for this flag. Only returned if the
request is filtered by environment, using the filterEnv
query parameter.
example:
my-environment:
_environmentName: My Environment
_site:
href: /default/my-environment/features/client-side-flag
type: text/html
_summary:
prerequisites: 0
variations:
'0':
contextTargets: 1
isFallthrough: true
nullRules: 0
rules: 0
targets: 1
'1':
isOff: true
nullRules: 0
rules: 0
targets: 0
archived: false
contextTargets:
- contextKind: device
values:
- device-key-123abc
variation: 0
fallthrough:
variation: 0
lastModified: 1627071171347
offVariation: 1
'on': false
prerequisites: []
rules: []
salt: 61eddeadbeef4da1facecafe3a60a397
sel: 810edeadbeef4844facecafe438f2999492
targets:
- contextKind: user
values:
- user-key-123abc
variation: 0
trackEvents: false
trackEventsFallthrough: false
version: 1
InvalidRequestErrorRep:
type: object
required:
- code
- message
properties:
code:
type: string
description: Specific error code encountered
example: invalid_request
message:
type: string
description: Description of the error
example: Invalid request body
UnauthorizedErrorRep:
type: object
required:
- code
- message
properties:
code:
type: string
description: Specific error code encountered
example: unauthorized
message:
type: string
description: Description of the error
example: Invalid access token
NotFoundErrorRep:
type: object
required:
- code
- message
properties:
code:
type: string
description: Specific error code encountered
example: not_found
message:
type: string
description: Description of the error
example: Invalid resource identifier
MethodNotAllowedErrorRep:
type: object
required:
- code
- message
properties:
code:
type: string
description: Specific error code encountered
example: method_not_allowed
message:
type: string
description: Description of the error
example: Method not allowed
StatusConflictErrorRep:
type: object
required:
- code
- message
properties:
code:
type: string
description: Specific error code encountered
example: optimistic_locking_error
message:
type: string
description: Description of the error
example: Conflict. Optimistic lock error. Try again later.
RateLimitedErrorRep:
type: object
required:
- code
- message
properties:
code:
type: string
description: Specific error code encountered
example: rate_limited
message:
type: string
description: Description of the error
example: You've exceeded the API rate limit. Try again later.
JSONPatch:
type: array
items:
$ref: '#/components/schemas/PatchOperation'
UnixMillis:
type: integer
format: int64
ClientSideAvailability:
type: object
properties:
usingMobileKey:
type: boolean
usingEnvironmentId:
type: boolean
Variation:
type: object
required:
- value
properties:
_id:
type: string
description: The ID of the variation. Leave empty when you are creating a flag.
value:
description: >-
The value of the variation. For boolean flags, this must be
true or false. For multivariate flags,
this may be a string, number, or JSON object.
description:
type: string
description: >-
Description of the variation. Defaults to an empty string, but is
omitted from the response if not set.
name:
type: string
description: >-
A human-friendly name for the variation. Defaults to an empty
string, but is omitted from the response if not set.
Link:
type: object
properties:
href:
type: string
type:
type: string
MemberSummary:
type: object
required:
- _links
- _id
- role
- email
properties:
_links:
type: object
additionalProperties:
$ref: '#/components/schemas/Link'
description: The location and content type of related resources
example:
self:
href: /api/v2/members/569f183514f4432160000007
type: application/json
_id:
type: string
description: The member's ID
example: 569f183514f4432160000007
firstName:
type: string
description: The member's first name
example: Ariel
lastName:
type: string
description: The member's last name
example: Flores
role:
type: string
description: >-
The member's base role. If the member has no additional roles, this
role will be in effect.
example: admin
email:
type: string
description: The member's email address
example: ariel@acme.com
MaintainerTeam:
type: object
required:
- key
- name
properties:
key:
type: string
description: The key of the maintainer team
example: team-key-123abc
name:
type: string
description: A human-friendly name for the maintainer team
example: Example team
_links:
type: object
additionalProperties:
$ref: '#/components/schemas/Link'
description: The location and content type of related resources
example:
parent:
href: /api/v2/teams
type: application/json
roles:
href: /api/v2/teams/example-team/roles
type: application/json
self:
href: /api/v2/teams/example-team
type: application/json
ExperimentInfoRep:
type: object
required:
- baselineIdx
- items
properties:
baselineIdx:
type: integer
items:
type: array
items:
$ref: '#/components/schemas/LegacyExperimentRep'
CustomProperties:
type: object
additionalProperties:
$ref: '#/components/schemas/customProperty'
Defaults:
type: object
required:
- onVariation
- offVariation
properties:
onVariation:
type: integer
description: >-
The index, from the array of variations for this flag, of the
variation to serve by default when targeting is on.
example: 0
offVariation:
type: integer
description: >-
The index, from the array of variations for this flag, of the
variation to serve by default when targeting is off.
example: 1
FlagMigrationSettingsRep:
type: object
properties:
contextKind:
type: string
description: >-
The context kind targeted by this migration flag. Only applicable
for six-stage migrations.
example: device
stageCount:
type: integer
description: The number of stages for this migration flag
example: 6
FeatureFlagConfig:
type: object
required:
- 'on'
- archived
- salt
- sel
- lastModified
- version
- _site
- _environmentName
- trackEvents
- trackEventsFallthrough
properties:
'on':
type: boolean
description: Whether the flag is on
archived:
type: boolean
description: Boolean indicating if the feature flag is archived
salt:
type: string
sel:
type: string
lastModified:
$ref: '#/components/schemas/UnixMillis'
description: Timestamp of when the flag configuration was most recently modified
version:
type: integer
description: Version of the feature flag
targets:
type: array
description: >-
An array of the individual targets that will receive a specific
variation based on their key. Individual targets with a context kind
of 'user' are included here.
items:
$ref: '#/components/schemas/Target'
contextTargets:
type: array
description: >-
An array of the individual targets that will receive a specific
variation based on their key. Individual targets with context kinds
other than 'user' are included here.
items:
$ref: '#/components/schemas/Target'
rules:
type: array
description: >-
An array of the rules for how to serve a variation to specific
targets based on their attributes
items:
$ref: '#/components/schemas/Rule'
fallthrough:
$ref: '#/components/schemas/VariationOrRolloutRep'
description: >-
Details on the variation or rollout to serve as part of the flag's
default rule
offVariation:
type: integer
description: The ID of the variation to serve when the flag is off
prerequisites:
type: array
description: >-
An array of the prerequisite flags and their variations that are
required before this flag takes effect
items:
$ref: '#/components/schemas/Prerequisite'
_site:
$ref: '#/components/schemas/Link'
description: >-
Details on how to access the flag configuration in the LaunchDarkly
UI
_access:
$ref: '#/components/schemas/Access'
description: Details on the allowed and denied actions for this flag
_environmentName:
type: string
description: The environment name
trackEvents:
type: boolean
description: >-
Whether LaunchDarkly tracks events for the feature flag, for all
rules
trackEventsFallthrough:
type: boolean
description: >-
Whether LaunchDarkly tracks events for the feature flag, for the
default rule
_debugEventsUntilDate:
$ref: '#/components/schemas/UnixMillis'
_summary:
$ref: '#/components/schemas/FlagSummary'
description: A summary of the prerequisites and variations for this flag
evaluation:
$ref: '#/components/schemas/FlagConfigEvaluation'
description: Evaluation information for the flag
migrationSettings:
$ref: '#/components/schemas/FlagConfigMigrationSettingsRep'
description: Migration-related settings for the flag configuration
PatchOperation:
type: object
required:
- op
- path
properties:
op:
type: string
description: The type of operation to perform
example: replace
path:
type: string
description: >-
A JSON Pointer string specifying the part of the document to operate
on
example: /exampleField
value:
description: A JSON value used in "add", "replace", and "test" operations
example: new example value
LegacyExperimentRep:
type: object
properties:
metricKey:
type: string
example: my-metric
_metric:
$ref: '#/components/schemas/MetricListingRep'
environments:
type: array
items:
type: string
example:
- production
- test
- my-environment
_environmentSettings:
type: object
additionalProperties:
$ref: '#/components/schemas/ExperimentEnvironmentSettingRep'
customProperty:
type: object
required:
- name
- value
properties:
name:
type: string
description: The name of the custom property of this type.
example: Jira issues
value:
type: array
description: >-
An array of values for the custom property data to associate with
this flag.
items:
type: string
example:
- is-123
- is-456
Target:
type: object
required:
- values
- variation
properties:
values:
type: array
description: >-
A list of the keys for targets that will receive this variation
because of individual targeting
items:
type: string
variation:
type: integer
description: >-
The index, from the array of variations for this flag, of the
variation to serve this list of targets
contextKind:
type: string
description: The context kind of the individual target
Rule:
type: object
required:
- clauses
- trackEvents
properties:
_id:
type: string
description: The flag rule ID
disabled:
type: boolean
description: Whether the rule is disabled
variation:
type: integer
description: >-
The index of the variation, from the array of variations for this
flag
rollout:
$ref: '#/components/schemas/Rollout'
description: Details on the percentage rollout, if it exists
clauses:
type: array
description: >-
An array of clauses used for individual targeting based on
attributes
items:
$ref: '#/components/schemas/Clause'
trackEvents:
type: boolean
description: Whether LaunchDarkly tracks events for this rule
description:
type: string
description: The rule description
ref:
type: string
VariationOrRolloutRep:
type: object
properties:
variation:
type: integer
description: >-
The index of the variation, from the array of variations for this
flag
rollout:
$ref: '#/components/schemas/Rollout'
description: Details on the percentage rollout, if it exists
Prerequisite:
type: object
required:
- key
- variation
properties:
key:
type: string
variation:
type: integer
Access:
type: object
required:
- denied
- allowed
properties:
denied:
type: array
items:
$ref: '#/components/schemas/AccessDenied'
allowed:
type: array
items:
$ref: '#/components/schemas/AccessAllowedRep'
FlagSummary:
type: object
required:
- variations
- prerequisites
properties:
variations:
$ref: '#/components/schemas/AllVariationsSummary'
description: A summary of the variations for this flag
prerequisites:
type: integer
description: The number of prerequisites for this flag
FlagConfigEvaluation:
type: object
properties:
contextKinds:
type: array
items:
type: string
FlagConfigMigrationSettingsRep:
type: object
properties:
checkRatio:
type: integer
MetricListingRep:
type: object
required:
- _id
- _versionId
- key
- name
- kind
- _links
- tags
- _creationDate
- dataSource
properties:
experimentCount:
type: integer
description: The number of experiments using this metric
example: 0
metricGroupCount:
type: integer
description: The number of metric groups using this metric
example: 0
activeExperimentCount:
type: integer
description: The number of active experiments using this metric
example: 2
activeGuardedRolloutCount:
type: integer
description: The number of active guarded rollouts using this metric
example: 1
_id:
type: string
description: The ID of this metric
example: 5902deadbeef667524a01290
_versionId:
type: string
description: The version ID of the metric
example: version-id-123abc
_version:
type: integer
description: Version of the metric
example: 1
key:
type: string
description: A unique key to reference the metric
example: metric-key-123abc
name:
type: string
description: A human-friendly name for the metric
example: My metric
kind:
type: string
description: The kind of event the metric tracks
example: custom
enum:
- pageview
- click
- custom
- trace
_attachedFlagCount:
type: integer
description: The number of feature flags currently attached to this metric
example: 0
_links:
type: object
additionalProperties:
$ref: '#/components/schemas/Link'
description: The location and content type of related resources
example:
parent:
href: /api/v2/metrics/my-project
type: application/json
self:
href: /api/v2/metrics/my-project/my-metric
type: application/json
_site:
$ref: '#/components/schemas/Link'
description: Details on how to access the metric in the LaunchDarkly UI
example: '{"href":"/experiments/metrics/my-metric/edit","type":"text/html"}'
_access:
$ref: '#/components/schemas/Access'
description: Details on the allowed and denied actions for this metric
tags:
type: array
description: Tags for the metric
items:
type: string
example: []
_creationDate:
$ref: '#/components/schemas/UnixMillis'
description: Timestamp of when the metric was created
example: '1628192791148'
lastModified:
$ref: '#/components/schemas/Modification'
maintainerId:
type: string
description: The ID of the member who maintains this metric
example: 569fdeadbeef1644facecafe
_maintainer:
$ref: '#/components/schemas/MemberSummary'
description: Details on the member who maintains this metric
example: >-
{"_links":{"self":{"href":"/api/v2/members/569fdeadbeef1644facecafe","type":"application/json"}},"_id":"569fdeadbeef1644facecafe","firstName":"Ariel","lastName":"Flores","role":"owner","email":"ariel@acme.com"}
description:
type: string
description: Description of the metric
category:
type: string
description: The category of the metric
example: Error monitoring
isNumeric:
type: boolean
description: >-
For custom and trace metrics, whether to track numeric changes in
value against a baseline (true) or to track a
conversion when an end user takes an action (false).
example: true
successCriteria:
type: string
description: For custom and trace metrics, the success criteria
enum:
- HigherThanBaseline
- LowerThanBaseline
unit:
type: string
description: For numeric custom and trace metrics, the unit of measure
eventKey:
type: string
description: For custom metrics, the event key to use in your code
example: Order placed
randomizationUnits:
type: array
description: An array of randomization units allowed for this metric
items:
type: string
example:
- user
filters:
$ref: '#/components/schemas/Filter'
description: >-
The filters narrowing down the audience based on context attributes
or event properties.
example: >-
{"type":"group","op":"and","values":[{"type":"contextAttribute","op":"in","contextKind":"user","attribute":"country","values":["JP"],"negate":false},{"type":"eventProperty","op":"in","attribute":"category","values":["magic-wands"],"negate":false}]}
unitAggregationType:
type: string
description: The method by which multiple unit event values are aggregated
example: average
enum:
- average
- sum
analysisType:
type: string
description: The method for analyzing metric events
example: mean
enum:
- mean
- percentile
percentileValue:
type: integer
description: >-
The percentile for the analysis method. An integer denoting the
target percentile between 0 and 100. Required when
analysisType is percentile.
example: 95
eventDefault:
$ref: '#/components/schemas/MetricEventDefaultRep'
dataSource:
$ref: '#/components/schemas/MetricDataSourceRefRep'
lastSeen:
$ref: '#/components/schemas/UnixMillis'
description: Timestamp of most recent data for this metric, at one-hour fidelity
archived:
type: boolean
description: Whether the metric version is archived
archivedAt:
$ref: '#/components/schemas/UnixMillis'
description: Timestamp when the metric version was archived
example: '1609459200000'
selector:
type: string
description: For click metrics, the CSS selectors
urls:
$ref: '#/components/schemas/UrlMatchers'
description: For click and pageview metrics, the target URLs
example: '[{"kind":"exact","url":"https://www.example.com/page1"}]'
windowStartOffset:
type: integer
format: int64
description: >-
Not yet implemented - The start of the measurement window, in
milliseconds relative to the unit's first exposure to a flag
variation
windowEndOffset:
type: integer
format: int64
description: >-
Not yet implemented - The end of the measurement window, in
milliseconds relative to the unit's first exposure to a flag
variation
traceQuery:
type: string
description: For trace metrics, the trace query to use for the metric.
example: service.name = "checkout"
traceValueLocation:
type: string
description: >-
For trace metrics, the location in the trace to use for numeric
values.
example: duration
ExperimentEnvironmentSettingRep:
type: object
properties:
startDate:
$ref: '#/components/schemas/UnixMillis'
stopDate:
$ref: '#/components/schemas/UnixMillis'
enabledPeriods:
type: array
items:
$ref: '#/components/schemas/ExperimentEnabledPeriodRep'
Rollout:
type: object
required:
- variations
properties:
variations:
type: array
items:
$ref: '#/components/schemas/WeightedVariation'
experimentAllocation:
$ref: '#/components/schemas/ExperimentAllocationRep'
seed:
type: integer
bucketBy:
type: string
contextKind:
type: string
Clause:
type: object
required:
- attribute
- op
- values
- negate
properties:
_id:
type: string
attribute:
type: string
op:
$ref: '#/components/schemas/Operator'
values:
type: array
items: {}
contextKind:
type: string
negate:
type: boolean
AccessDenied:
type: object
required:
- action
- reason
properties:
action:
$ref: '#/components/schemas/ActionIdentifier'
reason:
$ref: '#/components/schemas/AccessDeniedReason'
AccessAllowedRep:
type: object
required:
- action
- reason
properties:
action:
$ref: '#/components/schemas/ActionIdentifier'
reason:
$ref: '#/components/schemas/AccessAllowedReason'
AllVariationsSummary:
type: object
additionalProperties:
$ref: '#/components/schemas/VariationSummary'
Modification:
type: object
properties:
date:
type: string
format: date-time
example: '2021-08-05T19:46:31.148082Z'
Filter:
type: object
required:
- type
- op
- values
- negate
properties:
type:
type: string
description: Filter type. One of [contextAttribute, eventProperty, group]
example: contextAttribute
enum:
- group
- contextAttribute
- eventProperty
attribute:
type: string
description: >-
If not a group node, the context attribute name or event property
name to filter on
example: country
op:
$ref: '#/components/schemas/Operator'
description: The function to perform
example: in
values:
type: array
description: The context attribute / event property values or group member nodes
items: {}
example:
- JP
contextKind:
type: string
description: For context attribute filters, the context kind.
example: user
negate:
type: boolean
description: >-
If set, then take the inverse of the operator. 'in' becomes 'not
in'.
example: false
MetricEventDefaultRep:
type: object
properties:
disabled:
type: boolean
description: >-
Whether to disable defaulting missing unit events when calculating
results. Defaults to false
value:
type: number
description: >-
The default value applied to missing unit events. Set to 0 when
disabled is false. No other values are currently
supported.
example: 0
MetricDataSourceRefRep:
type: object
required:
- key
properties:
key:
type: string
environmentKey:
type: string
_name:
type: string
_integrationKey:
type: string
UrlMatchers:
items:
$ref: '#/components/schemas/UrlMatcher'
type: array
ExperimentEnabledPeriodRep:
type: object
properties:
startDate:
$ref: '#/components/schemas/UnixMillis'
stopDate:
$ref: '#/components/schemas/UnixMillis'
WeightedVariation:
type: object
required:
- variation
- weight
properties:
variation:
type: integer
weight:
type: integer
_untracked:
type: boolean
ExperimentAllocationRep:
type: object
required:
- defaultVariation
- canReshuffle
properties:
defaultVariation:
type: integer
canReshuffle:
type: boolean
Operator:
type: string
ActionIdentifier:
type: string
AccessDeniedReason:
type: object
required:
- effect
properties:
resources:
type: array
description: Resource specifier strings
items:
type: string
example:
- proj/*:env/*;qa_*:/flag/*
notResources:
type: array
description: >-
Targeted resources are the resources NOT in this list. The
resources and notActions fields must be
empty to use this field.
items:
type: string
actions:
type: array
description: Actions to perform on a resource
items:
$ref: '#/components/schemas/ActionSpecifier'
example:
- '*'
notActions:
type: array
description: >-
Targeted actions are the actions NOT in this list. The
actions and notResources fields must be
empty to use this field.
items:
$ref: '#/components/schemas/ActionSpecifier'
effect:
type: string
description: >-
Whether this statement should allow or deny actions on the
resources.
example: allow
enum:
- allow
- deny
role_name:
type: string
AccessAllowedReason:
type: object
required:
- effect
properties:
resources:
type: array
description: Resource specifier strings
items:
type: string
example:
- proj/*:env/*;qa_*:/flag/*
notResources:
type: array
description: >-
Targeted resources are the resources NOT in this list. The
resources and notActions fields must be
empty to use this field.
items:
type: string
actions:
type: array
description: Actions to perform on a resource
items:
$ref: '#/components/schemas/ActionSpecifier'
example:
- '*'
notActions:
type: array
description: >-
Targeted actions are the actions NOT in this list. The
actions and notResources fields must be
empty to use this field.
items:
$ref: '#/components/schemas/ActionSpecifier'
effect:
type: string
description: >-
Whether this statement should allow or deny actions on the
resources.
example: allow
enum:
- allow
- deny
role_name:
type: string
VariationSummary:
type: object
required:
- rules
- nullRules
- targets
- contextTargets
properties:
rules:
type: integer
nullRules:
type: integer
targets:
type: integer
contextTargets:
type: integer
isFallthrough:
type: boolean
isOff:
type: boolean
rollout:
type: integer
bucketBy:
type: string
UrlMatcher:
type: object
additionalProperties: {}
ActionSpecifier:
type: string
securitySchemes:
ApiKey:
type: apiKey
in: header
name: Authorization
````