New

The executive guide to generative AI

Read more
About usPartnersSupport|Login

It is time to say goodbye: This version of Elastic Cloud Enterprise has reached end-of-life (EOL) and is no longer supported.

The documentation for this version is no longer being maintained. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.

« ElasticsearchClustersInfo ElasticsearchCuration »
Elastic Docs ›Elastic Cloud Enterprise Reference [2.0] ›RESTful API ›API reference ›Definitions

ElasticsearchConfiguration

edit

ElasticsearchConfiguration

edit

Defines the Elasticsearch cluster settings. (If specified at the top level provides a field-by-field default; at the topology level provides the overrides)

Properties

edit
curation (ElasticsearchCuration)
Defines the index curation routing for the cluster
docker_image (string)
A docker URI that allows overriding of the default docker image specified for this version
enabled_built_in_plugins (array[string])
A list of plugin names from the Elastic-supported subset that are bundled with the version images. NOTES: (Users should consult the Elastic stack objects to see what plugins are available, this is currently only available from the UI)
system_settings (ElasticsearchSystemSettings)
This structure defines a curated subset of the Elasticsearch settings that are of particular relevance to ECE. (This field together with 'user_settings_override_' and 'user_settings_' defines the total set of Elasticsearch settings)
user_bundles (array[ElasticsearchUserBundle])
A list of admin-uploaded bundle objects (eg scripts, synonym files) that are available for this user.
user_plugins (array[ElasticsearchUserPlugin])
A list of admin-uploaded plugin objects that are available for this user.
user_settings_json (object)
An arbitrary JSON object allowing cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided they are on the whitelist ('user_settings_whitelist') and not on the blacklist ('user_settings_blacklist'). NOTES: (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Elasticsearch settings)
user_settings_override_json (object)
An arbitrary JSON object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), ie in addition to the documented 'system_settings'. NOTES: (This field together with 'system_settings' and 'user_settings*' defines the total set of Elasticsearch settings)
user_settings_override_yaml (string)
An arbitrary YAML object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_json' is allowed), ie in addition to the documented 'system_settings'. NOTES: (This field together with 'system_settings' and 'user_settings*' defines the total set of Elasticsearch settings)
user_settings_yaml (string)
An arbitrary YAML object allowing cluster owners to set their parameters (only one of this and 'user_settings_json' is allowed), provided they are on the whitelist ('user_settings_whitelist') and not on the blacklist ('user_settings_blacklist'). NOTES: (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Elasticsearch settings)
version (string)
The version of the Elasticsearch cluster (must be one of the ECE supported versions). Currently cannot be different across the topology (and is generally specified in the globals)

Example

edit
{
   "curation" : {
      "from_instance_configuration_id" : "string",
      "to_instance_configuration_id" : "string"
   },
   "docker_image" : "string",
   "enabled_built_in_plugins" : [
      "string"
   ],
   "system_settings" : {
      "auto_create_index" : true,
      "default_shards_per_index" : 0,
      "destructive_requires_name" : true,
      "enable_close_index" : true,
      "monitoring_collection_interval" : 0,
      "monitoring_history_duration" : "string",
      "reindex_whitelist" : [
         "string"
      ],
      "scripting" : {
         "expressions_enabled" : true,
         "file" : {
            "enabled" : true,
            "sandbox_mode" : true
         },
         "inline" : null,
         "mustache_enabled" : true,
         "painless_enabled" : true,
         "stored" : null
      },
      "use_disk_threshold" : true,
      "watcher_trigger_engine" : "string"
   },
   "user_bundles" : [
      {
         "elasticsearch_version" : "string",
         "name" : "string",
         "url" : "string"
      }
   ],
   "user_plugins" : [
      {
         "elasticsearch_version" : "string",
         "name" : "string",
         "url" : "string"
      }
   ],
   "user_settings_json" : {},
   "user_settings_override_json" : {},
   "user_settings_override_yaml" : "string",
   "user_settings_yaml" : "string",
   "version" : "string"
}
« ElasticsearchClustersInfo ElasticsearchCuration »

On this page

Was this helpful?
Feedback