Get snapshot repository information Generally available; Added in 0.0.0

GET /_snapshot/{repository}
Api key auth Basic auth Bearer auth

All methods and paths for this operation:

GET /_snapshot

GET /_snapshot/{repository}

Required authorization

  • Cluster privileges: monitor_snapshot

Path parameters

  • repository string | array[string] Required

    A comma-separated list of repository names

Query parameters

  • local boolean

    Return local information, do not retrieve the state from master node (default: false)

  • master_timeout string

    Explicit operation timeout for connection to master node

    Values are -1 or 0.

Responses

  • 200 application/json
GET /_snapshot/{repository} 
GET /_snapshot/my_repository 
resp = client.snapshot.get_repository( name="my_repository", )
const response = await client.snapshot.getRepository({ name: "my_repository", });
response = client.snapshot.get_repository( repository: "my_repository" )
$resp = $client->snapshot()->getRepository([ "repository" => "my_repository", ]);
curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_snapshot/my_repository"
Response examples (200)
A successful response from `GET /_snapshot/my_repository`. 
{ "my_repository" : { "type" : "fs", "uuid" : "0JLknrXbSUiVPuLakHjBrQ", "settings" : { "location" : "my_backup_location" } } }