Update stack version

PUT /stack/versions/{version}

Updates the Elastic Stack version configuration.

Path parameters

  • version string Required

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

Body Required

Elastic Stack configuration object

  • elasticsearch object Required

    The Elasticsearch configuration for an Elastic Stack version.

    Additional properties are allowed.

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

        Additional properties are allowed.

      • 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

        Additional properties are allowed.

        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

      Additional properties are allowed.

    • 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

      Additional properties are allowed.

      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.

    Additional properties are allowed.

    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

      Additional properties are allowed.

    • 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

      Additional properties are allowed.

      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.

    Additional properties are allowed.

    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

      Additional properties are allowed.

    • 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

      Additional properties are allowed.

      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

  • integrations_server object

    The Integrations Server configuration for an Elastic Stack version.

    Additional properties are allowed.

    Hide integrations_server attributes Show integrations_server attributes object
    • version string

      Version of Integrations Server

    • docker_image string Required

      Docker image for the Integrations Server

    • 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

      Additional properties are allowed.

    • 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

      Additional properties are allowed.

      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

    Additional properties are allowed.

    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

      Additional properties are allowed.

    • 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

      Additional properties are allowed.

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

        Additional properties are allowed.

      • 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

        Additional properties are allowed.

        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

    Additional properties are allowed.

    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

      Additional properties are allowed.

    • 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

      Additional properties are allowed.

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

        Additional properties are allowed.

      • 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

        Additional properties are allowed.

        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.

    Additional properties are allowed.

    Hide metadata attributes Show metadata attributes object

Responses

  • 200

    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.

      Additional properties are allowed.

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

      Additional properties are allowed.

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

          Additional properties are allowed.

        • 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

          Additional properties are allowed.

          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

        Additional properties are allowed.

      • 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

        Additional properties are allowed.

        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.

      Additional properties are allowed.

      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

        Additional properties are allowed.

      • 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

        Additional properties are allowed.

        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.

      Additional properties are allowed.

      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

        Additional properties are allowed.

      • 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

        Additional properties are allowed.

        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

      Additional properties are allowed.

      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

        Additional properties are allowed.

      • 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

        Additional properties are allowed.

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

          Additional properties are allowed.

        • 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

          Additional properties are allowed.

          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

      Additional properties are allowed.

      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

        Additional properties are allowed.

      • 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

        Additional properties are allowed.

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

          Additional properties are allowed.

        • 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

          Additional properties are allowed.

          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.

      Additional properties are allowed.

      Hide metadata attributes Show metadata attributes object
    • 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.
  • 404

    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
PUT /stack/versions/{version} 
curl \
 -X PUT https://{{hostname}}/api/v1/stack/versions/{version} \
 -d '{"elasticsearch":{"docker_image":"string","plugins":["string"],"default_plugins":["string"],"blacklist":["string"],"node_types":[{"node_type":"string","name":"string","description":"string","settings":{},"capacity_constraints":{"min":42,"max":42},"compatible_node_types":["string"],"mandatory":true}],"settings":{},"capacity_constraints":{"min":42,"max":42},"compatible_node_types":["string"]},"kibana":{"version":"string","docker_image":"string","blacklist":["string"],"settings":{},"capacity_constraints":{"min":42,"max":42},"compatible_node_types":["string"]},"apm":{"version":"string","docker_image":"string","blacklist":["string"],"settings":{},"capacity_constraints":{"min":42,"max":42},"compatible_node_types":["string"]},"integrations_server":{"version":"string","docker_image":"string","blacklist":["string"],"settings":{},"capacity_constraints":{"min":42,"max":42},"compatible_node_types":["string"]},"appsearch":{"version":"string","docker_image":"string","blacklist":["string"],"settings":{},"capacity_constraints":{"min":42,"max":42},"compatible_node_types":["string"],"node_types":[{"node_type":"string","name":"string","description":"string","settings":{},"capacity_constraints":{"min":42,"max":42},"compatible_node_types":["string"],"mandatory":true}]},"enterprise_search":{"version":"string","docker_image":"string","blacklist":["string"],"settings":{},"capacity_constraints":{"min":42,"max":42},"compatible_node_types":["string"],"node_types":[{"node_type":"string","name":"string","description":"string","settings":{},"capacity_constraints":{"min":42,"max":42},"compatible_node_types":["string"],"mandatory":true}]},"metadata":{"notes":"string","pre_release":true,"min_platform_version":"string","min_wire_compatibility_version":"string","min_index_compatibility_version":"string","schema_version":42}}'
Request examples 
{
  "elasticsearch": {
    "docker_image": "string",
    "plugins": [
      "string"
    ],
    "default_plugins": [
      "string"
    ],
    "blacklist": [
      "string"
    ],
    "node_types": [
      {
        "node_type": "string",
        "name": "string",
        "description": "string",
        "settings": {},
        "capacity_constraints": {
          "min": 42,
          "max": 42
        },
        "compatible_node_types": [
          "string"
        ],
        "mandatory": true
      }
    ],
    "settings": {},
    "capacity_constraints": {
      "min": 42,
      "max": 42
    },
    "compatible_node_types": [
      "string"
    ]
  },
  "kibana": {
    "version": "string",
    "docker_image": "string",
    "blacklist": [
      "string"
    ],
    "settings": {},
    "capacity_constraints": {
      "min": 42,
      "max": 42
    },
    "compatible_node_types": [
      "string"
    ]
  },
  "apm": {
    "version": "string",
    "docker_image": "string",
    "blacklist": [
      "string"
    ],
    "settings": {},
    "capacity_constraints": {
      "min": 42,
      "max": 42
    },
    "compatible_node_types": [
      "string"
    ]
  },
  "integrations_server": {
    "version": "string",
    "docker_image": "string",
    "blacklist": [
      "string"
    ],
    "settings": {},
    "capacity_constraints": {
      "min": 42,
      "max": 42
    },
    "compatible_node_types": [
      "string"
    ]
  },
  "appsearch": {
    "version": "string",
    "docker_image": "string",
    "blacklist": [
      "string"
    ],
    "settings": {},
    "capacity_constraints": {
      "min": 42,
      "max": 42
    },
    "compatible_node_types": [
      "string"
    ],
    "node_types": [
      {
        "node_type": "string",
        "name": "string",
        "description": "string",
        "settings": {},
        "capacity_constraints": {
          "min": 42,
          "max": 42
        },
        "compatible_node_types": [
          "string"
        ],
        "mandatory": true
      }
    ]
  },
  "enterprise_search": {
    "version": "string",
    "docker_image": "string",
    "blacklist": [
      "string"
    ],
    "settings": {},
    "capacity_constraints": {
      "min": 42,
      "max": 42
    },
    "compatible_node_types": [
      "string"
    ],
    "node_types": [
      {
        "node_type": "string",
        "name": "string",
        "description": "string",
        "settings": {},
        "capacity_constraints": {
          "min": 42,
          "max": 42
        },
        "compatible_node_types": [
          "string"
        ],
        "mandatory": true
      }
    ]
  },
  "metadata": {
    "notes": "string",
    "pre_release": true,
    "min_platform_version": "string",
    "min_wire_compatibility_version": "string",
    "min_index_compatibility_version": "string",
    "schema_version": 42
  }
}
Response examples (200) 
{
  "version": "string",
  "template": {
    "template_version": "string",
    "hashes": [
      {
        "path": "string",
        "hash": "string"
      }
    ]
  },
  "elasticsearch": {
    "docker_image": "string",
    "plugins": [
      "string"
    ],
    "default_plugins": [
      "string"
    ],
    "blacklist": [
      "string"
    ],
    "node_types": [
      {
        "node_type": "string",
        "name": "string",
        "description": "string",
        "settings": {},
        "capacity_constraints": {
          "min": 42,
          "max": 42
        },
        "compatible_node_types": [
          "string"
        ],
        "mandatory": true
      }
    ],
    "settings": {},
    "capacity_constraints": {
      "min": 42,
      "max": 42
    },
    "compatible_node_types": [
      "string"
    ]
  },
  "kibana": {
    "version": "string",
    "docker_image": "string",
    "blacklist": [
      "string"
    ],
    "settings": {},
    "capacity_constraints": {
      "min": 42,
      "max": 42
    },
    "compatible_node_types": [
      "string"
    ]
  },
  "apm": {
    "version": "string",
    "docker_image": "string",
    "blacklist": [
      "string"
    ],
    "settings": {},
    "capacity_constraints": {
      "min": 42,
      "max": 42
    },
    "compatible_node_types": [
      "string"
    ]
  },
  "appsearch": {
    "version": "string",
    "docker_image": "string",
    "blacklist": [
      "string"
    ],
    "settings": {},
    "capacity_constraints": {
      "min": 42,
      "max": 42
    },
    "compatible_node_types": [
      "string"
    ],
    "node_types": [
      {
        "node_type": "string",
        "name": "string",
        "description": "string",
        "settings": {},
        "capacity_constraints": {
          "min": 42,
          "max": 42
        },
        "compatible_node_types": [
          "string"
        ],
        "mandatory": true
      }
    ]
  },
  "enterprise_search": {
    "version": "string",
    "docker_image": "string",
    "blacklist": [
      "string"
    ],
    "settings": {},
    "capacity_constraints": {
      "min": 42,
      "max": 42
    },
    "compatible_node_types": [
      "string"
    ],
    "node_types": [
      {
        "node_type": "string",
        "name": "string",
        "description": "string",
        "settings": {},
        "capacity_constraints": {
          "min": 42,
          "max": 42
        },
        "compatible_node_types": [
          "string"
        ],
        "mandatory": true
      }
    ]
  },
  "metadata": {
    "notes": "string",
    "pre_release": true,
    "min_platform_version": "string",
    "min_wire_compatibility_version": "string",
    "min_index_compatibility_version": "string",
    "schema_version": 42
  },
  "deleted": true,
  "upgradable_to": [
    "string"
  ],
  "min_upgradable_from": "6.7.0",
  "whitelisted": true,
  "accessible": true
}
Response examples (404) 
# Headers
x-cloud-error-codes: stackpack.missing_platform_version

# Payload
{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}