Get a feature environment

GET 
<your-unleash-url>/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

200

featureEnvironmentSchema

application/json

Schema

Schema

namestringrequired

The name of the environment

Example: my-dev-env

featureNamestring

The name of the feature

Example: disable-comments

environmentstring

The name of the environment

Example: development

typestring

The type of the environment

Example: development

enabledbooleanrequired

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

Example: true

sortOrdernumber

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

Example: 3

variantCountnumber

The number of defined variants

strategies object[]

A list of activation strategies for the feature environment

Array [

idstring

A uuid for the feature strategy

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

namestringrequired

The name or type of strategy

Example: flexibleRollout

titlestringnullable

A descriptive title for the strategy

Example: Gradual Rollout 25-Prod

disabledbooleannullable

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

Example: false

featureNamestring

The name or feature the strategy is attached to

Example: myAwesomeFeature

sortOrdernumber

The order of the strategy in the list

Example: 9999

segmentsnumber[]

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/activation-strategies#constraints

Array [

contextNamestringrequired

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

Example: appName

operatorstringrequired

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

caseInsensitiveboolean

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

Default value: false

invertedboolean

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

valuesstring[]

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"]

valuestring

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 [

namestringrequired

The variant name. Must be unique for this feature flag

Example: blue_group

weightintegerrequired

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

weightTypestringrequired

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

stickinessstringrequired

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

typestringrequired

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

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

valuestringrequired

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 [

namestringrequired

The variants name. Is unique for this feature flag

Example: blue_group

weightnumberrequired

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

weightTypestring

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

stickinessstring

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

typestringrequired

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

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

valuestringrequired

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 [

contextNamestringrequired

The name of the context field used to determine overrides

Example: userId

valuesstring[]required

Which values that should be overriden

Example: ["red","blue"]

]

]

lastSeenAtdate-timenullable

The date when metrics where last collected for the feature environment

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

hasStrategiesboolean

Whether the feature has any strategies defined.

hasEnabledStrategiesboolean

Whether the feature has any enabled strategies defined.

Example (auto)

{
  "name": "my-dev-env",
  "featureName": "disable-comments",
  "environment": "development",
  "type": "development",
  "enabled": true,
  "sortOrder": 3,
  "variantCount": 0,
  "strategies": [
    {
      "id": "6b5157cb-343a-41e7-bfa3-7b4ec3044840",
      "name": "flexibleRollout",
      "title": "Gradual Rollout 25-Prod",
      "disabled": false,
      "featureName": "myAwesomeFeature",
      "sortOrder": 9999,
      "segments": [
        1,
        2
      ],
      "constraints": [
        {
          "contextName": "appName",
          "operator": "IN",
          "caseInsensitive": false,
          "inverted": false,
          "values": [
            "my-app",
            "my-other-app"
          ],
          "value": "my-app"
        }
      ],
      "variants": [
        {
          "name": "blue_group",
          "weight": 0,
          "weightType": "fix",
          "stickiness": "custom.context.field",
          "payload": {
            "type": "json",
            "value": "{\"color\": \"red\"}"
          }
        }
      ],
      "parameters": {}
    }
  ],
  "variants": [
    {
      "name": "blue_group",
      "weight": 0,
      "weightType": "variable",
      "stickiness": "custom.context.field",
      "payload": {
        "type": "json",
        "value": "{\"color\": \"red\"}"
      },
      "overrides": [
        {
          "contextName": "userId",
          "values": [
            "red",
            "blue"
          ]
        }
      ]
    }
  ],
  "lastSeenAt": "2023-01-28T16:21:39.975Z",
  "hasStrategies": true,
  "hasEnabledStrategies": true
}

401

Authorization information is missing or invalid. Provide a valid API token as the authorization header, e.g. authorization:*.*.my-admin-token.

application/json

Schema

Schema

idstring
The ID of the error instance
Example: 9c40958a-daac-400e-98fb-3bb438567008
namestring
The name of the error kind
Example: AuthenticationRequired
messagestring
A description of what went wrong.
Example: You must log in to use Unleash. Your request had no authorization header, so we could not authorize you. Try logging in at /auth/simple/login.

Example (auto)

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "AuthenticationRequired",
  "message": "You must log in to use Unleash. Your request had no authorization header, so we could not authorize you. Try logging in at /auth/simple/login."
}

403

The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation

application/json

Schema

Schema

idstring
The ID of the error instance
Example: 9c40958a-daac-400e-98fb-3bb438567008
namestring
The name of the error kind
Example: NoAccessError
messagestring
A description of what went wrong.
Example: You need the "UPDATE_ADDON" permission to perform this action in the "development" environment.

Example (auto)

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "NoAccessError",
  "message": "You need the \"UPDATE_ADDON\" permission to perform this action in the \"development\" environment."
}

404

The requested resource was not found.

application/json

Schema

Schema

idstring
The ID of the error instance
Example: 9c40958a-daac-400e-98fb-3bb438567008
namestring
The name of the error kind
Example: NotFoundError
messagestring
A description of what went wrong.
Example: Could not find the addon with ID "12345".

Example (auto)

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "NotFoundError",
  "message": "Could not find the addon with ID \"12345\"."
}

Authorization: Authorization

name: Authorizationtype: apiKeyin: headerdescription: API key needed to access this API

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L '<your-unleash-url>/api/admin/projects/:projectId/features/:featureName/environments/:environment' \
-H 'Accept: application/json' \
-H 'Authorization: <Authorization>'

Request Collapse all

Base URL

<your-unleash-url>

Auth

Security Scheme

apiKeybearerToken

apiKey

Parameters

projectId — pathrequired

featureName — pathrequired

environment — pathrequired

ResponseClear

Click the Send API Request button above and see the response here!