Sign in

v2

latestOpenAPI 3.0.42026-08-04123200540.7 KB
Feature Flag & Setting values using SDK Key V2

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.

get/v2/settings/{settingKeyOrId}/value

Path parameters

settingKeyOrIdstring required

The key or id of the Setting.

Headers

X-CONFIGCAT-SDKKEYstring

The ConfigCat SDK Key. (https://app.configcat.com/sdkkey)

Response

lastVersionIdstring uuid required

The version identifier of the last change made to the Feature Flag or Setting in the Environment. It can be used to make sure concurrent updates are not overwriting each other. If the version identifier does not match the current version, the update will be rejected with a 409 Conflict response.

updatedAtstring date-time nullable required

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

percentageEvaluationAttributestring nullable required

The user attribute used for percentage evaluation. If not set, it defaults to the Identifier user object attribute.

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.

settingIdsWherePrerequisiteinteger[] required

List of Feature Flag and Setting IDs where the actual Feature Flag or Setting is prerequisite.

changeRequestCountinteger required

The number of change requests for the Feature Flag or Setting.

readOnlyboolean required

Indicates whether you have Read-only access to the Environment.

approveRequiredboolean required

Indicates that a mandatory approval is required for saving and publishing.

canBypassApprovalboolean required

Indicates whether the user can bypass the approval flow.

reasonRequiredboolean required

Indicates that a mandatory note required for saving and publishing.