Get snapshot repository information Added in 2.1.0

GET /_cat/repositories
Api key auth Basic auth Bearer auth

Get a list of snapshot repositories for a cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get snapshot repository API.

Query parameters

  • h string | array[string]

    List of columns to appear in the response. Supports simple wildcards.

  • s string | array[string]

    List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting :asc or :desc as a suffix to the column name.

  • local boolean

    If true, the request computes the list of selected nodes from the local cluster state. If false the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node.

  • master_timeout string

    Period to wait for a connection to the master node.

Responses

GET /_cat/repositories 
curl \
 --request GET http://api.example.com/_cat/repositories \
 --header "Authorization: $API_KEY"
Response examples (200) 
[
  {
    "id": "string",
    "type": "string"
  }
]
Response examples (200)
A successful response from `GET /_cat/repositories?v=true`. 
id    type
repo1   fs
repo2   s3