Index rollups API

Introduced 1.0

Creates or updates an index rollup job. You must provide the and primary_term parameters.

Request

You can specify the following options.

Sample response

  1. {
  2.   "_id": "rollup_id",
  3.   "_primaryTerm": 1,
  4.   "rollup": { ... }
  5. }

Returns all information about an index rollup job based on the rollup_id.

Request

  1. GET _plugins/_rollup/jobs/<rollup_id>

Sample response

Introduced 1.0

Deletes an index rollup job based on the rollup_id.

Request

  1. DELETE _plugins/_rollup/jobs/<rollup_id>

Sample response

  1. 200 OK

Start or stop an index rollup job.

Request

Sample response

  1. 200 OK

Introduced 1.0

Returns detailed metadata information about the index rollup job and its current progress.

Request

  1. GET _plugins/_rollup/jobs/<rollup_id>/_explain

Sample response