Skip to main content

Create Flag

POST 
/v1/configs/:configId/settings

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.

Request​

Path Parameters

    configId uuidrequired

    The identifier of the Config.

Body

required

    hint stringnullable

    Possible values: <= 1000 characters

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

    tags int64[]nullable

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

    order int32nullable

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

    key stringrequired

    Possible values: non-empty and <= 255 characters, Value must match regular expression ^[a-zA-Z]+[a-zA-Z0-9_-]*$

    The key of the Feature Flag or Setting.

    name stringrequired

    Possible values: non-empty and <= 255 characters

    The name of the Feature Flag or Setting.

    settingType SettingTyperequired

    Possible values: [boolean, string, int, double]

    The type of the Feature Flag or Setting.

    initialValues

    object[]

    nullable

    Optional, initial value of the Feature Flag or Setting in the given Environments.

  • Array [

    • environmentId uuid

    The ID of the Environment where the initial value must be set.

    value nullable

    The initial value in the given Environment. It must respect the setting type.

  • ]

Responses​

When the creation was successful.

Schema

    settingId int32

    Identifier of the Feature Flag or Setting.

    key stringnullable

    Key of the Feature Flag or Setting.

    name stringnullable

    Name of the Feature Flag or Setting.

    hint stringnullable

    Description of the Feature Flag or Setting.

    order int32

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

    settingType SettingType

    Possible values: [boolean, string, int, double]

    The type of the Feature Flag or Setting.

    configId uuid

    Identifier of the Feature Flag's Config.

    configName stringnullable

    Name of the Feature Flag's Config.

    tags

    object[]

    nullable

    The tags attached to the Feature Flag or Setting.

  • Array [

    • product

    object

    Details of the Product.

    organization

    object

    Details of the Organization.

    organizationId uuid

    Identifier of the Organization.

    name stringnullable

    Name of the Organization.

    productId uuid

    Identifier of the Product.

    name stringnullable

    Name of the Product.

    description stringnullable

    Description of the Product.

    order int32

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

    reasonRequired boolean

    Determines whether a mandatory reason must be given every time when the Feature Flags or Settings within a Product are saved.

    tagId int64

    Identifier of the Tag.

    name stringnullable

    Name of the Tag.

    color stringnullable

    The configured color of the Tag.

  • ]

Loading...