OpenSearch/rest-api-spec/api/delete_by_query.json

55 lines
1.6 KiB
JSON

{
"delete_by_query": {
"documentation": "http://www.elasticsearch.org/guide/reference/api/delete-by-query/",
"methods": ["DELETE"],
"url": {
"path": "/{index}/_query",
"paths": ["/{index}/_query", "/{index}/{type}/_query"],
"parts": {
"index": {
"type" : "list",
"description" : "A comma-separated list of indices to restrict the operation"
},
"type": {
"type" : "list",
"description" : "A comma-separated list of types to restrict the operation"
}
},
"params": {
"consistency": {
"type" : "enum",
"options" : ["one", "quorum", "all"],
"description" : "Specific write consistency setting for the operation"
},
"ignore_indices": {
"type" : "enum",
"options" : ["none","missing"],
"default" : "none",
"description" : "When performed on multiple indices, allows to ignore `missing` ones"
},
"replication": {
"type" : "enum",
"options" : ["sync","async"],
"default" : "sync",
"description" : "Specific replication type"
},
"routing": {
"type" : "string",
"description" : "Specific routing value"
},
"source": {
"type" : "string",
"description" : "The URL-encoded query definition (instead of using the request body)"
},
"timeout": {
"type" : "time",
"description" : "Explicit operation timeout"
}
}
},
"body": {
"description" : "A query to restrict the operation"
}
}
}