mirror of
https://github.com/elastic/elasticsearch.git
synced 2025-06-28 09:28:55 -04:00
33a71e3289
* Remove `es-test-dir` book-scoped variable * Remove `plugins-examples-dir` book-scoped variable * Remove `:dependencies-dir:` and `:xes-repo-dir:` book-scoped variables - In `index.asciidoc`, two variables (`:dependencies-dir:` and `:xes-repo-dir:`) were removed. - In `sql/index.asciidoc`, the `:sql-tests:` path was updated to fuller path - In `esql/index.asciidoc`, the `:esql-tests:` path was updated idem * Replace `es-repo-dir` with `es-ref-dir` * Move `:include-xpack: true` to few files that use it, remove from index.asciidoc
52 lines
1.2 KiB
Text
52 lines
1.2 KiB
Text
[role="xpack"]
|
|
[[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::{es-ref-dir}/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
|
|
}
|
|
--------------------------------------------------
|