2015-10-22 05:00:51 -04:00
|
|
|
[[cat-repositories]]
|
2019-08-13 08:35:08 -04:00
|
|
|
=== cat repositories API
|
|
|
|
++++
|
|
|
|
<titleabbrev>cat repositories</titleabbrev>
|
|
|
|
++++
|
2015-10-22 05:00:51 -04:00
|
|
|
|
2019-08-12 08:30:25 -04:00
|
|
|
Returns the <<snapshots-repositories,snapshot repositories>> for a cluster.
|
|
|
|
|
|
|
|
|
|
|
|
[[cat-repositories-api-request]]
|
|
|
|
==== {api-request-title}
|
|
|
|
|
|
|
|
`GET /_cat/repositories`
|
|
|
|
|
|
|
|
|
|
|
|
[[cat-repositories-query-params]]
|
|
|
|
==== {api-query-parms-title}
|
|
|
|
|
2020-06-01 19:42:53 -04:00
|
|
|
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=http-format]
|
2019-08-12 08:30:25 -04:00
|
|
|
|
2020-06-01 19:42:53 -04:00
|
|
|
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-h]
|
2019-08-12 08:30:25 -04:00
|
|
|
|
2020-06-01 19:42:53 -04:00
|
|
|
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=help]
|
2019-08-12 08:30:25 -04:00
|
|
|
|
2020-06-01 19:42:53 -04:00
|
|
|
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=local]
|
2019-08-12 08:30:25 -04:00
|
|
|
|
2020-06-01 19:42:53 -04:00
|
|
|
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]
|
2019-08-12 08:30:25 -04:00
|
|
|
|
2020-06-01 19:42:53 -04:00
|
|
|
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-s]
|
2019-08-12 08:30:25 -04:00
|
|
|
|
2020-06-01 19:42:53 -04:00
|
|
|
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-v]
|
2019-08-12 08:30:25 -04:00
|
|
|
|
|
|
|
|
|
|
|
[[cat-repositories-api-example]]
|
|
|
|
==== {api-examples-title}
|
2015-10-22 05:00:51 -04:00
|
|
|
|
2019-09-09 13:38:14 -04:00
|
|
|
[source,console]
|
2016-10-25 10:56:30 -04:00
|
|
|
--------------------------------------------------
|
|
|
|
GET /_cat/repositories?v
|
|
|
|
--------------------------------------------------
|
|
|
|
// TEST[s/^/PUT \/_snapshot\/repo1\n{"type": "fs", "settings": {"location": "repo\/1"}}\n/]
|
|
|
|
|
2019-08-12 08:30:25 -04:00
|
|
|
The API returns the following response:
|
2016-10-25 10:56:30 -04:00
|
|
|
|
|
|
|
[source,txt]
|
2015-10-22 05:00:51 -04:00
|
|
|
--------------------------------------------------
|
|
|
|
id type
|
|
|
|
repo1 fs
|
|
|
|
repo2 s3
|
|
|
|
--------------------------------------------------
|
2019-06-10 09:33:32 -04:00
|
|
|
// TESTRESPONSE[s/\nrepo2 s3// non_json]
|