JSON Schema Opensearch

Properties

Property	Type	Required	Description
`action_auto_create_index_enabled`	boolean	no	Explicitly allow or block automatic creation of indices. Defaults to true
`action_destructive_requires_name`	boolean	no
`auth_failure_listeners`	Auth Failure Listeners	no
`cluster`	Cluster	no
`cluster_max_shards_per_node`	integer	no	Controls the number of shards allowed in the cluster per data node Min: `100`. Max: `10000`.
`cluster_routing_allocation_node_concurrent_recoveries`	integer	no	How many concurrent incoming/outgoing shard recoveries (normally replicas) are allowed to happen on a node. Defaults to 2. Min: `2`. Max: `16`.
`disk_watermarks`	Disk Watermarks	no
`email-sender`	Email Sender	no
`enable_remote_backed_storage`	boolean	no
`enable_searchable_snapshots`	boolean	no
`enable_security_audit`	boolean	no	Default: `false`.
`enable_snapshot_api`	boolean	no	Enable/Disable snapshot API for custom repositories, this requires security management to be enabled
`http_max_content_length`	integer	no	Maximum content length for HTTP requests to the OpenSearch HTTP API, in bytes. Min: `1`. Max: `2.147483647e+09`.
`http_max_header_size`	integer	no	The max size of allowed headers, in bytes Min: `1024`. Max: `262144`.
`http_max_initial_line_length`	integer	no	The max length of an HTTP URL, in bytes Min: `1024`. Max: `65536`.
`indices_fielddata_cache_size`	integer	no	Relative amount. Maximum amount of heap memory used for field data cache. This is an expert setting; decreasing the value too much will increase overhead of loading field data; too much memory used for field data cache will decrease amount of heap available for other operations. Min: `3`. Max: `100`. Default: `null`.
`indices_memory_index_buffer_size`	integer	no	Percentage value. Default is 10%. Total amount of heap used for indexing buffer, before writing segments to disk. This is an expert setting. Too low value will slow down indexing; too high value will increase indexing performance but causes performance issues for query performance. Min: `3`. Max: `40`.
`indices_memory_max_index_buffer_size`	integer	no	Absolute value. Default is unbound. Doesn’t work without indices.memory.index_buffer_size. Maximum amount of heap used for query cache, an absolute indices.memory.index_buffer_size maximum hard limit. Min: `3`. Max: `2048`.
`indices_memory_min_index_buffer_size`	integer	no	Absolute value. Default is 48mb. Doesn’t work without indices.memory.index_buffer_size. Minimum amount of heap used for query cache, an absolute indices.memory.index_buffer_size minimal hard limit. Min: `3`. Max: `2048`.
`indices_queries_cache_size`	integer	no	Percentage value. Default is 10%. Maximum amount of heap used for query cache. This is an expert setting. Too low value will decrease query performance and increase performance for other operations; too high value will cause issues with other OpenSearch functionality. Min: `3`. Max: `40`.
`indices_query_bool_max_clause_count`	integer	no	Maximum number of clauses Lucene BooleanQuery can have. The default value (1024) is relatively high, and increasing it may cause performance issues. Investigate other approaches first before increasing this value. Min: `64`. Max: `4096`.
`indices_recovery_max_bytes_per_sec`	integer	no	Limits total inbound and outbound recovery traffic for each node. Applies to both peer recoveries as well as snapshot recoveries (i.e., restores from a snapshot). Defaults to 40mb Min: `40`. Max: `400`.
`indices_recovery_max_concurrent_file_chunks`	integer	no	Number of file chunks sent in parallel for each recovery. Defaults to 2. Min: `2`. Max: `5`.
`ism-history`	Ism History	no
`knn_memory_circuit_breaker_enabled`	boolean	no	Enable or disable KNN memory circuit breaker. Defaults to true.
`knn_memory_circuit_breaker_limit`	integer	no	Maximum amount of memory that can be used for KNN index. Defaults to 50% of the JVM heap size. Min: `3`. Max: `100`.
`ml-commons`	Ml Commons	no
`node.search.cache.size`	string	no	Defines a limit of how much total remote data can be referenced as a ratio of the size of the disk reserved for the file cache. This is designed to be a safeguard to prevent oversubscribing a cluster. Defaults to 5gb. Requires restarting all OpenSearch nodes.
`override_main_response_version`	boolean	no	Compatibility mode sets OpenSearch to report its version as 7.10 so clients continue to work. Default is false
`plugins_alerting_filter_by_backend_roles`	boolean	no	Enable or disable filtering of alerting by backend roles. Requires Security plugin. Defaults to false
`reindex_remote_whitelist`	array[string]	no	Whitelisted addresses for reindexing. Changing this value will cause all OpenSearch instances to restart.
`remote_store`	Remote Store	no
`script_max_compilations_rate`	string	no	Script compilation circuit breaker limits the number of inline script compilations within a period of time. Default is use-context Max length: `1024`.
`search.insights.top_queries`	Search.insights.top Queries	no
`search_backpressure`	Search Backpressure	no
`search_max_buckets`	integer	no	Maximum number of aggregation buckets allowed in a single response. OpenSearch default value is used when this is not defined. Min: `1`. Max: `1e+06`.
`segrep`	Segrep	no
`shard_indexing_pressure`	Shard Indexing Pressure	no
`thread_pool_analyze_queue_size`	integer	no	Size for the thread pool queue. See documentation for exact details. Min: `10`. Max: `2000`.
`thread_pool_analyze_size`	integer	no	Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value. Min: `1`. Max: `128`.
`thread_pool_force_merge_size`	integer	no	Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value. Min: `1`. Max: `128`.
`thread_pool_get_queue_size`	integer	no	Size for the thread pool queue. See documentation for exact details. Min: `10`. Max: `2000`.
`thread_pool_get_size`	integer	no	Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value. Min: `1`. Max: `128`.
`thread_pool_search_queue_size`	integer	no	Size for the thread pool queue. See documentation for exact details. Min: `10`. Max: `2000`.
`thread_pool_search_size`	integer	no	Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value. Min: `1`. Max: `128`.
`thread_pool_search_throttled_queue_size`	integer	no	Size for the thread pool queue. See documentation for exact details. Min: `10`. Max: `2000`.
`thread_pool_search_throttled_size`	integer	no	Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value. Min: `1`. Max: `128`.
`thread_pool_write_queue_size`	integer	no	Size for the thread pool queue. See documentation for exact details. Min: `10`. Max: `2000`.
`thread_pool_write_size`	integer	no	Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value. Min: `1`. Max: `128`.

Search.insights.top Queries

Property	Type	Required
`cpu`	CPU	no
`latency`	Latency	no
`memory`	Memory	no

CPU

Property	Type	Required	Description
`enabled`	boolean	no	Enable or disable top N query monitoring by the metric Default: `false`.
`top_n_size`	integer	no	Min: `1`.
`window_size`	string	no	Configure the window size of the top N queries. The value should be a time value with unit, e.g. 1m, 5s, 1h.

Latency

Property	Type	Required	Description
`enabled`	boolean	no	Enable or disable top N query monitoring by the metric Default: `false`.
`top_n_size`	integer	no	Min: `1`.
`window_size`	string	no	Configure the window size of the top N queries. The value should be a time value with unit, e.g. 1m, 5s, 1h.

Memory

Property	Type	Required	Description
`enabled`	boolean	no	Enable or disable top N query monitoring by the metric Default: `false`.
`top_n_size`	integer	no	Min: `1`.
`window_size`	string	no	Configure the window size of the top N queries. The value should be a time value with unit, e.g. 1m, 5s, 1h.

Remote Store

Property	Type	Required	Description
`segment.pressure.bytes_lag.variance_factor`	number	no	The variance factor that is used together with the moving average to calculate the dynamic bytes lag threshold for activating remote segment backpressure. Defaults to 10. Min: `1`.
`segment.pressure.consecutive_failures.limit`	integer	no	The minimum consecutive failure count for activating remote segment backpressure. Defaults to 5. Min: `1`. Max: `2.147483647e+09`.
`segment.pressure.enabled`	boolean	no	Enables remote segment backpressure. Default is `true`
`segment.pressure.time_lag.variance_factor`	number	no	The variance factor that is used together with the moving average to calculate the dynamic time lag threshold for activating remote segment backpressure. Defaults to 10. Min: `1`.

Search Backpressure

Property	Type	Required	Description
`mode`	string	no	The search backpressure mode. Valid values are monitor_only, enforced, or disabled. Default is monitor_only Allowed values: `monitor_only`, `enforced`, `disabled`.
`node_duress`	Node Duress	no
`search_shard_task`	Search Shard Task	no
`search_task`	Search Task	no

Node Duress

Property	Type	Required	Description
`cpu_threshold`	number	no	The CPU usage threshold (as a percentage) required for a node to be considered to be under duress. Default is 0.9 Min: `0`. Max: `1`.
`heap_threshold`	number	no	The heap usage threshold (as a percentage) required for a node to be considered to be under duress. Default is 0.7 Min: `0`. Max: `1`.
`num_successive_breaches`	integer	no	The number of successive limit breaches after which the node is considered to be under duress. Default is 3 Min: `1`.

Search Shard Task

Property	Type	Required	Description
`cancellation_burst`	number	no	The maximum number of search tasks to cancel in a single iteration of the observer thread. Default is 10.0 Min: `1`.
`cancellation_rate`	number	no	The maximum number of tasks to cancel per millisecond of elapsed time. Default is 0.003 Min: `0`.
`cancellation_ratio`	number	no	The maximum number of tasks to cancel, as a percentage of successful task completions. Default is 0.1 Min: `0`. Max: `1`.
`cpu_time_millis_threshold`	integer	no	The CPU usage threshold (in milliseconds) required for a single search shard task before it is considered for cancellation. Default is 15000 Min: `0`.
`elapsed_time_millis_threshold`	integer	no	The elapsed time threshold (in milliseconds) required for a single search shard task before it is considered for cancellation. Default is 30000 Min: `0`.
`heap_moving_average_window_size`	integer	no	The number of previously completed search shard tasks to consider when calculating the rolling average of heap usage. Default is 100 Min: `0`.
`heap_percent_threshold`	number	no	The heap usage threshold (as a percentage) required for a single search shard task before it is considered for cancellation. Default is 0.5 Min: `0`. Max: `1`.
`heap_variance`	number	no	The minimum variance required for a single search shard task’s heap usage compared to the rolling average of previously completed tasks before it is considered for cancellation. Default is 2.0 Min: `0`.
`total_heap_percent_threshold`	number	no	The heap usage threshold (as a percentage) required for the sum of heap usages of all search shard tasks before cancellation is applied. Default is 0.5 Min: `0`. Max: `1`.

Search Task

Property	Type	Required	Description
`cancellation_burst`	number	no	The maximum number of search tasks to cancel in a single iteration of the observer thread. Default is 5.0 Min: `1`.
`cancellation_rate`	number	no	The maximum number of search tasks to cancel per millisecond of elapsed time. Default is 0.003 Min: `0`.
`cancellation_ratio`	number	no	The maximum number of search tasks to cancel, as a percentage of successful search task completions. Default is 0.1 Min: `0`. Max: `1`.
`cpu_time_millis_threshold`	integer	no	The CPU usage threshold (in milliseconds) required for an individual parent task before it is considered for cancellation. Default is 30000 Min: `0`.
`elapsed_time_millis_threshold`	integer	no	The elapsed time threshold (in milliseconds) required for an individual parent task before it is considered for cancellation. Default is 45000 Min: `0`.
`heap_moving_average_window_size`	integer	no	The window size used to calculate the rolling average of the heap usage for the completed parent tasks. Default is 10 Min: `0`.
`heap_percent_threshold`	number	no	The heap usage threshold (as a percentage) required for an individual parent task before it is considered for cancellation. Default is 0.2 Min: `0`. Max: `1`.
`heap_variance`	number	no	The heap usage variance required for an individual parent task before it is considered for cancellation. A task is considered for cancellation when taskHeapUsage is greater than or equal to heapUsageMovingAverage * variance. Default is 2.0 Min: `0`.
`total_heap_percent_threshold`	number	no	The heap usage threshold (as a percentage) required for the sum of heap usages of all search tasks before cancellation is applied. Default is 0.5 Min: `0`. Max: `1`.

Shard Indexing Pressure

Property	Type	Required	Description
`enabled`	boolean	no	Enable or disable shard indexing backpressure. Default is false
`enforced`	boolean	no	Run shard indexing backpressure in shadow mode or enforced mode. In shadow mode (value set as false), shard indexing backpressure tracks all granular-level metrics, but it doesn’t actually reject any indexing requests. In enforced mode (value set as true), shard indexing backpressure rejects any requests to the cluster that might cause a dip in its performance. Default is false
`operating_factor`	Operating Factor	no
`primary_parameter`	Primary Parameter	no

Primary Parameter

Property	Type	Required	Description
`node`	Node	no
`shard`	Shard	no

Shard

Property	Type	Required	Description
`min_limit`	number	no	Specify the minimum assigned quota for a new shard in any role (coordinator, primary, or replica). Shard indexing backpressure increases or decreases this allocated quota based on the inflow of traffic for the shard. Default is 0.001 Min: `0`.

Node

Property	Type	Required	Description
`soft_limit`	number	no	Define the percentage of the node-level memory threshold that acts as a soft indicator for strain on a node. Default is 0.7 Min: `0`.

Operating Factor

Property	Type	Required	Description
`lower`	number	no	Specify the lower occupancy limit of the allocated quota of memory for the shard. If the total memory usage of a shard is below this limit, shard indexing backpressure decreases the current allocated memory for that shard. Default is 0.75 Min: `0`.
`optimal`	number	no	Specify the optimal occupancy of the allocated quota of memory for the shard. If the total memory usage of a shard is at this level, shard indexing backpressure doesn’t change the current allocated memory for that shard. Default is 0.85 Min: `0`.
`upper`	number	no	Specify the upper occupancy limit of the allocated quota of memory for the shard. If the total memory usage of a shard is above this limit, shard indexing backpressure increases the current allocated memory for that shard. Default is 0.95 Min: `0`.

Cluster

Property	Type	Required	Description
`cluster.filecache.remote_data_ratio`	number	no	Defines a limit of how much total remote data can be referenced as a ratio of the size of the disk reserved for the file cache. This is designed to be a safeguard to prevent oversubscribing a cluster. Defaults to 0. Min: `0`. Max: `100`.
`cluster.remote_store`	Cluster.remote Store	no
`cluster.routing.allocation.balance.prefer_primary`	boolean	no	When set to true, OpenSearch attempts to evenly distribute the primary shards between the cluster nodes. Enabling this setting does not always guarantee an equal number of primary shards on each node, especially in the event of a failover. Changing this setting to false after it was set to true does not invoke redistribution of primary shards. Default is false.
`cluster.search.request.slowlog`	Cluster.search.request.slowlog	no

Cluster.remote Store

Property	Type	Required	Description
`state.global_metadata.upload_timeout`	string	no	The amount of time to wait for the cluster state upload to complete. Defaults to 20s.
`state.metadata_manifest.upload_timeout`	string	no	The amount of time to wait for the manifest file upload to complete. The manifest file contains the details of each of the files uploaded for a single cluster state, both index metadata files and global metadata files. Defaults to 20s.
`translog.buffer_interval`	string	no	The default value of the translog buffer interval used when performing periodic translog updates. This setting is only effective when the index setting `index.remote_store.translog.buffer_interval` is not present. Defaults to 650ms.
`translog.max_readers`	integer	no	Sets the maximum number of open translog files for remote-backed indexes. This limits the total number of translog files per shard. After reaching this limit, the remote store flushes the translog files. Default is 1000. The minimum required is 100. Min: `100`. Max: `2.147483647e+09`.

Cluster.search.request.slowlog

Property	Type	Required	Description
`level`	string	no	Allowed values: `debug`, `info`, `trace`, `warn`. Default: `trace`.
`threshold`	Threshold	no

Threshold

Property	Type	Required
`debug`	string	no
`info`	string	no
`trace`	string	no
`warn`	string	no

Segrep

Property	Type	Required	Description
`pressure.checkpoint.limit`	integer	no	The maximum number of indexing checkpoints that a replica shard can fall behind when copying from primary. Once `segrep.pressure.checkpoint.limit` is breached along with `segrep.pressure.time.limit`, the segment replication backpressure mechanism is initiated. Default is 4 checkpoints. Min: `0`. Default: `4`.
`pressure.enabled`	boolean	no	Enables the segment replication backpressure mechanism. Default is false. Default: `false`.
`pressure.replica.stale.limit`	number	no	The maximum number of stale replica shards that can exist in a replication group. Once `segrep.pressure.replica.stale.limit` is breached, the segment replication backpressure mechanism is initiated. Default is .5, which is 50% of a replication group. Min: `0`. Max: `1`. Default: `0.5`.
`pressure.time.limit`	string	no	The maximum amount of time that a replica shard can take to copy from the primary shard. Once segrep.pressure.time.limit is breached along with segrep.pressure.checkpoint.limit, the segment replication backpressure mechanism is initiated. Default is 5 minutes. Default: `5m`.

Email Sender

Property	Type	Required	Description
`email_sender_name`	string	yes	This should be identical to the Sender name defined in Opensearch dashboards Max length: `40`.
`email_sender_password`	string	yes	Sender password for Opensearch alerts to authenticate with SMTP server Max length: `1024`.
`email_sender_username`	string	yes	Max length: `320`.

Disk Watermarks

Property	Type	Required	Description
`flood_stage`	integer	yes	The flood stage watermark for disk usage.
`high`	integer	yes	The high watermark for disk usage.
`low`	integer	yes	The low watermark for disk usage.

Auth Failure Listeners

Property	Type	Required	Description
`internal_authentication_backend_limiting`	Internal Authentication Backend Limiting	no
`ip_rate_limiting`	IP Rate Limiting	no

Internal Authentication Backend Limiting

Property	Type	Required	Description
`allowed_tries`	integer	no	The number of login attempts allowed before login is blocked Min: `0`. Max: `2.147483647e+09`.
`authentication_backend`	string	no	The internal backend. Enter `internal` Allowed values: `internal`. Max length: `1024`.
`block_expiry_seconds`	integer	no	The duration of time that login remains blocked after a failed login Min: `0`. Max: `2.147483647e+09`.
`max_blocked_clients`	integer	no	The maximum number of blocked IP addresses Min: `0`. Max: `2.147483647e+09`.
`max_tracked_clients`	integer	no	The maximum number of tracked IP addresses that have failed login Min: `0`. Max: `2.147483647e+09`.
`time_window_seconds`	integer	no	The window of time in which the value for `allowed_tries` is enforced Min: `0`. Max: `2.147483647e+09`.
`type`	string	no	The type of rate limiting Allowed values: `username`. Max length: `1024`.

IP Rate Limiting

Property	Type	Required	Description
`allowed_tries`	integer	no	The number of login attempts allowed before login is blocked Min: `1`. Max: `2.147483647e+09`.
`block_expiry_seconds`	integer	no	The duration of time that login remains blocked after a failed login Min: `1`. Max: `36000`.
`max_blocked_clients`	integer	no	The maximum number of blocked IP addresses Min: `0`. Max: `2.147483647e+09`.
`max_tracked_clients`	integer	no	The maximum number of tracked IP addresses that have failed login Min: `0`. Max: `2.147483647e+09`.
`time_window_seconds`	integer	no	The window of time in which the value for `allowed_tries` is enforced Min: `1`. Max: `36000`.
`type`	string	no	The type of rate limiting Allowed values: `ip`. Max length: `1024`.

Ism History

Property	Type	Required	Description
`ism_enabled`	boolean	yes	Default: `true`.
`ism_history_enabled`	boolean	no	Default: `true`.
`ism_history_max_age`	integer	no	Min: `1`. Max: `2.147483647e+09`. Default: `24`.
`ism_history_max_docs`	integer	no	Min: `1`. Max: `9.223372036854776e+18`. Default: `2500000`.
`ism_history_rollover_check_period`	integer	no	Min: `1`. Max: `2.147483647e+09`. Default: `8`.
`ism_history_rollover_retention_period`	integer	no	Min: `1`. Max: `2.147483647e+09`. Default: `30`.

Ml Commons

Property	Type	Required	Description
`ml_commons_model_access_control_enabled`	boolean	no	Enable or disable model access control for ML Commons. When enabled, access to ML models is controlled by security permissions. Defaults to false.
`ml_commons_native_memory_threshold`	integer	no	Native memory threshold percentage for ML Commons. Controls the maximum percentage of native memory that can be used by ML Commons operations. Defaults to 90%. Min: `1`. Max: `100`.
`ml_commons_only_run_on_ml_node`	boolean	no	Enable or disable running ML Commons tasks only on ML nodes. When enabled, ML tasks will only execute on nodes designated as ML nodes. Defaults to true.

Last updated on September 28, 2026