Search features

GET

https://app.unleash-instance.example.com/api/admin/search/features

GET

/api/admin/search/features

curl https://app.unleash-instance.example.com/api/admin/search/features \
     -H "Authorization: <apiKey>"

{
  "features": [
    {
      "name": "disable-comments",
      "type": "kill-switch",
      "description": "Controls disabling of the comments section in case of an incident",
      "dependencyType": "parent",
      "project": "dx-squad",
      "stale": false,
      "favorite": true,
      "impressionData": false,
      "createdAt": "2023-01-28T15:21:39.975Z",
      "archivedAt": "2023-01-29T15:21:39.975Z",
      "environments": [
        {
          "name": "my-dev-env",
          "type": "development",
          "enabled": true,
          "featureName": "disable-comments",
          "environment": "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": {},
                  "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"
                      ]
                    },
                    "source": "internal"
                  }
                }
              ]
            }
          ],
          "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"
                  ]
                },
                "source": "internal"
              }
            }
          ],
          "yes": 974,
          "no": 50
        }
      ],
      "segments": [
        "pro-users",
        "main-segment"
      ],
      "createdBy": {
        "id": 123,
        "name": "User",
        "imageUrl": "https://example.com/242x200.png"
      },
      "tags": [
        {
          "value": "a-tag-value",
          "type": "simple",
          "color": "#FFFFFF"
        }
      ],
      "lifecycle": {
        "stage": "initial",
        "enteredStageAt": "2023-01-28T15:21:39.975Z",
        "status": "kept"
      }
    }
  ],
  "total": 10
}

Search and filter by selected fields.

Authentication

Authorizationstring

API key needed to access this API

AuthorizationBearer

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

Query parameters

querystringOptional

The search query for the feature name or tag

projectstringOptionalformat: "^(IS|IS_NOT|IS_ANY_OF|IS_NONE_OF):(.*?)(,([a-zA-Z0-9_]+))*$"

Id of the project where search and filter is performed. The project id can be specified with an operator. The supported operators are IS, IS_NOT, IS_ANY_OF, IS_NONE_OF.

statestringOptionalformat: "^(IS|IS_NOT|IS_ANY_OF|IS_NONE_OF):(.*?)(,([a-zA-Z0-9_]+))*$"

The state of the feature active/stale. The state can be specified with an operator. The supported operators are IS, IS_NOT, IS_ANY_OF, IS_NONE_OF.

lifecyclestringOptionalformat: "^(IS|IS_NOT|IS_ANY_OF|IS_NONE_OF):(.*?)(,([a-zA-Z0-9_]+))*$"

The lifecycle stage of the feature. The stage can be specified with an operator. The supported operators are IS, IS_NOT, IS_ANY_OF, IS_NONE_OF.

typestringOptionalformat: "^(IS|IS_NOT|IS_ANY_OF|IS_NONE_OF):(.*?)(,([a-zA-Z0-9_]+))*$"

The feature flag type to filter by. The type can be specified with an operator. The supported operators are IS, IS_NOT, IS_ANY_OF, IS_NONE_OF.

createdBystringOptionalformat: "^(IS|IS_NOT|IS_ANY_OF|IS_NONE_OF):(.*?)(,([a-zA-Z0-9_]+))*$"

The feature flag creator to filter by. The creators can be specified with an operator. The supported operators are IS, IS_NOT, IS_ANY_OF, IS_NONE_OF.

tagstringOptional

format: "^(INCLUDE|DO_NOT_INCLUDE|INCLUDE_ALL_OF|INCLUDE_ANY_OF|EXCLUDE_IF_ANY_OF|EXCLUDE_ALL):([^:,]+:.+?)(,\s*[^:,]+:.+?)*$"

The list of feature tags to filter by. Feature tag has to specify a type and a value joined with a colon.

segmentstringOptional

format: "^(INCLUDE|DO_NOT_INCLUDE|INCLUDE_ALL_OF|INCLUDE_ANY_OF|EXCLUDE_IF_ANY_OF|EXCLUDE_ALL):(.*?)(,([a-zA-Z0-9_]+))*$"

The list of segments with operators to filter by. The segment valid operators are INCLUDE, DO_NOT_INCLUDE, INCLUDE_ALL_OF, INCLUDE_ANY_OF, EXCLUDE_IF_ANY_OF, EXCLUDE_ALL.

statuslist of stringsOptional

The list of feature environment status to filter by. Feature environment has to specify a name and a status joined with a colon.

offsetstringOptional

The number of features to skip when returning a page. By default it is set to 0.

limitstringOptional

The number of feature environments to return in a page. By default it is set to 50.

sortBystringOptional

The field to sort the results by. By default it is set to "createdAt".

sortOrderenumOptional

The sort order for the sortBy. By default it is det to "asc".

Allowed values:

favoritesFirststringOptional

The flag to indicate if the favorite features should be returned first. By default it is set to false.

archivedstringOptionalformat: "^IS:(true|false)$"Deprecated

Deprecated: use the lifecycle parameter instead (lifecycle=IS:archived is equivalent to archived=IS:true). Whether to get results for archived feature flags or active feature flags. If IS:true, Unleash will return only archived flags, taking precedence over any lifecycle filter. If IS:false, it will return only active flags.

favoritestringOptionalformat: "^(IS|IS_ANY_OF):(true|false)(,(true|false))*$"

Filter by whether the feature is favorited by the current user. Use IS:true to show only favorites.

createdAtstringOptionalformat: "^(IS_BEFORE|IS_ON_OR_AFTER):\d{4}-\d{2}-\d{2}$"

The date the feature was created. The date can be specified with an operator. The supported operators are IS_BEFORE, IS_ON_OR_AFTER.

lastSeenAtstringOptionalformat: "^(IS_BEFORE|IS_ON_OR_AFTER):\d{4}-\d{2}-\d{2}$"

The date the feature was last seen from metrics. The date can be specified with an operator. The supported operators are IS_BEFORE, IS_ON_OR_AFTER.

Response

searchFeaturesSchema

featureslist of objects

The full list of features in this project matching search and filter criteria.

totaldoubleOptional

Total count of the features matching search and filter criteria

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error