Start rollup jobs APIedit
Deprecated in 8.11.0.
Rollups will be removed in a future version. Use downsampling instead.
Starts an existing, stopped rollup job.
Requestedit
POST _rollup/job/<job_id>/_start
Prerequisitesedit
-
If the Elasticsearch security features are enabled, you must have
manageormanage_rollupcluster 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:
response = client.rollup.start_job( id: 'sensor' ) puts response
POST _rollup/job/sensor/_start
Which will return the response:
{
"started": true
}