v1

latestOpenAPI 3.0.1Apache 2.02026-07-17427669.7 KB

Searches the index and deletes all matched documents

post/es/{index}/_delete_by_query

Path parameters

indexstring required

Index

Request body

_sourcestring[]

true, false, ["field1", "field2.*"]

aggsobject

explainboolean

fieldsstring[]

["field1", "field2.*", {"field": "fieldName", "format": "epoch_millis"}]

frominteger

sizeinteger

sortstring[]

"_sorce", ["+Year","-Year", {"Year": "desc"}, "Date": {"order": "asc"", "format": "yyyy-MM-dd"}}"}]

timeoutinteger

track_total_hitsboolean

Response

batchesinteger

deletedinteger

failuresstring[]

noopsinteger

requests_per_secondinteger

throttled_millisinteger

throttled_until_millisinteger

time_outboolean

tookinteger

totalinteger

version_conflictsinteger

Example response

{
  "batches": 0,
  "retries": {
    "search": 2,
    "bulk": 5
  },
  "throttled_millis": 7,
  "took": 3,
  "total": 2,
  "deleted": 6,
  "failures": [
    "failures",
    "failures"
  ],
  "noops": 1,
  "requests_per_second": 5,
  "version_conflicts": 4,
  "throttled_until_millis": 9,
  "time_out": true
}