cat apis to rest api reference

Adds both nodes for dashboards to talk to in docker-compose

README.md

@@ -34,7 +34,7 @@ If you encounter problems or have questions when contributing to the documentati
 
 After each commit to this repository, GitHub Pages automatically uses [Jekyll](https://jekyllrb.com) to rebuild the [website](https://docs-beta.opensearch.org). The whole process takes around 30 seconds.
 
-This repository contains many [Markdown](https://guides.github.com/features/mastering-markdown/) files in the `/docs` directory. Each Markdown file correlates with one page on the website. For example, the Markdown file for [this page](https://docs-beta.opensearch.org/docs/opensearch/) is [here](https://github.com/opensearch-project/documentation-website/blob/master/docs/opensearch/index.md).
+This repository contains many [Markdown](https://guides.github.com/features/mastering-markdown/) files in the `/docs` directory. Each Markdown file correlates with one page on the website.
 
 Using plain text on GitHub has many advantages:
 

_opensearch/catapis.md

@@ -1,256 +0,0 @@
----
-layout: default
-title: CAT API
-nav_order:  20
----
-
-# cat API
-
-You can get essential statistics about your cluster in an easy-to-understand, tabular format using the compact and aligned text (CAT) API. The cat API is a human-readable interface that returns plain text instead of traditional JSON.
-
-Using the cat API, you can answer questions like which node is the elected master, what state is the cluster in, how many documents are in each index, and so on.
-
-To see the available operations in the cat API, use the following command:
-
-```
-GET _cat
-```
-
-You can also use the following string parameters with your query.
-
-Parameter | Description
-:--- | :--- |
-`?v` |  Makes the output more verbose by adding headers to the columns. It also adds some formatting to help align each of the columns together. All examples on this page include the `v` parameter.
-`?help` | Lists the default and other available headers for a given operation.
-`?h`  |  Limits the output to specific headers.
-`?format` |  Outputs the result in JSON, YAML, or CBOR formats.
-`?sort` | Sorts the output by the specified columns.
-
-To see what each column represents, use the `?v` parameter:
-
-```
-GET _cat/<operation_name>?v
-```
-
-To see all the available headers, use the `?help` parameter:
-
-```
-GET _cat/<operation_name>?help
-```
-
-To limit the output to a subset of headers, use the `?h` parameter:
-
-```
-GET _cat/<operation_name>?h=<header_name_1>,<header_name_2>&v
-```
-
-Typically, for any operation you can find out what headers are available using the `?help` parameter, and then use the `?h` parameter to limit the output to only the headers that you care about.
-
----
-
-#### Table of contents
-1. TOC
-{:toc}
-
----
-## Aliases
-
-Lists the mapping of aliases to indices, plus routing and filtering information.
-
-```
-GET _cat/aliases?v
-```
-
-To limit the information to a specific alias, add the alias name after your query.
-
-```
-GET _cat/aliases/<alias>?v
-```
-
-## Allocation
-
-Lists the allocation of disk space for indices and the number of shards on each node.
-Default request:
-```
-GET _cat/allocation?v
-```
-
-## Count
-
-Lists the number of documents in your cluster.
-
-```
-GET _cat/count?v
-```
-
-To see the number of documents in a specific index, add the index name after your query.
-
-```
-GET _cat/count/<index>?v
-```
-
-## Field data
-
-Lists the memory size used by each field per node.
-
-```
-GET _cat/fielddata?v
-```
-
-To limit the information to a specific field, add the field name after your query.
-
-```
-GET _cat/fielddata/<fields>?v
-```
-
-## Health
-
-Lists the status of the cluster, how long the cluster has been up, the number of nodes, and other useful information that helps you analyze the health of your cluster.
-
-```
-GET _cat/health?v
-```
-
-## Indices
-
-Lists information related to indices⁠—how much disk space they are using, how many shards they have, their health status, and so on.
-
-```
-GET _cat/indices?v
-```
-
-To limit the information to a specific index, add the index name after your query.
-
-```
-GET _cat/indices/<index>?v
-```
-
-## Master
-
-Lists information that helps identify the elected master node.
-
-```
-GET _cat/master?v
-```
-
-## Node attributes
-
-Lists the attributes of custom nodes.
-
-```
-GET _cat/nodeattrs?v
-```
-
-## Nodes
-
-Lists node-level information, including node roles and load metrics.
-
-A few important node metrics are `pid`, `name`, `master`, `ip`, `port`, `version`, `build`, `jdk`, along with `disk`, `heap`, `ram`, and `file_desc`.
-
-```
-GET _cat/nodes?v
-```
-
-## Pending tasks
-
-Lists the progress of all pending tasks, including task priority and time in queue.
-
-```
-GET _cat/pending_tasks?v
-```
-
-## Plugins
-
-Lists the names, components, and versions of the installed plugins.
-
-```
-GET _cat/plugins?v
-```
-
-## Recovery
-
-Lists all completed and ongoing index and shard recoveries.
-
-```
-GET _cat/recovery?v
-```
-
-To see only the recoveries of a specific index, add the index name after your query.
-
-```
-GET _cat/recovery/<index>?v
-```
-
-## Repositories
-
-Lists all snapshot repositories and their types.
-
-```
-GET _cat/repositories?v
-```
-
-## Segments
-
-Lists Lucene segment-level information for each index.
-
-```
-GET _cat/segments?v
-```
-
-To see only the information about segments of a specific index, add the index name after your query.
-
-```
-GET _cat/segments/<index>?v
-```
-
-## Shards
-
-Lists the state of all primary and replica shards and how they are distributed.
-
-```
-GET _cat/shards?v
-```
-
-To see only the information about shards of a specific index, add the index name after your query.
-
-```
-GET _cat/shards/<index>?v
-```
-
-## Snapshots
-
-Lists all snapshots for a repository.
-
-```
-GET _cat/snapshots/<repository>?v
-```
-
-## Tasks
-
-Lists the progress of all tasks currently running on your cluster.
-
-```
-GET _cat/tasks?v
-```
-
-## Templates
-
-Lists the names, patterns, order numbers, and version numbers of index templates.
-
-```
-GET _cat/templates?v
-```
-
-## Thread pool
-
-Lists the active, queued, and rejected threads of different thread pools on each node.
-
-```
-GET _cat/thread_pool?v
-```
-
-To limit the information to a specific thread pool, add the thread pool name after your query.
-
-```
-GET _cat/thread_pool/<thread_pool>?v
-```

_opensearch/configuration.md

@@ -8,10 +8,10 @@ nav_order: 5
 
 Most OpenSearch configuration can take place in the cluster settings API. Certain operations require you to modify `opensearch.yml` and restart the cluster.
 
-Whenever possible, use the cluster settings API instead; `opensearch.yml` is local to each node, whereas the API applies the setting to all nodes in the cluster.
+Whenever possible, use the cluster settings API instead; `opensearch.yml` is local to each node, whereas the API applies the setting to all nodes in the cluster. Certain settings, however, require `opensearch.yml`. In general, these settings relate to networking, cluster formation, and the local file system. To learn more, see [Cluster formation]({{site.url}}{{site.baseurl}}/opensearch/cluster/).
 
 
-## Cluster settings API
+## Update cluster settings using the API
 
 The first step in changing a setting is to view the current settings:
 
@@ -37,7 +37,7 @@ If you specify the same setting in multiple places, OpenSearch uses the followin
 To change a setting, just specify the new one as either persistent or transient. This example shows the flat settings form:
 
 ```json
-PUT /_cluster/settings
+PUT _cluster/settings
 {
   "persistent" : {
     "action.auto_create_index" : false
@@ -48,7 +48,7 @@ PUT /_cluster/settings
 You can also use the expanded form, which lets you copy and paste from the GET response and change existing values:
 
 ```json
-PUT /_cluster/settings
+PUT _cluster/settings
 {
   "persistent": {
     "action": {
@@ -63,6 +63,6 @@ PUT /_cluster/settings
 
 ## Configuration file
 
-You can find `opensearch.yml` in `/usr/share/opensearch/config/opensearch.yml` (Docker) or `/etc/opensearch/opensearch.yml` (RPM and DEB) on each node.
+You can find `opensearch.yml` in `/usr/share/opensearch/config/opensearch.yml` (Docker) or `/etc/opensearch/opensearch.yml` (most Linux distributions) on each node.
 
 The demo configuration includes a number of settings for the security plugin that you should modify before using OpenSearch for a production workload. To learn more, see [Security]({{site.url}}{{site.baseurl}}/security-plugin/).

_opensearch/install/docker-security.md

@@ -93,8 +93,7 @@ services:
     expose:
       - "5601"
     environment:
-      OPENSEARCH_URL: https://opensearch-node1:9200
-      OPENSEARCH_HOSTS: https://opensearch-node1:9200
+      OPENSEARCH_HOSTS: '["https://opensearch-node1:9200","https://opensearch-node2:9200"]' # must be a string with no spaces when specified as an environment variable
     volumes:
       - ./custom-opensearch_dashboards.yml:/usr/share/opensearch-dashboards/config/opensearch_dashboards.yml
     networks:

_opensearch/install/docker.md

@@ -138,7 +138,7 @@ services:
     expose:
       - "5601"
     environment:
-      OPENSEARCH_HOSTS: '["https://opensearch-node1:9200","https://opensearch-node2:9200"]'
+      OPENSEARCH_HOSTS: '["https://opensearch-node1:9200","https://opensearch-node2:9200"]' # must be a string with no spaces when specified as an environment variable
     networks:
       - opensearch-net
 

_opensearch/logs.md

@@ -9,7 +9,7 @@ nav_order: 60
 The OpenSearch logs include valuable information for monitoring cluster operations and troubleshooting issues. The location of the logs differs based on the installation type:
 
 - On Docker, OpenSearch writes most logs to the console and stores the remainder in `opensearch/logs/`. The tarball installation also uses `opensearch/logs/`.
-- On the RPM and Debian installations, OpenSearch writes logs to `/var/log/opensearch/`.
+- On most Linux installations, OpenSearch writes logs to `/var/log/opensearch/`.
 
 Logs are available as `.log` (plain text) and `.json` files.
 

_opensearch/popular-api.md

@@ -6,7 +6,7 @@ nav_order: 96
 
 # Popular APIs
 
-This page contains sample requests for popular OpenSearch APIs.
+This page contains sample requests for popular OpenSearch operations.
 
 
 ---
@@ -80,7 +80,7 @@ POST _bulk
 ## List all indices
 
 ```
-GET _cat/indices?v
+GET _cat/indices?v&expand_wildcards=all
 ```
 
 
@@ -183,7 +183,7 @@ PUT _snapshot/my-repository/my-snapshot
 ```json
 POST _snapshot/my-repository/my-snapshot/_restore
 {
-  "indices": "-.opensearch_security",
+  "indices": "-.opendistro_security",
   "include_global_state": false
 }
 ```

_opensearch/rest-api/bulk.md

@@ -2,7 +2,7 @@
 layout: default
 title: Bulk
 parent: REST API reference
-nav_order: 15
+nav_order: 5
 ---
 
 # Bulk

_opensearch/rest-api/cat/cat-aliases.md

@@ -0,0 +1,61 @@
+---
+layout: default
+title: cat aliases
+parent: CAT
+grand_parent: REST API reference
+nav_order: 1
+has_children: false
+---
+
+# cat aliases
+
+The cat aliases operation lists the mapping of aliases to indices, plus routing and filtering information.
+
+## Example
+
+```json
+GET _cat/aliases?v
+```
+
+To limit the information to a specific alias, add the alias name after your query:
+
+```json
+GET _cat/aliases/<alias>?v
+```
+
+If you want to get information for more than one alias, separate the alias names with commas:
+
+```json
+GET _cat/aliases/alias1,alias2,alias3
+```
+
+## Path and HTTP methods
+
+```
+GET _cat/aliases/<alias>
+GET _cat/aliases
+```
+
+
+## URL parameters
+
+All cat aliases URL parameters are optional.
+
+In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/opensearch/rest-api/cat/index#common-url-parameters), you can specify the following parameters:
+
+Parameter | Type | Description
+:--- | :--- | :---
+local | Boolean | Whether to return information from the local node only instead of from the master node. Default is false.
+expand_wildcards | Enum | Expands wildcard expressions to concrete indices. Combine multiple values with commas. Supported values are `all`, `open`, `closed`, `hidden`, and `none`. Default is `open`.
+
+## Response
+
+The following response shows that `alias1` refers to a `movies` index and has a configured filter:
+
+```json
+alias   | index     | filter  | routing.index | routing.search  | is_write_index
+alias1  | movies    |   *     |      -        |       -         |      -
+.kibana | .kibana_1 |   -     |      -        |       -         |      -
+```
+
+To learn more about index aliases, see [Index aliases]({{site.url}}{{site.baseurl}}/opensearch/index-alias).

_opensearch/rest-api/cat/cat-allocation.md

@@ -0,0 +1,61 @@
+---
+layout: default
+title: cat allocation
+parent: CAT
+grand_parent: REST API reference
+nav_order: 5
+has_children: false
+---
+
+# cat allocation
+
+The cat allocation operation lists the allocation of disk space for indices and the number of shards on each node.
+
+## Example
+
+```json
+GET _cat/allocation?v
+```
+
+To limit the information to a specific node, add the node name after your query:
+
+```json
+GET _cat/allocation/<node_name>
+```
+
+If you want to get information for more than one node, separate the node names with commas:
+
+```json
+GET _cat/aliases/node_name_1,node_name_2,node_name_3
+```
+
+## Path and HTTP methods
+
+```
+GET _cat/allocation?v
+GET _cat/allocation/<node_name>
+```
+
+## URL parameters
+
+All cat allocation URL parameters are optional.
+
+In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/opensearch/rest-api/cat/index#common-url-parameters), you can specify the following parameters:
+
+Parameter | Type | Description
+:--- | :--- | :---
+bytes | Byte size | Specify the units for byte size. For example, `7kb` or `6gb`. For more information, see [Supported units]({{site.url}}{{site.baseurl}}/opensearch/units/).
+local | Boolean | Whether to return information from the local node only instead of from the master node. Default is false.
+master_timeout | Time | The amount of time to wait for a connection to the master node. Default is 30 seconds.
+
+
+
+## Response
+
+The following response shows that 8 shards are allocated to each the two nodes available:
+
+```json
+shards | disk.indices | disk.used | disk.avail | disk.total | disk.percent host | ip          | node
+  8    |   989.4kb    |   25.9gb  |   32.4gb   |   58.4gb   |   44 172.18.0.4   | 172.18.0.4  | odfe-node1
+  8    |   962.4kb    |   25.9gb  |   32.4gb   |   58.4gb   |   44 172.18.0.3   | 172.18.0.3  | odfe-node2
+```

_opensearch/rest-api/cat/cat-count.md

@@ -0,0 +1,51 @@
+---
+layout: default
+title: cat count
+parent: CAT
+grand_parent: REST API reference
+nav_order: 10
+has_children: false
+---
+
+# cat count
+
+The cat count operation lists the number of documents in your cluster.
+
+## Example
+
+```json
+GET _cat/count?v
+```
+
+To see the number of documents in a specific index or alias, add the index or alias name after your query:
+
+```json
+GET _cat/count/<index_or_alias>?v
+```
+
+If you want to get information for more than one index or alias, separate the index or alias names with commas:
+
+```json
+GET _cat/aliases/index_or_alias_1,index_or_alias_2,index_or_alias_3
+```
+
+## Path and HTTP methods
+
+```
+GET _cat/count?v
+GET _cat/count/<index>?v
+```
+
+## URL parameters
+
+All cat count URL parameters are optional. You can specify any of the [common URL parameters]({{site.url}}{{site.baseurl}}/opensearch/rest-api/cat/index#common-url-parameters).
+
+
+## Response
+
+The following response shows the overall document count as 1625:
+
+```json
+epoch      | timestamp | count
+1624237738 | 01:08:58  | 1625
+```

_opensearch/rest-api/cat/cat-field-data.md

@@ -0,0 +1,57 @@
+---
+layout: default
+title: cat field data
+parent: CAT
+grand_parent: REST API reference
+nav_order: 15
+has_children: false
+---
+
+# cat fielddata
+
+The cat fielddata operation lists the memory size used by each field per node.
+
+## Example
+
+```json
+GET _cat/fielddata?v
+```
+
+To limit the information to a specific field, add the field name after your query:
+
+```json
+GET _cat/fielddata/<field_name>?v
+```
+
+If you want to get information for more than one field, separate the field names with commas:
+
+```json
+GET _cat/aliases/field_name_1,field_name_2,field_name_3
+```
+
+## Path and HTTP methods
+
+```
+GET _cat/fielddata?v
+GET _cat/fielddata/<field_name>?v
+```
+
+## URL parameters
+
+All cat fielddata URL parameters are optional.
+
+In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/opensearch/rest-api/cat/index#common-url-parameters), you can specify the following parameter:
+
+Parameter | Type | Description
+:--- | :--- | :---
+bytes | Byte size | Specify the units for byte size. For example, `7kb` or `6gb`. For more information, see [Supported units]({{site.url}}{{site.baseurl}}/opensearch/units/).
+
+## Response
+
+The following response shows the memory size for all fields as 284 bytes:
+
+```json
+id                     host       ip         node       field size
+1vo54NuxSxOrbPEYdkSF0w 172.18.0.4 172.18.0.4 odfe-node1 _id   284b
+ZaIkkUd4TEiAihqJGkp5CA 172.18.0.3 172.18.0.3 odfe-node2 _id   284b
+```

_opensearch/rest-api/cat/cat-health.md

@@ -0,0 +1,42 @@
+---
+layout: default
+title: cat health
+parent: CAT
+grand_parent: REST API reference
+nav_order: 20
+has_children: false
+---
+
+# cat health
+
+The cat health operation lists the status of the cluster, how long the cluster has been up, the number of nodes, and other useful information that helps you analyze the health of your cluster.
+
+## Example
+
+```json
+GET _cat/health?v
+```
+
+## Path and HTTP methods
+
+```
+GET _cat/health?v
+```
+
+## URL parameters
+
+All cat health URL parameters are optional.
+
+Parameter | Type | Description
+:--- | :--- | :---
+time | Time | Specify the units for time. For example, `5d` or `7h`. For more information, see [Supported units]({{site.url}}{{site.baseurl}}/opensearch/units/).
+ts | Boolean | If true, returns HH:MM:SS and Unix epoch timestamps. Default is true.
+
+## Response
+
+```json
+GET _cat/health?v&time=5d
+
+epoch | timestamp | cluster | status | node.total | node.data | shards | pri | relo | init | unassign | pending_tasks | max_task_wait_time | active_shards_percent
+1624248112 | 04:01:52 | odfe-cluster | green | 2 | 2 | 16 | 8 | 0 | 0 | 0 | 0 | - | 100.0%
+```

_opensearch/rest-api/cat/cat-indices.md

@@ -0,0 +1,61 @@
+---
+layout: default
+title: cat indices
+parent: CAT
+grand_parent: REST API reference
+nav_order: 25
+has_children: false
+---
+
+# cat indices
+
+The cat indices operation lists information related to indices⁠—how much disk space they are using, how many shards they have, their health status, and so on.
+
+## Example
+
+```
+GET _cat/indices?v
+```
+
+To limit the information to a specific index, add the index name after your query.
+
+```
+GET _cat/indices/<index>?v
+```
+
+If you want to get information for more than one index, separate the indices with commas:
+
+```json
+GET _cat/aliases/index1,index2,index3
+```
+
+## Path and HTTP methods
+
+```
+GET _cat/indices/<index>
+GET _cat/indices
+```
+
+## URL parameters
+
+All cat indices URL parameters are optional.
+
+In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/opensearch/rest-api/cat/index#common-url-parameters), you can specify the following parameters:
+
+Parameter | Type | Description
+:--- | :--- | :---
+bytes | Byte size | Specify the units for byte size. For example, `7kb` or `6gb`. For more information, see [Supported units]({{site.url}}{{site.baseurl}}/opensearch/units/).
+health | String | Limit indices based on their health status. Supported values are `green`, `yellow`, and `red`.
+include_unloaded_segments | Boolean | Whether to include information from segments not loaded into memory. Default is false.
+master_timeout | Time | The amount of time to wait for a connection to the master node. Default is 30 seconds.
+pri | Boolean | Whether to return information only from the primary shards. Default is false.
+time | Time | Specify the units for time. For example, `5d` or `7h`. For more information, see [Supported units]({{site.url}}{{site.baseurl}}/opensearch/units/).
+expand_wildcards | Enum | Expands wildcard expressions to concrete indices. Combine multiple values with commas. Supported values are `all`, `open`, `closed`, `hidden`, and `none`. Default is `open`.
+
+
+## Response
+
+```json
+health | status | index | uuid | pri | rep | docs.count | docs.deleted | store.size | pri.store.size
+green  | open | movies | UZbpfERBQ1-3GSH2bnM3sg | 1 | 1 | 1 | 0 | 7.7kb | 3.8kb
+```

_opensearch/rest-api/cat/cat-master.md

@@ -0,0 +1,42 @@
+---
+layout: default
+title: cat master
+parent: CAT
+grand_parent: REST API reference
+nav_order: 30
+has_children: false
+---
+
+# cat master
+
+The cat master operation lists information that helps identify the elected master node.
+
+## Example
+
+```
+GET _cat/master?v
+```
+
+## Path and HTTP methods
+
+```
+GET _cat/master
+```
+
+## URL parameters
+
+All cat master URL parameters are optional.
+
+In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/opensearch/rest-api/cat/index#common-url-parameters), you can specify the following parameters:
+
+Parameter | Type | Description
+:--- | :--- | :---
+master_timeout | Time | The amount of time to wait for a connection to the master node. Default is 30 seconds.
+
+
+## Response
+
+```json
+id                     |   host     |     ip     |   node
+ZaIkkUd4TEiAihqJGkp5CA | 172.18.0.3 | 172.18.0.3 | odfe-node2
+```

_opensearch/rest-api/cat/cat-nodeattrs.md

@@ -0,0 +1,43 @@
+---
+layout: default
+title: cat nodeattrs
+parent: CAT
+grand_parent: REST API reference
+nav_order: 35
+has_children: false
+---
+
+# cat nodeattrs
+
+The cat nodeattrs operation lists the attributes of custom nodes.
+
+## Example
+
+```
+GET _cat/nodeattrs?v
+```
+
+## Path and HTTP methods
+
+```
+GET _cat/nodeattrs
+```
+
+## URL parameters
+
+All cat nodeattrs URL parameters are optional.
+
+In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/opensearch/rest-api/cat/index#common-url-parameters), you can specify the following parameters:
+
+Parameter | Type | Description
+:--- | :--- | :---
+local | Boolean | Whether to return information from the local node only instead of from the master node. Default is false.
+master_timeout | Time | The amount of time to wait for a connection to the master node. Default is 30 seconds.
+
+
+## Response
+
+```json
+node | host | ip | attr | value
+odfe-node2 | 172.18.0.3 | 172.18.0.3 | testattr | test
+```

_opensearch/rest-api/cat/cat-nodes.md

@@ -0,0 +1,50 @@
+---
+layout: default
+title: cat nodes
+parent: CAT
+grand_parent: REST API reference
+nav_order: 40
+has_children: false
+---
+
+# cat nodes
+
+The cat nodes operation lists node-level information, including node roles and load metrics.
+
+A few important node metrics are `pid`, `name`, `master`, `ip`, `port`, `version`, `build`, `jdk`, along with `disk`, `heap`, `ram`, and `file_desc`.
+
+## Example
+
+```
+GET _cat/nodes?v
+```
+
+## Path and HTTP methods
+
+```
+GET _cat/nodes
+```
+
+## URL parameters
+
+All cat nodes URL parameters are optional.
+
+In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/opensearch/rest-api/cat/index#common-url-parameters), you can specify the following parameters:
+
+Parameter | Type | Description
+:--- | :--- | :---
+bytes | Byte size | Specify the units for byte size. For example, `7kb` or `6gb`. For more information, see [Supported units]({{site.url}}{{site.baseurl}}/opensearch/units/).
+full_id | Boolean | If true, return the full node ID. If false, return the shortened node ID. Defaults to false.
+local | Boolean | Whether to return information from the local node only instead of from the master node. Default is false.
+master_timeout | Time | The amount of time to wait for a connection to the master node. Default is 30 seconds.
+time | Time | Specify the units for time. For example, `5d` or `7h`. For more information, see [Supported units]({{site.url}}{{site.baseurl}}/opensearch/units/).
+include_unloaded_segments | Boolean | Whether to include information from segments not loaded into memory. Default is false.
+
+
+## Response
+
+```json
+ip         | heap.percent | ram.percent | cpu load_1m | load_5m | load_15m | node.role | master | name
+172.18.0.3 |     31       |     97      |       3     |  0.03   |   0.10   |  0.14 dimr |  *    |  odfe-node2
+172.18.0.4 |     45       |     97      |       3     |  0.19   |   0.14   |  0.15 dimr |  -    |  odfe-node1
+```

_opensearch/rest-api/cat/cat-pending-tasks.md

@@ -0,0 +1,44 @@
+---
+layout: default
+title: cat pending tasks
+parent: CAT
+grand_parent: REST API reference
+nav_order: 45
+has_children: false
+---
+
+# cat pending tasks
+
+The cat pending tasks operation lists the progress of all pending tasks, including task priority and time in queue.
+
+## Example
+
+```
+GET _cat/pending_tasks?v
+```
+
+## Path and HTTP methods
+
+```
+GET _cat/pending_tasks
+```
+
+## URL parameters
+
+All cat nodes URL parameters are optional.
+
+In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/opensearch/rest-api/cat/index#common-url-parameters), you can specify the following parameters:
+
+Parameter | Type | Description
+:--- | :--- | :---
+local | Boolean | Whether to return information from the local node only instead of from the master node. Default is false.
+master_timeout | Time | The amount of time to wait for a connection to the master node. Default is 30 seconds.
+time | Time | Specify the units for time. For example, `5d` or `7h`. For more information, see [Supported units]({{site.url}}{{site.baseurl}}/opensearch/units/).
+
+
+## Response
+
+```json
+insertOrder | timeInQueue | priority | source
+  1786      |    1.8s     |  URGENT  | shard-started
+```

_opensearch/rest-api/cat/cat-plugins.md

@@ -0,0 +1,62 @@
+---
+layout: default
+title: cat plugins
+parent: CAT
+grand_parent: REST API reference
+nav_order: 50
+has_children: false
+---
+
+# cat plugins
+
+The cat plugins operation lists the names, components, and versions of the installed plugins.
+
+## Example
+
+```
+GET _cat/plugins?v
+```
+
+## Path and HTTP methods
+
+```
+GET _cat/plugins
+```
+
+## URL parameters
+
+All cat plugins URL parameters are optional.
+
+In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/opensearch/rest-api/cat/index#common-url-parameters), you can specify the following parameters:
+
+Parameter | Type | Description
+:--- | :--- | :---
+local | Boolean | Whether to return information from the local node only instead of from the master node. Default is false.
+master_timeout | Time | The amount of time to wait for a connection to the master node. Default is 30 seconds.
+
+
+## Response
+
+```json
+name       component                       version
+odfe-node2 opendistro-alerting             1.13.1.0
+odfe-node2 opendistro-anomaly-detection    1.13.0.0
+odfe-node2 opendistro-asynchronous-search  1.13.0.1
+odfe-node2 opendistro-index-management     1.13.2.0
+odfe-node2 opendistro-job-scheduler        1.13.0.0
+odfe-node2 opendistro-knn                  1.13.0.0
+odfe-node2 opendistro-performance-analyzer 1.13.0.0
+odfe-node2 opendistro-reports-scheduler    1.13.0.0
+odfe-node2 opendistro-sql                  1.13.2.0
+odfe-node2 opendistro_security             1.13.1.0
+odfe-node1 opendistro-alerting             1.13.1.0
+odfe-node1 opendistro-anomaly-detection    1.13.0.0
+odfe-node1 opendistro-asynchronous-search  1.13.0.1
+odfe-node1 opendistro-index-management     1.13.2.0
+odfe-node1 opendistro-job-scheduler        1.13.0.0
+odfe-node1 opendistro-knn                  1.13.0.0
+odfe-node1 opendistro-performance-analyzer 1.13.0.0
+odfe-node1 opendistro-reports-scheduler    1.13.0.0
+odfe-node1 opendistro-sql                  1.13.2.0
+odfe-node1 opendistro_security             1.13.1.0
+```

_opensearch/rest-api/cat/cat-recovery.md

@@ -0,0 +1,57 @@
+---
+layout: default
+title: cat recovery
+parent: CAT
+grand_parent: REST API reference
+nav_order: 50
+has_children: false
+---
+
+# cat recovery
+
+The cat recovery operation lists all completed and ongoing index and shard recoveries.
+
+## Example
+
+```
+GET _cat/recovery?v
+```
+
+To see only the recoveries of a specific index, add the index name after your query.
+
+```
+GET _cat/recovery/<index>?v
+```
+
+If you want to get information for more than one index, separate the indices with commas:
+
+```json
+GET _cat/aliases/index1,index2,index3
+```
+
+## Path and HTTP methods
+
+```
+GET _cat/recovery
+```
+
+## URL parameters
+
+All cat recovery URL parameters are optional.
+
+In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/opensearch/rest-api/cat/index#common-url-parameters), you can specify the following parameters:
+
+Parameter | Type | Description
+:--- | :--- | :---
+active_only | Boolean | Whether to only include ongoing shard recoveries. Default is false.
+bytes | Byte size | Specify the units for byte size. For example, `7kb` or `6gb`. For more information, see [Supported units]({{site.url}}{{site.baseurl}}/opensearch/units/).
+detailed | Boolean | Whether to include detailed information about shard recoveries. Default is false.
+time | Time | Specify the units for time. For example, `5d` or `7h`. For more information, see [Supported units]({{site.url}}{{site.baseurl}}/opensearch/units/).
+
+## Response
+
+```json
+index | shard | time | type | stage | source_host | source_node | target_host | target_node | repository | snapshot | files | files_recovered | files_percent | files_total | bytes | bytes_recovered | bytes_percent | bytes_total | translog_ops | translog_ops_recovered | translog_ops_percent
+movies | 0 | 117ms | empty_store | done | n/a | n/a | 172.18.0.4 | odfe-node1 | n/a | n/a | 0 | 0 | 0.0% | 0 | 0 | 0 | 0.0% | 0 | 0 | 0 | 100.0%
+movies | 0 | 382ms | peer | done | 172.18.0.4 | odfe-node1 | 172.18.0.3 | odfe-node2 | n/a | n/a | 1 | 1 |  100.0% | 1 | 208 | 208 | 100.0% | 208 | 1 | 1 | 100.0%
+```

_opensearch/rest-api/cat/cat-repositories.md

@@ -0,0 +1,44 @@
+---
+layout: default
+title: cat repositories
+parent: CAT
+grand_parent: REST API reference
+nav_order: 55
+has_children: false
+---
+
+# cat repositories
+
+The cat repositories operation lists all completed and ongoing index and shard recoveries.
+
+## Example
+
+```
+GET _cat/repositories?v
+```
+
+## Path and HTTP methods
+
+```
+GET _cat/repositories
+```
+
+## URL parameters
+
+All cat repositories URL parameters are optional.
+
+In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/opensearch/rest-api/cat/index#common-url-parameters), you can specify the following parameters:
+
+Parameter | Type | Description
+:--- | :--- | :---
+local | Boolean | Whether to return information from the local node only instead of from the master node. Default is false.
+master_timeout | Time | The amount of time to wait for a connection to the master node. Default is 30 seconds.
+
+
+## Response
+
+```json
+id    type
+repo1   fs
+repo2   s3
+```

_opensearch/rest-api/cat/cat-segments.md

@@ -0,0 +1,55 @@
+---
+layout: default
+title: cat segments
+parent: CAT
+grand_parent: REST API reference
+nav_order: 55
+has_children: false
+---
+
+# cat segments
+
+The cat segments operation lists Lucene segment-level information for each index.
+
+## Example
+
+```
+GET _cat/segments?v
+```
+
+To see only the information about segments of a specific index, add the index name after your query.
+
+```
+GET _cat/segments/<index>?v
+```
+
+If you want to get information for more than one index, separate the indices with commas:
+
+```
+GET _cat/segments/index1,index2,index3
+```
+
+## Path and HTTP methods
+
+```
+GET _cat/segments
+```
+
+## URL parameters
+
+All cat segments URL parameters are optional.
+
+In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/opensearch/rest-api/cat/index#common-url-parameters), you can specify the following parameter:
+
+Parameter | Type | Description
+:--- | :--- | :---
+bytes | Byte size | Specify the units for byte size. For example, `7kb` or `6gb`. For more information, see [Supported units]({{site.url}}{{site.baseurl}}/opensearch/units/)..
+
+
+## Response
+
+```json
+index | shard | prirep | ip | segment | generation | docs.count | docs.deleted | size | size.memory | committed | searchable | version | compound
+movies | 0 | p | 172.18.0.4 | _0 | 0 | 1 | 0 | 3.5kb | 1364 | true | true | 8.7.0 | true
+movies | 0 | r | 172.18.0.3 | _0 | 0 | 1 | 0 | 3.5kb | 1364 | true | true | 8.7.0 | true
+```

_opensearch/rest-api/cat/cat-shards.md

@@ -0,0 +1,58 @@
+---
+layout: default
+title: cat shards
+parent: CAT
+grand_parent: REST API reference
+nav_order: 60
+has_children: false
+---
+
+# cat shards
+
+The cat shards operation lists the state of all primary and replica shards and how they are distributed.
+
+## Example
+
+```
+GET _cat/shards?v
+```
+
+To see only the information about shards of a specific index, add the index name after your query.
+
+```
+GET _cat/shards/<index>?v
+```
+
+If you want to get information for more than one index, separate the indices with commas:
+
+```
+GET _cat/shards/index1,index2,index3
+```
+
+## Path and HTTP methods
+
+```
+GET _cat/shards
+```
+
+## URL parameters
+
+All cat shards URL parameters are optional.
+
+In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/opensearch/rest-api/cat/index#common-url-parameters), you can specify the following parameter:
+
+Parameter | Type | Description
+:--- | :--- | :---
+bytes | Byte size | Specify the units for byte size. For example, `7kb` or `6gb`. For more information, see [Supported units]({{site.url}}{{site.baseurl}}/opensearch/units/).
+local | Boolean | Whether to return information from the local node only instead of from the master node. Default is false.
+master_timeout | Time | The amount of time to wait for a connection to the master node. Default is 30 seconds.
+time | Time | Specify the units for time. For example, `5d` or `7h`. For more information, see [Supported units]({{site.url}}{{site.baseurl}}/opensearch/units/).
+
+
+## Response
+
+```json
+index | shard | prirep | state   | docs | store | ip |       | node
+plugins | 0   |   p    | STARTED |   0  |  208b | 172.18.0.4 | odfe-node1
+plugins | 0   |   r    | STARTED |   0  |  208b | 172.18.0.3 |  odfe-node2          
+```

_opensearch/rest-api/cat/cat-snapshots.md

@@ -0,0 +1,44 @@
+---
+layout: default
+title: cat snapshots
+parent: CAT
+grand_parent: REST API reference
+nav_order: 65
+has_children: false
+---
+
+# cat snapshots
+
+The cat snapshots operation lists all snapshots for a repository.
+
+## Example
+
+```
+GET _cat/snapshots?v
+```
+
+## Path and HTTP methods
+
+```
+GET _cat/snapshots
+```
+
+## URL parameters
+
+All cat snapshots URL parameters are optional.
+
+In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/opensearch/rest-api/cat/index#common-url-parameters), you can specify the following parameter:
+
+Parameter | Type | Description
+:--- | :--- | :---
+master_timeout | Time | The amount of time to wait for a connection to the master node. Default is 30 seconds.
+time | Time | Specify the units for time. For example, `5d` or `7h`. For more information, see [Supported units]({{site.url}}{{site.baseurl}}/opensearch/units/).
+
+
+## Response
+
+```json
+index | shard | prirep | state   | docs | store | ip |       | node
+plugins | 0   |   p    | STARTED |   0  |  208b | 172.18.0.4 | odfe-node1
+plugins | 0   |   r    | STARTED |   0  |  208b | 172.18.0.3 |  odfe-node2          
+```

_opensearch/rest-api/cat/cat-tasks.md

@@ -0,0 +1,45 @@
+---
+layout: default
+title: cat tasks
+parent: CAT
+grand_parent: REST API reference
+nav_order: 70
+has_children: false
+---
+
+# cat tasks
+
+The cat tasks operation lists the progress of all tasks currently running on your cluster.
+
+## Example
+
+```
+GET _cat/tasks?v
+```
+
+## Path and HTTP methods
+
+```
+GET _cat/tasks
+```
+
+## URL parameters
+
+All cat tasks URL parameters are optional.
+
+In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/opensearch/rest-api/cat/index#common-url-parameters), you can specify the following parameter:
+
+Parameter | Type | Description
+:--- | :--- | :---
+nodes | List | A comma-separated list of node IDs or names to limit the returned information. Use `_local` to return information from the node you're connecting to, specify the node name to get information from specific nodes, or keep the parameter empty to get information from all nodes.
+detailed | Boolean | Returns detailed task information. (Default: false)
+parent_task_id | String | Returns tasks with a specified parent task ID (node_id:task_number). Keep empty or set to -1 to return all.
+time | Time | Specify the units for time. For example, `5d` or `7h`. For more information, see [Supported units]({{site.url}}{{site.baseurl}}/opensearch/units/).
+
+
+## Response
+
+```json
+action | task_id | parent_task_id | type | start_time | timestamp | running_time | ip | node
+cluster:monitor/tasks/lists | 1vo54NuxSxOrbPEYdkSF0w:168062 | - | transport | 1624337809471 | 04:56:49 | 489.5ms | 172.18.0.4 | odfe-node1     
+```

_opensearch/rest-api/cat/cat-templates.md

@@ -0,0 +1,51 @@
+---
+layout: default
+title: cat templates
+parent: CAT
+grand_parent: REST API reference
+nav_order: 70
+has_children: false
+---
+
+# cat templates
+
+The cat templates operation lists the names, patterns, order numbers, and version numbers of index templates.
+
+## Example
+
+```
+GET _cat/templates?v
+```
+
+If you want to get information for more than one template, separate the template names with commas:
+
+```
+GET _cat/shards/template_name_1,template_name_2,template_name_3
+```
+
+## Path and HTTP methods
+
+```
+GET _cat/templates
+```
+
+## URL parameters
+
+All cat templates URL parameters are optional.
+
+In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/opensearch/rest-api/cat/index#common-url-parameters), you can specify the following parameter:
+
+Parameter | Type | Description
+:--- | :--- | :---
+local | Boolean | Whether to return information from the local node only instead of from the master node. Default is false.
+master_timeout | Time | The amount of time to wait for a connection to the master node. Default is 30 seconds.
+
+
+## Response
+
+```
+name | index_patterns order version composed_of
+tenant_template | [kibana*] | 0  |    
+```
+
+To learn more about index templates, see [Index templates]({{site.url}}{{site.baseurl}}/opensearch/index-templates).

_opensearch/rest-api/cat/cat-thread-pool.md

@@ -0,0 +1,51 @@
+---
+layout: default
+title: cat thread pool
+parent: CAT
+grand_parent: REST API reference
+nav_order: 75
+has_children: false
+---
+
+# cat thread pool
+
+The cat thread pool operation lists the active, queued, and rejected threads of different thread pools on each node.
+
+## Example
+
+```
+GET _cat/thread_pool?v
+```
+
+If you want to get information for more than one thread pool, separate the thread pool names with commas:
+
+```
+GET _cat/v/thread_pool_name_1,thread_pool_name_2,thread_pool_name_3
+```
+
+## Path and HTTP methods
+
+```
+GET _cat/thread_pool
+```
+
+## URL parameters
+
+All cat thread pool URL parameters are optional.
+
+In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/opensearch/rest-api/cat/index#common-url-parameters), you can specify the following parameter:
+
+Parameter | Type | Description
+:--- | :--- | :---
+local | Boolean | Whether to return information from the local node only instead of from the master node. Default is false.
+master_timeout | Time | The amount of time to wait for a connection to the master node. Default is 30 seconds.
+
+
+## Response
+
+```json
+node_name  name                      active queue rejected
+odfe-node2 ad-batch-task-threadpool    0     0        0
+odfe-node2 ad-threadpool               0     0        0
+odfe-node2 analyze                     0     0        0s 
+```

_opensearch/rest-api/cat/index.md

@@ -0,0 +1,58 @@
+---
+layout: default
+title: CAT
+parent: REST API reference
+nav_order: 100
+has_children: true
+redirect_from:
+  - /opensearch/catapis/
+---
+
+# cat API
+
+You can get essential statistics about your cluster in an easy-to-understand, tabular format using the compact and aligned text (CAT) API. The cat API is a human-readable interface that returns plain text instead of traditional JSON.
+
+Using the cat API, you can answer questions like which node is the elected master, what state is the cluster in, how many documents are in each index, and so on.
+
+## Example
+
+To see the available operations in the cat API, use the following command:
+
+```
+GET _cat
+```
+
+## Common URL parameters
+
+You can use the following string parameters with your query.
+
+Parameter | Description
+:--- | :--- |
+`?v` |  Makes the output more verbose by adding headers to the columns. It also adds some formatting to help align each of the columns together. All examples in this section include the `v` parameter.
+`?help` | Lists the default and other available headers for a given operation.
+`?h`  |  Limits the output to specific headers.
+`?format` |  Outputs the result in JSON, YAML, or CBOR formats.
+`?sort` | Sorts the output by the specified columns.
+
+To see what each column represents, use the `?v` parameter:
+
+```
+GET _cat/<operation_name>?v
+```
+
+To see all the available headers, use the `?help` parameter:
+
+```
+GET _cat/<operation_name>?help
+```
+
+To limit the output to a subset of headers, use the `?h` parameter:
+
+```
+GET _cat/<operation_name>?h=<header_name_1>,<header_name_2>&v
+```
+
+Typically, for any operation you can find out what headers are available using the `?help` parameter, and then use the `?h` parameter to limit the output to only the headers that you care about.
+
+If you use the security plugin, make sure you have the appropriate permissions.
+{: .note }

_opensearch/rest-api/cluster-allocation.md

@@ -2,7 +2,7 @@
 layout: default
 title: Cluster allocation explain
 parent: REST API reference
-nav_order: 30
+nav_order: 10
 ---
 
 # Cluster allocation explain
@@ -15,7 +15,7 @@ If you add some options, you can instead get information on a specific shard, in
 ## Example
 
 ```json
-GET /_cluster/allocation/explain?include_yes_decisions=true
+GET _cluster/allocation/explain?include_yes_decisions=true
 {
   "index": "movies",
   "shard": 0,

_opensearch/rest-api/cluster-health.md

@@ -2,8 +2,7 @@
 layout: default
 title: Cluster health
 parent: REST API reference
-grand_parent: OpenSearch
-nav_order: 45
+nav_order: 15
 ---
 
 # Cluster health
@@ -17,7 +16,7 @@ To get the status of a specific index, provide the index name.
 This request waits 50 seconds for the cluster to reach the yellow status or better:
 
 ```
-GET /_cluster/health?wait_for_status=yellow&timeout=50s
+GET _cluster/health?wait_for_status=yellow&timeout=50s
 ```
 
 If the cluster health becomes yellow or green before 50 seconds elapse, it returns a response immediately. Otherwise it returns a response as soon as it exceeds the timeout.
@@ -25,8 +24,8 @@ If the cluster health becomes yellow or green before 50 seconds elapse, it retur
 ## Path and HTTP methods
 
 ```
-GET /_cluster/health
-GET /_cluster/health/<index>
+GET _cluster/health
+GET _cluster/health/<index>
 ```
 
 ## URL parameters
@@ -35,18 +34,18 @@ All cluster health parameters are optional.
 
 Parameter | Type | Description
 :--- | :--- | :---
-expand_wildcards | enum | Expands wildcard expressions to concrete indices. Combine multiple values with commas. Supported values are `all`, `open`, `closed`, `hidden`, and `none`. Default is `open`. 
-level | enum | The level of detail for returned health information. Supported values are `cluster`, `indices`, and `shards`. Default is `cluster`.
-local | boolean | Whether to return information from the local node only instead of from the master node. Default is false.
-master_timeout | time | The amount of time to wait for a connection to the master node. Default is 30 seconds.
-timeout | time | The amount of time to wait for a response. If the timeout expires, the request fails. Default is 30 seconds.
-wait_for_active_shards | string | Wait until the specified number of shards is active before returning a response. `all` for all shards. Default is `0`. 
-wait_for_events | enum | Wait until all currently queued events with the given priority are processed. Supported values are `immediate`, `urgent`, `high`, `normal`, `low`, and `languid`.
-wait_for_no_relocating_shards | boolean | Whether to wait until there are no relocating shards in the cluster. Default is false.
-wait_for_no_initializing_shards | boolean | Whether to wait until there are no initializing shards in the cluster. Default is false.
-wait_for_status | enum | Wait until the cluster is in a specific state or better. Supported values are `green`, `yellow`, and `red`.
+expand_wildcards | Enum | Expands wildcard expressions to concrete indices. Combine multiple values with commas. Supported values are `all`, `open`, `closed`, `hidden`, and `none`. Default is `open`.
+level | Enum | The level of detail for returned health information. Supported values are `cluster`, `indices`, and `shards`. Default is `cluster`.
+local | Boolean | Whether to return information from the local node only instead of from the master node. Default is false.
+master_timeout | Time | The amount of time to wait for a connection to the master node. Default is 30 seconds.
+timeout | Time | The amount of time to wait for a response. If the timeout expires, the request fails. Default is 30 seconds.
+wait_for_active_shards | String | Wait until the specified number of shards is active before returning a response. `all` for all shards. Default is `0`.
+wait_for_events | Enum | Wait until all currently queued events with the given priority are processed. Supported values are `immediate`, `urgent`, `high`, `normal`, `low`, and `languid`.
+wait_for_no_relocating_shards | Boolean | Whether to wait until there are no relocating shards in the cluster. Default is false.
+wait_for_no_initializing_shards | Boolean | Whether to wait until there are no initializing shards in the cluster. Default is false.
+wait_for_status | Enum | Wait until the cluster is in a specific state or better. Supported values are `green`, `yellow`, and `red`.
 
-<!-- wait_for_nodes | string | Wait until the specified number of nodes is available. Also supports operators <=, >=, <, and > 
+<!-- wait_for_nodes | string | Wait until the specified number of nodes is available. Also supports operators <=, >=, <, and >
 # Not working properly when tested -->
 
 ## Response
@@ -69,4 +68,4 @@ wait_for_status | enum | Wait until the cluster is in a specific state or better
   "task_max_waiting_in_queue_millis" : 0,
   "active_shards_percent_as_number" : 100.0
 }
-```
+```

_opensearch/rest-api/cluster-settings.md

@@ -0,0 +1,83 @@
+---
+layout: default
+title: Cluster settings
+parent: REST API reference
+nav_order: 20
+---
+
+# Cluster settings
+
+The cluster settings operation lets you check the current settings for your cluster, review default settings, and change settings. When you update a setting using the API, OpenSearch applies it to all nodes in the cluster.
+
+
+## Examples
+
+```json
+GET _cluster/settings?include_defaults=true
+```
+
+```json
+PUT _cluster/settings
+{
+  "persistent": {
+    "action": {
+      "auto_create_index": false
+    }
+  }
+}
+```
+
+
+## Path and HTTP methods
+
+```
+GET _cluster/settings
+PUT _cluster/settings
+```
+
+
+## URL parameters
+
+All cluster settings parameters are optional.
+
+Parameter | Type | Description
+:--- | :--- | :---
+flat_settings | Boolean | Whether to return settings in the flat form, which can improve readability, especially for heavily nested settings. For example, the flat form of `"cluster": { "max_shards_per_node": 500 }` is `"cluster.max_shards_per_node": "500"`.
+include_defaults (GET only) | Boolean | Whether to include default settings as part of the response. This parameter is useful for identifying the names and current values of settings you want to update.
+master_timeout | Time | The amount of time to wait for a response from the master node. Default is 30 seconds.
+timeout (PUT only) | Time | The amount of time to wait for a response from the cluster. Default is 30 seconds.
+
+
+## Request body
+
+The GET operation has no request body options.
+
+For a PUT operation, the request body must contain `transient` or `persistent`, along with the setting you want to update:
+
+```json
+PUT _cluster/settings
+{
+  "persistent": {
+    "cluster": {
+      "max_shards_per_node": 500
+    }
+  }
+}
+```
+
+For more information about transient settings, persistent settings, and precedence, see [OpenSearch configuration]({{site.url}}{{site.baseurl}}/opensearch/configuration/).
+
+
+## Response
+
+```json
+{
+  "acknowledged": true,
+  "persistent": {
+    "cluster": {
+      "max_shards_per_node": "500"
+    }
+  },
+  "transient": {}
+}
+```

_opensearch/rest-api/tasks.md

@@ -1,10 +1,13 @@
 ---
 layout: default
-title: Tasks API
-nav_order: 25
+title: Tasks
+parent: REST API reference
+nav_order: 80
+redirect_from:
+  - /opensearch/tasksapi/
 ---
 
-# Tasks API operation
+# Tasks
 
 A task is any operation you run in a cluster. For example, searching your data collection of books for a title or author name is a task. When you run OpenSearch, a task is automatically created to monitor your cluster's health and performance. For more information about all of the tasks currently executing in your cluster, you can use the `tasks` API operation.
 

_opensearch/snapshot-restore.md

@@ -362,19 +362,19 @@ Snapshots are only forward-compatible by one major version. If you have an old s
 If you're using the security plugin, snapshots have some additional restrictions:
 
 - To perform snapshot and restore operations, users must have the built-in `manage_snapshots` role.
-- You can't restore snapshots that contain global state or the `.opensearch_security` index.
+- You can't restore snapshots that contain global state or the `.opendistro_security` index.
 
-If a snapshot contains global state, you must exclude it when performing the restore. If your snapshot also contains the `.opensearch_security` index, either exclude it or list all the other indices you want to include:
+If a snapshot contains global state, you must exclude it when performing the restore. If your snapshot also contains the `.opendistro_security` index, either exclude it or list all the other indices you want to include:
 
 ```json
 POST _snapshot/my-repository/3/_restore
 {
-  "indices": "-.opensearch_security",
+  "indices": "-.opendistro_security",
   "include_global_state": false
 }
 ```
 
-The `.opensearch_security` index contains sensitive data, so we recommend excluding it when you take a snapshot. If you do need to restore the index from a snapshot, you must include an admin certificate in the request:
+The `.opendistro_security` index contains sensitive data, so we recommend excluding it when you take a snapshot. If you do need to restore the index from a snapshot, you must include an admin certificate in the request:
 
 ```bash
 curl -k --cert ./kirk.pem --key ./kirk-key.pem -XPOST 'https://localhost:9200/_snapshot/my-repository/3/_restore?pretty'

_security-plugin/access-control/users-roles.md

@@ -31,7 +31,7 @@ You can create users using OpenSearch Dashboards, `internal_users.yml`, or the R
 ### OpenSearch Dashboards
 
 1. Choose **Security**, **Internal Users**, and **Create internal user**.
-1. Provide a username and password. The security plugin automatically hashes the password and stores it in the `.opensearch_security` index.
+1. Provide a username and password. The security plugin automatically hashes the password and stores it in the `.opendistro_security` index.
 1. If desired, specify user attributes.
 
    Attributes are optional user properties that you can use for variable substitution in index permissions or document-level security.

_security-plugin/configuration/security-admin.md

@@ -8,11 +8,11 @@ redirect_from: /docs/security/configuration/security-admin/
 
 # Apply configuration changes using securityadmin.sh
 
-The security plugin stores its configuration---including users, roles, and permissions---in an index on the OpenSearch cluster (`.opensearch_security`). Storing these settings in an index lets you change settings without restarting the cluster and eliminates the need to edit configuration files on every single node.
+The security plugin stores its configuration---including users, roles, and permissions---in an index on the OpenSearch cluster (`.opendistro_security`). Storing these settings in an index lets you change settings without restarting the cluster and eliminates the need to edit configuration files on every single node.
 
-After changing any of the configuration files in `plugins/opensearch-security/securityconfig`, however, you must run `plugins/opensearch-security/tools/securityadmin.sh` to load these new settings into the index. You must also run this script at least once to initialize the `.opensearch_security` index and configure your authentication and authorization methods.
+After changing any of the configuration files in `plugins/opensearch-security/securityconfig`, however, you must run `plugins/opensearch-security/tools/securityadmin.sh` to load these new settings into the index. You must also run this script at least once to initialize the `.opendistro_security` index and configure your authentication and authorization methods.
 
-After the `.opensearch_security` index is initialized, you can use OpenSearch Dashboards to manage your users, roles, and permissions.
+After the `.opendistro_security` index is initialized, you can use OpenSearch Dashboards to manage your users, roles, and permissions.
 
 
 ## Configure the admin certificate
@@ -228,7 +228,7 @@ Name | Description
 `-esa` | Enable shard allocation and exit. This option is useful if you disabled shard allocation while performing a full cluster restart and need to recreate the security plugin index.
 `-w` | Displays information about the used admin certificate.
 `-rl` | By default, the security plugin caches authenticated users, along with their roles and permissions, for one hour. This option reloads the current security plugin configuration stored in your cluster, invalidating any cached users, roles, and permissions.
-`-i` | The security plugin index name. Default is `.opensearch_security`.
+`-i` | The security plugin index name. Default is `.opendistro_security`.
 `-er` | Set explicit number of replicas or auto-expand expression for the `opensearch_security` index.
 `-era` | Enable replica auto-expand.
 `-dra` | Disable replica auto-expand.

_security-plugin/configuration/system-indices.md

@@ -8,9 +8,9 @@ redirect_from: /docs/security/configuration/system-indices/
 
 # System indices
 
-By default, OpenSearch has a protected system index, `.opensearch_security`, which you create using [securityadmin.sh]({{site.url}}{{site.baseurl}}/security-plugin/configuration/security-admin/). Even if your user account has read permissions for all indices, you can't directly access the data in this system index.
+By default, OpenSearch has a protected system index, `.opendistro_security`, which you create using [securityadmin.sh]({{site.url}}{{site.baseurl}}/security-plugin/configuration/security-admin/). Even if your user account has read permissions for all indices, you can't directly access the data in this system index.
 
-You can add additional system indices in in `opensearch.yml`. In addition to automatically creating `.opensearch_security`, the demo configuration adds several indices for the various OpenSearch plugins that integrate with the security plugin:
+You can add additional system indices in in `opensearch.yml`. In addition to automatically creating `.opendistro_security`, the demo configuration adds several indices for the various OpenSearch plugins that integrate with the security plugin:
 
 ```yml
 plugins.security.system_indices.enabled: true
@@ -20,7 +20,7 @@ plugins.security.system_indices.indices: [".opendistro-alerting-config", ".opend
 To access these indices, you must authenticate with an [admin certificate]({{site.url}}{{site.baseurl}}/security-plugin/configuration/tls#configure-admin-certificates):
 
 ```bash
-curl -k --cert ./kirk.pem --key ./kirk-key.pem -XGET 'https://localhost:9200/.opensearch_security/_search'
+curl -k --cert ./kirk.pem --key ./kirk-key.pem -XGET 'https://localhost:9200/.opendistro_security/_search'
 ```
 
 The alternative is to remove indices from the `plugins.security.system_indices.indices` list on each node and restart OpenSearch.

_security-plugin/configuration/yaml.md

@@ -8,7 +8,7 @@ redirect_from: /docs/security/configuration/yaml/
 
 # YAML files
 
-Before running `securityadmin.sh` to load the settings into the `.opensearch_security` index, configure the YAML files in `plugins/opensearch-security/securityconfig`. You might want to back up these files so that you can reuse them on other clusters.
+Before running `securityadmin.sh` to load the settings into the `.opendistro_security` index, configure the YAML files in `plugins/opensearch-security/securityconfig`. You might want to back up these files so that you can reuse them on other clusters.
 
 The best use of these YAML files is to configure [reserved and hidden resources]({{site.url}}{{site.baseurl}}/security-plugin/access-control/api#reserved-and-hidden-resources), such as the `admin` and `kibanaserver` users. You might find it easier to create other users, roles, mappings, action groups, and tenants using OpenSearch Dashboards or the REST API.