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.

› › › ›

Update stack version

edit

Update stack version

edit

Updates the Elastic Stack version configuration.

Request

edit

PUT /api/v1/stack/versions/{version}

Path parameters

edit

Name	Type	Required	Description
`version`	`string`	Y	The Elastic Stack version. For example, `5.3.1` or `5.0.0-RC4`.

Request body

edit

(StackVersionConfigPost) (required) Elastic Stack configuration object

Responses

edit

200

(StackVersionConfig) The Elastic Stack version successfully updated.

404

(BasicFailedReply) The Elastic Stack version can't be found. (code: stackpack.missing_platform_version)

Headers

x-cloud-error-codes (string; allowed values: [stackpack.missing_platform_version]): The error codes associated with the response

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request example

edit

curl -XPUT https://{{hostname}}/api/v1/stack/versions/{version} \
-H "Authorization: ApiKey $ECE_API_KEY" \
-H 'Content-Type: application/json' \
-d '
{
   "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"
   },
   "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
   },
   "sitesearch" : {
      "blacklist" : [
         "string"
      ],
      "capacity_constraints" : null,
      "compatible_node_types" : [
         "string"
      ],
      "docker_image" : "string",
      "node_types" : [
         null
      ],
      "settings" : {},
      "version" : "string"
   }
}
'

« Get stack version Telemetry »