Get snapshot repository information

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

Response

application/json

Examples

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

Request Console 1 / 7 languages

Console Kibana Dev Tools

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

JavaScript Elasticsearch JavaScript Client

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

Python Elasticsearch Python Client

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

curl Shell

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

Java Elasticsearch Java Client

client.cat().repositories(r -> r);

PHP Elasticsearch PHP Client

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

Ruby Elasticsearch Ruby Client

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

Response

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

Required authorization

Query Parameters { h , s , local , master_timeout , }

Response

Query Parameters