resume_follow.asciidoc 939 B

1234567891011121314151617181920212223242526272829303132333435
  1. --
  2. :api: ccr-resume-follow
  3. :request: ResumeFollowRequest
  4. :response: AcknowledgedResponse
  5. --
  6. [role="xpack"]
  7. [id="{upid}-{api}"]
  8. === Resume Follow API
  9. [id="{upid}-{api}-request"]
  10. ==== Request
  11. The Resume Follow API allows you to resume following a follower index that has been paused.
  12. ["source","java",subs="attributes,callouts,macros"]
  13. --------------------------------------------------
  14. include-tagged::{doc-tests-file}[{api}-request]
  15. --------------------------------------------------
  16. <1> The name of follower index.
  17. [id="{upid}-{api}-response"]
  18. ==== Response
  19. The returned +{response}+ indicates if the resume follow request was received.
  20. ["source","java",subs="attributes,callouts,macros"]
  21. --------------------------------------------------
  22. include-tagged::{doc-tests-file}[{api}-response]
  23. --------------------------------------------------
  24. <1> Whether or not the resume follow was acknowledged.
  25. include::../execution.asciidoc[]