Get snapshot repository API

Gets information about one or more registered snapshot repositories.

GET /_snapshot/my_repository

Request

GET /_snapshot/<repository>

GET /_snapshot

Path parameters

<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 parameters

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 body

<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:
-   [repository-s3](https://www.elastic.co/guide/en/elasticsearch/plugins/current/repository-s3.html) for S3 repository support
-   [repository-hdfs](https://www.elastic.co/guide/en/elasticsearch/plugins/current/repository-hdfs.html) for HDFS repository support in Hadoop environments
-   [repository-azure](https://www.elastic.co/guide/en/elasticsearch/plugins/current/repository-azure.html) for Azure storage repositories
-   [repository-gcs](https://www.elastic.co/guide/en/elasticsearch/plugins/current/repository-gcs.html) for Google Cloud Storage repositories
`settings`
(object) Contains settings for the repository. Valid properties for the `settings` object depend on the repository type, set using the [`type`]($dc3b4a817e87b963.md#put-snapshot-repo-api-request-type) parameter.
For properties, see the [put snapshot repository API]($dc3b4a817e87b963.md "Put snapshot repository API")'s [`settings` parameter]($dc3b4a817e87b963.md#put-snapshot-repo-api-settings-param).

Examples

GET /_snapshot/my_repository

The API returns the following response:

{
  "my_repository" : {
    "type" : "fs",
    "settings" : {
      "location" : "my_backup_location"
    }
  }
}