slm-start.asciidoc 1.2 KB

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