OpenSearch/rest-api-spec/api/indices.get.json

52 lines
1.6 KiB
JSON

{
"indices.get":{
"documentation":"http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-index.html",
"methods":[ "GET" ],
"url":{
"path":"/{index}",
"paths":[ "/{index}", "/{index}/{feature}" ],
"parts":{
"index":{
"type":"list",
"required" : true,
"description":"A comma-separated list of index names"
},
"feature":{
"type":"list",
"description":"A comma-separated list of features"
}
},
"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","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)"
},
"human": {
"type": "boolean",
"description": "Whether to return version and creation date values in human-readable format.",
"default": false
}
}
},
"body": null
}
}