OpenSearch/docs/reference/cat/repositories.asciidoc

[[cat-repositories]]
=== cat repositories API
++++
<titleabbrev>cat repositories</titleabbrev>
++++

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}

include::{docdir}/rest-api/common-parms.asciidoc[tag=http-format]

include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-h]

include::{docdir}/rest-api/common-parms.asciidoc[tag=help]

include::{docdir}/rest-api/common-parms.asciidoc[tag=local]

include::{docdir}/rest-api/common-parms.asciidoc[tag=master-timeout]

include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-s]

include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-v]


[[cat-repositories-api-example]]
==== {api-examples-title}

[source,console]
--------------------------------------------------
GET /_cat/repositories?v
--------------------------------------------------
// TEST[s/^/PUT \/_snapshot\/repo1\n{"type": "fs", "settings": {"location": "repo\/1"}}\n/]

The API returns the following response:

[source,txt]
--------------------------------------------------
id    type
repo1   fs
repo2   s3
--------------------------------------------------
// TESTRESPONSE[s/\nrepo2   s3// non_json]