Path parameters

• index string | array[string] Required

  Comma-separated list of data streams, indices, and index aliases used to limit the request. Wildcard expressions (*) are supported.

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.

  Default value is true.

• expand_wildcards

  Type of index that wildcard expressions 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.

  Supported values include:

  • all: Match any data stream or index, including hidden ones.
  • open: Match open, non-hidden indices. Also matches any non-hidden data stream.
  • closed: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed.
  • hidden: Match hidden data streams and hidden indices. Must be combined with open, closed, or both.
  • none: Wildcard expressions are not accepted.

  Default value is open.

• flat_settings boolean

  If true, returns settings in flat format.

  Default value is false.

• 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.

  Default value is false.

• include_defaults boolean

  If true, return all default settings in the response.

  Default value is false.

• local boolean

  If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node.

  Default value is false.

• 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.

  Default value is 30s.

• features Generally available

  Return only information on specified index features

  Supported values include: aliases, mappings, settings

  Default value is ['aliases', 'mappings', 'settings'].

Responses

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

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

    • aliases object
      Hide aliases attribute Show aliases attribute object

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

        • filter object

          Query used to limit documents the alias can access.

          External documentation
        • index_routing string

          Value used to route indexing operations to a specific shard. If specified, this overwrites the routing value for indexing operations.

        • is_hidden boolean

          If true, the alias is hidden. All indices for the alias must have the same is_hidden value.

          Default value is false.

        • is_write_index boolean

          If true, the index is the write index for the alias.

          Default value is false.

        • routing string

          Value used to route indexing and search operations to a specific shard.

        • search_routing string

          Value used to route search operations to a specific shard. If specified, this overwrites the routing value for search operations.

    • mappings object
      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

        • 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
        Hide _data_stream_timestamp attribute Show _data_stream_timestamp attribute object

        • enabled boolean Required
    • settings object Additional properties
      Index settings
    • defaults object Additional properties

      Default settings, included when the request's include_default is true.

      Index settings
    • data_stream string
    • lifecycle object Generally available

      Data stream lifecycle applicable if this is a data stream.

      Hide lifecycle attributes Show lifecycle attributes object

      • data_retention string

        If defined, every document added to this data stream will be stored at least for this time frame. Any time after this duration the document could be deleted. When empty, every document in this data stream will be stored indefinitely.

        External documentation
      • effective_retention string

        The least amount of time data should be kept by elasticsearch.

        External documentation
      • retention_determined_by string

        Configuration source that can influence the retention of a data stream.

        Values are data_stream_configuration, default_global_retention, max_global_retention, or default_failures_retention.

      • downsampling array[object]

        The list of downsampling rounds to execute as part of this downsampling configuration

        Hide downsampling attributes Show downsampling attributes object

        • after
        • fixed_interval
      • downsampling_method string

        The method used to downsample the data. There are two options aggregate and last_value. It requires downsampling to be defined. Defaults to aggregate.

        Values are aggregate or last_value.

      • enabled boolean

        If defined, it turns data stream lifecycle on/off (true/false) for this data stream. A data stream lifecycle that's disabled (enabled: false) will have no effect on the data stream.

        Default value is true.