Get the features

GET /_features

Get a list of features that can be included in snapshots using the feature_states field when creating a snapshot. You can use this 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 state to be listed in this API and recognized as a valid feature state by the create snapshot API, the plugin that defines that feature must be installed on the master node.

More about managing snapshots

Query Parameters

master_timeout string Duration · default: 30s: Period to wait for a connection to the master node.

Response

application/json

Examples

A successful response for retrieving a list of feature states that can be included when taking a snapshot.

Request Console 1 / 8 languages

Console Kibana Dev Tools

GET _features

JavaScript Elasticsearch JavaScript Client

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

Python Elasticsearch Python Client

resp = client.features.get_features()

curl Shell

curl -X GET "$ELASTICSEARCH_URL/_features" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.features().getFeatures(g -> g);

C# Elasticsearch .NET Client

var response = await client.Features.GetFeaturesAsync();

PHP Elasticsearch PHP Client

$resp = $client->features()->getFeatures();

Ruby Elasticsearch Ruby Client

response = client.features.get_features

Response

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