› › ›

Reset features API

This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.

Clears all of the state information stored in system indices by Elasticsearch features, including the security and machine learning indices.

Intended for development and testing use only. Do not reset features on a production cluster.

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

response = client.features.reset_features
puts response

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

POST /_features/_reset

Request

edit

POST /_features/_reset

Description

edit

Return a cluster to the same state as a new installation by resetting the feature state for all Elasticsearch features. This deletes all state information stored in system indices.

The response code is HTTP 200 if state is successfully reset for all features, HTTP 207 if there is a mixture of successes and failures, and HTTP 500 if the reset operation fails for all features.

Note that select features might provide a way to reset particular system indices. Using this API resets all features, both those that are built-in and implemented as plugins.

To list the features that will be affected, use the get features API.

The features installed on the node you submit this request to are the features that will be reset. Run on the master node if you have any doubts about which plugins are installed on individual nodes.

Query parameters

edit

master_timeout: (Optional, time units) Period to wait for the master node. If the master node is not available before the timeout expires, the request fails and returns an error. Defaults to 30s. Can also be set to -1 to indicate that the request should never timeout.

Examples

edit

Example response:

{
  "features" : [
    {
      "feature_name" : "security",
      "status" : "SUCCESS"
    },
    {
      "feature_name" : "tasks",
      "status" : "SUCCESS"
    }
  ]
}

« Get Features API Fleet APIs »