slm-get-status.asciidoc

Get {slm} status API

Get {slm} status

Retrieves the status of {slm} ({slm-init}).

{api-request-title}

GET /_slm/status

{api-description-title}

Returns the status of the {slm-init} plugin. The operation_mode field in the response shows one of three states: RUNNING, STOPPING, or STOPPED. You halt and restart the {slm-init} plugin with the stop and start APIs.

{api-query-parms-title}

{es-repo-dir}/rest-api/common-parms.asciidoc

{api-prereq-title}

If the {es} {security-features} are enabled, you must have the manage_slm or read_slm cluster privileges to use this API. For more information, see [security-privileges].

{api-examples-title}

GET _slm/status

The API returns the following result:

{
  "operation_mode": "RUNNING"
}