Start rollup jobs API

Start rollup jobs API

Deprecated in 8.11.0.

Rollups will be removed in a future version. Use downsampling instead.

New API reference

For the most up-to-date API details, refer to Rollup APIs.

Starts an existing, stopped rollup job.

Request

POST _rollup/job/<job_id>/_start

Prerequisites

  • If the Elasticsearch security features are enabled, you must have manage or manage_rollup cluster privileges to use this API. For more information, see Security privileges.

Description

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 parameters

<job_id>

(Required, string) Identifier for the rollup job.

Response codes

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.

Examples

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

  1. resp = client.rollup.start_job(
  2. id="sensor",
  3. )
  4. print(resp)
  1. response = client.rollup.start_job(
  2. id: 'sensor'
  3. )
  4. puts response
  1. const response = await client.rollup.startJob({
  2. id: "sensor",
  3. });
  4. console.log(response);
  1. POST _rollup/job/sensor/_start

Which will return the response:

  1. {
  2. "started": true
  3. }