Skip to content

Add docs for feature reset API #71759

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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/]