v1

latestOpenAPI 3.0.42026-07-13107171473.3 KB

Feature Flags & Settings

Create Flag

This endpoint creates a new Feature Flag or Setting in a specified Config identified by the configId parameter.

Important: The key attribute must be unique within the given Config.

post/v1/configs/{configId}/settings

Path parameters

configIdstring uuid required

The identifier of the Config.

Request body

namestring required

The name of the Feature Flag or Setting.

hintstring nullable

A short description for the setting, shown on the Dashboard UI.

tagsinteger[] nullable

The IDs of the tags which are attached to the setting.

orderinteger nullable

The order of the Setting represented on the ConfigCat Dashboard. Determined from an ascending sequence of integers.

isJsonboolean nullable

Indicates whether this setting should validate string values as JSON values.

keystring required

The key of the Feature Flag or Setting.

settingType'boolean' | 'string' | 'int' | 'double' required

The type of the Feature Flag or Setting.

settingIdToInitFrominteger nullable

Optional, the SettingId to initialize the values and tags of the Feature Flag or Setting from. Only can be set if you have at least ReadOnly access in all the Environments. Only one of the SettingIdToInitFrom or the InitialValues properties can be set.

Response

When the creation was successful.

settingIdinteger required

Identifier of the Feature Flag or Setting.

keystring required

Key of the Feature Flag or Setting.

namestring required

Name of the Feature Flag or Setting.

hintstring nullable required

Description of the Feature Flag or Setting.

orderinteger required

The order of the Feature Flag or Setting represented on the ConfigCat Dashboard.

settingType'boolean' | 'string' | 'int' | 'double' required

The type of the Feature Flag or Setting.

isJsonboolean required

configIdstring uuid required

Identifier of the Feature Flag's Config.

configNamestring required

Name of the Feature Flag's Config.

createdAtstring date-time nullable required

The creation time of the Feature Flag or Setting.