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

Start rollup jobs API

edit

Starts an existing, stopped rollup job.

This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.

For version 8.5 and above we recommend downsampling over rollups as a way to reduce your storage costs for time series data.

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:

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

POST _rollup/job/sensor/_start

Which will return the response:

{
  "started": true
}

« Rollup search Stop rollup jobs API »