Skip to content

Commit

Permalink
[DOCS] Adds ignore_throttled to index conventions (#53063)
Browse files Browse the repository at this point in the history
  • Loading branch information
lcawl committed Mar 3, 2020
1 parent cf87724 commit bb4bcbc
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion docs/reference/api-conventions.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ API, unless otherwise specified.
* <<url-access-control>>

[[multi-index]]
=== Multiple Indices
=== Multiple indices

Most APIs that refer to an `index` parameter support execution across multiple indices,
using simple `test1,test2,test3` notation (or `_all` for all indices). It also
Expand All @@ -29,6 +29,10 @@ include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards]

The defaults settings for the above parameters depend on the API being used.

Some multi index APIs also support the following url query string parameter:

include::{docdir}/rest-api/common-parms.asciidoc[tag=ignore_throttled]

NOTE: Single index APIs such as the <<docs>> and the
<<indices-aliases,single-index `alias` APIs>> do not support multiple indices.

Expand Down

0 comments on commit bb4bcbc

Please sign in to comment.