IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

› › ›

Start rollup jobs API

edit

IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.

Start rollup jobs API

edit

Deprecated in 8.11.0.

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

Starts an existing, stopped rollup job.

Request

edit

POST _rollup/job/<job_id>/_start

Prerequisites

edit

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

edit

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

edit

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

Response codes

edit

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

edit

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

resp = client.rollup.start_job(
    id="sensor",
)
print(resp)

response = client.rollup.start_job(
  id: 'sensor'
)
puts response

const response = await client.rollup.startJob({
  id: "sensor",
});
console.log(response);

POST _rollup/job/sensor/_start

Which will return the response:

{
  "started": true
}

« Rollup search Stop rollup jobs API »