rest-api-spec.api.indices.get_settings.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
Show all versions of rest-api-spec Show documentation
OpenSearch subproject :rest-api-spec
{
"indices.get_settings":{
"documentation":{
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-settings.html",
"description":"Returns settings for one or more indices."
},
"stability":"stable",
"url":{
"paths":[
{
"path":"/_settings",
"methods":[
"GET"
]
},
{
"path":"/{index}/_settings",
"methods":[
"GET"
],
"parts":{
"index":{
"type":"list",
"description":"A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices"
}
}
},
{
"path":"/{index}/_settings/{name}",
"methods":[
"GET"
],
"parts":{
"index":{
"type":"list",
"description":"A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices"
},
"name":{
"type":"list",
"description":"The name of the settings that should be included"
}
}
},
{
"path":"/_settings/{name}",
"methods":[
"GET"
],
"parts":{
"name":{
"type":"list",
"description":"The name of the settings that should be included"
}
}
}
]
},
"params":{
"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"
},
"ignore_unavailable":{
"type":"boolean",
"description":"Whether specified concrete indices should be ignored when unavailable (missing or closed)"
},
"allow_no_indices":{
"type":"boolean",
"description":"Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)"
},
"expand_wildcards":{
"type":"enum",
"options":[
"open",
"closed",
"hidden",
"none",
"all"
],
"default": "all",
"description":"Whether to expand wildcard expression to concrete indices that are open, closed or both."
},
"flat_settings":{
"type":"boolean",
"description":"Return settings in flat format (default: false)"
},
"local":{
"type":"boolean",
"description":"Return local information, do not retrieve the state from master node (default: false)"
},
"include_defaults":{
"type":"boolean",
"description":"Whether to return all default setting for each of the indices.",
"default":false
}
}
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy