Skip to content
Merged
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/reference/cat/shards.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,10 @@ For <<data-streams,data streams>>, the API returns information about the stream'
`manage` <<privileges-list-cluster,cluster privilege>> to use this API.
You must also have the `monitor` or `manage` <<privileges-list-indices,index privilege>>
for any data stream, index, or alias you retrieve.
Additionally, to retrieve shard information of restricted indices, you must have `allow_restricted_indices` set to `true`.
Without the necessary <<roles-indices-priv,index privileges>> for restricted indices,
you may encounter security exceptions when they are explicitly included in the `<target>` list,
or receive incomplete shard results when using wildcards or when omitting the `<target>` parameter.

[[cat-shards-path-params]]
==== {api-path-parms-title}
Expand Down