You're viewing version 2.11 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.

Verify snapshot repository

Introduced 1.0

Verifies that a snapshot repository is functional. Verifies the repository on each node in a cluster.

If verification is successful, the verify snapshot repository API returns a list of nodes connected to the snapshot repository. If verification failed, the API returns an error.

If you use the Security plugin, you must have the manage cluster privilege.

Path parameters

Path parameters are optional.

Query parameters

Example request

The following request verifies that the my-opensearch-repo is functional:

POST /_snapshot/my-opensearch-repo/_verify?timeout=0s&cluster_manager_timeout=50s

Example response

The example that follows corresponds to the request above in the Example request section.

The POST /_snapshot/my-opensearch-repo/_verify?timeout=0s&cluster_manager_timeout=50s request returns the following fields:

{
  "nodes" : {
    "by1kztwTRoeCyg4iGU5Y8A" : {
      "name" : "opensearch-node1"
    }
  }
}

In the preceding sample, one node is connected to the snapshot repository. If more were connected, you would see them in the response. Example:

{
  "nodes" : {
    "lcfL6jv2jo6sMEtp4idMvg" : {
      "name" : "node-1"
    },
    "rEPtFT/B+cuuOHnQn0jy4s" : {
      "name" : "node-2"
  }
}

Response fields