repositories.asciidoc 1.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051
  1. [[cat-repositories]]
  2. === cat repositories API
  3. ++++
  4. <titleabbrev>cat repositories</titleabbrev>
  5. ++++
  6. Returns the <<snapshots-repositories,snapshot repositories>> for a cluster.
  7. [[cat-repositories-api-request]]
  8. ==== {api-request-title}
  9. `GET /_cat/repositories`
  10. [[cat-repositories-query-params]]
  11. ==== {api-query-parms-title}
  12. include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=http-format]
  13. include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-h]
  14. include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=help]
  15. include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=local]
  16. include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]
  17. include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-s]
  18. include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-v]
  19. [[cat-repositories-api-example]]
  20. ==== {api-examples-title}
  21. [source,console]
  22. --------------------------------------------------
  23. GET /_cat/repositories?v
  24. --------------------------------------------------
  25. // TEST[s/^/PUT \/_snapshot\/repo1\n{"type": "fs", "settings": {"location": "repo\/1"}}\n/]
  26. The API returns the following response:
  27. [source,txt]
  28. --------------------------------------------------
  29. id type
  30. repo1 fs
  31. repo2 s3
  32. --------------------------------------------------
  33. // TESTRESPONSE[s/\nrepo2 s3// non_json]