promote-data-stream-api.asciidoc 1.3 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243
  1. [role="xpack"]
  2. [[promote-data-stream-api]]
  3. === Promote data stream API
  4. ++++
  5. <titleabbrev>Promote data stream</titleabbrev>
  6. ++++
  7. The purpose of the promote data stream api is to turn
  8. a data stream that is replicated by CCR into a regular
  9. data stream.
  10. Via CCR Auto Following, a data stream from a remote cluster
  11. can be replicated to the local cluster. These data streams
  12. can't be rolled over in the local cluster. Only if the upstream
  13. data stream rolls over then these replicated data streams roll
  14. over as well. In the event that the remote cluster is no longer
  15. available, the data stream in the local cluster can be promoted
  16. to a regular data stream, which allows these data streams to
  17. be rolled over in the local cluster.
  18. [source,console]
  19. ----
  20. POST /_data_stream/_promote/my-data-stream
  21. ----
  22. // TEST[catch:missing]
  23. [[promote-data-stream-api-request]]
  24. ==== {api-request-title}
  25. `POST /_data_stream/_promote/<data-stream>`
  26. [[promote-data-stream-api-prereqs]]
  27. ==== {api-prereq-title}
  28. * If the {es} {security-features} are enabled, you must have the `manage_follow_index`
  29. <<privileges-list-cluster,cluster privilege>> to use this API.
  30. [[promote-data-stream-api-path-params]]
  31. ==== {api-path-parms-title}
  32. `<data-stream>`::
  33. (Required, string)
  34. The name of the data stream to promote.