Start rollup jobs APIedit

Starts an existing, stopped rollup job.

This functionality is experimental and may be changed or removed completely in a future release. Elastic will take a best effort approach to fix any issues, but experimental features are not subject to the support SLA of official GA features.

Requestedit

POST _rollup/job/<job_id>/_start

Prerequisitesedit

  • You must have manage or manage_rollup cluster privileges to use this API. For more information, see Security privileges.

Descriptionedit

If you try to start a job that does not exist, an exception occurs. If you try to start a job that is already started, nothing happens.

Path parametersedit

<job_id>
(Required, string) Identifier for the rollup job.

Response codesedit

404 (Missing resources)
This code indicates that there are no resources that match the request. It occurs if you try to start a job that doesn’t exist.

Examplesedit

If we have already created a rollup job named sensor, it can be started with:

POST _rollup/job/sensor/_start

Which will return the response:

{
  "started": true
}