post-pause-follow.asciidoc 1.6 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970
  1. [role="xpack"]
  2. [testenv="platinum"]
  3. [[ccr-post-pause-follow]]
  4. === Pause Follower API
  5. ++++
  6. <titleabbrev>Pause Follower</titleabbrev>
  7. ++++
  8. beta[]
  9. Pauses a follower index.
  10. ==== Description
  11. This API pauses a follower index. When this API returns, the follower index will
  12. not fetch any additional operations from the leader index. You can resume
  13. following with the <<ccr-post-resume-follow,resume follower API>>. Pausing and
  14. resuming a follower index can be used to change the configuration of the
  15. following task.
  16. ==== Request
  17. //////////////////////////
  18. [source,js]
  19. --------------------------------------------------
  20. PUT /follower_index/_ccr/follow
  21. {
  22. "remote_cluster" : "remote_cluster",
  23. "leader_index" : "leader_index"
  24. }
  25. --------------------------------------------------
  26. // CONSOLE
  27. // TESTSETUP
  28. // TEST[setup:remote_cluster_and_leader_index]
  29. //////////////////////////
  30. [source,js]
  31. --------------------------------------------------
  32. POST /<follower_index>/_ccr/pause_follow
  33. --------------------------------------------------
  34. // CONSOLE
  35. // TEST[s/<follower_index>/follower_index/]
  36. ==== Path Parameters
  37. `follower_index` (required)::
  38. (string) the name of the follower index
  39. ==== Example
  40. This example pauses a follower index named `follower_index`:
  41. [source,js]
  42. --------------------------------------------------
  43. POST /follower_index/_ccr/pause_follow
  44. --------------------------------------------------
  45. // CONSOLE
  46. // TEST
  47. The API returns the following result:
  48. [source,js]
  49. --------------------------------------------------
  50. {
  51. "acknowledged" : true
  52. }
  53. --------------------------------------------------
  54. // TESTRESPONSE