Search

Search and filter features

Changed on

Search and filter by selected fields.

get/api/admin/search/features

Request

  • Base URL
    https://app.unleash-instance.example.com
  • URL
    https://app.unleash-instance.example.com/api/admin/search/features
  • Auth
    • API key in header Authorization
    • or HTTP bearer

Query parameters

querystring
Example:feature_a

The search query for the feature name or tag

projectstring
Example:IS:default

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.

statestring
Example:IS:active

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.

lifecyclestring
Example:IS:initial

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.

typestring
Example:IS:release

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.

createdBystring
Example:IS:1

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.

tagstring
Example:INCLUDE:simple:my_tag

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

segmentstring
Example:INCLUDE:pro-users

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.

statusstring[]

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

[
  "production:enabled"
]
offsetstring
Example:50

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

limitstring
Example:50

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

sortBystring
Example:type

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

sortOrder'asc' | 'desc'
Example:desc

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

favoritesFirststring
Example:true

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

archivedstring
Example:IS:true

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.

favoritestring
Example:IS:true

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

createdAtstring
Example:IS_ON_OR_AFTER:2023-01-28

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

lastSeenAtstring
Example:IS_ON_OR_AFTER:2023-01-28

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

totalnumber

Total count of the features matching search and filter criteria

Changes

  • b2c3116e633eRevision changes
    • warning

      added the new SEMVER_GTE enum value to the //////////// response property for the response status

    • warning

      added the new SEMVER_GTE enum value to the //////// response property for the response status

    • warning

      added the new SEMVER_LTE enum value to the //////////// response property for the response status

    • warning

      added the new SEMVER_LTE enum value to the //////// response property for the response status

  • 774670258f04Revision changes
    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      added the new REGEX enum value to the //////////// response property for the response status

    • warning

      added the new REGEX enum value to the //////// response property for the response status

    • info

      added the new optional query request parameter favorite

    • info

      query request parameter archived was deprecated (stability: stable)

    • info

      added the optional property ////////// to the response with the status

    • info

      added the optional property ///////// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      response property features/items/environments/items/releasePlans/items/milestones/items/strategies/items/strategyName deprecated (stability: stable)

    • info

      added the required property ////////// to the response with the status