elasticsearch/docs/reference
Jay Modi 173c3bdac4
Introduce hidden indices (#50452)
This change introduces a new feature for indices so that they can be
hidden from wildcard expansion. The feature is referred to as hidden
indices. An index can be marked hidden through the use of an index
setting, `index.hidden`, at creation time. One primary use case for
this feature is to have a construct that fits indices that are created
by the stack that contain data used for display to the user and/or
intended for querying by the user. The desire to keep them hidden is
to avoid confusing users when searching all of the data they have
indexed and getting results returned from indices created by the
system.

Hidden indices have the following properties:
* API calls for all indices (empty indices array, _all, or *) will not
  return hidden indices by default.
* Wildcard expansion will not return hidden indices by default unless
  the wildcard pattern begins with a `.`. This behavior is similar to
  shell expansion of wildcards.
* REST API calls can enable the expansion of wildcards to hidden
  indices with the `expand_wildcards` parameter. To expand wildcards
  to hidden indices, use the value `hidden` in conjunction with `open`
  and/or `closed`.
* Creation of a hidden index will ignore global index templates. A
  global index template is one with a match-all pattern.
* Index templates can make an index hidden, with the exception of a
  global index template.
* Accessing a hidden index directly requires no additional parameters.

Relates #50251
2020-01-17 09:16:31 -07:00
..
aggregations Adds support for geo-bounds filtering in geogrid aggregations (#50002) 2020-01-14 08:29:10 -08:00
analysis [DOCS] Add tutorials section to analysis topic (#50809) 2020-01-16 13:11:42 -05:00
cat [Docs] Fix short alias for 'unassigned.for' (#51059) 2020-01-16 12:09:54 +01:00
ccr Remove outdated requirement of CCR (#50859) 2020-01-13 19:59:50 -05:00
cluster [DOCS] Collapse node stats response sections (#51063) 2020-01-16 13:18:36 -05:00
commands [DOCS] Fixes typo in keystore command 2020-01-14 11:56:08 -08:00
docs [DOCS] Fixes "enables you to" typos (#50225) 2019-12-23 14:38:37 -05:00
graph [DOCS] [2 of 5] Change // CONSOLE comments to [source,console] (#46353) 2019-09-09 13:13:41 -04:00
high-availability [DOCS] Move snapshot-restore out of modules. (#49618) 2020-01-09 16:12:02 -08:00
how-to [DOCS] Remove unneeded redirects (#50476) 2019-12-26 07:49:41 -05:00
ilm Add blurb about ILM-injected unfollow action (#51009) 2020-01-15 09:46:34 -07:00
images [DOCS] Replace cross-cluster search PNG images with SVGs (#49395) 2019-11-21 09:05:33 -05:00
index-modules [DOCS] Fix indent issue in similarity snippet (#51107) 2020-01-16 10:59:18 -05:00
indices Goodbye and thank you synced flush! (#50882) 2020-01-16 09:43:07 -05:00
ingest Add pipeline name to ingest metadata (#50467) 2020-01-15 16:17:05 +01:00
licensing Add max_resource_units to enterprise license (#50735) 2020-01-13 18:13:20 +11:00
mapping [DOCS] Correct typo in ignore_malformed mapping parm docs (#50780) 2020-01-13 09:49:10 -05:00
migration Goodbye and thank you synced flush! (#50882) 2020-01-16 09:43:07 -05:00
ml [ML] DF Analytics _explain API should skip object fields (#51115) 2020-01-17 12:24:17 +02:00
modules Goodbye and thank you synced flush! (#50882) 2020-01-16 09:43:07 -05:00
monitoring Deprecating kibana_user and kibana_dashboard_only_user roles (#46456) 2020-01-14 18:08:44 +11:00
query-dsl Adds support for geo-bounds filtering in geogrid aggregations (#50002) 2020-01-14 08:29:10 -08:00
release-notes [DOCS] Remove abbrevtitles for Asciidoctor migration (#41366) 2019-04-22 05:26:36 -07:00
rest-api Introduce hidden indices (#50452) 2020-01-17 09:16:31 -07:00
rollup [DOCS] Merge rollup config details into API (#49412) 2019-11-22 08:31:30 -08:00
scripting Document use of context in put stored script (#50446) 2019-12-20 10:52:44 -08:00
search [DOCS] Fix search request body links (#50500) 2019-12-26 14:20:51 -05:00
settings Add ILM histore store index (#50287) 2019-12-18 16:09:59 -07:00
setup Goodbye and thank you synced flush! (#50882) 2020-01-16 09:43:07 -05:00
snapshot-restore [DOCS] Move snapshot-restore out of modules. (#49618) 2020-01-09 16:12:02 -08:00
sql [DOCS] Update SQL REST API pages for new structure (#50690) 2020-01-07 09:17:54 -06:00
testing Uppercasing some docs section title (#37781) 2019-01-24 22:54:55 +01:00
transform [Transform] fail to start/put on missing pipeline (#50701) 2020-01-09 09:31:44 -05:00
upgrade Goodbye and thank you synced flush! (#50882) 2020-01-16 09:43:07 -05:00
vectors Remove the 'experimental' marking from vector fields. (#49120) 2019-11-18 11:57:18 -08:00
aggregations.asciidoc [Docs] Update aggregations.asciidoc (#29265) 2018-03-28 15:01:45 +02:00
analysis.asciidoc [DOCS] Add tutorials section to analysis topic (#50809) 2020-01-16 13:11:42 -05:00
api-conventions.asciidoc Remove type field from DocWriteRequest and associated Response objects (#47671) 2019-10-11 10:23:55 +01:00
cat.asciidoc [DOCS] Use s parameter in cat API overview example (#50616) 2020-01-14 08:21:32 -05:00
cluster.asciidoc [DOCS] Adds machine learning node type and filters (#49121) 2019-11-15 11:27:36 -05:00
data-rollup-transform.asciidoc [DOCS] Adds transforms to Elasticsearch book (#46846) 2019-09-24 15:56:18 -07:00
docs.asciidoc [DOCS] Remove heading offsets for REST APIs (#44568) 2019-07-19 14:35:36 -04:00
frozen-indices.asciidoc [DOCS] [2 of 5] Change // CONSOLE comments to [source,console] (#46353) 2019-09-09 13:13:41 -04:00
getting-started.asciidoc [Docs] Fix typo in getting-started.asciidoc (#49985) 2019-12-09 16:25:21 +01:00
glossary.asciidoc [DOCS] Move snapshot-restore out of modules. (#49618) 2020-01-09 16:12:02 -08:00
gs-index.asciidoc [DOCS] Adding index file for GS "mini book". 2017-07-18 13:44:08 -07:00
high-availability.asciidoc [DOCS] Remove leveloffset for CCR docs (#46818) 2019-09-18 09:44:28 -04:00
how-to.asciidoc Correct grammar in list in how-to docs 2017-01-17 20:57:22 -05:00
index-extra-title-page.html [DOCS] Add index-extra-title-page.html for direct HTML migration (#50189) 2019-12-13 12:44:12 -05:00
index-modules.asciidoc Introduce hidden indices (#50452) 2020-01-17 09:16:31 -07:00
index.asciidoc [DOCS] Move snapshot-restore out of modules. (#49618) 2020-01-09 16:12:02 -08:00
index.x.asciidoc [DOCS] Removes redundant index.asciidoc files (#30707) 2018-05-18 11:05:40 -07:00
indices.asciidoc Goodbye and thank you synced flush! (#50882) 2020-01-16 09:43:07 -05:00
ingest.asciidoc Replace required pipeline with final pipeline (#49470) 2019-11-22 14:00:38 -05:00
intro.asciidoc [DOCS] Updates ML links (#50387) 2019-12-19 14:47:28 -08:00
mapping.asciidoc [DOCS] Note clause limit in index.mapping.total_fields.limit docs (#48153) 2019-10-18 10:20:23 -04:00
modules.asciidoc [DOCS] Move snapshot-restore out of modules. (#49618) 2020-01-09 16:12:02 -08:00
query-dsl.asciidoc [SPATIAL] New ShapeQueryBuilder for querying indexed cartesian geometry (#45108) 2019-08-08 15:28:35 -05:00
redirects.asciidoc [DOCS] Move snapshot-restore out of modules. (#49618) 2020-01-09 16:12:02 -08:00
release-notes.asciidoc [DOCS] Adds placeholders for v8 highlights, breaking changes, release notes (#38641) 2019-02-08 15:48:42 -08:00
scripting.asciidoc [DOCS] Move 'Scripting' section to top-level navigation. (#42939) 2019-06-06 10:45:04 -04:00
search.asciidoc Use snake casing for document field (#45432) 2019-09-19 14:26:31 +02:00
setup.asciidoc [DOCS] Creates a cluster restart documentation page (#48583) 2019-11-12 14:49:11 +01:00
testing.asciidoc [Docs] Unify spelling of Elasticsearch (#27567) 2017-11-29 09:44:25 +01:00
upgrade.asciidoc Clarify that you cannot abort an upgrade (#47342) 2019-10-02 09:27:17 +01:00