mirror of
https://github.com/honeymoose/OpenSearch.git
synced 2025-02-14 00:45:30 +00:00
c0156cbb5d
* [DOCS] Align with ILM API docs (#48705) * [DOCS] Reconciled with Snapshot/Restore reorg * [DOCS] Split off ILM overview to a separate topic. (#51287) * [DOCS} Split off overview to a separate topic. * [DOCS] Incorporated feedback from @jrodewig. * [DOCS] Edit ILM GS tutorial (#51513) * [DOCS] Edit ILM GS tutorial * [DOCS] Incorporated review feedback from @andreidan. * [DOCS] Removed test link & fixed anchor & title. * Update docs/reference/ilm/getting-started-ilm.asciidoc Co-Authored-By: James Rodewig <james.rodewig@elastic.co> * Fixed glossary merge error. Co-authored-by: James Rodewig <james.rodewig@elastic.co>
51 lines
1.2 KiB
Plaintext
51 lines
1.2 KiB
Plaintext
[[slm-api-start]]
|
|
=== Start {slm} API
|
|
|
|
[subs="attributes"]
|
|
++++
|
|
<titleabbrev>Start {slm}</titleabbrev>
|
|
++++
|
|
|
|
Turns on {slm} ({slm-init}).
|
|
|
|
[[slm-api-start-request]]
|
|
==== {api-request-title}
|
|
|
|
`POST /_slm/start`
|
|
|
|
[[slm-api-start-prereqs]]
|
|
==== {api-prereq-title}
|
|
|
|
If the {es} {security-features} are enabled, you must have the `manage_slm`
|
|
cluster privilege to use this API. For more information, see
|
|
<<security-privileges>>.
|
|
|
|
[[slm-api-start-desc]]
|
|
==== {api-description-title}
|
|
|
|
Starts the {slm-init} plugin if it's not running.
|
|
{slm-init} starts automatically when a cluster is formed.
|
|
Manually starting {slm-init} is only necessary if it has been stopped using the <<slm-api-stop>>.
|
|
|
|
==== {api-query-parms-title}
|
|
|
|
include::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
|
|
|
|
[[slm-api-start-example]]
|
|
==== {api-examples-title}
|
|
|
|
Start the {slm-init} plugin:
|
|
|
|
[source,console]
|
|
--------------------------------------------------
|
|
POST _slm/start
|
|
--------------------------------------------------
|
|
|
|
If successful, this request returns:
|
|
|
|
[source,console-result]
|
|
--------------------------------------------------
|
|
{
|
|
"acknowledged": true
|
|
}
|
|
-------------------------------------------------- |