ccr-apis.asciidoc 1.8 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758
  1. [role="xpack"]
  2. [[ccr-apis]]
  3. == {ccr-cap} APIs
  4. .New API reference
  5. [sidebar]
  6. --
  7. For the most up-to-date API details, refer to {api-es}/group/endpoint-ccr[Cross-cluster replication APIs].
  8. --
  9. You can use the following APIs to perform <<xpack-ccr,{ccr}>> operations.
  10. [discrete]
  11. [[ccr-api-top-level]]
  12. === Top-Level
  13. * <<ccr-get-stats,Get {ccr} stats>>
  14. [discrete]
  15. [[ccr-api-follow]]
  16. === Follow
  17. * <<ccr-put-follow,Create follower index>>
  18. * <<ccr-post-pause-follow,Pause follower>>
  19. * <<ccr-post-resume-follow,Resume follower>>
  20. * <<ccr-post-unfollow,Convert follower index to a regular index>>
  21. * <<ccr-post-forget-follower,Remove follower retention leases from the leader>>
  22. * <<ccr-get-follow-stats,Get stats about follower indices>>
  23. * <<ccr-get-follow-info,Get info about follower indices>>
  24. [discrete]
  25. [[ccr-api-auto-follow]]
  26. === Auto-follow
  27. * <<ccr-put-auto-follow-pattern,Create auto-follow pattern>>
  28. * <<ccr-delete-auto-follow-pattern,Delete auto-follow pattern>>
  29. * <<ccr-get-auto-follow-pattern,Get auto-follow patterns>>
  30. * <<ccr-pause-auto-follow-pattern,Pause auto-follow pattern>>
  31. * <<ccr-resume-auto-follow-pattern,Resume auto-follow pattern>>
  32. // top-level
  33. include::get-ccr-stats.asciidoc[]
  34. // follow
  35. include::follow/put-follow.asciidoc[]
  36. include::follow/post-pause-follow.asciidoc[]
  37. include::follow/post-resume-follow.asciidoc[]
  38. include::follow/post-unfollow.asciidoc[]
  39. include::follow/post-forget-follower.asciidoc[]
  40. include::follow/get-follow-stats.asciidoc[]
  41. include::follow/get-follow-info.asciidoc[]
  42. // auto-follow
  43. include::auto-follow/put-auto-follow-pattern.asciidoc[]
  44. include::auto-follow/delete-auto-follow-pattern.asciidoc[]
  45. include::auto-follow/get-auto-follow-pattern.asciidoc[]
  46. include::auto-follow/pause-auto-follow-pattern.asciidoc[]
  47. include::auto-follow/resume-auto-follow-pattern.asciidoc[]