-
Notifications
You must be signed in to change notification settings - Fork 25.2k
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
williamrandolph
merged 6 commits into
elastic:master
from
williamrandolph:feature-reset-api-docs
Apr 21, 2021
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
66ce12e
Add docs for feature reset API
williamrandolph 4532a90
Fix name of reset api doc
williamrandolph 3aef1c2
Use warning blocks in docs
williamrandolph 325a985
Apply suggestions from code review
williamrandolph d9818e1
Reduce size of example results
williamrandolph 97b9649
Merge branch 'master' into feature-reset-api-docs
williamrandolph File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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 hidden or 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/] |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.