Get a feature environment | Unleash Documentation

curl https://app.unleash-instance.example.com/api/admin/projects/projectId/features/featureName/environments/environment \
     -H "Authorization: <apiKey>"

{
  "name": "my-dev-env",
  "enabled": true,
  "featureName": "disable-comments",
  "environment": "development",
  "type": "development",
  "sortOrder": 3,
  "variantCount": 1.1,
  "strategies": [
    {
      "name": "flexibleRollout",
      "id": "6b5157cb-343a-41e7-bfa3-7b4ec3044840",
      "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": 1,
          "weightType": "fix",
          "stickiness": "custom.context.field",
          "payload": {
            "type": "json",
            "value": "{\"color\": \"red\"}"
          }
        }
      ],
      "parameters": {}
    }
  ],
  "variants": [
    {
      "name": "blue_group",
      "weight": 1.1,
      "weightType": "variable",
      "stickiness": "custom.context.field",
      "payload": {
        "type": "json",
        "value": "{\"color\": \"red\"}"
      },
      "overrides": [
        {
          "contextName": "userId",
          "values": [
            "red",
            "blue"
          ]
        }
      ]
    }
  ],
  "changeRequestIds": [
    1.1
  ],
  "milestoneName": "Phase One",
  "milestoneOrder": 0,
  "totalMilestones": 0,
  "lastSeenAt": "2023-01-28T16:21:39.975Z",
  "hasStrategies": true,
  "hasEnabledStrategies": true,
  "releasePlans": [
    {
      "id": "01JB9GGTGQYEQ9D40R17T3YVW2",
      "discriminator": "plan",
      "name": "My release plan",
      "featureName": "my-feature",
      "environment": "production",
      "createdByUserId": 53,
      "createdAt": "2022-01-01T00:00:00Z",
      "milestones": [
        {
          "id": "01JB9GGTGQYEQ9D40R17T3YVW1",
          "name": "My milestone",
          "sortOrder": 1,
          "releasePlanDefinitionId": "01JB9GGTGQYEQ9D40R17T3YVW2",
          "startedAt": "2024-01-01T00:00:00.000Z",
          "transitionCondition": {
            "intervalMinutes": 30
          },
          "progressionExecutedAt": "2024-01-01T00:00:00.000Z",
          "pausedAt": "2024-01-01T00:00:00.000Z",
          "strategies": [
            {
              "id": "01JB9GGTGQYEQ9D40R17T3YVW3",
              "milestoneId": "01JB9GGTGQYEQ9D40R17T3YVW1",
              "sortOrder": 9999,
              "name": "flexibleRollout",
              "strategyName": "flexibleRollout",
              "title": "Gradual Rollout 25-Prod",
              "parameters": {
                "groupId": "some_new",
                "rollout": "25",
                "stickiness": "sessionId"
              },
              "constraints": [
                {
                  "contextName": "appName",
                  "operator": "IN",
                  "caseInsensitive": false,
                  "inverted": false,
                  "values": [
                    "1",
                    "2"
                  ]
                }
              ],
              "variants": [
                {
                  "name": "blue_group",
                  "weight": 1,
                  "weightType": "fix",
                  "stickiness": "custom.context.field",
                  "payload": {
                    "type": "json",
                    "value": "{\"color\": \"red\"}"
                  }
                }
              ],
              "segments": [
                1,
                2
              ],
              "disabled": false
            }
          ]
        }
      ],
      "releasePlanTemplateId": "01JB9GGTGQYEQ9D40R17T3YVW2",
      "description": "This is my release plan",
      "activeMilestoneId": "01JB9GGTGQYEQ9D40R17T3YVW1",
      "safeguards": [
        {
          "id": "01JB9GGTGQYEQ9D40R17T3YVW1",
          "action": {
            "type": "pauseReleasePlanProgressions",
            "id": "01JB9GGTGQYEQ9D40R17T3YVW2"
          },
          "triggerCondition": {
            "operator": ">",
            "threshold": 100
          },
          "impactMetric": {
            "id": "01JB9GGTGQYEQ9D40R17T3YVW1",
            "metricName": "unleash_counter_feature_toggle_usage_total",
            "timeRange": "day",
            "aggregationMode": "rps",
            "labelSelectors": {
              "environment": [
                "development"
              ],
              "project": [
                "default"
              ]
            }
          }
        }
      ]
    }
  ],
  "safeguards": [
    {
      "id": "01JB9GGTGQYEQ9D40R17T3YVW1",
      "action": {
        "type": "disableFeatureEnvironment",
        "featureName": "string",
        "environment": "string",
        "project": "string"
      },
      "triggerCondition": {
        "operator": ">",
        "threshold": 100
      },
      "impactMetric": {
        "id": "01JB9GGTGQYEQ9D40R17T3YVW1",
        "metricName": "unleash_counter_feature_toggle_usage_total",
        "timeRange": "day",
        "aggregationMode": "rps",
        "labelSelectors": {
          "environment": [
            "development"
          ],
          "project": [
            "default"
          ]
        }
      }
    }
  ],
  "yes": 974,
  "no": 50
}

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

Authentication

Authorizationstring

API key needed to access this API

AuthorizationBearer

API key needed to access this API, in Bearer token format

Path parameters

projectIdstringRequired

featureNamestringRequired

environmentstringRequired

Response

featureEnvironmentSchema

namestring

The name of the environment

enabledboolean

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

featureNamestring

The name of the feature

environmentstring

The name of the environment

typestring

The type of the environment

sortOrderdouble

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

variantCountdouble

The number of defined variants

strategieslist of objects

A list of activation strategies for the feature environment

variantslist of objects

A list of variants for the feature environment

changeRequestIdslist of doubles

Experimental. A list of change request identifiers for actionable change requests that are not Cancelled, Rejected or Approved.

milestoneNamestring

Experimental: The name of the currently active release plan milestone

milestoneOrderdouble

Experimental: The zero-indexed order of currently active milestone in the list of all release plan milestones

totalMilestonesdouble

Experimental: The total number of milestones in the feature environment release plan

lastSeenAtstring or nullformat: "date-time"

The date when metrics where last collected for the feature environment

hasStrategiesboolean

Whether the feature has any strategies defined.

hasEnabledStrategiesboolean

Whether the feature has any enabled strategies defined.

releasePlanslist of objects

Release plans for this feature environment (only available when milestoneProgression feature flag is enabled)

safeguardslist of objects

Safeguards for this feature environment

yesinteger>=0

How many times the feature evaluated to true (enabled)

nointeger>=0

How many times the feature evaluated to false (disabled)

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error