IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
Elasticsearch Guide [7.7] » REST APIs » Snapshot and restore APIs » Get snapshot repository API
« Delete snapshot repository API Put snapshot repository API »

Get snapshot repository APIedit

Gets information about one or more registered snapshot repositories.

GET /_snapshot/my_repository

Requestedit

GET /_snapshot/<repository>

GET /_snapshot

Path parametersedit

<repository>

(Required, string) Comma-separated list of snapshot repository names used to limit the request. Wildcard (*) expressions are supported.

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

Query parametersedit

local
(Optional, boolean) If true, the request gets information from the local node only. If false, the request gets information from the master node. Defaults to false.
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.

Response bodyedit

<repository>

(object) Contains information about the snapshot repository. Key is the name of the snapshot repository.

Properties of <repository>
type

(string) Repository type.

Values for type
fs
Shared file system repository. See Shared file system repository.
source
Source-only repository. See Source only repository.
url
URL repository. See Read-only URL repository.

More repository types are available through these official plugins:

settings

(object) Contains settings for the repository. Valid properties for the settings object depend on the repository type, set using the type parameter.

For properties, see the put snapshot repository API's settings parameter.

Examplesedit 

GET /_snapshot/my_repository

The API returns the following response:

{
  "my_repository" : {
    "type" : "fs",
    "settings" : {
      "location" : "my_backup_location"
    }
  }
}
« Delete snapshot repository API Put snapshot repository API »