--
:api: rollup-stop-job
:request: StopRollupJobRequest
:response: StopRollupJobResponse
--
[role="xpack"]
[id="{upid}-{api}"]
=== Stop Rollup Job API

experimental::[]

[id="{upid}-{api}-request"]
==== Request

The Stop Rollup Job API allows you to stop a job by ID.

["source","java",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{doc-tests-file}[{api}-request]
--------------------------------------------------
<1> The ID of the job to stop.
<2> Whether the request should wait that the stop operation has completed
before returning (optional, defaults to `false`)
<3> If `wait_for_completion=true`, this parameter controls how long to wait
before giving up and throwing an error (optional, defaults to 30 seconds).


[id="{upid}-{api}-response"]
==== Response

The returned +{response}+ indicates if the stop command was received.

["source","java",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{doc-tests-file}[{api}-response]
--------------------------------------------------
<1> Whether or not the stop job request was received.

include::../execution.asciidoc[]


