All URIs are relative to https://api.configcat.com
| Method | HTTP request | Description |
|---|---|---|
| getSettingValueBySdkkeyV2 | GET /v2/settings/{settingKeyOrId}/value | Get value |
| replaceSettingValueBySdkkeyV2 | PUT /v2/settings/{settingKeyOrId}/value | Replace value |
| updateSettingValueBySdkkeyV2 | PATCH /v2/settings/{settingKeyOrId}/value | Update value |
SettingFormulaModel getSettingValueBySdkkeyV2(settingKeyOrId, X_CONFIGCAT_SDKKEY)
Get value
This endpoint returns the value of a Feature Flag or Setting in a specified Environment identified by the <a target="_blank" rel="noopener noreferrer" href="https://app.configcat.com/sdkkey\">SDK key</a> passed in the `X-CONFIGCAT-SDKKEY` header. The most important fields in the response are the `defaultValue`, `targetingRules`. The `defaultValue` represents what the clients will get when the evaluation requests of our SDKs are not matching to any of the defined Targeting Rules, or when there are no additional rules to evaluate. The `targetingRules` represents the current Targeting Rule configuration of the actual Feature Flag or Setting in an ordered collection, which means the order of the returned rules is matching to the evaluation order. You can read more about these rules here. The `percentageEvaluationAttribute` represents the custom User Object attribute that must be used at the percentage evaluation of the Feature Flag or Setting.
// Import classes:
import com.configcat.publicapi.java.client.ApiClient;
import com.configcat.publicapi.java.client.ApiException;
import com.configcat.publicapi.java.client.Configuration;
import com.configcat.publicapi.java.client.auth.*;
import com.configcat.publicapi.java.client.models.*;
import com.configcat.publicapi.java.client.api.FeatureFlagSettingValuesUsingSdkKeyV2Api;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.configcat.com");
// Configure HTTP basic authorization: Basic
HttpBasicAuth Basic = (HttpBasicAuth) defaultClient.getAuthentication("Basic");
Basic.setUsername("YOUR USERNAME");
Basic.setPassword("YOUR PASSWORD");
FeatureFlagSettingValuesUsingSdkKeyV2Api apiInstance = new FeatureFlagSettingValuesUsingSdkKeyV2Api(defaultClient);
String settingKeyOrId = "settingKeyOrId_example"; // String | The key or id of the Setting.
String X_CONFIGCAT_SDKKEY = "X_CONFIGCAT_SDKKEY_example"; // String | The ConfigCat SDK Key. (https://app.configcat.com/sdkkey)
try {
SettingFormulaModel result = apiInstance.getSettingValueBySdkkeyV2(settingKeyOrId, X_CONFIGCAT_SDKKEY);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling FeatureFlagSettingValuesUsingSdkKeyV2Api#getSettingValueBySdkkeyV2");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| settingKeyOrId | String | The key or id of the Setting. | |
| X_CONFIGCAT_SDKKEY | String | The ConfigCat SDK Key. (https://app.configcat.com/sdkkey) | [optional] |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | - | |
| 400 | Bad request. | - |
| 404 | Not found. | - |
| 429 | Too many requests. In case of the request rate exceeds the rate limits. | - |
SettingFormulaModel replaceSettingValueBySdkkeyV2(settingKeyOrId, updateEvaluationFormulaModel, reason, X_CONFIGCAT_SDKKEY)
Replace value
This endpoint replaces the value and the Targeting Rules of a Feature Flag or Setting in a specified Environment identified by the <a target="_blank" rel="noopener noreferrer" href="https://app.configcat.com/sdkkey\">SDK key</a> passed in the `X-CONFIGCAT-SDKKEY` header. Only the `defaultValue`, `targetingRules`, and `percentageEvaluationAttribute` fields are modifiable by this endpoint. Important: As this endpoint is doing a complete replace, it's important to set every other field that you don't want to change to its original state. Not listing one means it will reset. For example: We have the following resource of a Feature Flag. ```json { "defaultValue": { "boolValue": false }, "targetingRules": [ { "conditions": [ { "userCondition": { "comparisonAttribute": "Email", "comparator": "sensitiveTextEquals", "comparisonValue": { "stringValue": "[email protected]" } } } ], "percentageOptions": [], "value": { "boolValue": true } } ] } ``` If we send a replace request body as below: ```json { "defaultValue": { "boolValue": true } } ``` Then besides that the default served value is set to `true`, all the Targeting Rules are deleted. So we get a response like this: ```json { "defaultValue": { "boolValue": true }, "targetingRules": [] } ```
// Import classes:
import com.configcat.publicapi.java.client.ApiClient;
import com.configcat.publicapi.java.client.ApiException;
import com.configcat.publicapi.java.client.Configuration;
import com.configcat.publicapi.java.client.auth.*;
import com.configcat.publicapi.java.client.models.*;
import com.configcat.publicapi.java.client.api.FeatureFlagSettingValuesUsingSdkKeyV2Api;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.configcat.com");
// Configure HTTP basic authorization: Basic
HttpBasicAuth Basic = (HttpBasicAuth) defaultClient.getAuthentication("Basic");
Basic.setUsername("YOUR USERNAME");
Basic.setPassword("YOUR PASSWORD");
FeatureFlagSettingValuesUsingSdkKeyV2Api apiInstance = new FeatureFlagSettingValuesUsingSdkKeyV2Api(defaultClient);
String settingKeyOrId = "settingKeyOrId_example"; // String | The key or id of the Setting.
UpdateEvaluationFormulaModel updateEvaluationFormulaModel = new UpdateEvaluationFormulaModel(); // UpdateEvaluationFormulaModel |
String reason = "reason_example"; // String | The reason note for the Audit Log if the Product's \"Config changes require a reason\" preference is turned on.
String X_CONFIGCAT_SDKKEY = "X_CONFIGCAT_SDKKEY_example"; // String | The ConfigCat SDK Key. (https://app.configcat.com/sdkkey)
try {
SettingFormulaModel result = apiInstance.replaceSettingValueBySdkkeyV2(settingKeyOrId, updateEvaluationFormulaModel, reason, X_CONFIGCAT_SDKKEY);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling FeatureFlagSettingValuesUsingSdkKeyV2Api#replaceSettingValueBySdkkeyV2");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| settingKeyOrId | String | The key or id of the Setting. | |
| updateEvaluationFormulaModel | UpdateEvaluationFormulaModel | ||
| reason | String | The reason note for the Audit Log if the Product's "Config changes require a reason" preference is turned on. | [optional] |
| X_CONFIGCAT_SDKKEY | String | The ConfigCat SDK Key. (https://app.configcat.com/sdkkey) | [optional] |
- Content-Type: application/json, text/json, application/*+json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | - | |
| 400 | Bad request. | - |
| 404 | Not found. | - |
| 429 | Too many requests. In case of the request rate exceeds the rate limits. | - |
SettingFormulaModel updateSettingValueBySdkkeyV2(settingKeyOrId, jsonPatchOperation, reason, X_CONFIGCAT_SDKKEY)
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 `defaultValue`, `targetingRules`, and `percentageEvaluationAttribute` fields 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 of a Feature Flag. ```json { "defaultValue": { "boolValue": false }, "targetingRules": [ { "conditions": [ { "userCondition": { "comparisonAttribute": "Email", "comparator": "sensitiveTextEquals", "comparisonValue": { "stringValue": "[email protected]" } } } ], "percentageOptions": [], "value": { "boolValue": true } } ] } ``` If we send an update request body as below: ```json [ { "op": "replace", "path": "/targetingRules/0/value/boolValue", "value": true } ] ``` Only the first Targeting Rule's `value` is going to be set to `false` and all the other fields are remaining unchanged. So we get a response like this: ```json { "defaultValue": { "boolValue": false }, "targetingRules": [ { "conditions": [ { "userCondition": { "comparisonAttribute": "Email", "comparator": "sensitiveTextEquals", "comparisonValue": { "stringValue": "[email protected]" } } } ], "percentageOptions": [], "value": { "boolValue": false } } ] } ```
// Import classes:
import com.configcat.publicapi.java.client.ApiClient;
import com.configcat.publicapi.java.client.ApiException;
import com.configcat.publicapi.java.client.Configuration;
import com.configcat.publicapi.java.client.auth.*;
import com.configcat.publicapi.java.client.models.*;
import com.configcat.publicapi.java.client.api.FeatureFlagSettingValuesUsingSdkKeyV2Api;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.configcat.com");
// Configure HTTP basic authorization: Basic
HttpBasicAuth Basic = (HttpBasicAuth) defaultClient.getAuthentication("Basic");
Basic.setUsername("YOUR USERNAME");
Basic.setPassword("YOUR PASSWORD");
FeatureFlagSettingValuesUsingSdkKeyV2Api apiInstance = new FeatureFlagSettingValuesUsingSdkKeyV2Api(defaultClient);
String settingKeyOrId = "settingKeyOrId_example"; // String | The key or id of the Setting.
List<JsonPatchOperation> jsonPatchOperation = Arrays.asList(); // List<JsonPatchOperation> |
String reason = "reason_example"; // String | The reason note for the Audit Log if the Product's \"Config changes require a reason\" preference is turned on.
String X_CONFIGCAT_SDKKEY = "X_CONFIGCAT_SDKKEY_example"; // String | The ConfigCat SDK Key. (https://app.configcat.com/sdkkey)
try {
SettingFormulaModel result = apiInstance.updateSettingValueBySdkkeyV2(settingKeyOrId, jsonPatchOperation, reason, X_CONFIGCAT_SDKKEY);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling FeatureFlagSettingValuesUsingSdkKeyV2Api#updateSettingValueBySdkkeyV2");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| settingKeyOrId | String | The key or id of the Setting. | |
| jsonPatchOperation | List<JsonPatchOperation> | ||
| reason | String | The reason note for the Audit Log if the Product's "Config changes require a reason" preference is turned on. | [optional] |
| X_CONFIGCAT_SDKKEY | String | The ConfigCat SDK Key. (https://app.configcat.com/sdkkey) | [optional] |
- Content-Type: application/json, text/json, application/*+json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | - | |
| 204 | When no change applied on the resource. | - |
| 400 | Bad request. | - |
| 404 | Not found. | - |
| 429 | Too many requests. In case of the request rate exceeds the rate limits. | - |