Get snapshot repository API
Get snapshot repository API
Gets information about one or more registered snapshot repositories.
GET /_snapshot/my_repository
Request
GET /_snapshot/<repository>
GET /_snapshot
Prerequisites
- If the Elasticsearch security features are enabled, you must have the
monitor_snapshot
,create_snapshot
, ormanage
cluster privilege to use this API.
Path parameters
<repository>
(Optional, string) 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
.
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 for S3 repository support
- repository-hdfs for HDFS repository support in Hadoop environments
- repository-azure for Azure storage repositories
- repository-gcs 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 parameter.For properties, see the create or update snapshot repository API‘s settings parameter.
Examples
GET /_snapshot/my_repository
The API returns the following response:
{
"my_repository" : {
"type" : "fs",
"uuid" : "0JLknrXbSUiVPuLakHjBrQ",
"settings" : {
"location" : "my_backup_location"
}
}
}