[role="xpack"]
[testenv="platinum"]
[[ccr-apis]]
== {ccr-cap} APIs

You can use the following APIs to perform {ccr} operations.

[float]
[[ccr-api-top-level]]
=== Top-Level

* <<ccr-get-stats,Get {ccr} stats>>

[float]
[[ccr-api-follow]]
=== Follow

* <<ccr-put-follow,Create follower index>>
* <<ccr-post-pause-follow,Pause follower>>
* <<ccr-post-resume-follow,Resume follower>>
* <<ccr-post-unfollow,Convert follower index to a regular index>>
* <<ccr-post-forget-follower,Remove follower retention leases from the leader>>
* <<ccr-get-follow-stats,Get stats about follower indices>>
* <<ccr-get-follow-info,Get info about follower indices>>

[float]
[[ccr-api-auto-follow]]
=== Auto-follow

* <<ccr-put-auto-follow-pattern,Create auto-follow pattern>>
* <<ccr-delete-auto-follow-pattern,Delete auto-follow pattern>>
* <<ccr-get-auto-follow-pattern,Get auto-follow patterns>>
* <<ccr-pause-auto-follow-pattern,Pause auto-follow pattern>>
* <<ccr-resume-auto-follow-pattern,Resume auto-follow pattern>>

// top-level
include::get-ccr-stats.asciidoc[]

// follow
include::follow/put-follow.asciidoc[]
include::follow/post-pause-follow.asciidoc[]
include::follow/post-resume-follow.asciidoc[]
include::follow/post-unfollow.asciidoc[]
include::follow/post-forget-follower.asciidoc[]
include::follow/get-follow-stats.asciidoc[]
include::follow/get-follow-info.asciidoc[]

// auto-follow
include::auto-follow/put-auto-follow-pattern.asciidoc[]
include::auto-follow/delete-auto-follow-pattern.asciidoc[]
include::auto-follow/get-auto-follow-pattern.asciidoc[]
include::auto-follow/pause-auto-follow-pattern.asciidoc[]
include::auto-follow/resume-auto-follow-pattern.asciidoc[]