Skip to content

Commit

Permalink
Add docs for feature reset API (#71759)
Browse files Browse the repository at this point in the history
* Add docs for feature reset API
* Prose and style much improved by Deb Adair.

Co-authored-by: debadair <[email protected]>
  • Loading branch information
williamrandolph and debadair authored Apr 21, 2021
1 parent 1e49d36 commit d1bcd2a
Show file tree
Hide file tree
Showing 2 changed files with 54 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/reference/features/apis/features-apis.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,7 @@ by Elasticsearch and Elasticsearch plugins.
[discrete]
=== Features APIs
* <<get-features-api,Get Features API>>
* <<reset-features-api,Rest Features API>>

include::get-features-api.asciidoc[]
include::reset-features-api.asciidoc[]
52 changes: 52 additions & 0 deletions docs/reference/features/apis/reset-features-api.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
[[reset-features-api]]
=== Reset features API
++++
<titleabbrev>Reset features</titleabbrev>
++++

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 <<get-features-api,get features API>>.

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/]

0 comments on commit d1bcd2a

Please sign in to comment.