Skip to content

Commit 04a087f

Browse files
authored
[DOCS] Adds authorization info for CCR APIs (#35557)
1 parent 84db1e4 commit 04a087f

File tree

3 files changed

+25
-0
lines changed

3 files changed

+25
-0
lines changed

docs/reference/ccr/apis/follow/post-pause-follow.asciidoc

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,14 @@ POST /<follower_index>/_ccr/pause_follow
4848
`follower_index` (required)::
4949
(string) the name of the follower index
5050

51+
52+
==== Authorization
53+
54+
If the {es} {security-features} are enabled, you must have `manage_ccr` cluster
55+
privileges on the cluster that contains the follower index. For more information,
56+
see {stack-ov}/security-privileges.html[Security privileges].
57+
58+
5159
==== Example
5260

5361
This example pauses a follower index named `follower_index`:

docs/reference/ccr/apis/follow/post-resume-follow.asciidoc

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,14 @@ POST /<follower_index>/_ccr/resume_follow
6363
==== Request Body
6464
include::../follow-request-body.asciidoc[]
6565

66+
==== Authorization
67+
68+
If the {es} {security-features} are enabled, you must have `write` and `monitor`
69+
index privileges for the follower index. You must have `read` and `monitor`
70+
index privileges for the leader index. You must also have `manage_ccr` cluster
71+
privileges on the cluster that contains the follower index. For more information,
72+
see {stack-ov}/security-privileges.html[Security privileges].
73+
6674
==== Example
6775

6876
This example resumes a follower index named `follower_index`:

docs/reference/ccr/apis/follow/put-follow.asciidoc

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,15 @@ PUT /<follower_index>/_ccr/follow
5858

5959
include::../follow-request-body.asciidoc[]
6060

61+
==== Authorization
62+
63+
If the {es} {security-features} are enabled, you must have `write`, `monitor`,
64+
and `manage_follow_index` index privileges for the follower index. You must have
65+
`read` and `monitor` index privileges for the leader index. You must also have
66+
`manage_ccr` cluster privileges on the cluster that contains the follower index.
67+
For more information, see
68+
{stack-ov}/security-privileges.html[Security privileges].
69+
6170
==== Example
6271

6372
This example creates a follower index named `follower_index`:

0 commit comments

Comments
 (0)