API conventions

We will only discuss some of the major conventions. For others, please refer to the Elasticsearch reference (https://www.elastic.co/guide/en/elasticsearch/reference/master/api-conventions.html). The following list can be applied throughout the REST API:

  • Access across multiple indices: This convention cannot be used in single document APIs:
    • _all: For all indices
    • comma: A separator between two indices
    • wildcard (*,-): The asterisk character, *, is used to match any sequence of characters in the index name, excluding the index afterwards
  • Common options:
    • Boolean values: false means the mentioned value is false; true means the value is true.
    • Number values: A number is as a string on top of the native JSON number type.
    • Time ...

Get Advanced Elasticsearch 7.0 now with the O’Reilly learning platform.

O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.