Path parameters

• index string | array[string] Required

  The name of the index to explain

Query parameters

• include_defaults boolean

  indicates if the API should return the default values the system uses for the index's lifecycle

• master_timeout string

  Specify timeout for connection to master

Responses

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

  • indices object Required
    Hide indices attribute Show indices attribute object

    • * object Additional properties

      Additional properties are allowed.

      Hide * attributes Show * attributes object

      • index string Required
      • managed_by_lifecycle boolean Required
      • index_creation_date_millis number

        Time unit for milliseconds

      • time_since_index_creation string

        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.

      • rollover_date_millis number

        Time unit for milliseconds

      • time_since_rollover string

        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.

      • lifecycle object

        Additional properties are allowed.

        Hide lifecycle attributes Show lifecycle attributes object

        • data_retention string

          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.

        • downsampling object

          Additional properties are allowed.

          Hide downsampling attribute Show downsampling attribute object

          • rounds array[object] Required

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

            Additional properties are allowed.

        • rollover object

          Additional properties are allowed.

          Hide rollover attributes Show rollover attributes object

          • min_age string

            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.

          • max_age string
          • min_docs number
          • max_docs number

          • min_size number | string

            One of:

            _types:ByteSize number _types:ByteSize string

          • max_size number | string

            One of:

            _types:ByteSize number _types:ByteSize string

          • min_primary_shard_size number | string

            One of:

            _types:ByteSize number _types:ByteSize string

          • max_primary_shard_size number | string

            One of:

            _types:ByteSize number _types:ByteSize string
          • min_primary_shard_docs number
          • max_primary_shard_docs number
      • generation_time string

        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.

      • error string