slm-start.asciidoc 1.2 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152
  1. [role="xpack"]
  2. [[slm-api-start]]
  3. === Start {slm} API
  4. [subs="attributes"]
  5. ++++
  6. <titleabbrev>Start {slm}</titleabbrev>
  7. ++++
  8. Turns on {slm} ({slm-init}).
  9. [[slm-api-start-request]]
  10. ==== {api-request-title}
  11. `POST /_slm/start`
  12. [[slm-api-start-prereqs]]
  13. ==== {api-prereq-title}
  14. If the {es} {security-features} are enabled, you must have the `manage_slm`
  15. cluster privilege to use this API. For more information, see
  16. <<security-privileges>>.
  17. [[slm-api-start-desc]]
  18. ==== {api-description-title}
  19. Starts the {slm-init} plugin if it's not running.
  20. {slm-init} starts automatically when a cluster is formed.
  21. Manually starting {slm-init} is only necessary if it has been stopped using the <<slm-api-stop>>.
  22. ==== {api-query-parms-title}
  23. include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
  24. [[slm-api-start-example]]
  25. ==== {api-examples-title}
  26. Start the {slm-init} plugin:
  27. [source,console]
  28. --------------------------------------------------
  29. POST _slm/start
  30. --------------------------------------------------
  31. If successful, this request returns:
  32. [source,console-result]
  33. --------------------------------------------------
  34. {
  35. "acknowledged": true
  36. }
  37. --------------------------------------------------