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

45 lines
1.4 KiB
JSON

{
"indices.put_template": {
"documentation": "http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/indices-templates.html",
"methods": ["PUT", "POST"],
"url": {
"path": "/_template/{name}",
"paths": ["/_template/{name}"],
"parts": {
"name": {
"type" : "string",
"required" : true,
"description" : "The name of the template"
}
},
"params": {
"order": {
"type" : "number",
"description" : "The order for this template when merging multiple matching ones (higher numbers are merged later, overriding the lower numbers)"
},
"create" : {
"type" : "boolean",
"description" : "Whether the index template should only be added if new or can also replace an existing one",
"default" : false
},
"timeout": {
"type" : "time",
"description" : "Explicit operation timeout"
},
"master_timeout": {
"type" : "time",
"description" : "Specify timeout for connection to master"
},
"flat_settings": {
"type": "boolean",
"description": "Return settings in flat format (default: false)"
}
}
},
"body": {
"description" : "The template definition",
"required" : true
}
}
}