Stops an existing, started rollup job Technical preview

POST /_rollup/job/{id}/_stop

Path parameters

  • id string Required

    Identifier for the rollup job.

Query parameters

  • timeout string

    If wait_for_completion is true, the API blocks for (at maximum) the specified duration while waiting for the job to stop. If more than timeout time has passed, the API throws a timeout exception.

  • wait_for_completion 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.

Responses

  • 200 application/json
    Hide response attribute Show response attribute object
POST /_rollup/job/{id}/_stop 
curl \
 -X POST http://api.example.com/_rollup/job/{id}/_stop
Response examples (200) 
{
  "stopped": true
}