Get Watcher index settings Generally available

GET /_watcher/settings

Get settings for the Watcher internal index (.watches). Only a subset of settings are shown, for example index.auto_expand_replicas and index.number_of_replicas.

Query parameters

  • master_timeout string

    The 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
    • index object Required
      Hide index attributes Show index attributes object
      • index object
      • mode string

      • routing_path string | array[string]

        One of:
        string-1 string array-2 array[string]
      • soft_deletes object
        Hide soft_deletes attributes Show soft_deletes attributes object
        • enabled boolean

          Indicates whether soft deletes are enabled on the index.

          Default value is true.

        • retention_lease object

          The maximum period to retain a shard history retention lease before it is considered expired. Shard history retention leases ensure that soft deletes are retained during merges on the Lucene index. If a soft delete is merged away before it can be replicated to a follower the following process will fail due to incomplete history on the leader.

      • sort object
        Hide sort attributes Show sort attributes object

      • number_of_shards number | string Generally available

        One of:
        number-1 number string-2 string

        Default value is 1.

        Default value is 1.

      • number_of_replicas number | string Generally available

        One of:
        number-1 number string-2 string

        Default value is 0.

        Default value is 0.

      • number_of_routing_shards number
      • check_on_startup string

        Values are true, false, or checksum.

      • codec string

        Default value is LZ4.

      • routing_partition_size number | string

        One of:
        number-1 number string-2 string
      • load_fixed_bitset_filters_eagerly boolean

        Default value is true.

      • hidden boolean | string

        One of:
        boolean-1 boolean string-2 string

        Default value is false.

        Default value is false.

      • auto_expand_replicas string | null

        One of:
        string-1 string NullValue string | null

        Default value is false.

        A null value that is to be interpreted as an actual value, unless other uses of null that are equivalent to a missing value. It is used for exemple in settings, where using the NullValue for a setting will reset it to its default value.

      • merge object
        Hide merge attribute Show merge attribute object
        • scheduler object
      • search object
        Hide search attributes Show search attributes object
        • idle object
        • slowlog object
      • refresh_interval 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.

        External documentation
      • max_result_window number

        Default value is 10000.0.

      • max_inner_result_window number

        Default value is 100.0.

      • max_rescore_window number

        Default value is 10000.0.

      • max_docvalue_fields_search number

        Default value is 100.0.

      • max_script_fields number

        Default value is 32.0.

      • max_ngram_diff number

        Default value is 1.0.

      • max_shingle_diff number

        Default value is 3.0.

      • blocks object
        Hide blocks attributes Show blocks attributes object
        • read_only
        • read_only_allow_delete
        • read
        • write
        • metadata
      • max_refresh_listeners number
      • analyze object

        Settings to define analyzers, tokenizers, token filters and character filters. Refer to the linked documentation for step-by-step examples of updating analyzers on existing indices.

        External documentation
        Hide analyze attribute Show analyze attribute object
        • max_token_count
      • highlight object
        Hide highlight attribute Show highlight attribute object
        • max_analyzed_offset number

          Default value is 1000000.0.

      • max_terms_count number

        Default value is 65536.0.

      • max_regex_length number

        Default value is 1000.0.

      • routing object
        Hide routing attributes Show routing attributes object
        • allocation object
        • rebalance object
      • gc_deletes 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.

        External documentation
      • default_pipeline string
      • final_pipeline string
      • lifecycle object
        Hide lifecycle attributes Show lifecycle attributes object
        • name string

          The name of the policy to use to manage the index. For information about how Elasticsearch applies policy changes, see Policy updates.

        • indexing_complete
        • origination_date number

          If specified, this is the timestamp used to calculate the index age for its phase transitions. Use this setting if you create a new index that contains old data and want to use the original creation date to calculate the index age. Specified as a Unix epoch value in milliseconds.

          Default value is 0.0.

        • parse_origination_date boolean

          Set to true to parse the origination date from the index name. This origination date is used to calculate the index age for its phase transitions. The index name must match the pattern .*-{date_format}-\d+, where the date_format is yyyy.MM.dd and the trailing digits are optional. An index that was rolled over would normally match the full format, for example logs-2016.10.31-000002). If the index name doesn’t match the pattern, index creation fails.

        • step object
        • rollover_alias string

          The index alias to update when the index rolls over. Specify when using a policy that contains a rollover action. When the index rolls over, the alias is updated to reflect that the index is no longer the write index. For more information about rolling indices, see Rollover.

          Default value is empty.

        • prefer_ilm boolean | string

          Preference for the system that manages a data stream backing index (preferring ILM when both ILM and DLM are applicable for an index).

          One of:
          boolean-1 boolean string-2 string

          Default value is true.

          Default value is true.

      • provided_name string

      • creation_date number | string

        One of:
        EpochTimeUnitMillis number string-2 string

        Time unit for milliseconds

      • creation_date_string string | number

        One of:
        string-1 string EpochTimeUnitMillis number

        Time unit for milliseconds

      • uuid string
      • version object
        Hide version attributes Show version attributes object
        • created string
        • created_string string

      • verified_before_close boolean | string

        One of:
        boolean-1 boolean string-2 string

      • format string | number

        One of:
        string-1 string number-2 number
      • max_slices_per_scroll number
      • translog object
        Hide translog attributes Show translog attributes object
        • sync_interval string

          How often the translog is fsynced to disk and committed, regardless of write operations. Values less than 100ms are not allowed.

        • durability string

          Whether or not to fsync and commit the translog after every index, delete, update, or bulk request.

          Values are request, REQUEST, async, or ASYNC.

        • flush_threshold_size
        • retention object
      • query_string object
        Hide query_string attribute Show query_string attribute object
        • lenient

      • priority number | string

        One of:
        number-1 number string-2 string
      • top_metrics_max_size number
      • analysis object
        Hide analysis attributes Show analysis attributes object
        • analyzer object
        • char_filter object
        • filter object
        • normalizer object
        • tokenizer object
      • settings object
      • time_series object
        Hide time_series attributes Show time_series attributes object
        • end_time
        • start_time
      • queries object
        Hide queries attribute Show queries attribute object
        • cache object
      • similarity object

        Configure custom similarity settings to customize how search results are scored.

      • mapping object

        Enable or disable dynamic mapping for an index.

        Hide mapping attributes Show mapping attributes object
        • coerce boolean
        • total_fields object
        • depth object
        • nested_fields object
        • nested_objects object
        • field_name_length object
        • dimension_fields object
        • source object

        • ignore_malformed boolean | string

          One of:
          boolean-1 boolean string-2 string
      • indexing.slowlog object
        Hide indexing.slowlog attributes Show indexing.slowlog attributes object
        • level string
        • source number
        • reformat boolean
        • threshold object
      • indexing_pressure object

        Configure indexing back pressure limits.

        Hide indexing_pressure attribute Show indexing_pressure attribute object
        • memory object Required
      • store object

        The store module allows you to control how index data is stored and accessed on disk.

        Hide store attributes Show store attributes object
        • type
        • allow_mmap boolean

          You can restrict the use of the mmapfs and the related hybridfs store type via the setting node.store.allow_mmap. This is a boolean setting indicating whether or not memory-mapping is allowed. The default is to allow it. This setting is useful, for example, if you are in an environment where you can not control the ability to create a lot of memory maps so you need disable the ability to use memory-mapping.

        • stats_refresh_interval string

          How often store statistics are refreshed
GET /_watcher/settings 
curl \
 --request GET 'http://api.example.com/_watcher/settings'
Response examples (200)
A successful response with two index settings. 
{
  "index": {
    "auto_expand_replicas": "0-4",
    "number_of_replicas": 0
  }
}