Query parameters

• allow_no_indices boolean

  If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices.

• 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. Valid values are: all, open, closed, hidden, none.

• ignore_unavailable boolean

  If false, the request returns an error if it targets a missing or closed index.

• local boolean

  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.

Responses

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

  • Additional properties
  • item object
    Hide item attributes Show item attributes

    • all_field object
      Hide all_field attributes Show all_field attributes

      • 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

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

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

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

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

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

      • compress boolean
      • compress_threshold string
      • enabled boolean
      • excludes array[string]
      • includes array[string]
      • mode string

        Values are disabled, stored, or synthetic.

    • runtime object
      Hide runtime attributes Show runtime attributes

      • Additional properties
      • fetch_fields array[object]

        For type lookup
      • format string

        A custom format for date type runtime fields.

      • input_field string

        Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

      • target_field string

        Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

      • target_index string
      • script object
        Hide script attributes Show script attributes

        • source string

          The script source.

        • id string
        • params object

          Specifies any named parameters that are passed into the script as variables. Use parameters instead of hard-coded values to decrease compile time.

        • lang
        • options object
      • type string Required

        Values are boolean, composite, date, double, geo_point, ip, keyword, long, or lookup.

    • enabled boolean
    • subobjects boolean
    • _data_stream_timestamp object
      Hide _data_stream_timestamp attribute Show _data_stream_timestamp attribute

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

    • all_field object
      Hide all_field attributes Show all_field attributes

      • 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

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

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

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

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

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

      • compress boolean
      • compress_threshold string
      • enabled boolean
      • excludes array[string]
      • includes array[string]
      • mode string

        Values are disabled, stored, or synthetic.

    • runtime object
      Hide runtime attributes Show runtime attributes

      • Additional properties
      • fetch_fields array[object]

        For type lookup
      • format string

        A custom format for date type runtime fields.

      • input_field string

        Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

      • target_field string

        Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

      • target_index string
      • script object
        Hide script attributes Show script attributes

        • source string

          The script source.

        • id string
        • params object

          Specifies any named parameters that are passed into the script as variables. Use parameters instead of hard-coded values to decrease compile time.

        • lang
        • options object
      • type string Required

        Values are boolean, composite, date, double, geo_point, ip, keyword, long, or lookup.

    • enabled boolean
    • subobjects boolean
    • _data_stream_timestamp object
      Hide _data_stream_timestamp attribute Show _data_stream_timestamp attribute

      • enabled boolean Required