-
Notifications
You must be signed in to change notification settings - Fork 24.9k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add docs for feature reset API (#71759)
* Add docs for feature reset API * Prose and style much improved by Deb Adair. Co-authored-by: debadair <[email protected]>
- Loading branch information
1 parent
1e49d36
commit d1bcd2a
Showing
2 changed files
with
54 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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/] |