Start rollup jobs API

» » »

Start rollup jobs API

Starts an existing, stopped rollup job.

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

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:

POST _rollup/job/sensor/_start

Which will return the response:

{
  "started": true
}

« Rollup search Stop rollup jobs API »