v2

latestOpenAPI 3.0.42026-08-04123200540.7 KB
Feature Flag & Setting values

Update value

This endpoint updates the value of a Feature Flag or Setting with a collection of JSON Patch operations in a specified Environment.

Only the value, rolloutRules and percentageRules attributes are modifiable by this endpoint.

The advantage of using JSON Patch is that you can describe individual update operations on a resource without touching attributes that you don't want to change. It supports collection reordering, so it also can be used for reordering the targeting rules of a Feature Flag or Setting.

For example: We have the following resource.

{
  "rolloutPercentageItems": [
    {
      "percentage": 30,
      "value": true
    },
    {
      "percentage": 70,
      "value": false
    }
  ],
  "rolloutRules": [],
  "value": false
}

If we send an update request body as below:

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

Only the default value is going to be set to true and all the Percentage Rules are remaining unchanged. So we get a response like this:

{
  "rolloutPercentageItems": [
    {
      "percentage": 30,
      "value": true
    },
    {
      "percentage": 70,
      "value": false
    }
  ],
  "rolloutRules": [],
  "value": true
}

The rolloutRules property describes two types of rules:

  • Targeting rules: When you want to add or update a targeting rule, the comparator, comparisonAttribute, and comparisonValue members are required.
  • Segment rules: When you want to add add or update a segment rule, the segmentId which identifies the desired segment and the segmentComparator members are required.
patch/v1/environments/{environmentId}/settings/{settingId}/value

Path parameters

environmentIdstring uuid required

The identifier of the Environment.

settingIdinteger required

The id of the Setting.

Query parameters

reasonstring

The reason note for the Audit Log if the Product's "Config changes require a reason" preference is turned on.

Request body

op'unknown' | 'add' | 'remove' | 'replace' | 'move' | 'copy' | 'test' required
pathstring required

The source path.

fromstring nullable

The target path.

{"stackTrail":"components:schemas:JsonPatchOperation:properties:value","oasType":"schema","type":"unknown","description":"The discrete value.","nullable":true}

Response

When the patch was successful.

updatedAtstring date-time nullable required

The last updated date and time when the Feature Flag or Setting.

lastUpdaterUserEmailstring nullable required

The email of the user who last updated the Feature Flag or Setting.

lastUpdaterUserFullNamestring nullable required

The name of the user who last updated the Feature Flag or Setting.

readOnlyboolean required