OpenSearch/docs/reference/cat/repositories.asciidoc
James Rodewig a63f60b776 [DOCS] Remove heading offsets for REST APIs (#44568)
Several files in the REST APIs nav section are included using
:leveloffset: tags. This increments headings (h2 -> h3, h3 -> h4, etc.)
in those files and removes the :leveloffset: tags.

Other supporting changes:
* Alphabetizes top-level REST API nav items.
* Change 'indices APIs' heading to 'index APIs.'
* Changes 'Snapshot lifecycle management' heading to sentence case.
2019-07-19 14:36:06 -04:00

25 lines
666 B
Plaintext

[[cat-repositories]]
=== cat repositories
The `repositories` command shows the snapshot repositories registered in the
cluster. For example:
[source,js]
--------------------------------------------------
GET /_cat/repositories?v
--------------------------------------------------
// CONSOLE
// TEST[s/^/PUT \/_snapshot\/repo1\n{"type": "fs", "settings": {"location": "repo\/1"}}\n/]
might looks like:
[source,txt]
--------------------------------------------------
id type
repo1 fs
repo2 s3
--------------------------------------------------
// TESTRESPONSE[s/\nrepo2 s3// non_json]
We can quickly see which repositories are registered and their type.