Query parameters

• allow_no_indicesboolean

  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. For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar.
• expand_wildcardsstring | 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.

  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.

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

• flat_settingsboolean

  If true, returns settings in flat format.

• ignore_unavailableboolean

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

• include_defaultsboolean

  If true, return all default settings in the response.

• localboolean

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

• master_timeoutstring

  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.

Responses

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

  • *object
    Hide * attributes Show * attributes object

    • aliasesobject
      Hide aliases attribute Show aliases attribute object

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

        • filterobject

          An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

          External documentation
        • index_routingstring
        • is_hiddenboolean

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

        • is_write_indexboolean

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

        • routingstring
        • search_routingstring
    • mappingsobject
      Hide mappings attributes Show mappings attributes object

      • all_fieldobject
        Hide all_field attributes Show all_field attributes object

        • analyzerstring Required
        • enabledboolean Required
        • omit_normsboolean Required
        • search_analyzerstring Required
        • similaritystring Required
        • storeboolean Required
        • store_term_vector_offsetsboolean Required
        • store_term_vector_payloadsboolean Required
        • store_term_vector_positionsboolean Required
        • store_term_vectorsboolean Required
      • date_detectionboolean
      • dynamicstring

        Values are strict, runtime, true, or false.

      • dynamic_date_formatsarray[string]
      • dynamic_templatesarray[object]
      • _field_namesobject
        Hide _field_names attribute Show _field_names attribute object

        • enabledboolean Required
      • index_fieldobject
        Hide index_field attribute Show index_field attribute object

        • enabledboolean Required
      • _metaobject
        Hide _meta attribute Show _meta attribute object

        • *object Additional properties
      • numeric_detectionboolean
      • propertiesobject
      • _routingobject
        Hide _routing attribute Show _routing attribute object

        • requiredboolean Required
      • _sizeobject
        Hide _size attribute Show _size attribute object

        • enabledboolean Required
      • _sourceobject
        Hide _source attributes Show _source attributes object

        • compressboolean
        • compress_thresholdstring
        • enabledboolean
        • excludesarray[string]
        • includesarray[string]
        • modestring

          Values are disabled, stored, or synthetic.

      • runtimeobject
        Hide runtime attribute Show runtime attribute object

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

          • fieldsobject

            For type composite

            Hide fields attribute Show fields attribute object

            • *object Additional properties
          • fetch_fieldsarray[object]

            For type lookup
          • formatstring

            A custom format for date type runtime fields.

          • input_fieldstring

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

          • target_fieldstring

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

          • target_indexstring
          • scriptobject
            Hide script attributes Show script attributes object

            • source
            • idstring
            • paramsobject

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

            • lang
            • optionsobject
          • typestring Required

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

      • enabledboolean
      • subobjectsstring

        Values are true or false.

      • _data_stream_timestampobject
        Hide _data_stream_timestamp attribute Show _data_stream_timestamp attribute object

        • enabledboolean Required
    • settingsobject
      Index settings
    • defaultsobject
      Index settings
    • data_streamstring
    • lifecycleobject
      Hide lifecycle attributes Show lifecycle attributes object

      • data_retentionstring

        A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.

      • downsamplingobject
        Hide downsampling attribute Show downsampling attribute object

        • roundsarray[object] Required

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

          Hide rounds attributes Show rounds attributes object

          • afterstring Required

            A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.

          • configobject Required
      • enabledboolean

        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.