Get snapshot repository information Generally available; Added in 2.1.0

GET /_cat/repositories

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.

Required authorization

Cluster privileges: monitor_snapshot

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.

External documentation

Responses

200 application/json
Hide response attributes Show response attributes object
- id string
  
  The unique repository identifier.
- type string
  
  The repository type.

GET /_cat/repositories

GET /_cat/repositories?v=true&format=json

resp = client.cat.repositories(
    v=True,
    format="json",
)

const response = await client.cat.repositories({
  v: "true",
  format: "json",
});

response = client.cat.repositories(
  v: "true",
  format: "json"
)

$resp = $client->cat()->repositories([
    "v" => "true",
    "format" => "json",
]);

curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_cat/repositories?v=true&format=json"

client.cat().repositories();

Response examples (200)

A successful response from `GET /_cat/repositories?v=true&format=json`.

[
  {
    "id": "repo1",
    "type": "fs"
  },
  {
    "id": "repo2",
    "type": "s3"
  }
]