Path parameters

• version string Required

  The Elastic Stack version. For example, 5.3.1 or 5.0.0-RC4.

Responses

• 200 application/json

  The Elastic Stack version successfully updated.

  Hide response attributes Show response attributes object

  • version string

    Stack version

  • template object Required

    The template information for an Elastic Stack version.

    Hide template attributes Show template attributes object

    • template_version string

      Template version

    • hashes array[object]

      Relative paths of files with SHA-256 hashes that contains the template

      Hide hashes attributes Show hashes attributes object

      The template file hash for an Elastic Stack version.

      • path string Required

        File path relative to template's root

      • hash string Required

        SHA-256 hash of a file

  • elasticsearch object Required

    The Elasticsearch configuration for an Elastic Stack version.

    Hide elasticsearch attributes Show elasticsearch attributes object

    • docker_image string Required

      Docker image for the Elasticsearch

    • plugins array[string] Required

      List of available plugins

    • default_plugins array[string] Required

      List of default plugins

    • blacklist array[string] Required

      List of configuration options that cannot be overridden by user settings

    • node_types array[object]

      Node types that are supported by this stack version

      Hide node_types attributes Show node_types attributes object

      The configuration for an Elastic Stack node type.

      • node_type string Required

        Type of the node (master, data, ...)

      • name string Required

        Name of the node type

      • description string Required

        Description of the node type

      • settings object

        Settings that are applied to all nodes of this type

      • capacity_constraints object

        WARNING This endpoint is deprecated and scheduled to be removed in the next major version. This field will soon be removed in favor of having a global capacity constraint for all node types.

        Capacity constraints for the node type

        Hide capacity_constraints attributes Show capacity_constraints attributes object

        • min integer(int32) Required

          Min capacity of the instances

        • max integer(int32) Required

          Max capacity of the instances

      • compatible_node_types array[string]

        Node types that are compatible with this one

      • mandatory boolean

        Flag to specify a node type is mandatory in a cluster's plan

    • settings object

      Settings that are applied to all nodes of this type

    • capacity_constraints object

      WARNING This endpoint is deprecated and scheduled to be removed in the next major version. This field will soon be removed in favor of having a global capacity constraint for all node types.

      Capacity constraints for the node type

      Hide capacity_constraints attributes Show capacity_constraints attributes object

      • min integer(int32) Required

        Min capacity of the instances

      • max integer(int32) Required

        Max capacity of the instances

    • compatible_node_types array[string]

      Node types that are compatible with this one

  • kibana object Required

    The Kibana configuration for an Elastic Stack version.

    Hide kibana attributes Show kibana attributes object

    • version string

      Version of Kibana

    • docker_image string Required

      Docker image for the kibana

    • blacklist array[string] Required

      List of configuration options that cannot be overridden by user settings

    • settings object

      Settings that are applied to all nodes of this type

    • capacity_constraints object

      WARNING This endpoint is deprecated and scheduled to be removed in the next major version. This field will soon be removed in favor of having a global capacity constraint for all node types.

      Capacity constraints for the node type

      Hide capacity_constraints attributes Show capacity_constraints attributes object

      • min integer(int32) Required

        Min capacity of the instances

      • max integer(int32) Required

        Max capacity of the instances

    • compatible_node_types array[string]

      Node types that are compatible with this one

  • apm object

    The APM Server configuration for an Elastic Stack version.

    Hide apm attributes Show apm attributes object

    • version string

      Version of APM

    • docker_image string Required

      Docker image for the APM

    • blacklist array[string] Required

      List of configuration options that cannot be overridden by user settings

    • settings object

      Settings that are applied to all nodes of this type

    • capacity_constraints object

      WARNING This endpoint is deprecated and scheduled to be removed in the next major version. This field will soon be removed in favor of having a global capacity constraint for all node types.

      Capacity constraints for the node type

      Hide capacity_constraints attributes Show capacity_constraints attributes object

      • min integer(int32) Required

        Min capacity of the instances

      • max integer(int32) Required

        Max capacity of the instances

    • compatible_node_types array[string]

      Node types that are compatible with this one

  • appsearch object

    AppSearch related configuration of an Elastic Stack version

    Hide appsearch attributes Show appsearch attributes object

    • version string

      Version of AppSearch

    • docker_image string Required

      Docker image for the AppSearch

    • blacklist array[string] Required

      List of configuration options that cannot be overridden by user settings

    • settings object

      Settings that are applied to all nodes of this type

    • capacity_constraints object

      WARNING This endpoint is deprecated and scheduled to be removed in the next major version. This field will soon be removed in favor of having a global capacity constraint for all node types.

      Capacity constraints for the node type

      Hide capacity_constraints attributes Show capacity_constraints attributes object

      • min integer(int32) Required

        Min capacity of the instances

      • max integer(int32) Required

        Max capacity of the instances

    • compatible_node_types array[string]

      Node types that are compatible with this one

    • node_types array[object]

      Node types that are supported by this stack version

      Hide node_types attributes Show node_types attributes object

      The configuration for an Elastic Stack node type.

      • node_type string Required

        Type of the node (master, data, ...)

      • name string Required

        Name of the node type

      • description string Required

        Description of the node type

      • settings object

        Settings that are applied to all nodes of this type

      • capacity_constraints object

        WARNING This endpoint is deprecated and scheduled to be removed in the next major version. This field will soon be removed in favor of having a global capacity constraint for all node types.

        Capacity constraints for the node type

        Hide capacity_constraints attributes Show capacity_constraints attributes object

        • min integer(int32) Required

          Min capacity of the instances

        • max integer(int32) Required

          Max capacity of the instances

      • compatible_node_types array[string]

        Node types that are compatible with this one

      • mandatory boolean

        Flag to specify a node type is mandatory in a cluster's plan

  • enterprise_search object

    EnterpriseSearch related configuration of an Elastic Stack version

    Hide enterprise_search attributes Show enterprise_search attributes object

    • version string

      Version of EnterpriseSearch

    • docker_image string Required

      Docker image for the EnterpriseSearch

    • blacklist array[string] Required

      List of configuration options that cannot be overridden by user settings

    • settings object

      Settings that are applied to all nodes of this type

    • capacity_constraints object

      WARNING This endpoint is deprecated and scheduled to be removed in the next major version. This field will soon be removed in favor of having a global capacity constraint for all node types.

      Capacity constraints for the node type

      Hide capacity_constraints attributes Show capacity_constraints attributes object

      • min integer(int32) Required

        Min capacity of the instances

      • max integer(int32) Required

        Max capacity of the instances

    • compatible_node_types array[string]

      Node types that are compatible with this one

    • node_types array[object]

      Node types that are supported by this stack version

      Hide node_types attributes Show node_types attributes object

      The configuration for an Elastic Stack node type.

      • node_type string Required

        Type of the node (master, data, ...)

      • name string Required

        Name of the node type

      • description string Required

        Description of the node type

      • settings object

        Settings that are applied to all nodes of this type

      • capacity_constraints object

        WARNING This endpoint is deprecated and scheduled to be removed in the next major version. This field will soon be removed in favor of having a global capacity constraint for all node types.

        Capacity constraints for the node type

        Hide capacity_constraints attributes Show capacity_constraints attributes object

        • min integer(int32) Required

          Min capacity of the instances

        • max integer(int32) Required

          Max capacity of the instances

      • compatible_node_types array[string]

        Node types that are compatible with this one

      • mandatory boolean

        Flag to specify a node type is mandatory in a cluster's plan

  • metadata object

    The metadata for the Elastic Stack.

    Hide metadata attributes Show metadata attributes object

    • notes string

      Notes for administrator

    • pre_release boolean

      Indicates that the stack pack version is not GA and is not supposed to be used in production

    • min_platform_version string

      The minimum version of the platform that the stack pack version is compatible with

    • min_wire_compatibility_version string

      The minimum version required for performing a rolling upgrade to this stack version.

    • min_index_compatibility_version string

      The minimum version required for performing a full cluster restart upgrade to this stack version.

    • schema_version integer(int32)

      The schema version of the stack pack version

  • deleted boolean

    Identifies that the Elastic Stack version is marked for deletion

  • upgradable_to array[string] Required

    Stack Versions that this version can upgrade to

  • min_upgradable_from string

    The minimum version recommended to upgrade this version.

  • whitelisted boolean

    Whether or not this version is whitelisted. This is only relevant in EC (SaaS) and is not sent in ECE.

  • 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.

  • rolling_upgrade_compatible_versions array[string]

    List of versions that can be upgraded to the current version of the stackpack

• 404 application/json

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

  Hide headers attribute Show headers attribute

  • x-cloud-error-codes string

    The error codes associated with the response

    Value is stackpack.missing_platform_version.

  Hide response attribute Show response attribute object

  • errors array[object] Required

    A list of errors that occurred in the failing request

    Hide errors attributes Show errors attributes object

    • code string Required

      A structured code representing the error type that occurred

    • message string Required

      A human readable message describing the error that occurred

    • fields array[string]

      If the error can be tied to a specific field or fields in the user request, this lists those fields