IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

« Create data stream API Get data stream API »

› › ›

Delete data stream API

edit

Delete data stream API

edit

Deletes one or more data streams and their backing indices. See Delete a data stream.

resp = client.indices.delete_data_stream(
    name="my-data-stream",
)
print(resp)

response = client.indices.delete_data_stream(
  name: 'my-data-stream'
)
puts response

const response = await client.indices.deleteDataStream({
  name: "my-data-stream",
});
console.log(response);

DELETE /_data_stream/my-data-stream

Request

edit

DELETE /_data_stream/<data-stream>

Prerequisites

edit

If the Elasticsearch security features are enabled, you must have the delete_index or manage index privilege for the data stream.

Path parameters

edit

<data-stream>: (Required, string) Comma-separated list of data streams to delete. Wildcard (*) expressions are supported.

Query parameters

edit

expand_wildcards

(Optional, string) Type of data stream that wildcard patterns can match. Supports comma-separated values, such as open,hidden. Valid values are:

all, hidden: Match any data stream, including hidden ones.
open, closed: Matches any non-hidden data stream. Data streams cannot be closed.
none: Wildcard patterns are not accepted.

Defaults to open.

« Create data stream API Get data stream API »