get-index.asciidoc 1.0 KB

12345678910111213141516171819202122232425262728293031323334
  1. [[indices-get-index]]
  2. == Get Index
  3. The get index API allows to retrieve information about one or more indexes.
  4. [source,js]
  5. --------------------------------------------------
  6. GET /twitter
  7. --------------------------------------------------
  8. // CONSOLE
  9. // TEST[setup:twitter]
  10. The above example gets the information for an index called `twitter`. Specifying an index,
  11. alias or wildcard expression is required.
  12. The get index API can also be applied to more than one index, or on
  13. all indices by using `_all` or `*` as index.
  14. [float]
  15. === Filtering index information
  16. The information returned by the get API can be filtered to include only specific features
  17. by specifying a comma delimited list of features in the URL:
  18. [source,js]
  19. --------------------------------------------------
  20. GET twitter/_settings,_mappings
  21. --------------------------------------------------
  22. // CONSOLE
  23. // TEST[setup:twitter]
  24. The above command will only return the settings and mappings for the index called `twitter`.
  25. The available features are `_settings`, `_mappings` and `_aliases`.