Path parameters

• index string | array[string] Required

  Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (*). By default, you must explicitly name the indices you using to limit the request. To limit a request using _all, *, or other wildcard expressions, change the action.destructive_requires_name setting to false. You can update this setting in the elasticsearch.yml file or using the cluster update settings API.

Query parameters

• allow_no_indices boolean

  If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices.

• expand_wildcards string | array[string]

  Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as open,hidden. Valid values are: all, open, closed, hidden, none.

• ignore_unavailable boolean

  If false, the request returns an error if it targets a missing or closed index.

• master_timeout string

  Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

• timeout string

  Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

• wait_for_active_shards number | string

  The number of shard copies that must be active before proceeding with the operation. Set to all or any positive integer up to the total number of shards in the index (number_of_replicas+1).

Responses

• 200 application/json
  Hide response attributes Show response attributes object

  • acknowledged boolean Required
  • shards_acknowledged boolean Required