v2

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

Replace value

This endpoint replaces the whole value of a Feature Flag or Setting in a specified Environment.

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

Important: As this endpoint is doing a complete replace, it's important to set every other attribute that you don't want to change in its original state. Not listing one means it will reset.

For example: We have the following resource.

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

If we send a replace request body as below:

{
  "value": true
}

Then besides that the default value is set to true, all the Percentage Rules are deleted. So we get a response like this:

{
  "rolloutPercentageItems": [],
  "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.
put/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

Response

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