Query parameters

• allow_no_indices boolean

  A setting that does two separate checks on the index expression. If false, the request returns an error (1) if any wildcard expression (including _all and *) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If true, index expressions that resolve to no indices are allowed and the request returns an empty result.

• expand_wildcards string | array[string]

  Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as open,hidden.

  Values are all, open, closed, hidden, or none.

• ignore_unavailable boolean

  If false, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If true, unavailable concrete targets are silently ignored.

• local boolean Deprecated

  If true, the request retrieves information from the local node only.

• master_timeout string

  Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

  Values are -1 or 0.

  External documentation

Responses

• 200 application/json
  Hide response attribute Show response attribute object

  • * object Additional properties
    Hide * attributes Show * attributes object

    • item object
      Hide item attributes Show item attributes object

      • all_field object
        Hide all_field attributes Show all_field attributes object

        • analyzer string Required
        • enabled boolean Required
        • omit_norms boolean Required
        • search_analyzer string Required
        • similarity string Required
        • store boolean Required
        • store_term_vector_offsets boolean Required
        • store_term_vector_payloads boolean Required
        • store_term_vector_positions boolean Required
        • store_term_vectors boolean Required
      • date_detection boolean
      • dynamic string

        Values are strict, runtime, true, or false.

      • dynamic_date_formats array[string]
      • dynamic_templates array[object]
      • _field_names object
        Hide _field_names attribute Show _field_names attribute object

        • enabled boolean Required
      • index_field object
        Hide index_field attribute Show index_field attribute object

        • enabled boolean Required
      • _meta object
        Hide _meta attribute Show _meta attribute object

        • * object Additional properties
      • numeric_detection boolean
      • properties object
      • _routing object
        Hide _routing attribute Show _routing attribute object

        • required boolean Required
      • _size object
        Hide _size attribute Show _size attribute object

        • enabled boolean Required
      • _source object
        Hide _source attributes Show _source attributes object

        • compress boolean
        • compress_threshold string
        • enabled boolean
        • excludes array[string]
        • includes array[string]
      • runtime object
        Hide runtime attribute Show runtime attribute object

        • * object Additional properties
          Hide * attributes Show * attributes object

          • fields object

            For type composite

          • fetch_fields array[object]

            For type lookup

          • format string

            A custom format for date type runtime fields.

      • enabled boolean
      • subobjects string

        Values are true or false.

      • _data_stream_timestamp object Generally available; Added in 7.16.0
        Hide _data_stream_timestamp attribute Show _data_stream_timestamp attribute object

        • enabled boolean Required
    • mappings object Required
      Hide mappings attributes Show mappings attributes object

      • all_field object
        Hide all_field attributes Show all_field attributes object

        • analyzer string Required
        • enabled boolean Required
        • omit_norms boolean Required
        • search_analyzer string Required
        • similarity string Required
        • store boolean Required
        • store_term_vector_offsets boolean Required
        • store_term_vector_payloads boolean Required
        • store_term_vector_positions boolean Required
        • store_term_vectors boolean Required
      • date_detection boolean
      • dynamic string

        Values are strict, runtime, true, or false.

      • dynamic_date_formats array[string]
      • dynamic_templates array[object]
      • _field_names object
        Hide _field_names attribute Show _field_names attribute object

        • enabled boolean Required
      • index_field object
        Hide index_field attribute Show index_field attribute object

        • enabled boolean Required
      • _meta object
        Hide _meta attribute Show _meta attribute object

        • * object Additional properties
      • numeric_detection boolean
      • properties object
      • _routing object
        Hide _routing attribute Show _routing attribute object

        • required boolean Required
      • _size object
        Hide _size attribute Show _size attribute object

        • enabled boolean Required
      • _source object
        Hide _source attributes Show _source attributes object

        • compress boolean
        • compress_threshold string
        • enabled boolean
        • excludes array[string]
        • includes array[string]
      • runtime object
        Hide runtime attribute Show runtime attribute object

        • * object Additional properties
          Hide * attributes Show * attributes object

          • fields object

            For type composite

          • fetch_fields array[object]

            For type lookup

          • format string

            A custom format for date type runtime fields.

      • enabled boolean
      • subobjects string

        Values are true or false.

      • _data_stream_timestamp object Generally available; Added in 7.16.0
        Hide _data_stream_timestamp attribute Show _data_stream_timestamp attribute object

        • enabled boolean Required