OpenSearch/docs/reference/cat/repositories.asciidoc

[[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.
Add cat API for repositories and snapshots Closes #14247 Closes #13919 2015-10-22 05:00:51 -04:00			`[[cat-repositories]]`
[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:35:36 -04:00			`=== cat repositories`
Add cat API for repositories and snapshots Closes #14247 Closes #13919 2015-10-22 05:00:51 -04:00
Convert more docs to // CONSOLE Converts docs for `_cat/segments`, `_cat/plugins` and `_cat/repositories` from `curl` to `// CONSOLE` so they are tested as part of the build and are cleaner to use in Console. They should work fine with `curl` with the `COPY AS CURL` link. Also swaps the `source` type of the response from `js` to `txt` because that is more correct. The syntax highlighter doesn't care. It looks at the text to figure out the language. So it looks a little funny for `_cat` responses regardless. Relates to #18160 2016-10-25 10:56:30 -04:00			The `repositories` command shows the snapshot repositories registered in the
			`cluster. For example:`
Add cat API for repositories and snapshots Closes #14247 Closes #13919 2015-10-22 05:00:51 -04:00
Convert more docs to // CONSOLE Converts docs for `_cat/segments`, `_cat/plugins` and `_cat/repositories` from `curl` to `// CONSOLE` so they are tested as part of the build and are cleaner to use in Console. They should work fine with `curl` with the `COPY AS CURL` link. Also swaps the `source` type of the response from `js` to `txt` because that is more correct. The syntax highlighter doesn't care. It looks at the text to figure out the language. So it looks a little funny for `_cat` responses regardless. Relates to #18160 2016-10-25 10:56:30 -04:00			`[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]`
Add cat API for repositories and snapshots Closes #14247 Closes #13919 2015-10-22 05:00:51 -04:00			`--------------------------------------------------`
			`id type`
			`repo1 fs`
			`repo2 s3`
			`--------------------------------------------------`
[DOCS] Change `// TESTRESPONSE[_cat]` to `// TESTRESPONSE[non_json]` (#43006) 2019-06-10 09:33:32 -04:00			`// TESTRESPONSE[s/\nrepo2 s3// non_json]`
Add cat API for repositories and snapshots Closes #14247 Closes #13919 2015-10-22 05:00:51 -04:00
			`We can quickly see which repositories are registered and their type.`