Get snapshot repository information Added in 0.0.0

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

Path parameters

  • repository string | array[string] Required

    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.

Query parameters

  • local boolean

    If true, the request gets information from the local node only. If false, the request gets information from the master node.

  • master_timeout string

    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.

Responses

GET /_snapshot/{repository} 
curl \
 --request GET 'http://api.example.com/_snapshot/{repository}' \
 --header "Authorization: $API_KEY"
Response examples (200)
A successful response from `GET /_snapshot/my_repository`. 
{
  "my_repository" : {
    "type" : "fs",
    "uuid" : "0JLknrXbSUiVPuLakHjBrQ",
    "settings" : {
      "location" : "my_backup_location"
    }
  }
}