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

« cat recovery API cat task management API »

› › ›

cat repositories API

edit

cat repositories API

edit

Returns the snapshot repositories for a cluster.

Request

edit

GET /_cat/repositories

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) Specifies the period of time to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. Defaults to 30s.
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

GET /_cat/repositories?v

The API returns the following response:

id    type
repo1   fs
repo2   s3

« cat recovery API cat task management API »