diff --git a/docs/reference/features/apis/features-apis.asciidoc b/docs/reference/features/apis/features-apis.asciidoc index a833a091f6579..fe06471cff0df 100644 --- a/docs/reference/features/apis/features-apis.asciidoc +++ b/docs/reference/features/apis/features-apis.asciidoc @@ -7,5 +7,7 @@ by Elasticsearch and Elasticsearch plugins. [discrete] === Features APIs * <> +* <> include::get-features-api.asciidoc[] +include::reset-features-api.asciidoc[] diff --git a/docs/reference/features/apis/reset-features-api.asciidoc b/docs/reference/features/apis/reset-features-api.asciidoc new file mode 100644 index 0000000000000..2d17825a39d96 --- /dev/null +++ b/docs/reference/features/apis/reset-features-api.asciidoc @@ -0,0 +1,52 @@ +[[reset-features-api]] +=== Reset features API +++++ +Reset features +++++ + +experimental::[] + +Clears all of the the state information stored in system indices by {es} features, including the security and machine learning indices. + +WARNING: Intended for development and testing use only. Do not reset features on a production cluster. + +[source,console] +----------------------------------- +POST /_features/_reset +----------------------------------- + +[[reset-features-api-request]] +==== {api-request-title} + +`POST /_features/_reset` + + +[[reset-features-api-desc]] +==== {api-description-title} + +Return a cluster to the same state as a new installation by resetting the feature state for all {es} features. This deletes all state information stored in system indices. + +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 <>. + +IMPORTANT: 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. + +==== {api-examples-title} +Example response: +[source,console-result] +---- +{ + "features" : [ + { + "feature_name" : "security", + "status" : "SUCCESS" + }, + { + "feature_name" : "tasks", + "status" : "SUCCESS" + } + ] +} +---- +// TESTRESPONSE[s/"features" : \[[^\]]*\]/"features": $body.$_path/]