Skip to content

Commit d1bcd2a

Browse files
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]>
1 parent 1e49d36 commit d1bcd2a

File tree

2 files changed

+54
-0
lines changed

2 files changed

+54
-0
lines changed

docs/reference/features/apis/features-apis.asciidoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,5 +7,7 @@ by Elasticsearch and Elasticsearch plugins.
77
[discrete]
88
=== Features APIs
99
* <<get-features-api,Get Features API>>
10+
* <<reset-features-api,Rest Features API>>
1011

1112
include::get-features-api.asciidoc[]
13+
include::reset-features-api.asciidoc[]
Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
[[reset-features-api]]
2+
=== Reset features API
3+
++++
4+
<titleabbrev>Reset features</titleabbrev>
5+
++++
6+
7+
experimental::[]
8+
9+
Clears all of the the state information stored in system indices by {es} features, including the security and machine learning indices.
10+
11+
WARNING: Intended for development and testing use only. Do not reset features on a production cluster.
12+
13+
[source,console]
14+
-----------------------------------
15+
POST /_features/_reset
16+
-----------------------------------
17+
18+
[[reset-features-api-request]]
19+
==== {api-request-title}
20+
21+
`POST /_features/_reset`
22+
23+
24+
[[reset-features-api-desc]]
25+
==== {api-description-title}
26+
27+
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.
28+
29+
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.
30+
31+
To list the features that will be affected, use the <<get-features-api,get features API>>.
32+
33+
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.
34+
35+
==== {api-examples-title}
36+
Example response:
37+
[source,console-result]
38+
----
39+
{
40+
"features" : [
41+
{
42+
"feature_name" : "security",
43+
"status" : "SUCCESS"
44+
},
45+
{
46+
"feature_name" : "tasks",
47+
"status" : "SUCCESS"
48+
}
49+
]
50+
}
51+
----
52+
// TESTRESPONSE[s/"features" : \[[^\]]*\]/"features": $body.$_path/]

0 commit comments

Comments
 (0)