Get the rollup index capabilities Technical preview

GET /{index}/_rollup/data

Get the rollup capabilities of all jobs inside of a rollup index. A single rollup index may store the data for multiple rollup jobs and may have a variety of capabilities depending on those jobs. This API enables you to determine:

  • What jobs are stored in an index (or indices specified via a pattern)?
  • What target indices were rolled up, what fields were used in those rollups, and what aggregations can be performed on each job?

Path parameters

  • index string | array[string] Required

    Data stream or index to check for rollup capabilities. Wildcard (*) expressions are supported.

Responses

  • 200 application/json
    Hide response attribute Show response attribute object
    • * object Additional properties

      Additional properties are allowed.

      Hide * attribute Show * attribute object
      • rollup_jobs array[object] Required
        Hide rollup_jobs attributes Show rollup_jobs attributes object
GET /{index}/_rollup/data 
curl \
 -X GET http://api.example.com/{index}/_rollup/data
Response examples (200) 
{
  "additionalProperty1": {
    "rollup_jobs": [
      {
        "fields": {
          "additionalProperty1": [
            {}
          ],
          "additionalProperty2": [
            {}
          ]
        },
        "index_pattern": "string",
        "job_id": "string",
        "rollup_index": "string"
      }
    ]
  },
  "additionalProperty2": {
    "rollup_jobs": [
      {
        "fields": {
          "additionalProperty1": [
            {}
          ],
          "additionalProperty2": [
            {}
          ]
        },
        "index_pattern": "string",
        "job_id": "string",
        "rollup_index": "string"
      }
    ]
  }
}