OpenSearch/docs/reference/indices/delete-data-stream.asciidoc

62 lines
1.0 KiB
Plaintext
Raw Normal View History

[role="xpack"]
2020-05-15 10:37:45 -04:00
[[indices-delete-data-stream]]
=== Delete data stream API
++++
<titleabbrev>Delete data stream</titleabbrev>
++++
Deletes one or more <<data-streams,data streams>> and their backing
indices. See <<delete-a-data-stream>>.
2020-05-15 10:37:45 -04:00
////
[source,console]
----
PUT /_index_template/template
2020-05-15 10:37:45 -04:00
{
"index_patterns": ["my-data-stream*"],
"template": {
"mappings": {
"properties": {
"@timestamp": {
"type": "date"
}
}
}
},
"data_stream": {
"timestamp_field": "@timestamp"
}
2020-05-15 10:37:45 -04:00
}
PUT /_data_stream/my-data-stream
----
2020-05-15 10:37:45 -04:00
// TESTSETUP
////
[source,console]
----
DELETE /_data_stream/my-data-stream
----
2020-05-15 10:37:45 -04:00
////
[source,console]
----
DELETE /_index_template/template
----
// TEST[continued]
////
2020-05-15 10:37:45 -04:00
[[delete-data-stream-api-request]]
==== {api-request-title}
`DELETE /_data_stream/<data-stream>`
2020-05-15 10:37:45 -04:00
[[delete-data-stream-api-path-params]]
==== {api-path-parms-title}
`<data-stream>`::
(Required, string)
Name of the data stream to delete.
Wildcard (`*`) expressions are supported.