summaryrefslogtreecommitdiff
path: root/rest-api-spec/api/cat.indices.json
blob: 55fb1c6598e2e888011f930cff101bd9584e44df (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
{
  "cat.indices": {
    "documentation": "http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cat-indices.html",
    "methods": ["GET"],
    "url": {
      "path": "/_cat/indices",
      "paths": ["/_cat/indices", "/_cat/indices/{index}"],
      "parts": {
        "index": {
          "type" : "list",
          "description": "A comma-separated list of index names to limit the returned information"
        }
      },
      "params": {
        "bytes": {
          "type": "enum",
          "description" : "The unit in which to display byte values",
          "options": [ "b", "k", "m", "g" ]
        },
        "local": {
          "type" : "boolean",
          "description" : "Return local information, do not retrieve the state from master node (default: false)"
        },
        "master_timeout": {
          "type" : "time",
          "description" : "Explicit operation timeout for connection to master node"
        },
        "h": {
            "type": "list",
            "description" : "Comma-separated list of column names to display"
        },
        "help": {
          "type": "boolean",
          "description": "Return help information",
          "default": false
        },
        "pri" : {
          "type": "boolean",
          "description": "Set to true to return stats only for primary shards",
          "default": false
        },
        "v": {
          "type": "boolean",
          "description": "Verbose mode. Display column headers",
          "default": false
        }
      }
    },
    "body": null
  }
}