Search and filter features

GET /api/admin/search/features

Search and filter by selected fields.

Request

Query Parameters

query string

The search query for the feature name or tag

project string

Possible values: Value must match regular expression ^(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.

state string

Possible values: Value must match regular expression ^(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.

type string

Possible values: Value must match regular expression ^(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.

createdBy string

Possible values: Value must match regular expression ^(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.

tag string

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

segment string

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.

status string[]

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

offset string

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

limit string

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

sortBy string

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

sortOrder string

Possible values: [asc, desc]

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

favoritesFirst string

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

archived string

Whether to get results for archived feature flags or active feature flags. If true, Unleash will return only archived flags. If false, it will return only active flags.

createdAt string

Possible values: Value must match regular expression ^(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.

Responses

searchFeaturesSchema

application/json

Schema
Example (from schema)

Schema

features

object[]

required

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

Array [

name stringrequired

Unique feature name

Example: disable-comments

type stringrequired

Type of the flag e.g. experiment, kill-switch, release, operational, permission

Example: kill-switch

description stringnullablerequired

Detailed description of the feature

Example: Controls disabling of the comments section in case of an incident

dependencyType stringnullablerequired

The type of dependency. 'parent' means that the feature is a parent feature, 'child' means that the feature is a child feature.

Possible values: [parent, child, null]

Example: parent

project stringrequired

Name of the project the feature belongs to

Example: dx-squad

stale booleanrequired

true if the feature is stale based on the age and feature type, otherwise false.

Example: false

favorite booleanrequired

true if the feature was favorited, otherwise false.

Example: true

impressionData booleanrequired

true if the impression data collection is enabled for the feature, otherwise false.

Example: false

createdAt date-timenullablerequired

The date the feature was created

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

archivedAt date-timenullablerequired

The date the feature was archived

Example: 2023-01-29T15:21:39.975Z

lastSeenAt date-timenullabledeprecated

The date when metrics where last collected for the feature. This field was deprecated in v5 and will be removed in a future release, use the one in featureEnvironmentSchema

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

environments

object[]

required

The list of environments where the feature can be used

Array [

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 stringrequired

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.

yes integer

How many times the toggle evaluated to true in last hour bucket

Example: 974

no integer

How many times the toggle evaluated to false in last hour bucket

Example: 50

]

segments string[]required

The list of segments the feature is enabled for.

Example: ["pro-users","main-segment"]

variants

object[]

deprecated

The list of feature variants. This field was deprecated in v5

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

]

strategies object[]deprecated

This is a legacy field that was deprecated in v5

tags

object[]

nullable

The list of feature tags

Array [

value stringrequired

The value of the tag.

Possible values: >= 2 characters and <= 50 characters

Example: a-tag-value

type stringrequired

The type of the tag

Possible values: >= 2 characters and <= 50 characters

Example: simple

]

lifecycle

object

Current lifecycle stage of the feature

stage stringrequired

The name of the current lifecycle stage

Possible values: [initial, pre-live, live, completed, archived]

Example: initial

status stringnullable

The name of the detailed status of a given stage. E.g. completed stage can be kept or discarded.

Example: kept

enteredStageAt date-timerequired

When the feature entered this stage

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

createdBy

object

required

User who created the feature flag

id integerrequired

The user id

Example: 123

name stringrequired

Name of the user

Example: User

imageUrl stringrequired

URL used for the user profile image

Example: https://example.com/242x200.png

]

total number

Total count of the features matching search and filter criteria

Example: 10

{
  "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",
          "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,
          "yes": 974,
          "no": 50
        }
      ],
      "segments": [
        "pro-users",
        "main-segment"
      ],
      "tags": [
        {
          "value": "a-tag-value",
          "type": "simple"
        }
      ],
      "lifecycle": {
        "stage": "initial",
        "status": "kept",
        "enteredStageAt": "2023-01-28T15:21:39.975Z"
      },
      "createdBy": {
        "id": 123,
        "name": "User",
        "imageUrl": "https://example.com/242x200.png"
      }
    }
  ],
  "total": 10
}

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

application/json

Schema
Example (from schema)

Schema

id string

The ID of the error instance

Example: 9c40958a-daac-400e-98fb-3bb438567008

name string

The name of the error kind

Example: AuthenticationRequired

message string

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.

{
  "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."
}

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

application/json

Schema
Example (from schema)

Schema

id string

The ID of the error instance

Example: 9c40958a-daac-400e-98fb-3bb438567008

name string

The name of the error kind

Example: NoAccessError

message string

A description of what went wrong.

Example: You need the "UPDATE_ADDON" permission to perform this action in the "development" environment.

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

The requested resource was not found.

application/json

Schema
Example (from schema)

Schema

id string

The ID of the error instance

Example: 9c40958a-daac-400e-98fb-3bb438567008

name string

The name of the error kind

Example: NotFoundError

message string

A description of what went wrong.

Example: Could not find the addon with ID "12345".

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

Search and filter features

/api/admin/search/features

Request​

Query Parameters

Responses​

Request

Responses