Verify a snapshot repository Generally available; Added in 0.0.0

View as markdown
POST /_snapshot/{repository}/_verify
Api key auth Basic auth Bearer auth

Check for common misconfigurations in a snapshot repository.

Required authorization

  • Cluster privileges: manage
External documentation

Path parameters

  • repository string Required

    The name of the snapshot repository to verify.

Query parameters

  • master_timeout string

    The period to wait for the master node. If the master node is not available before the timeout expires, the request fails and returns an error. To indicate that the request should never timeout, set it to -1.

    External documentation
  • timeout string

    The period to wait for a response from all relevant nodes in the cluster after updating the cluster metadata. If no response is received before the timeout expires, the cluster metadata update still applies but the response will indicate that it was not completely acknowledged. To indicate that the request should never timeout, set it to -1.

    External documentation

Responses

  • 200 application/json
    Hide response attribute Show response attribute object
    • nodes object Required

      Information about the nodes connected to the snapshot repository. The key is the ID of the node.

      Hide nodes attribute Show nodes attribute object
      • * object Additional properties
        Hide * attribute Show * attribute object
        • name string Required

          A human-readable name for the node. You can set this name using the node.name property in elasticsearch.yml. The default value is the machine's hostname.
POST /_snapshot/{repository}/_verify 
POST _snapshot/my_unverified_backup/_verify

resp = client.snapshot.verify_repository(
    name="my_unverified_backup",
)
const response = await client.snapshot.verifyRepository({
  name: "my_unverified_backup",
});
response = client.snapshot.verify_repository(
  repository: "my_unverified_backup"
)
$resp = $client->snapshot()->verifyRepository([
    "repository" => "my_unverified_backup",
]);
curl -X POST -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_snapshot/my_unverified_backup/_verify"
client.snapshot().verifyRepository(v -> v
    .name("my_unverified_backup")
);