elasticsearch/docs/reference/data-streams/data-stream-apis.asciidoc
Mary Gouseti 2122da31cd
[DSL] Introduce data stream global retention - Part 3 (#105682)
In this PR we introduce the API that will expose the global retention configuration and will allow users to take advantage of it.

These APIs are protected by the dedicated introduced privileges:

`manage_data_stream_global_retention` or higher, which allows all operations on the global retention configuration
`monitor_data_stream_retention` or higher, which allows the retrieval of the global retention configuration.

This PR is the final PR that makes the global retention available for our users.
2024-03-28 10:40:33 +02:00

74 lines
2.5 KiB
Text

[role="xpack"]
[[data-stream-apis]]
== Data stream APIs
The following APIs are available for managing <<data-streams,data streams>>:
* <<indices-create-data-stream>>
* <<indices-delete-data-stream>>
* <<indices-get-data-stream>>
* <<indices-migrate-to-data-stream>>
* <<data-stream-stats-api>>
* <<promote-data-stream-api>>
* <<modify-data-streams-api>>
[[data-stream-lifecycle-api]]
The following APIs are available for managing the built-in lifecycle of data streams:
preview::[]
* <<data-streams-put-lifecycle,Update data stream lifecycle>>
preview:[]
* <<data-streams-get-lifecycle,Get data stream lifecycle>>
preview:[]
* <<data-streams-delete-lifecycle,Delete data stream lifecycle>>
preview:[]
* <<data-streams-explain-lifecycle,Explain data stream lifecycle>>
preview:[]
* <<data-streams-get-lifecycle-stats,Get data stream lifecycle stats>>
preview:[]
* <<data-streams-put-global-retention,Update the global retention for data stream lifecycle managed data streams>>
preview:[]
* <<data-streams-get-global-retention,Get the global retention for data stream lifecycle managed data streams>>
preview:[]
* <<data-streams-delete-global-retention,Delete the global retention for data stream lifecycle managed data streams>>
preview:[]
The following API is available for <<tsds,time series data streams>>:
* <<indices-downsample-data-stream>>
For concepts and tutorials, see <<data-streams>>.
include::{es-repo-dir}/indices/create-data-stream.asciidoc[]
include::{es-repo-dir}/indices/delete-data-stream.asciidoc[]
include::{es-repo-dir}/indices/get-data-stream.asciidoc[]
include::{es-repo-dir}/indices/migrate-to-data-stream.asciidoc[]
include::{es-repo-dir}/indices/data-stream-stats.asciidoc[]
include::{es-repo-dir}/data-streams/promote-data-stream-api.asciidoc[]
include::{es-repo-dir}/data-streams/modify-data-streams-api.asciidoc[]
include::{es-repo-dir}/data-streams/lifecycle/apis/put-lifecycle.asciidoc[]
include::{es-repo-dir}/data-streams/lifecycle/apis/get-lifecycle.asciidoc[]
include::{es-repo-dir}/data-streams/lifecycle/apis/delete-lifecycle.asciidoc[]
include::{es-repo-dir}/data-streams/lifecycle/apis/explain-lifecycle.asciidoc[]
include::{es-repo-dir}/data-streams/lifecycle/apis/get-lifecycle-stats.asciidoc[]
include::{es-repo-dir}/data-streams/lifecycle/apis/put-global-retention.asciidoc[]
include::{es-repo-dir}/data-streams/lifecycle/apis/get-global-retention.asciidoc[]
include::{es-repo-dir}/data-streams/lifecycle/apis/delete-global-retention.asciidoc[]
include::{es-repo-dir}/indices/downsample-data-stream.asciidoc[]