Get the rollup job capabilities

GET /_rollup/data/{id}
GET /_rollup/data

Auth

Deprecated

Get the capabilities of any rollup jobs that have been configured for a specific index or index pattern.

This API is useful because a rollup job is often configured to rollup only a subset of fields from the source index. Furthermore, only certain aggregations can be configured for various fields, leading to a limited subset of functionality depending on that configuration. This API enables you to inspect an index and determine:

Does this index have associated rollup data somewhere in the cluster?
If yes to the first question, what fields were rolled up, what aggregations can be performed, and where does the data live?

Required authorization

Cluster privileges monitor_rollup

Path parameters

id string optional

Index, indices or index-pattern to return rollup capabilities for. _all may be used to fetch rollup capabilities from all jobs.

Leave it out to use /_rollup/data.

Response

application/json

<string> object

Examples

Request Console 1 / 8 languages

Console Kibana Dev Tools

GET _rollup/data/sensor-*

JavaScript Elasticsearch JavaScript Client

const response = await client.rollup.getRollupCaps({
  id: "sensor-*",
});

Python Elasticsearch Python Client

resp = client.rollup.get_rollup_caps(
    id="sensor-*",
)

curl Shell

curl -X GET "$ELASTICSEARCH_URL/_rollup/data/sensor-*" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.rollup().getRollupCaps(g -> g
    .id("sensor-*")
);

C# Elasticsearch .NET Client

var response = await client.Rollup
    .GetRollupCapsAsync(d1 => d1
        .Id("sensor-*")
    );

PHP Elasticsearch PHP Client

$resp = $client->rollup()->getRollupCaps([
    "id" => "sensor-*",
]);

Ruby Elasticsearch Ruby Client

response = client.perform_request(
  "GET",
  "/_rollup/data/sensor-*",
  {},
)

Response

A successful response from GET _rollup/data/sensor-* for a rollup job that targets the index pattern sensor-*. The response contains the rollup job ID, the index that holds the rolled data, and the index pattern that the job was targeting. It also shows a list of fields that contain data eligible for rollup searches. For example, you can use a min, max, or sum aggregation on the temperature field, but only a date_histogram on timestamp.

{
  "sensor-*" : {
    "rollup_jobs" : [
      {
        "job_id" : "sensor",
        "rollup_index" : "sensor_rollup",
        "index_pattern" : "sensor-*",
        "fields" : {
          "node" : [
            {
              "agg" : "terms"
            }
          ],
          "temperature" : [
            {
              "agg" : "min"
            },
            {
              "agg" : "max"
            },
            {
              "agg" : "sum"
            }
          ],
          "timestamp" : [
            {
              "agg" : "date_histogram",
              "time_zone" : "UTC",
              "fixed_interval" : "1h",
              "delay": "7d"
            }
          ],
          "voltage" : [
            {
              "agg" : "avg"
            }
          ]
        }
      }
    ]
  }
}