Skip to content

Commit b2f8b37

Browse files
authored
(Doc+) System Index definition
👋 howdy team! While waiting for #50251 (comment), may we at least include the per-current-version method of telling which indices are system indices? Also cross-warns from [here](https://www.elastic.co/guide/en/elasticsearch/reference/current/snapshot-restore.html#feature-state) that snapshot restoring system indices needs to happen per feature state or it won't work.
1 parent 2620cd6 commit b2f8b37

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

docs/reference/api-conventions.asciidoc

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -254,6 +254,16 @@ as they contain data essential to the operation of the system.
254254
IMPORTANT: Direct access to system indices is deprecated and
255255
will no longer be allowed in a future major version.
256256

257+
To view system indices within cluster:
258+
259+
[source,console]
260+
--------------------------------------------------
261+
GET _cluster/state/metadata?filter_path=metadata.indices.*.system
262+
--------------------------------------------------
263+
264+
WARNING: When overwriting current cluster state, system indices should be restored
265+
as part of their {ref}/snapshot-restore.html#feature-state[feature state].
266+
257267
[discrete]
258268
[[api-conventions-parameters]]
259269
=== Parameters

0 commit comments

Comments
 (0)