You are looking at preliminary documentation for a future release.
Not what you want? See the
current release documentation.
Start legacy rollup jobs APIedit
This documentation is about legacy rollups. Legacy rollups are deprecated and will be replaced by new rollup functionality introduced in Elasticsearch 7.x.
Starts a stopped legacy rollup job.
Requestedit
POST _rollup/job/<job_id>/_start
Prerequisitesedit
-
If the Elasticsearch security features are enabled, you must have
manage
ormanage_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 }