IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Create or update snapshot repository API Repository analysis API »
Elastic Docs ›Elasticsearch Guide [8.6] ›REST APIs ›Snapshot and restore APIs

Verify snapshot repository API

edit

Verify snapshot repository API

edit

Verifies that a snapshot repository is functional. See Verify a repository.

POST /_snapshot/my_repository/_verify

Request

edit

POST /_snapshot/<repository>/_verify

Prerequisites

edit
  • If the Elasticsearch security features are enabled, you must have the manage cluster privilege to use this API.

Path parameters

edit
<repository>
(Required, string) Name of the snapshot repository to verify.

Query parameters

edit
master_timeout
(Optional, time units) Specifies the period of time to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. Defaults to 30s.
timeout
(Optional, time units) Specifies the period of time to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Defaults to 30s.

Response body

edit
nodes

(object)

Properties of nodes objects
<node_id>

(object) Contains information about a node connected to the snapshot repository.

The key is the ID of the node.

Properties of <node_id>
name

(string) Human-readable name for the node.

You can set this name using the node.name property in elasticsearch.yml. Defaults to the machine’s hostname.

« Create or update snapshot repository API Repository analysis API »