IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

› › ›

cat repositories API

edit

cat repositories API

edit

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.

Returns the snapshot repositories for a cluster.

Request

edit

GET /_cat/repositories

Prerequisites

edit

If the Elasticsearch security features are enabled, you must have the monitor_snapshot, create_snapshot, or manage cluster privilege to use this API.

Query parameters

edit

format: (Optional, string) Short version of the HTTP accept header. Valid values include JSON, YAML, etc.
h: (Optional, string) Comma-separated list of column names to display.
help: (Optional, Boolean) If true, the response includes help information. Defaults to false.
local: (Optional, Boolean) If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node.
master_timeout: (Optional, time units) 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. Defaults to 30s. Can also be set to -1 to indicate that the request should never timeout.
s: (Optional, string) Comma-separated list of column names or column aliases used to sort the response.
v: (Optional, Boolean) If true, the response includes column headings. Defaults to false.

Examples

edit

response = client.cat.repositories(
  v: true
)
puts response

GET /_cat/repositories?v=true

The API returns the following response:

id    type
repo1   fs
repo2   s3

« cat recovery API cat segments API »