Stops an existing, started rollup job.
This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
If the Elasticsearch security features are enabled, you must have
manage_rollupcluster privileges to use this API. For more information, see Security privileges.
If you try to stop a job that does not exist, an exception occurs. If you try to stop a job that is already stopped, nothing happens.
- (Required, string) Identifier for the rollup job.
(Optional, TimeValue) If
true, the API blocks for (at maximum) the specified duration while waiting for the job to stop. If more than
timeouttime has passed, the API throws a timeout exception. Defaults to
Even if a timeout exception is thrown, the stop request is still processing and eventually moves the job to
STOPPED. The timeout simply means the API call itself timed out while waiting for the status change.
(Optional, Boolean) If set to
true, causes the API to block until the indexer state completely stops. If set to
false, the API returns immediately and the indexer is stopped asynchronously in the background. Defaults to
- This code indicates that there are no resources that match the request. It occurs if you try to stop a job that doesn’t exist.
Since only a stopped job can be deleted, it can be useful to block the API until
the indexer has fully stopped. This is accomplished with the
wait_for_completion query parameter, and optionally a
The parameter blocks the API call from returning until either the job has moved
STOPPED or the specified time has elapsed. If the specified time elapses
without the job moving to
STOPPED, a timeout exception is thrown.