Get instance types

GET /stack/instance-types
Basic auth Api key

Retrieves a list of all instance types.

Responses

  • 200 application/json

    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

      Information about the node type.

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

      Compatible versions

      Information about the compatible version.

      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

        Information about the compatible node types.

        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

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

            Min capacity

          • max integer(int64) Required

            Max capacity

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

          Min capacity

        • max integer(int64) Required

          Max capacity

    • default_instance_configuration_id string

      Id of the default instance configuration to use for this instance type.
GET /stack/instance-types 
curl \
 --request GET 'https://{{hostname}}/api/v1/stack/instance-types' \
 --user "username:password"