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

36 lines
1.2 KiB
JSON

{
"indices.put_alias": {
"documentation": "http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/indices-aliases.html",
"methods": ["PUT", "POST"],
"url": {
"path": "/{index}/_alias/{name}",
"paths": ["/{index}/_alias/{name}", "/_alias/{name}", "/{index}/_aliases/{name}", "/_aliases/{name}"],
"parts": {
"index": {
"type" : "list",
"description" : "A comma-separated list of index names the alias should point to (supports wildcards); use `_all` or omit to perform the operation on all indices."
},
"name": {
"type" : "string",
"required" : true,
"description" : "The name of the alias to be created or updated"
}
},
"params": {
"timeout": {
"type" : "time",
"description" : "Explicit timestamp for the document"
},
"master_timeout": {
"type" : "time",
"description" : "Specify timeout for connection to master"
}
}
},
"body": {
"description" : "The settings for the alias, such as `routing` or `filter`",
"required" : false
}
}
}