unfollow.asciidoc 1009 B

123456789101112131415161718192021222324252627282930313233343536
  1. --
  2. :api: ccr-unfollow
  3. :request: UnfollowRequest
  4. :response: AcknowledgedResponse
  5. --
  6. [role="xpack"]
  7. [id="{upid}-{api}"]
  8. === Unfollow API
  9. [id="{upid}-{api}-request"]
  10. ==== Request
  11. The Unfollow API allows you to unfollow a follower index and make it a regular index.
  12. Note that the follower index needs to be paused and the follower index needs to be closed.
  13. ["source","java",subs="attributes,callouts,macros"]
  14. --------------------------------------------------
  15. include-tagged::{doc-tests-file}[{api}-request]
  16. --------------------------------------------------
  17. <1> The name of follow index to unfollow.
  18. [id="{upid}-{api}-response"]
  19. ==== Response
  20. The returned +{response}+ indicates if the unfollow request was received.
  21. ["source","java",subs="attributes,callouts,macros"]
  22. --------------------------------------------------
  23. include-tagged::{doc-tests-file}[{api}-response]
  24. --------------------------------------------------
  25. <1> Whether or not the unfollow was acknowledge.
  26. include::../execution.asciidoc[]