rest-api-spec.api.indices.get.json Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of rest-api-spec Show documentation

OpenSearch subproject :rest-api-spec

There is a newer version: 2.18.0

{
  "indices.get":{
    "documentation":{
      "url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-index.html",
      "description":"Returns information about one or more indices."
    },
    "stability":"stable",
    "url":{
      "paths":[
        {
          "path":"/{index}",
          "methods":[
            "GET"
          ],
          "parts":{
            "index":{
              "type":"list",
              "description":"A comma-separated list of index names"
            }
          }
        }
      ]
    },
    "params":{
      "local":{
        "type":"boolean",
        "description":"Return local information, do not retrieve the state from master node (default: false)"
      },
      "ignore_unavailable":{
        "type":"boolean",
        "description":"Ignore unavailable indexes (default: false)"
      },
      "allow_no_indices":{
        "type":"boolean",
        "description":"Ignore if a wildcard expression resolves to no concrete indices (default: false)"
      },
      "expand_wildcards":{
        "type":"enum",
        "options":[
          "open",
          "closed",
          "hidden",
          "none",
          "all"
        ],
        "default":"open",
        "description":"Whether wildcard expressions should get expanded to open or closed indices (default: open)"
      },
      "flat_settings":{
        "type":"boolean",
        "description":"Return settings in flat format (default: false)"
      },
      "include_defaults":{
        "type":"boolean",
        "description":"Whether to return all default setting for each of the indices.",
        "default":false
      },
      "master_timeout":{
        "type":"time",
        "description":"Specify timeout for connection to master",
        "deprecated":{
          "version":"2.0.0",
          "description":"To promote inclusive language, use 'cluster_manager_timeout' instead."
        }
      },
      "cluster_manager_timeout":{
        "type":"time",
        "description":"Specify timeout for connection to cluster-manager node"
      }
    }
  }
}