Heather Halter 22cfcf119b
CAT API redirects (#3965)
* catapi redirects

Signed-off-by: Heather Halter <hdhalter@amazon.com>

* data prepper redirects

Signed-off-by: Heather Halter <hdhalter@amazon.com>

* committing unsaved

Signed-off-by: Heather Halter <hdhalter@amazon.com>

---------

Signed-off-by: Heather Halter <hdhalter@amazon.com>
2023-05-04 11:22:52 -07:00

1.2 KiB

layout title parent nav_order has_children redirect_from
default CAT snapshots CAT API 65 false
/opensearch/rest-api/cat/cat-snapshots/

CAT snapshots

Introduced 1.0 {: .label .label-purple }

The CAT snapshots operation lists all snapshots for a repository.

Example

GET _cat/snapshots?v

{% include copy-curl.html %}

Path and HTTP methods

GET _cat/snapshots

URL parameters

All CAT snapshots URL parameters are optional.

In addition to the common URL parameters, you can specify the following parameter:

Parameter Type Description
cluster_manager_timeout Time The amount of time to wait for a connection to the cluster manager node. Default is 30 seconds.
time Time Specify the units for time. For example, 5d or 7h. For more information, see Supported units.

Response

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