Skip to main content

Get the environments available to a project

GET 
/api/admin/environments/project/:projectId

Gets the environments that are available for this project. An environment is available for a project if enabled in the project configuration

Request​

Path Parameters

    projectId stringrequired

Responses​

environmentsProjectSchema

Schema

    version integerrequired

    Version of the environments schema

    Example: 1

    environments

    object[]

    required

    List of environments

  • Array [

    • name stringrequired

    The name of the environment

    Example: development
    type stringrequired
    Example: production
    enabled booleanrequired

    true if the environment is enabled for the project, otherwise false

    Example: true
    protected booleanrequired

    true if the environment is protected, otherwise false. A protected environment can not be deleted.

    Example: false
    sortOrder integerrequired

    Priority of the environment in a list of environments, the lower the value, the higher up in the list the environment will appear

    Example: 1
    projectApiTokenCount integer

    The number of client and front-end API tokens that have access to this project

    Example: 5
    projectEnabledToggleCount integer

    The number of features enabled in this environment for this project

    Example: 7

    defaultStrategy

    object

    The strategy configuration to add when enabling a feature environment by default

    name stringrequired

    The name of the strategy type

    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
    sortOrder number

    The order of the strategy in the list

    Example: 9999

    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
    segments number[]

    Ids of segments to use for this strategy

    Example: [1,2]

  • ]

Loading...