redirects.asciidoc 47 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928
  1. ["appendix",role="exclude",id="redirects"]
  2. = Deleted pages
  3. The following pages have moved or been deleted.
  4. [role="exclude",id="modules-discovery-hosts-providers"]
  5. === Node discovery
  6. Refer to <<discovery-hosts-providers,Discovery>>.
  7. [role="exclude",id="modules-discovery-troubleshooting"]
  8. ==== Troubleshooting node discovery
  9. Refer to <<discovery-troubleshooting,Troubleshooting discovery>>.
  10. [role="exclude",id="jwt-realm"]
  11. === JWT realm
  12. Refer to <<jwt-auth-realm,JWT authentication>>.
  13. [role="exclude",id="_authorizing_with_the_role_mapping_api"]
  14. ==== Role mapping with JWT
  15. Refer to <<jwt-authorization-role-mapping,Authorizing with the role mapping API>>.
  16. [role="exclude",id="migration-api-feature-upgrade"]
  17. === Feature upgrade APIs
  18. Refer to <<feature-migration-api,Feature migration APIs>>.
  19. [role="exclude",id="java-clients"]
  20. === Java transport client and security
  21. The Java transport client has been removed. Use the
  22. https://www.elastic.co/guide/en/elasticsearch/client/java-rest/7.15/java-rest-high.html[Java
  23. high-level REST client] instead. For migration steps, refer to the
  24. https://www.elastic.co/guide/en/elasticsearch/client/java-rest/7.15/java-rest-high-level-migration.html[migration
  25. guide].
  26. // [START] Snapshot and restore
  27. [role="exclude",id="snapshot-lifecycle-management"]
  28. === {slm-cap} ({slm-init})
  29. See <<automate-snapshots-slm>>.
  30. [role="exclude",id="getting-started-snapshot-lifecycle-management"]
  31. === Tutorial: Automate backups with {slm-init}
  32. See <<automate-snapshots-slm>>.
  33. [role="exclude",id="slm-and-security"]
  34. === Security and {slm-init}
  35. See <<slm-security>>.
  36. [role="exclude",id="slm-retention"]
  37. === Snapshot retention
  38. See <<slm-retention-task>>.
  39. [role="exclude",id="delete-snapshots"]
  40. === Delete a snapshot
  41. See <<delete-snapshot>>.
  42. [role="exclude",id="snapshots-monitor-snapshot-restore"]
  43. === Monitor snapshot progress
  44. See <<monitor-snapshot>>.
  45. [role="exclude",id="backup-cluster"]
  46. === Back up a cluster
  47. See <<snapshots-take-snapshot>>.
  48. [role="exclude",id="backup-cluster-data"]
  49. === Back up a cluster's data
  50. See <<snapshots-take-snapshot>>.
  51. [role="exclude",id="backup-cluster-configuration"]
  52. === Back up a cluster's configuration
  53. See <<back-up-config-files>>.
  54. [role="exclude",id="security-backup"]
  55. === Back up a cluster's security configuration
  56. See <<back-up-config-files>> and <<cluster-state-snapshots>>.
  57. // [END] Snapshot and restore
  58. [role="exclude",id="configuring-tls-docker"]
  59. === Encrypting communications in an {es} Docker Container
  60. Refer to <<docker-compose-file,Starting a multi-node cluster with Docker Compose>>.
  61. [role="exclude",id="next-getting-started-tls-docker"]
  62. === Start a multi-node cluster with TLS enabled
  63. Refer to <<docker-compose-file,Starting a multi-node cluster with Docker Compose>>.
  64. // [START] Remote clusters
  65. [role="exclude",id="ccs-clients-integrations"]
  66. === {ccs-cap}, clients, and integrations
  67. Refer to <<security-clients-integrations,Securing clients and integrations>>.
  68. [role="exclude",id="cross-cluster-configuring"]
  69. === {ccs-cap} and security
  70. Refer to <<remote-clusters-security,configure remote clusters with security>>.
  71. [role="exclude",id="cross-cluster-kibana"]
  72. ==== {ccs-cap} and {kib}
  73. Refer to <<clusters-privileges-ccs-kibana,Configure privileges for {ccs} and {kib}>>.
  74. [role="exclude",id="ccr-getting-started"]
  75. === Configure {ccr}
  76. Refer to <<ccr-getting-started-tutorial,Set up {ccr}>>.
  77. [role="exclude",id="ccr-getting-started-remote-cluster"]
  78. ==== Connect a remote cluster
  79. Refer to <<remote-clusters-connect,Connecting remote clusters>>.
  80. [role="exclude",id="modules-remote-clusters"]
  81. === Remote clusters
  82. Refer to <<remote-clusters,Remote clusters>>.
  83. [role="exclude",id="configuring-remote-clusters"]
  84. ==== Configuring remote clusters
  85. Refer to <<remote-clusters-connect,Connect remote clusters>>.
  86. [role="exclude",id="remote-cluster-settings"]
  87. ==== Remote cluster settings
  88. Refer to <<remote-clusters-settings,Remote clusters settings>>.
  89. // [END] Remote clusters
  90. [role="exclude",id="restore-cluster-data"]
  91. === Restore a cluster's data
  92. See <<restore-entire-cluster>>.
  93. [role="exclude",id="freeze-index-api"]
  94. === Freeze index API
  95. The freeze index API was removed in 8.0.
  96. // tag::frozen-removal-explanation[]
  97. Frozen indices are no longer useful due to
  98. https://www.elastic.co/blog/significantly-decrease-your-elasticsearch-heap-memory-usage[recent
  99. improvements in heap memory usage].
  100. // end::frozen-removal-explanation[]
  101. [role="exclude",id="ilm-freeze"]
  102. === Freeze {ilm-init} action
  103. The freeze {ilm-init} action was removed in 8.0.
  104. include::redirects.asciidoc[tag=frozen-removal-explanation]
  105. [role="exclude",id="ilm-freeze-action"]
  106. === Freeze {ilm-init} action
  107. The freeze {ilm-init} action was removed in 8.0.
  108. include::redirects.asciidoc[tag=frozen-removal-explanation]
  109. [role="exclude",id="alias"]
  110. === Aliases
  111. For field aliases, refer to the <<field-alias,alias field type>>.
  112. For index and data stream aliases, refer to <<aliases>>.
  113. [role="exclude",id="modules-scripting-other-layers"]
  114. === Other security layers
  115. Refer to <<modules-scripting-security>>.
  116. [role="exclude",id="grok-basics"]
  117. === Grok basics
  118. See <<grok,Grokking grok>>.
  119. // [START] Security redirects
  120. [role="exclude",id="get-started-users"]
  121. ==== Create users
  122. Refer to the <<reset-password,`elasticsearch-reset-password`>> tool for resetting
  123. passwords of built-in users.
  124. [role="exclude",id="encrypting-communications-certificates"]
  125. === Generate certificates
  126. See <<security-basic-setup,Set up basic security for the Elastic Stack>>.
  127. [role="exclude",id="encrypting-internode-communications"]
  128. === Tutorial: Encrypting communications
  129. See <<security-basic-setup,Set up basic security for the Elastic Stack>>.
  130. [role="exclude",id="encrypting-internode"]
  131. === Encrypting internode communication
  132. See <<security-basic-setup,Set up basic security for the Elastic Stack>>.
  133. [role="exclude",id="security-getting-started"]
  134. === Tutorial: Getting started with security
  135. See <<secure-cluster,Secure the Elastic Stack>>.
  136. // [START] OpenID Connect authentication
  137. [role="exclude",id="oidc-guide-authentication"]
  138. === Configure {es} for OpenID Connect authentication
  139. See <<oidc-elasticsearch-authentication,Configure {es} for OpenID Connect authentication>>.
  140. [role="exclude",id="oidc-claims-mapping"]
  141. ==== Claims mapping
  142. See <<oidc-claims-mappings,Claims mapping for OpenID Connect>>.
  143. [role="exclude",id="oidc-kibana"]
  144. === Configuring {kib}
  145. See <<oidc-configure-kibana,Configuring {kib} for OpenID Connect>>.
  146. [role="exclude",id="oidc-role-mapping"]
  147. === Configuring role mappings
  148. See <<oidc-role-mappings,Configuring OpenID Connect role mappings>>.
  149. // [END] OpenID Connect authentication
  150. // [START] SAML authentication
  151. [role="exclude",id="saml-guide"]
  152. === Configure SAML single-sign on
  153. See <<saml-guide-stack,Configuring SAML single-sign-on on the {stack}>>.
  154. [role="exclude",id="saml-kibana"]
  155. === Configuring {kib}
  156. See <<saml-configure-kibana,Configuring {kib} for SAML>>.
  157. [role="exclude",id="saml-guide-authentication"]
  158. === Configure {es} for SAML authentication
  159. See <<saml-elasticsearch-authentication,Configure {es} for SAML authentication>>.
  160. [role="exclude",id="saml-attribute-mapping"]
  161. ==== Attribute mapping
  162. See <<saml-attributes-mapping,SAML attribute mapping>>.
  163. [role="exclude",id="saml-user-properties"]
  164. ===== User properties
  165. See <<saml-es-user-properties,{es} user properties>>.
  166. // [END] SAML authentication
  167. [role="exclude",id="active-directory-ssl"]
  168. === Setting up SSL between {es} and Active Directory
  169. See <<tls-active-directory,Encrypting communications between {es} and Active Directory>>.
  170. [role="exclude",id="elasticsearch-security"]
  171. === Security overview
  172. See <<secure-cluster,Secure the Elastic Stack>>.
  173. [role="exclude",id="get-started-enable-security"]
  174. === Enable {es} {security-features}
  175. See <<security-minimal-setup,Set up minimal security for {es}>>.
  176. [role="exclude",id="ssl-tls"]
  177. === Set up TLS on a cluster
  178. See <<encrypt-internode-communication,Encrypt internode communication>>.
  179. // [START] Configuring TLS
  180. [role="exclude",id="configuring-tls"]
  181. === Configure TLS
  182. See <<encrypt-internode-communication,Encrypt internode communication>>.
  183. [role="exclude",id="tls-http"]
  184. ==== Encrypt HTTP client communications
  185. See <<encrypt-http-communication,Encrypt HTTP client communications>>.
  186. [role="exclude",id="tls-transport"]
  187. ==== Encrypt internode communication
  188. See <<encrypt-internode-communication,Encrypt internode communications>>.
  189. [role="exclude",id="node-certificates"]
  190. ==== Generating node certificates
  191. See <<generate-certificates,Generate the certificate authority>>.
  192. [role="exclude",id="configuring-security"]
  193. === Configure security in {es}
  194. See <<configuring-stack-security,Configuring security for the Elastic Stack>>.
  195. // [END] Configuring TLS
  196. [role="exclude",id="encrypting-communications"]
  197. === Encrypting communications
  198. See <<configuring-stack-security,Configuring security for the Elastic Stack>>.
  199. [role="exclude",id="security-api-search-user-profile"]
  200. === Search user profile API
  201. See <<security-api-suggest-user-profile,Suggest user profile API>>.
  202. // [END] Security redirects
  203. [roles="exclude",id="modules-scripting-stored-scripts"]
  204. === Stored scripts
  205. See <<script-stored-scripts,Store and retrieve scripts>>
  206. [role="exclude",id="node.name"]
  207. === Node name setting
  208. See <<node-name,Node name setting>>.
  209. [role="exclude",id="cluster.name"]
  210. === Cluster name setting
  211. See <<cluster-name,Cluster name setting>>.
  212. [role="exclude",id="heap-size"]
  213. === Heap size settings
  214. See <<heap-size-settings>>.
  215. [role="exclude",id="ccr-remedy-follower-index"]
  216. === Leader index retaining operations for replication
  217. See <<ccr-leader-requirements,Requirements for leader indices>>.
  218. [role="exclude",id="ccr-leader-not-replicating"]
  219. === Remedying a follower that has fallen behind
  220. See <<ccr-recreate-follower-index,Recreating a follower index>>.
  221. [role="exclude",id="remote-reovery"]
  222. === Remote recovery process
  223. See <<ccr-remote-recovery,Remote recovery process>>.
  224. [role="exclude",id="ccr-requirements"]
  225. === Leader index requirements
  226. See <<ccr-leader-requirements,Requirements for leader indices>>.
  227. [role="exclude",id="ccr-overview"]
  228. === Cross-cluster replication overview
  229. See <<xpack-ccr,Cross-cluster replication>>.
  230. [role="exclude",id="indices-upgrade"]
  231. === Upgrade API
  232. The `_upgrade` API is no longer useful and will be removed.
  233. For information about upgrading, see
  234. {stack-ref}/upgrading-elasticsearch.html[Upgrading {es}].
  235. [role="exclude",id="mapping-parent-field"]
  236. === `_parent` field
  237. The `_parent` field has been removed in favour of the <<parent-join,`join` field>>.
  238. [role="exclude",id="indices-warmers"]
  239. === Warmers
  240. Warmers have been removed. There have been significant improvements to the
  241. index that make warmers not necessary anymore.
  242. [role="exclude",id="indices-types-exists"]
  243. === Types Exists
  244. The types exists endpoint has been removed. See <<removal-of-types>> for
  245. more details.
  246. [role="exclude",id="xpack-commands"]
  247. === X-Pack commands
  248. See <<commands>>.
  249. [role="exclude",id="xpack-api"]
  250. === X-Pack APIs
  251. {es} {xpack} APIs are now documented in <<rest-apis, REST APIs>>.
  252. [role="exclude",id="ml-calendar-resource"]]
  253. === Calendar resources
  254. See <<ml-get-calendar>> and
  255. {ml-docs}/ml-ad-run-jobs.html#ml-ad-calendars[Calendars and scheduled events].
  256. [role="exclude",id="ml-filter-resource"]
  257. === Filter resources
  258. See <<ml-get-filter>> and
  259. {ml-docs}/ml-ad-run-jobs.html#ml-ad-rules[Machine learning custom rules].
  260. [role="exclude",id="ml-event-resource"]
  261. === Scheduled event resources
  262. See <<ml-get-calendar-event>> and
  263. {ml-docs}/ml-ad-run-jobs.html#ml-ad-calendars[Calendars and scheduled events].
  264. [role="exclude",id="index-apis"]
  265. === Index APIs
  266. {es} index APIs are now documented in <<indices>>.
  267. [role="exclude",id="search-request-docvalue-fields"]
  268. === Doc value fields parameter for request body search API
  269. See <<request-body-search-docvalue-fields>>.
  270. [role="exclude",id="search-request-explain"]
  271. === Explain parameter for request body search API
  272. See <<request-body-search-explain>>.
  273. [role="exclude",id="search-request-collapse"]
  274. === Collapse parameter for request body search API
  275. See <<collapse-search-results>>.
  276. [role="exclude",id="search-request-from-size"]
  277. === From and size parameters for request body search API
  278. See <<paginate-search-results>>.
  279. [role="exclude",id="search-request-highlighting"]
  280. === Highlight parameter for request body search API
  281. See <<highlighting>>.
  282. [role="exclude",id="search-request-index-boost"]
  283. === Index boost parameter for request body search API
  284. See <<index-boost>>.
  285. [role="exclude",id="search-request-inner-hits"]
  286. === Inner hits parameter for request body search API
  287. See <<inner-hits>>.
  288. [role="exclude",id="search-request-min-score"]
  289. === Minimum score parameter for request body search API
  290. See <<search-api-min-score>>.
  291. [role="exclude",id="search-request-named-queries-and-filters"]
  292. === Named query parameter for request body search API
  293. See <<named-queries>>.
  294. [role="exclude",id="search-request-post-filter"]
  295. === Post filter parameter for request body search API
  296. See <<post-filter>>.
  297. [role="exclude",id="search-request-preference"]
  298. === Preference parameter for request body search API
  299. See <<search-preference>>.
  300. [role="exclude",id="search-request-query"]
  301. === Query parameter for request body search API
  302. See <<request-body-search-query>>.
  303. [role="exclude",id="search-request-rescore"]
  304. === Rescoring parameter for request body search API
  305. See <<rescore>>.
  306. [role="exclude",id="search-request-script-fields"]
  307. === Script fields parameter for request body search API
  308. See <<script-fields>>.
  309. [role="exclude",id="search-request-scroll"]
  310. === Scroll parameter for request body search API
  311. See <<scroll-search-results>>.
  312. [role="exclude",id="search-request-search-after"]
  313. === Search after parameter for request body search API
  314. See <<search-after>>.
  315. [role="exclude",id="search-request-search-type"]
  316. === Search type parameter for request body search API
  317. See <<search-type>>.
  318. [role="exclude",id="search-request-seq-no-primary-term"]
  319. === Sequence numbers and primary terms parameter for request body search API
  320. See <<optimistic-concurrency-control>>.
  321. [role="exclude",id="search-request-sort"]
  322. === Sort parameter for request body search API
  323. See <<sort-search-results>>.
  324. [role="exclude",id="search-request-source-filtering"]
  325. === Source filtering parameter for request body search API
  326. See <<source-filtering>>.
  327. [role="exclude",id="search-request-stored-fields"]
  328. === Stored fields parameter for request body search API
  329. See <<stored-fields>>.
  330. [role="exclude",id="search-request-track-total-hits"]
  331. === Track total hits parameter for request body search API
  332. See <<track-total-hits>>.
  333. [role="exclude",id="search-request-version"]
  334. === Version parameter for request body search API
  335. See <<request-body-search-version>>.
  336. [role="exclude",id="search-suggesters-term"]
  337. === Term suggester
  338. See <<term-suggester>>.
  339. [role="exclude",id="search-suggesters-phrase"]
  340. === Phrase suggester
  341. See <<phrase-suggester>>.
  342. [role="exclude",id="search-suggesters-completion"]
  343. === Completion suggester
  344. See <<completion-suggester>>.
  345. [role="exclude",id="suggester-context"]
  346. === Context suggester
  347. See <<context-suggester>>.
  348. [role="exclude",id="returning-suggesters-type"]
  349. === Return suggester type
  350. See <<return-suggesters-type>>.
  351. [role="exclude",id="search-profile-queries"]
  352. === Profiling queries
  353. See <<profiling-queries>>.
  354. [role="exclude",id="search-profile-aggregations"]
  355. === Profiling aggregations
  356. See <<profiling-aggregations>>.
  357. [role="exclude",id="search-profile-considerations"]
  358. === Profiling considerations
  359. See <<profiling-considerations>>.
  360. [role="exclude",id="_explain_analyze"]
  361. === Explain analyze API
  362. See <<explain-analyze-api>>.
  363. [role="exclude",id="indices-synced-flush"]
  364. === Synced flush API
  365. The synced flush API has been removed. Use the <<indices-flush,flush API>>
  366. instead. A regular flush has the same effect as a synced flush in 7.6 and later.
  367. [role="exclude",id="indices-synced-flush-api"]
  368. === Synced flush API
  369. The synced flush API has been removed. Use the <<indices-flush,flush API>>
  370. instead. A regular flush has the same effect as a synced flush in 7.6 and later.
  371. [role="exclude",id="_repositories"]
  372. === Snapshot repositories
  373. See <<snapshots-register-repository>>.
  374. [role="exclude",id="_snapshot"]
  375. === Snapshot
  376. See <<snapshots-take-snapshot>>.
  377. [role="exclude",id="getting-started-explore"]
  378. === Exploring your cluster
  379. See <<cat>>.
  380. [role="exclude",id="getting-started-cluster-health"]
  381. === Cluster health
  382. See <<cat-health>>.
  383. [role="exclude", id="getting-started-list-indices"]
  384. === List all indices
  385. See <<cat-indices>>.
  386. [role="exclude", id="getting-started-create-index"]
  387. === Create an index
  388. See <<indices-create-index>>.
  389. [role="exclude", id="getting-started-query-document"]
  390. === Index and query a document
  391. See <<getting-started-index>>.
  392. [role="exclude", id="getting-started-delete-index"]
  393. === Delete an index
  394. See <<indices-delete-index>>.
  395. [role="exclude", id="getting-started-modify-data"]
  396. === Modifying your data
  397. See <<docs-update>>.
  398. [role="exclude", id="indexing-replacing-documents"]
  399. === Indexing/replacing documents
  400. See <<docs-index_>>.
  401. [role="exclude", id="getting-started-explore-data"]
  402. === Exploring your data
  403. See <<getting-started-search>>.
  404. [role="exclude", id="getting-started-search-API"]
  405. === Search API
  406. See <<getting-started-search>>.
  407. [role="exclude",id="ccs-reduction"]
  408. === {ccs-cap} reduction
  409. See <<ccs-works>>.
  410. [role="exclude",id="administer-elasticsearch"]
  411. === Administering {es}
  412. See <<high-availability>>.
  413. [role="exclude",id="slm-api"]
  414. === Snapshot lifecycle management API
  415. See <<snapshot-lifecycle-management-api>>.
  416. [role="exclude",id="delete-data-frame-transform"]
  417. === Delete {transforms} API
  418. See <<delete-transform>>.
  419. [role="exclude",id="get-data-frame-transform-stats"]
  420. === Get {transform} statistics API
  421. See <<get-transform-stats>>.
  422. [role="exclude",id="get-data-frame-transform"]
  423. === Get {transforms} API
  424. See <<get-transform>>.
  425. [role="exclude",id="preview-data-frame-transform"]
  426. === Preview {transforms} API
  427. See <<preview-transform>>.
  428. [role="exclude",id="put-data-frame-transform"]
  429. === Create {transforms} API
  430. See <<put-transform>>.
  431. [role="exclude",id="start-data-frame-transform"]
  432. === Start {transforms} API
  433. See <<start-transform>>.
  434. [role="exclude",id="stop-data-frame-transform"]
  435. === Stop {transforms} API
  436. See <<stop-transform>>.
  437. [role="exclude",id="update-data-frame-transform"]
  438. === Update {transforms} API
  439. See <<update-transform>>.
  440. [role="exclude",id="data-frame-apis"]
  441. === {transform-cap} APIs
  442. See <<transform-apis>>.
  443. [role="exclude",id="data-frame-transform-resource"]
  444. === {transform-cap} resources
  445. See <<transform-resource>>.
  446. [role="exclude",id="data-frame-transform-dest"]
  447. === Dest objects
  448. See <<transform-resource>>.
  449. [role="exclude",id="data-frame-transform-source"]
  450. ==== Source objects
  451. See <<transform-resource>>.
  452. [role="exclude",id="data-frame-transform-pivot"]
  453. ==== Pivot objects
  454. See <<transform-resource>>.
  455. [role="exclude",id="es-monitoring"]
  456. === Monitoring {es}
  457. See <<monitor-elasticsearch-cluster>>.
  458. [role="exclude",id="docker-cli-run"]
  459. === Docker Run
  460. See <<docker-cli-run-dev-mode>>.
  461. [role="exclude",id="auditing"]
  462. === Audit logging
  463. See <<enable-audit-logging>>.
  464. [role="exclude",id="analysis-compound-word-tokenfilter"]
  465. === Compound word token filters
  466. See <<analysis-dict-decomp-tokenfilter>> and
  467. <<analysis-hyp-decomp-tokenfilter>>.
  468. [role="exclude",id="configuring-native-realm"]
  469. === Configuring a native realm
  470. See <<native-realm-configuration>>.
  471. [role="exclude",id="native-settings"]
  472. ==== Native realm settings
  473. See <<ref-native-settings>>.
  474. [role="exclude",id="configuring-saml-realm"]
  475. === Configuring a SAML realm
  476. See <<saml-guide-stack>>.
  477. [role="exclude",id="saml-settings"]
  478. ==== SAML realm settings
  479. See <<ref-saml-settings>>.
  480. [role="exclude",id="_saml_realm_signing_settings"]
  481. ==== SAML realm signing settings
  482. See <<ref-saml-signing-settings>>.
  483. [role="exclude",id="_saml_realm_encryption_settings"]
  484. ==== SAML realm encryption settings
  485. See <<ref-saml-encryption-settings>>.
  486. [role="exclude",id="_saml_realm_ssl_settings"]
  487. ==== SAML realm SSL settings
  488. See <<ref-saml-ssl-settings>>.
  489. [role="exclude",id="configuring-file-realm"]
  490. === Configuring a file realm
  491. See <<file-realm-configuration>>.
  492. [role="exclude",id="ldap-user-search"]
  493. === User search mode and user DN templates mode
  494. See <<ldap-realm-configuration>>.
  495. [role="exclude",id="configuring-ldap-realm"]
  496. === Configuring an LDAP realm
  497. See <<ldap-realm-configuration>>.
  498. [role="exclude",id="ldap-settings"]
  499. === LDAP realm settings
  500. See <<ref-ldap-settings>>.
  501. [role="exclude",id="ldap-ssl"]
  502. === Setting up SSL between Elasticsearch and LDAP
  503. See <<tls-ldap>>.
  504. [role="exclude",id="configuring-kerberos-realm"]
  505. === Configuring a Kerberos realm
  506. See <<kerberos-realm-configuration>>.
  507. [role="exclude",id="beats"]
  508. === Beats and Security
  509. See:
  510. * {auditbeat-ref}/securing-auditbeat.html[{auditbeat}]
  511. * {filebeat-ref}/securing-filebeat.html[{filebeat}]
  512. * {heartbeat-ref}/securing-heartbeat.html[{heartbeat}]
  513. * {metricbeat-ref}/securing-metricbeat.html[{metricbeat}]
  514. * {packetbeat-ref}/securing-packetbeat.html[{packetbeat}]
  515. * {winlogbeat-ref}/securing-winlogbeat.html[{winlogbeat}]
  516. [role="exclude",id="configuring-pki-realm"]
  517. === Configuring a PKI realm
  518. See <<pki-realm>>.
  519. [role="exclude",id="pki-settings"]
  520. ==== PKI realm settings
  521. See <<ref-pki-settings>>.
  522. [role="exclude",id="configuring-ad-realm"]
  523. === Configuring an Active Directory realm
  524. See <<ad-realm-configuration>>.
  525. [role="exclude",id="ad-settings"]
  526. === Active Directory realm settings
  527. See <<ref-ad-settings>>.
  528. [role="exclude",id="mapping-roles-ad"]
  529. === Mapping Active Directory users and groups to roles
  530. See <<ad-realm-configuration>>.
  531. [role="exclude",id="how-security-works"]
  532. === How security works
  533. See <<configuring-stack-security>>.
  534. [role="exclude",id="rollup-job-config"]
  535. === Rollup job configuration
  536. See <<rollup-put-job-api-request-body>>.
  537. [role="exclude",id="ml-job-resource"]
  538. === Job resources
  539. This page was deleted.
  540. [[ml-analysisconfig]]
  541. See the details in
  542. [[ml-apimodelplotconfig]]
  543. <<ml-put-job>>, <<ml-update-job>>, and <<ml-get-job>>.
  544. [role="exclude",id="ml-datafeed-resource"]
  545. === {dfeed-cap} resources
  546. This page was deleted.
  547. [[ml-datafeed-chunking-config]]
  548. See the details in <<ml-put-datafeed>>, <<ml-update-datafeed>>,
  549. [[ml-datafeed-delayed-data-check-config]]
  550. <<ml-get-datafeed>>,
  551. [[ml-datafeed-counts]]
  552. <<ml-get-datafeed-stats>>.
  553. [role="exclude",id="ml-jobstats"]
  554. === Job statistics
  555. This
  556. [[ml-datacounts]]
  557. page
  558. [[ml-modelsizestats]]
  559. was
  560. [[ml-forecastsstats]]
  561. deleted.
  562. [[ml-timingstats]]
  563. See
  564. [[ml-stats-node]]
  565. the details in <<ml-get-job-stats>>.
  566. [role="exclude",id="ml-snapshot-resource"]
  567. === Model snapshot resources
  568. This page was deleted.
  569. [[ml-snapshot-stats]]
  570. See <<ml-update-snapshot>> and <<ml-get-snapshot>>.
  571. [role="exclude",id="transform-resource"]
  572. === {transform-cap} resources
  573. This page was deleted.
  574. See <<put-transform>>, <<preview-transform>>, <<update-transform>>,
  575. <<get-transform>>.
  576. [role="exclude",id="ml-dfanalytics-resources"]
  577. === {dfanalytics-cap} job resources
  578. This page was deleted.
  579. See <<put-dfanalytics>>.
  580. [role="exclude",id="put-inference"]
  581. === Create trained model API
  582. See <<put-trained-models>>.
  583. [role="exclude",id="get-inference-stats"]
  584. === Get trained model statistics API
  585. See <<get-trained-models-stats>>.
  586. [role="exclude",id="get-inference"]
  587. === Get trained model API
  588. See <<get-trained-models>>.
  589. [role="exclude",id="delete-inference"]
  590. === Delete trained model API
  591. See <<delete-trained-models>>.
  592. [role="exclude",id="data-frames-settings"]
  593. === {transforms-cap} settings in Elasticsearch
  594. See <<transform-settings>>.
  595. [role="exclude",id="general-data-frames-settings"]
  596. ==== General {transforms} settings
  597. See <<general-transform-settings>>.
  598. [role="exclude",id="ml-results-resource"]
  599. === Results resources
  600. This page was deleted.
  601. [[ml-results-buckets]]
  602. See <<ml-get-bucket>>,
  603. [[ml-results-bucket-influencers]]
  604. <<ml-get-bucket>>,
  605. [[ml-results-influencers]]
  606. <<ml-get-influencer>>,
  607. [[ml-results-records]]
  608. <<ml-get-record>>,
  609. [[ml-results-categories]]
  610. <<ml-get-category>>, and
  611. [[ml-results-overall-buckets]]
  612. <<ml-get-overall-buckets>>.
  613. [role="exclude",id="modules-snapshots"]
  614. === Snapshot module
  615. See <<snapshot-restore>>.
  616. [role="exclude",id="_repository_plugins"]
  617. ==== Repository plugins
  618. See <<self-managed-repo-types>>.
  619. [role="exclude",id="_changing_index_settings_during_restore"]
  620. ==== Change index settings during restore
  621. See <<restore-snapshot-api-index-settings>>.
  622. [role="exclude",id="restore-snapshot"]
  623. === Restore snapshot
  624. See <<snapshots-restore-snapshot>>.
  625. [role="exclude",id="snapshots-repositories"]
  626. === Snapshot repositories
  627. See <<snapshots-register-repository>>.
  628. [role="exclude",id="ml-dfa-analysis-objects"]
  629. === Analysis configuration objects
  630. This page was deleted.
  631. See <<put-dfanalytics>>.
  632. [role="exclude",id="slm-api-delete"]
  633. === {slm-init} delete policy API
  634. See <<slm-api-delete-policy>>.
  635. [role="exclude",id="slm-api-execute"]
  636. === {slm-init} execute lifecycle API
  637. See <<slm-api-execute-lifecycle>>.
  638. [role="exclude",id="slm-api-execute-policy"]
  639. === {slm-init} execute lifecycle API
  640. See <<slm-api-execute-lifecycle>>.
  641. [role="exclude",id="slm-api-get"]
  642. === {slm-init} get policy API
  643. See <<slm-api-get-policy>>.
  644. [role="exclude",id="slm-get-stats"]
  645. === {slm-init} get stats API
  646. See <<slm-api-get-stats>>.
  647. [role="exclude",id="slm-get-status"]
  648. === {slm-init} status API
  649. See <<slm-api-get-status>>.
  650. [role="exclude",id="slm-api-put"]
  651. === {slm-init} put policy API
  652. See <<slm-api-put-policy>>.
  653. [role="exclude",id="slm-start"]
  654. === Start {slm} API
  655. See <<slm-api-start>>.
  656. [role="exclude",id="slm-stop"]
  657. === Stop {slm} API
  658. See <<slm-api-stop>>.
  659. [role="exclude",id="ccs-works"]
  660. === How {ccs} works
  661. See <<ccs-gateway-seed-nodes>> and <<ccs-min-roundtrips>>.
  662. [role="exclude",id="indices-component-templates"]
  663. === Component template APIs
  664. See <<index-templates-apis,index template APIs>>.
  665. [role="exclude",id="modules-indices"]
  666. === Indices module
  667. See:
  668. * <<circuit-breaker>>
  669. * <<indexing-buffer>>
  670. * <<modules-fielddata>>
  671. * <<query-cache>>
  672. * <<recovery>>
  673. * <<search-settings>>
  674. * <<shard-request-cache>>
  675. [role="exclude",id="testing"]
  676. === Testing
  677. This page was deleted.
  678. Information about the Java testing framework was removed
  679. ({es-issue}55257[#55257]) from the {es} Guide
  680. because it was out of date and erroneously implied that it should be used by application developers.
  681. There is an issue ({es-issue}55258[#55258])
  682. for providing general testing guidance for applications that communicate with {es}.
  683. [role="exclude",id="testing-framework"]
  684. === Java testing framework
  685. This page was deleted.
  686. Information about the Java testing framework was removed
  687. ({es-issue}55257[55257]) from the {es} Guide because it was out of date and
  688. erroneously implied that it should be used by application developers.
  689. There is an issue ({es-issue}55258[#55258]) for providing general testing
  690. guidance for applications that communicate with {es}.
  691. [role="exclude",id="why-randomized-testing"]
  692. === Why randomized testing?
  693. This page was deleted.
  694. Information about the Java testing framework was removed
  695. ({es-issue}55257[55257]) from the {es} Guide
  696. because it was out of date and erroneously implied that it should be used by application developers.
  697. There is an issue ({es-issue}[#55258])
  698. for providing general testing guidance for applications that communicate with {es}.
  699. [role="exclude",id="using-elasticsearch-test-classes"]
  700. === Using the {es} test classes
  701. This page was deleted.
  702. Information about the Java testing framework was removed
  703. ({es-issue}55257[55257]) from the {es} Guide
  704. because it was out of date and erroneously implied that it should be used by application developers.
  705. There is an issue ({es-issue}55258[#55258])
  706. for providing general testing guidance for applications that communicate with {es}.
  707. [role="exclude",id="unit-tests"]
  708. === Unit tests
  709. This page was deleted.
  710. Information about the Java testing framework was removed
  711. ({es-issue}55257[55257]) from the {es} Guide
  712. because it was out of date and erroneously implied that it should be used by application developers.
  713. There is an issue ({es-issue}55258[#55258])
  714. for providing general testing guidance for applications that communicate with {es}.
  715. [role="exclude",id="integration-tests"]
  716. === Integration tests
  717. This page was deleted.
  718. Information about the Java testing framework was removed
  719. ({es-issue}55257[55257]) from the {es} Guide
  720. because it was out of date and erroneously implied that it should be used by application developers.
  721. There is an issue ({es-issue}55258[#55258])
  722. for providing general testing guidance for applications that communicate with {es}.
  723. [role="exclude",id="number-of-shards"]
  724. ==== Number of shards
  725. This section was deleted.
  726. [role="exclude",id="helper-methods"]
  727. ==== Generic helper methods
  728. This section was deleted.
  729. [role="exclude",id="test-cluster-methods"]
  730. ==== Test cluster methods
  731. This section was deleted.
  732. [role="exclude",id="changing-node-settings"]
  733. ==== Changing node settings
  734. This section was deleted.
  735. [role="exclude",id="accessing-clients"]
  736. ==== Accessing clients
  737. This section was deleted.
  738. [role="exclude",id="scoping"]
  739. ==== Scoping
  740. This section was deleted.
  741. [role="exclude",id="changing-node-configuration"]
  742. ==== Changing plugins via configuration
  743. This section was deleted.
  744. [role="exclude",id="randomized-testing"]
  745. === Randomized testing
  746. This page was deleted.
  747. [role="exclude",id="generating-random-data"]
  748. ==== Generating random data
  749. This section was deleted.
  750. [role="exclude",id="assertions"]
  751. === Assertions
  752. This page was deleted.
  753. [role="exclude",id="_actions"]
  754. === {ilm-init} actions
  755. See <<ilm-actions>>.
  756. [role="exclude",id="ilm-allocate-action"]
  757. ==== Allocate action
  758. See <<ilm-allocate>>.
  759. [role="exclude",id="ilm-delete-action"]
  760. ==== Delete action
  761. See <<ilm-delete>>.
  762. [role="exclude",id="ilm-forcemerge-action"]
  763. ==== Force merge action
  764. See <<ilm-forcemerge>>.
  765. [role="exclude",id="ilm-migrate-action"]
  766. ==== Migrate action
  767. See <<ilm-migrate>>.
  768. [role="exclude",id="ilm-readonly-action"]
  769. ==== Read only action
  770. See <<ilm-readonly>>.
  771. [role="exclude",id="ilm-rollover-action"]
  772. ==== Rollover action
  773. See <<ilm-rollover>>.
  774. [role="exclude",id="ilm-searchable-snapshot-action"]
  775. ==== Searchable snapshot action
  776. See <<ilm-searchable-snapshot>>.
  777. [role="exclude",id="ilm-set-priority-action"]
  778. ==== Set priority action
  779. See <<ilm-set-priority>>.
  780. [role="exclude",id="ilm-shrink-action"]
  781. ==== Shrink action
  782. See <<ilm-shrink>>.
  783. [role="exclude",id="ilm-unfollow-action"]
  784. ==== Unfollow action
  785. See <<ilm-unfollow>>.
  786. [role="exclude",id="ilm-wait-for-snapshot-action"]
  787. ==== Wait for snapshot action
  788. See <<ilm-wait-for-snapshot>>.
  789. [role="exclude",id="ilm-policy-definition"]
  790. === {ilm-init} policy definition
  791. See <<ilm-index-lifecycle>>.
  792. [role="exclude",id="search-uri-request"]
  793. === URI search
  794. See <<search-search>>.
  795. [role="exclude",id="modules-gateway-dangling-indices"]
  796. === Dangling indices
  797. See <<dangling-indices>>.
  798. [role="exclude",id="shards-allocation"]
  799. === Cluster-level shard allocation
  800. See <<cluster-shard-allocation-settings>>.
  801. [role="exclude",id="disk-allocator"]
  802. === Disk-based shard allocation
  803. See <<disk-based-shard-allocation>>.
  804. [role="exclude",id="allocation-awareness"]
  805. === Shard allocation awareness
  806. See <<shard-allocation-awareness>>.
  807. [role="exclude",id="allocation-filtering"]
  808. === Cluster-level shard allocation filtering
  809. See <<cluster-shard-allocation-filtering>>.
  810. [role="exclude",id="misc-cluster"]
  811. === Miscellaneous cluster settings
  812. See <<misc-cluster-settings>>.
  813. [role="exclude",id="modules"]
  814. === Modules
  815. This page has been removed.
  816. See <<settings,Configuring Elasticsearch>> for settings information:
  817. * <<circuit-breaker>>
  818. * <<modules-cluster>>
  819. * <<modules-discovery-settings>>
  820. * <<modules-fielddata>>
  821. * <<recovery>>
  822. * <<indexing-buffer>>
  823. * <<modules-gateway>>
  824. * <<modules-network>>
  825. * <<query-cache>>
  826. * <<search-settings>>
  827. * <<shard-request-cache>>
  828. For other information, see:
  829. * <<modules-threadpool>>
  830. * <<modules-node>>
  831. * <<modules-plugins>>
  832. * <<remote-clusters>>
  833. [role="exclude",id="modules-http"]
  834. === HTTP
  835. See <<modules-network,Networking>>.
  836. [role="exclude",id="modules-transport"]
  837. === Transport
  838. See <<modules-network,Networking>>.
  839. [role="exclude",id="modules-discovery-adding-removing-nodes"]
  840. === Adding and removing nodes
  841. See <<add-elasticsearch-nodes>>.
  842. [role="exclude",id="_timing"]
  843. === Timing
  844. See <<ilm-phase-transitions>>.
  845. [role="exclude",id="_installation"]
  846. === Installation
  847. See <<install-elasticsearch>>.
  848. [role="exclude",id="mapping-ttl-field"]
  849. === `_ttl` mappings
  850. The `_ttl` mappings have been removed. As a replacement for `_ttl`
  851. mappings, we recommend using <<index-lifecycle-management,{ilm-init}>> to create
  852. time-based indices.
  853. [role="exclude",id="setup-service"]
  854. === Running as a service on Linux
  855. See <<starting-elasticsearch>>.
  856. [role="exclude",id="modules-scripting-painless-syntax"]
  857. === Painless syntax
  858. See {painless}/painless-lang-spec.html[Painless language specification].
  859. [role="exclude",id="using-policies-rollover"]
  860. === Using policies to manage index rollover
  861. See <<getting-started-index-lifecycle-management>>.
  862. [role="exclude",id="_applying_a_policy_to_our_index"]
  863. === Applying a policy to our index
  864. See <<ilm-gs-apply-policy>>.
  865. [role="exclude",id="setup-dir-layout"]
  866. === Directory layout
  867. See <<settings>>.
  868. [role="exclude",id="scan-scroll"]
  869. === Scan and scroll
  870. See <<scroll-search-results>>.
  871. [role="exclude",id="mapping-dynamic-mapping"]
  872. === Dynamic mapping
  873. See <<dynamic-mapping>>.
  874. [role="exclude",id="applying-policy-to-template"]
  875. === Applying a policy to an index template
  876. See <<ilm-gs-apply-policy>>.
  877. [role="exclude",id="indices-status"]
  878. === Index status API
  879. The index `_status` API has been replaced with the <<indices-stats,index
  880. stats>> and <<indices-recovery,index recovery>> APIs.
  881. [role="exclude",id="search-facets"]
  882. === Search facets
  883. See <<search-aggregations>>.
  884. [role="exclude",id="_executing_searches"]
  885. === Executing searches
  886. See <<getting-started-search>>.
  887. [role="exclude",id="mapping-root-object-type"]
  888. === Mapping root object type
  889. Mapping types have been removed. See <<mapping>>.
  890. [role="exclude",id="query-dsl-filters"]
  891. === Query DSL filters
  892. See <<query-filter-context>>.
  893. [role="exclude",id="esms"]
  894. === {esms}
  895. We have stopped adding new customers to our {esms}.
  896. If you are interested in similar capabilities, contact
  897. https://support.elastic.co[Elastic Support] to discuss available options.
  898. [role="exclude",id="ilm-with-existing-periodic-indices"]
  899. === Manage existing periodic indices with {ilm-init}
  900. See <<ilm-existing-indices-apply>>.
  901. [role="exclude",id="ilm-reindexing-into-rollover"]
  902. === Reindexing via {ilm-init}
  903. See <<ilm-existing-indices-reindex>>.
  904. [role="exclude",id="analysis-pathhierarchy-tokenizer-examples"]
  905. === Path hierarchy tokenizer examples
  906. See <<analysis-pathhierarchy-tokenizer-detailed-examples>>.
  907. [role="exclude",id="modules-tribe"]
  908. === Tribe node
  909. Tribe node functionality has been removed in favor of {ccs}. See
  910. <<modules-cross-cluster-search>>.
  911. [role="exclude",id="release-highlights-7.0.0"]
  912. === Release highlights
  913. See <<release-highlights>>.
  914. [role="exclude",id="sql-settings"]
  915. === SQL access settings in Elasticsearch
  916. The `xpack.sql.enabled` setting has been deprecated. SQL access is always enabled.
  917. [role="exclude",id="indices-templates"]
  918. === Index templates [[getting]]
  919. See <<index-templates>>.
  920. [role="exclude",id="indices-template-exists"]
  921. === Index template exists (legacy)
  922. See <<indices-template-exists-v1>>.
  923. [role="exclude",id="run-a-search"]
  924. === Run a search
  925. See <<run-an-es-search>>.
  926. [role="exclude",id="how-highlighters-work-internally"]
  927. === How highlighters work internally
  928. See <<how-es-highlighters-work-internally>>.
  929. [role="exclude",id="eql-search"]
  930. === Run an EQL search
  931. See <<run-an-eql-search>>.
  932. [role="exclude",id="eql-limitations"]
  933. === EQL limitations
  934. See <<eql-syntax-limitations>>.
  935. [role="exclude",id="eql-requirements"]
  936. === EQL requirements
  937. See <<eql-required-fields>>.
  938. [role="exclude",id="sql-client-apps-tableau"]
  939. === Tableau Desktop
  940. See <<sql-client-apps-tableau-desktop>> and <<sql-client-apps-tableau-server>>.
  941. [role="exclude",id="search-request-body"]
  942. === Request body search
  943. This page has been removed.
  944. For search API reference documentation, see <<search-search>>.
  945. For search examples, see <<search-your-data>>.
  946. [role="exclude",id="request-body-search-docvalue-fields"]
  947. ==== Doc value fields
  948. See <<docvalue-fields, doc value fields>>.
  949. [role="exclude",id="_fast_check_for_any_matching_docs"]
  950. ==== Fast check for any matching docs
  951. See <<quickly-check-for-matching-docs>>.
  952. [role="exclude",id="request-body-search-collapse"]
  953. ==== Field collapsing
  954. See <<collapse-search-results>>.
  955. [role="exclude",id="request-body-search-from-size"]
  956. ==== From / size
  957. See <<paginate-search-results>>.
  958. [role="exclude",id="request-body-search-highlighting"]
  959. ==== Highlighting
  960. See <<highlighting>>.
  961. [role="exclude",id="highlighter-internal-work"]
  962. ==== How highlighters work internally
  963. See <<how-es-highlighters-work-internally>>.
  964. [role="exclude",id="request-body-search-index-boost"]
  965. ==== Index boost
  966. See <<index-boost>>.
  967. [role="exclude",id="request-body-search-inner-hits"]
  968. ==== Inner hits
  969. See <<inner-hits>>.
  970. [role="exclude",id="request-body-search-min-score"]
  971. ==== `min_score`
  972. See the <<search-api-min-score,`min_score`>> parameter.
  973. [role="exclude",id="request-body-search-queries-and-filters"]
  974. ==== Named queries
  975. See <<named-queries>>.
  976. [role="exclude",id="request-body-search-post-filter"]
  977. ==== Post filter
  978. See <<post-filter>>.
  979. [role="exclude",id="request-body-search-preference"]
  980. ==== Preference
  981. See <<search-preference>>.
  982. [role="exclude",id="request-body-search-rescore"]
  983. ==== Rescoring
  984. See <<rescore>>.
  985. [role="exclude",id="request-body-search-script-fields"]
  986. ==== Script fields
  987. See <<script-fields>>.
  988. [role="exclude",id="request-body-search-scroll"]
  989. ==== Scroll
  990. See <<scroll-search-results>>.
  991. [[_clear_scroll_api]]
  992. ==== Clear scroll API
  993. See <<clear-scroll-api>>.
  994. [[sliced-scroll]]
  995. ==== Sliced scroll
  996. See <<slice-scroll>>.
  997. [role="exclude",id="request-body-search-search-after"]
  998. ==== Search after
  999. See <<search-after>>.
  1000. [role="exclude",id="request-body-search-search-type"]
  1001. ==== Search type
  1002. See <<search-type>>.
  1003. [role="exclude",id="request-body-search-sort"]
  1004. ==== Sort
  1005. See <<sort-search-results>>.
  1006. [role="exclude",id="request-body-search-source-filtering"]
  1007. ==== Source filtering
  1008. See <<source-filtering>>.
  1009. [role="exclude",id="request-body-search-stored-fields"]
  1010. ==== Stored fields
  1011. See <<stored-fields>>.
  1012. [role="exclude",id="request-body-search-track-total-hits"]
  1013. ==== Track total hits
  1014. See <<track-total-hits>>.
  1015. [role="exclude",id="_notes_3"]
  1016. === Joining queries notes
  1017. See <<joining-queries-notes>>.
  1018. [role="exclude",id="_notes_4"]
  1019. === Percolate query notes
  1020. See <<percolate-query-notes>>.
  1021. [role="exclude",id="point-in-time"]
  1022. === Point in time API
  1023. See <<point-in-time-api>>.
  1024. [role="exclude",id="constant-keyword"]
  1025. === Constant keyword field type
  1026. See <<constant-keyword-field-type>>.
  1027. [role="exclude",id="wildcard"]
  1028. === Wildcard field type
  1029. See <<wildcard-field-type>>.
  1030. [role="exclude",id="searchable-snapshots-repository-stats"]
  1031. === Searchable snapshot repository statistics API
  1032. We have removed documentation for this API. This a low-level API used to get
  1033. information about searchable snapshot indices. We plan to remove or drastically
  1034. change this API as part of a future release.
  1035. For other searchable snapshot APIs, see <<searchable-snapshots-apis>>.
  1036. [role="exclude",id="avoid-oversharding"]
  1037. === Avoid oversharding
  1038. See <<size-your-shards>>.
  1039. [role="exclude",id="_parameters_8"]
  1040. === elasticsearch-croneval parameters
  1041. See <<elasticsearch-croneval-parameters>>.
  1042. [role="exclude",id="autoscaling-get-autoscaling-decision"]
  1043. === Autoscaling decision API
  1044. The autoscaling decision API has been renamed to capacity,
  1045. see <<autoscaling-get-autoscaling-capacity>>.
  1046. [role="exclude",id="caching-heavy-aggregations"]
  1047. === Caching heavy aggregations
  1048. See <<agg-caches>>.
  1049. [role="exclude",id="returning-only-agg-results"]
  1050. === Returning only aggregation results
  1051. See <<return-only-agg-results>>.
  1052. [role="exclude",id="agg-metadata"]
  1053. === Aggregation metadata
  1054. See <<add-metadata-to-an-agg>>.
  1055. [role="exclude",id="returning-aggregation-type"]
  1056. === Returning the type of the aggregation
  1057. See <<return-agg-type>>.
  1058. [role="exclude",id="indexing-aggregation-results"]
  1059. === Indexing aggregation results with transforms
  1060. See <<transforms>>.
  1061. [role="exclude",id="search-aggregations-matrix"]
  1062. === Matrix aggregations
  1063. See <<search-aggregations-matrix-stats-aggregation>>.
  1064. [role="exclude",id="search-aggregations-pipeline-movavg-aggregation"]
  1065. === Moving average aggregation
  1066. The moving average aggregation has been removed. Use the
  1067. <<search-aggregations-pipeline-movfn-aggregation,moving function aggregation>>
  1068. instead.
  1069. [role="exclude",id="fielddata"]
  1070. === `fielddata` mapping parameter
  1071. See <<fielddata-mapping-param>>.
  1072. [role="exclude",id="pipeline"]
  1073. === Pipeline definition
  1074. See <<ingest>>.
  1075. [role="exclude",id="accessing-data-in-pipelines"]
  1076. === Accessing data in pipelines
  1077. See <<access-source-fields>>, <<access-metadata-fields>>, and
  1078. <<access-ingest-metadata>>.
  1079. [role="exclude",id="ingest-conditionals"]
  1080. === Conditional execution in pipelines
  1081. See <<conditionally-run-processor>>.
  1082. [role="exclude",id="ingest-conditional-nullcheck"]
  1083. === Handling nested fields in conditionals
  1084. See <<conditionally-run-processor>>.
  1085. [role="exclude",id="ingest-conditional-complex"]
  1086. === Complex conditionals
  1087. See <<conditionally-run-processor>>.
  1088. [role="exclude",id="conditionals-with-multiple-pipelines"]
  1089. === Conditionals with the pipeline processor
  1090. See <<conditionally-apply-pipelines>>.
  1091. [role="exclude",id="conditionals-with-regex"]
  1092. === Conditionals with the regular expressions
  1093. See <<conditionally-run-processor>>.
  1094. [role="exclude",id="handling-failure-in-pipelines"]
  1095. === Handling failures in pipelines
  1096. See <<handling-pipeline-failures>>.
  1097. [role="exclude",id="ingest-processors"]
  1098. === Ingest processors
  1099. See <<processors>>.
  1100. [role="exclude",id="enrich-policy-definition"]
  1101. === Enrich policy definition
  1102. See <<put-enrich-policy-api>>.
  1103. [role="exclude",id="rollup-api"]
  1104. === Rollup API
  1105. See <<rollup-apis>>.
  1106. [role="exclude",id="getting-started-install"]
  1107. === Get {es} up and running
  1108. See <<configuring-stack-security>>.
  1109. [role="exclude",id="getting-started"]
  1110. === Quick start
  1111. See {estc-welcome}/getting-started-general-purpose.html[Set up a general purpose Elastic deployment].
  1112. [role="exclude",id="getting-started-index"]
  1113. === Index some documents
  1114. See {estc-welcome}/getting-started-general-purpose.html#gp-gs-add-data[Add data].
  1115. [role="exclude",id="getting-started-search"]
  1116. === Start searching
  1117. See {estc-welcome}/getting-started-general-purpose.html#gp-gs-search-data[Search and sort data].
  1118. [role="exclude",id="getting-started-aggregations"]
  1119. === Analyze results with aggregations
  1120. See <<search-aggregations>>.
  1121. [role="exclude",id="jvm-options"]
  1122. === Setting JVM options
  1123. See <<set-jvm-options>>.
  1124. [role="exclude",id="terms-enum"]
  1125. === Terms enum API
  1126. See <<search-terms-enum>>.
  1127. [role="exclude",id="frozen-indices"]
  1128. === Frozen indices
  1129. // tag::frozen-index-redirect[]
  1130. For API documentation, see <<unfreeze-index-api>>.
  1131. // end::frozen-index-redirect[]
  1132. [role="exclude",id="best_practices"]
  1133. === Best practices for frozen indices
  1134. include::redirects.asciidoc[tag=frozen-index-redirect]
  1135. [role="exclude",id="searching_a_frozen_index"]
  1136. === Searching a frozen index
  1137. include::redirects.asciidoc[tag=frozen-index-redirect]
  1138. [role="exclude",id="monitoring_frozen_indices"]
  1139. === Monitoring frozen indices
  1140. include::redirects.asciidoc[tag=frozen-index-redirect]
  1141. [role="exclude",id="glossary"]
  1142. === Glossary
  1143. See the {glossary}/terms.html[Elastic glossary].
  1144. [role="exclude",id="multi-index"]
  1145. === Multi-target syntax
  1146. See <<api-multi-index>>.
  1147. [float]
  1148. [[hidden]]
  1149. ==== Hidden data streams and indices
  1150. See <<multi-hidden>>.
  1151. [role="exclude",id="date-math-index-names"]
  1152. === Date math support in system and index alias names
  1153. See <<api-date-math-index-names>>.
  1154. [role="exclude",id="cron-expressions"]
  1155. === Cron expressions
  1156. See <<api-cron-expressions>>.
  1157. [role="exclude",id="url-access-control"]
  1158. === URL-based access control
  1159. See <<api-url-access-control>>.
  1160. [role="exclude",id="indices-field-usage-stats"]
  1161. === Field usage stats API
  1162. See <<field-usage-stats>>.
  1163. [role="exclude",id="security-api-enroll-kibana"]
  1164. === Enroll {kib} API
  1165. See <<security-api-kibana-enrollment>>.
  1166. [role="exclude",id="sql-rest-fields"]
  1167. === Supported REST parameters for SQL search API
  1168. See the <<sql-search-api-request-body,request body parameters>> for the
  1169. <<sql-search-api,SQL search API>>.
  1170. [role="exclude",id="restart-upgrade"]
  1171. === Full cluster restart upgrade
  1172. When upgrading to {es} 8.0 and later, you must first upgrade to {prev-major-last}
  1173. even if you opt to perform a full-cluster restart instead of a rolling upgrade.
  1174. For more information about upgrading, refer to
  1175. {stack-ref}/upgrading-elastic-stack.html[Upgrading to Elastic {version}].
  1176. [role="exclude",id="rolling-upgrades"]
  1177. === Rolling upgrade
  1178. When upgrading to {es} 8.0 and later, you must first upgrade to {prev-major-last}
  1179. whether you opt to perform a rolling upgrade (upgrade one node at a time) or a full-cluster restart upgrade.
  1180. For more information about upgrading, refer to
  1181. {stack-ref}/upgrading-elastic-stack.html[Upgrading to Elastic {version}].
  1182. [role="exclude",id="reindex-upgrade"]
  1183. === Reindex before upgrading
  1184. //tag::upgrade-reindex[]
  1185. Before upgrading to {es} 8.0 and later, you must reindex any indices created in
  1186. a 6.x version. We recommend using the **Upgrade Assistant** to guide you
  1187. through this process.
  1188. For more information about upgrading, refer to
  1189. {stack-ref}/upgrading-elastic-stack.html[Upgrading to Elastic {version}].
  1190. //end::upgrade-reindex[]
  1191. For more information about reindexing, refer to <<docs-reindex>>.
  1192. [role="exclude",id="reindex-upgrade-inplace"]
  1193. === Reindex in place
  1194. include::redirects.asciidoc[tag=upgrade-reindex]
  1195. For more information about reindexing, refer to <<docs-reindex>>.
  1196. [role="exclude",id="reindex-upgrade-remote"]
  1197. === Reindex from a remote cluster
  1198. include::redirects.asciidoc[tag=upgrade-reindex]
  1199. For more information about reindexing from a remote cluster, refer to
  1200. <<reindex-from-remote>>.
  1201. [role="exclude",id="infer-trained-model-deployment"]
  1202. === Infer trained model deployment API
  1203. See <<infer-trained-model>>.
  1204. [role="exclude",id="watching-meetup-data"]
  1205. === Watching event data
  1206. This example has been removed, as the Meetup.com streaming API has been
  1207. discontinued.
  1208. Refer to <<example-watches>> for other Watcher examples.
  1209. [role="exclude",id="disk-usage-exceeded"]
  1210. === Fix watermark errors
  1211. Refer to <<fix-watermark-errors>>.
  1212. [role="exclude",id="dlm-delete-lifecycle"]
  1213. === Delete the lifecycle of a data stream
  1214. Refer to <<data-streams-delete-lifecycle,Delete data stream lifecycle API>>.
  1215. [role="exclude",id="dlm-explain-lifecycle"]
  1216. === Explain the lifecycle of a data stream
  1217. Refer to <<data-streams-explain-lifecycle,Explain data stream lifecycle API>>.
  1218. [role="exclude",id="dlm-get-lifecycle"]
  1219. === Get the lifecycle of a data stream
  1220. Refer to <<data-streams-get-lifecycle,Get data stream lifecycle API>>.
  1221. [role="exclude",id="dlm-put-lifecycle"]
  1222. === Update the lifecycle of a data stream
  1223. Refer to <<data-streams-delete-lifecycle,Update data stream lifecycle API>>.
  1224. [role="exclude",id="get-synonyms"]
  1225. === Get synonyms set API
  1226. See <<get-synonyms-set>>
  1227. [role="exclude",id="delete-synonyms"]
  1228. === Delete synonyms sets API
  1229. See <<delete-synonyms-set>>
  1230. [role="exclude",id="put-synonyms"]
  1231. === Create or delete synonyms sets API
  1232. See <<put-synonyms-set>>
  1233. [role="exclude",id="remote-clusters-api-key"]
  1234. === Add remote clusters using API key authentication
  1235. coming::[8.10]
  1236. [role="exclude",id="remote-clusters-cert"]
  1237. === Add remote clusters using TLS certificate authentication
  1238. coming::[8.10]