ccr-apis.asciidoc 1.6 KB

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