StackVersionConfig

edit

The details for an Elastic Stack configuration.

Properties

edit
accessible (boolean)
Whether or not this version is accessible by the calling user. This is only relevant in EC (SaaS) and is not sent in ECE.
apm (StackVersionApmConfig)
The APM Server configuration for an Elastic Stack version.
appsearch (StackVersionAppSearchConfig)
AppSearch related configuration of an Elastic Stack version
deleted (boolean)
Identifies that the Elastic Stack version is marked for deletion
elasticsearch (StackVersionElasticsearchConfig, required)
The Elasticsearch configuration for an Elastic Stack version.
enterprisesearch (StackVersionEnterpriseSearchConfig)
EnterpriseSearch related configuration of an Elastic Stack version
kibana (StackVersionKibanaConfig, required)
The Kibana configuration for an Elastic Stack version.
metadata (StackVersionMetadata)
The metadata for the Elastic Stack.
min_upgradable_from (string)

The minimum version recommended to upgrade this version.

Example: "6.7.0"

sitesearch (StackVersionSiteSearchConfig)
SiteSearch related configuration of an Elastic Stack version
template (StackVersionTemplateInfo, required)
The template information for an Elastic Stack version.
upgradable_to (array[string], required)
Stack Versions that this version can upgrade to
version (string)
Stack version
whitelisted (boolean)
Whether or not this version is whitelisted. This is only relevant in EC (SaaS) and is not sent in ECE.

Example

edit
{
   "accessible" : true,
   "apm" : {
      "blacklist" : [
         "string"
      ],
      "capacity_constraints" : {
         "max" : 0,
         "min" : 0
      },
      "compatible_node_types" : [
         "string"
      ],
      "docker_image" : "string",
      "settings" : {},
      "version" : "string"
   },
   "appsearch" : {
      "blacklist" : [
         "string"
      ],
      "capacity_constraints" : null,
      "compatible_node_types" : [
         "string"
      ],
      "docker_image" : "string",
      "node_types" : [
         {
            "capacity_constraints" : null,
            "compatible_node_types" : [
               "string"
            ],
            "description" : "string",
            "mandatory" : true,
            "name" : "string",
            "node_type" : "string",
            "settings" : {}
         }
      ],
      "settings" : {},
      "version" : "string"
   },
   "deleted" : true,
   "elasticsearch" : {
      "blacklist" : [
         "string"
      ],
      "capacity_constraints" : null,
      "compatible_node_types" : [
         "string"
      ],
      "default_plugins" : [
         "string"
      ],
      "docker_image" : "string",
      "node_types" : [
         null
      ],
      "plugins" : [
         "string"
      ],
      "settings" : {}
   },
   "enterprisesearch" : {
      "blacklist" : [
         "string"
      ],
      "capacity_constraints" : null,
      "compatible_node_types" : [
         "string"
      ],
      "docker_image" : "string",
      "node_types" : [
         null
      ],
      "settings" : {},
      "version" : "string"
   },
   "kibana" : {
      "blacklist" : [
         "string"
      ],
      "capacity_constraints" : null,
      "compatible_node_types" : [
         "string"
      ],
      "docker_image" : "string",
      "settings" : {},
      "version" : "string"
   },
   "metadata" : {
      "min_platform_version" : "string",
      "notes" : "string",
      "pre_release" : true,
      "schema_version" : 0
   },
   "min_upgradable_from" : "string",
   "sitesearch" : {
      "blacklist" : [
         "string"
      ],
      "capacity_constraints" : null,
      "compatible_node_types" : [
         "string"
      ],
      "docker_image" : "string",
      "node_types" : [
         null
      ],
      "settings" : {},
      "version" : "string"
   },
   "template" : {
      "hashes" : [
         {
            "hash" : "string",
            "path" : "string"
         }
      ],
      "template_version" : "string"
   },
   "upgradable_to" : [
      "string"
   ],
   "version" : "string",
   "whitelisted" : true
}