› › ›

Get Features API

Gets a list of features which can be included in snapshots using the feature_states field when creating a snapshot.

resp = client.features.get_features()
print(resp)

response = client.features.get_features
puts response

const response = await client.features.getFeatures();
console.log(response);

GET /_features

Request

GET /_features

Description

You can use the get features API to determine which feature states to include when taking a snapshot. By default, all feature states are included in a snapshot if that snapshot includes the global state, or none if it does not.

A feature state includes one or more system indices necessary for a given feature to function. In order to ensure data integrity, all system indices that comprise a feature state are snapshotted and restored together.

The features listed by this API are a combination of built-in features and features defined by plugins. In order for a feature’s state to be listed in this API and recognized as a valid feature state by the create snapshot API, the plugin which defines that feature must be installed on the master node.

Examples

{
    "features": [
        {
            "name": "tasks",
            "description": "Manages task results"
        },
        {
            "name": "kibana",
            "description": "Manages Kibana configuration and reports"
        }
    ]
}

© 2023-2025 Elasticsearch
As of September 2024, Elasticsearch is available under a choice of three licenses: the Server Side Public License (SSPL), the Elastic License, or the AGPLv3 (OSI approved).
Elasticsearch and the Elasticsearch logo are trademarks of Elasticsearch B.V., registered in the U.S. and in other countries.
https://www.elastic.co/guide/en/elasticsearch/reference/8.17/get-features-api.html