Skip to main content

Get a feature environment

GET 
/api/admin/projects/:projectId/features/:featureName/environments/:environment

Information about the enablement status and strategies for a feature flag in specified environment.

Request​

Path Parameters

    projectId stringrequired
    featureName stringrequired
    environment stringrequired

Responses​

featureEnvironmentSchema

Schema

    name stringrequired

    The name of the environment

    Example: my-dev-env
    featureName string

    The name of the feature

    Example: disable-comments
    environment string

    The name of the environment

    Example: development
    type string

    The type of the environment

    Example: development
    enabled booleanrequired

    true if the feature is enabled for the environment, otherwise false.

    Example: true
    sortOrder number

    The sort order of the feature environment in the feature environments list

    Example: 3
    variantCount number

    The number of defined variants

    strategies

    object[]

    A list of activation strategies for the feature environment

  • Array [

    • id string

    A uuid for the feature strategy

    Example: 6b5157cb-343a-41e7-bfa3-7b4ec3044840
    name stringrequired

    The name or type of strategy

    Example: flexibleRollout
    title stringnullable

    A descriptive title for the strategy

    Example: Gradual Rollout 25-Prod
    disabled booleannullable

    A toggle to disable the strategy. defaults to false. Disabled strategies are not evaluated or returned to the SDKs

    Example: false
    featureName string

    The name or feature the strategy is attached to

    Example: myAwesomeFeature
    sortOrder number

    The order of the strategy in the list

    Example: 9999
    segments number[]

    A list of segment ids attached to the strategy

    Example: [1,2]

    constraints

    object[]

    A list of the constraints attached to the strategy. See https://docs.getunleash.io/reference/strategy-constraints

  • Array [

    • contextName stringrequired

    The name of the context field that this constraint should apply to.

    Example: appName
    operator stringrequired

    The operator to use when evaluating this constraint. For more information about the various operators, refer to the strategy constraint operator documentation.

    Possible values: [NOT_IN, IN, STR_ENDS_WITH, STR_STARTS_WITH, STR_CONTAINS, NUM_EQ, NUM_GT, NUM_GTE, NUM_LT, NUM_LTE, DATE_AFTER, DATE_BEFORE, SEMVER_EQ, SEMVER_GT, SEMVER_LT]

    Example: IN
    caseInsensitive boolean

    Whether the operator should be case sensitive or not. Defaults to false (being case sensitive).

    Default value: false
    inverted boolean

    Whether the result should be negated or not. If true, will turn a true result into a false result and vice versa.

    Default value: false
    values string[]

    The context values that should be used for constraint evaluation. Use this property instead of value for properties that accept multiple values.

    Example: ["my-app","my-other-app"]
    value string

    The context value that should be used for constraint evaluation. Use this property instead of values for properties that only accept single values.

    Example: my-app

  • ]

    • variants

    object[]

    Strategy level variants

  • Array [

    • name stringrequired

    The variant name. Must be unique for this feature flag

    Example: blue_group
    weight integerrequired

    The weight is the likelihood of any one user getting this variant. It is an integer between 0 and 1000. See the section on variant weights for more information

    Possible values: <= 1000

    weightType stringrequired

    Set to fix if this variant must have exactly the weight allocated to it. If the type is variable, the weight will adjust so that the total weight of all variants adds up to 1000. Refer to the variant weight documentation.

    Possible values: [variable, fix]

    Example: fix
    stickiness stringrequired

    The stickiness to use for distribution of this variant. Stickiness is how Unleash guarantees that the same user gets the same variant every time

    Example: custom.context.field

    payload

    object

    Extra data configured for this variant

    type stringrequired

    The type of the value. Commonly used types are string, number, json and csv.

    Possible values: [json, csv, string, number]

    value stringrequired

    The actual value of payload

  • ]

    • parameters

    object

    A list of parameters for a strategy

    property name* string

  • ]

    • variants

    object[]

    A list of variants for the feature environment

  • Array [

    • name stringrequired

    The variants name. Is unique for this feature flag

    Example: blue_group
    weight numberrequired

    The weight is the likelihood of any one user getting this variant. It is a number between 0 and 1000. See the section on variant weights for more information

    Possible values: <= 1000

    weightType string

    Set to fix if this variant must have exactly the weight allocated to it. If the type is variable, the weight will adjust so that the total weight of all variants adds up to 1000

    Possible values: [variable, fix]

    Example: variable
    stickiness string

    Stickiness is how Unleash guarantees that the same user gets the same variant every time

    Example: custom.context.field

    payload

    object

    Extra data configured for this variant

    type stringrequired

    The type of the value. Commonly used types are string, number, json and csv.

    Possible values: [json, csv, string, number]

    value stringrequired

    The actual value of payload

    overrides

    object[]

    Overrides assigning specific variants to specific users. The weighting system automatically assigns users to specific groups for you, but any overrides in this list will take precedence.

  • Array [

    • contextName stringrequired

    The name of the context field used to determine overrides

    Example: userId
    values string[]required

    Which values that should be overriden

    Example: ["red","blue"]

  • ]

  • ]

    • lastSeenAt date-timenullable

    The date when metrics where last collected for the feature environment

    Example: 2023-01-28T16:21:39.975Z
    hasStrategies boolean

    Whether the feature has any strategies defined.

    hasEnabledStrategies boolean

    Whether the feature has any enabled strategies defined.

Loading...