Skip to main content

Get Flag

GET 
/v1/settings/:settingId

This endpoint returns the metadata attributes of a Feature Flag or Setting identified by the settingId parameter.

Request​

Path Parameters

    settingId int32required

    The identifier of the Setting.

Responses​

When everything is ok, the setting data returned.

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 (string)

    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...