Get snapshot repository information

GET /_snapshot/{repository}
GET /_snapshot

Auth

Required authorization

Cluster privileges monitor_snapshot

Path parameters

repository union string | string[] optional

A comma-separated list of snapshot repository names used to limit the request. Wildcard (*) expressions are supported including combining wildcards with exclude patterns starting with -.

To get information about all snapshot repositories registered in the cluster, omit this parameter or use * or _all.

Leave it out to use /_snapshot.

Query parameters

local boolean · default: false: If true, the request gets information from the local node only. If false, the request gets information from the master node.
master_timeout string · default: 30s: 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.

Response

application/json

Response Type: map string to oneOf

Examples

Request Console 1 / 8 languages

Console Kibana Dev Tools

GET /_snapshot/my_repository

JavaScript Elasticsearch JavaScript Client

const response = await client.snapshot.getRepository({
  name: "my_repository",
});

Python Elasticsearch Python Client

resp = client.snapshot.get_repository(
    name="my_repository",
)

curl Shell

curl -X GET "$ELASTICSEARCH_URL/_snapshot/my_repository" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.snapshot().getRepository(g -> g
    .name("my_repository")
);

C# Elasticsearch .NET Client

var response = await client.Snapshot
    .GetRepositoryAsync(d1 => d1
        .Name(new[] { "my_repository" })
    );

PHP Elasticsearch PHP Client

$resp = $client->snapshot()->getRepository([
    "repository" => "my_repository",
]);

Ruby Elasticsearch Ruby Client

response = client.snapshot.get_repository(
  repository: "my_repository"
)

Response

A successful response from GET /_snapshot/my_repository.

{
  "my_repository" : {
    "type" : "fs",
    "uuid" : "0JLknrXbSUiVPuLakHjBrQ",
    "settings" : {
      "location" : "my_backup_location"
    }
  }
}