slm-start.asciidoc 1.2 KB

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