Skip to content

Commit

Permalink
Add documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
dakrone committed Apr 18, 2023
1 parent be7c703 commit 304cb9c
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 0 deletions.
20 changes: 20 additions & 0 deletions x-pack/docs/en/rest-api/watcher/get-settings.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
[role="xpack"]
[[watcher-api-update-settings]]
=== Get Watcher index settings
++++
<titleabbrev>Get Watcher settings</titleabbrev>
++++

This API allows a user to retrieve the user-configurable settings for the Watcher internal index (`.watches`). Only a subset of the index settings—those that are use-configurable—will be shown. This includes:

- `index.auto_expand_replias`
- `index.number_of_replicas`

And example of retrieving the Watcher settings:

[source,console]
-----------------------------------------------------------
GET /_watcher/settings
-----------------------------------------------------------

The configurable settings can be modified using the <<watcher-api-update-settings,Update Watcher index settings>> API.
23 changes: 23 additions & 0 deletions x-pack/docs/en/rest-api/watcher/update-settings.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
[role="xpack"]
[[watcher-api-update-settings]]
=== Update Watcher index settings
++++
<titleabbrev>Update Watcher settings</titleabbrev>
++++

This API allows a user to modify the settings for the Watcher internal index (`.watches`). Only a subset of settings are allowed to by modified. This includes:

- `index.auto_expand_replias`
- `index.number_of_replicas`

And example of modifying the Watcher settings:

[source,console]
-----------------------------------------------------------
PUT /_watcher/settings
{
"index.auto_expand_replicas": "0-4"
}
-----------------------------------------------------------

The configurable settings can be retrieved using the <<watcher-api-get-settings,Get Watcher index settings>> API.

0 comments on commit 304cb9c

Please sign in to comment.