Skip to content

(Doc+) System Index definition #120327

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.

Sign up for GitHub

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 1 commit into from
Jan 29, 2025
Merged

(Doc+) System Index definition #120327

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 10 additions & 0 deletions docs/reference/api-conventions.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -254,6 +254,16 @@ as they contain data essential to the operation of the system.
IMPORTANT: Direct access to system indices is deprecated and
will no longer be allowed in a future major version.

To view system indices within cluster:

[source,console]
--------------------------------------------------
GET _cluster/state/metadata?filter_path=metadata.indices.*.system
--------------------------------------------------

WARNING: When overwriting current cluster state, system indices should be restored
as part of their {ref}/snapshot-restore.html#feature-state[feature state].

[discrete]
[[api-conventions-parameters]]
=== Parameters
Expand Down
Loading