elasticsearch/docs/reference/cat/repositories.asciidoc

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

[IMPORTANT]
====
cat APIs are only intended for human consumption using the command line or {kib} 
console. They are _not_ intended for use by applications. For application 
consumption, use the <<get-snapshot-repo-api,get snapshot repository API>>.
====

Returns the <<snapshots-register-repository,snapshot repositories>> for a cluster.


[[cat-repositories-api-request]]
==== {api-request-title}

`GET /_cat/repositories`

[[cat-repositories-api-prereqs]]
==== {api-prereq-title}

* If the {es} {security-features} are enabled, you must have the
`monitor_snapshot`, `create_snapshot`, or `manage`
<<privileges-list-cluster,cluster privilege>> to use this API.

[[cat-repositories-query-params]]
==== {api-query-parms-title}

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

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

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

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

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

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

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


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

[source,console]
--------------------------------------------------
GET /_cat/repositories?v=true
--------------------------------------------------
// 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]