Get instance types

GET /stack/instance-types

Retrieves a list of all instance types.

Responses

  • List of node types

    Hide response attributes Show response attributes object
    • instance_type string Required

      Instance type, the key for this resource

      Values are elasticsearch, kibana, apm, integrations_server, appsearch, or enterprise_search.

    • name string Required

      Instance type name

    • description string Required

      Instance type description

    • node_types array[object] Required

      Supported node types

      Hide node_types attributes Show node_types attributes object
    • compatibility array[object] Required

      Compatible versions

      Hide compatibility attributes Show compatibility attributes object
      • version string Required

        Compatible version, the key for this resource

      • node_types array[object] Required

        Supported node types for the version

        Hide node_types attributes Show node_types attributes object
        • node_type string Required

          Type of this node

        • compatible_node_types array[string] Required

          Compatible node types for the this node type

        • 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(int64) Required

            Min capacity

          • max integer(int64) Required

            Max capacity

      • 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(int64) Required

          Min capacity

        • max integer(int64) Required

          Max capacity

    • Id of the default instance configuration to use for this instance type.

GET /stack/instance-types
curl \
 -X GET https://{{hostname}}/api/v1/stack/instance-types
Response examples (200)
[
  {
    "instance_type": "elasticsearch",
    "name": "string",
    "description": "string",
    "node_types": [
      {
        "node_type": "string",
        "name": "string",
        "description": "string",
        "default_instance_configuration_id": "string",
        "mandatory": true
      }
    ],
    "compatibility": [
      {
        "version": "string",
        "node_types": [
          {
            "node_type": "string",
            "compatible_node_types": [
              "string"
            ],
            "capacity_constraints": {
              "min": 42,
              "max": 42
            }
          }
        ],
        "capacity_constraints": {
          "min": 42,
          "max": 42
        }
      }
    ],
    "default_instance_configuration_id": "string"
  }
]