Link Search Menu Expand Document Documentation Menu

You're viewing version 2.16 of the OpenSearch documentation. This version is no longer maintained. For the latest version, see the current documentation. For information about OpenSearch version maintenance, see Release Schedule and Maintenance Policy.

CAT snapshots

Introduced 1.0

The CAT snapshots operation lists all snapshots for a repository.

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.

Example request

The following example request lists all snapshots:

GET _cat/snapshots?v

Example 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          
350 characters left

Have a question? .

Want to contribute? or .