Search and filter features

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

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

segment string

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

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

200

searchFeaturesSchema

application/json

Schema

Schema

features object[]required
The full list of features in this project matching search and filter criteria.
Array [
namestringrequired
Unique feature name
Example: disable-comments
typestringrequired
Type of the flag e.g. experiment, kill-switch, release, operational, permission
Example: kill-switch
descriptionstringnullablerequired
Detailed description of the feature
Example: Controls disabling of the comments section in case of an incident
dependencyTypestringnullablerequired
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
projectstringrequired
Name of the project the feature belongs to
Example: dx-squad
stalebooleanrequired
true if the feature is stale based on the age and feature type, otherwise false.
Example: false
favoritebooleanrequired
true if the feature was favorited, otherwise false.
Example: true
impressionDatabooleanrequired
true if the impression data collection is enabled for the feature, otherwise false.
Example: false
createdAtdate-timenullablerequired
The date the feature was created
Example: 2023-01-28T15:21:39.975Z
archivedAtdate-timenullablerequired
The date the feature was archived
Example: 2023-01-29T15:21:39.975Z
lastSeenAtdate-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 [
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
typestringrequired
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.
yesinteger
How many times the toggle evaluated to true in last hour bucket
Example: 974
nointeger
How many times the toggle evaluated to false in last hour bucket
Example: 50
]
segmentsstring[]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 [
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"]
]
]
strategiesobject[]deprecated
This is a legacy field that was deprecated in v5
tags object[]nullable
The list of feature tags
Array [
valuestringrequired
The value of the tag.
Possible values: >= 2 characters and <= 50 characters
Example: a-tag-value
typestringrequired
The type of the tag
Possible values: >= 2 characters and <= 50 characters
Example: simple
]
lifecycle object
Current lifecycle stage of the feature
stagestringrequired
The name of the current lifecycle stage
Possible values: [initial, pre-live, live, completed, archived]
Example: initial
statusstringnullable
The name of the detailed status of a given stage. E.g. completed stage can be kept or discarded.
Example: kept
enteredStageAtdate-timerequired
When the feature entered this stage
Example: 2023-01-28T15:21:39.975Z
createdBy objectrequired
User who created the feature flag
idintegerrequired
The user id
Example: 123
namestringrequired
Name of the user
Example: User
imageUrlstringrequired
URL used for the user profile image
Example: https://example.com/242x200.png
]
totalnumber
Total count of the features matching search and filter criteria
Example: 10

Example (auto)

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

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/search/features' \
-H 'Accept: application/json' \
-H 'Authorization: <Authorization>'

Request Collapse all

Base URL

<your-unleash-url>

Auth

Security Scheme

apiKeybearerToken

apiKey

Parameters

query — query

project — query

state — query

type — query

createdBy — query

tag — query

segment — query

status — query

offset — query

limit — query

sortBy — query

sortOrder — query

---ascdesc

favoritesFirst — query

archived — query

createdAt — query

ResponseClear

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