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

    Hide node_types attributes Show node_types attributes object

    Information about the node type.

    • node_type string Required

      Node type, part of the key for this resource

    • name string Required

      Node type name

    • description string Required

      Node type description

    • default_instance_configuration_id string

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

    • mandatory boolean

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

  • compatibility array[object] Required

    Compatible versions

    Hide compatibility attributes Show compatibility attributes object

    Information about the compatible version.

    • 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

      Information about the compatible node types.

      • 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 versions. When specified its value will be ignored.

      Capacity constraints for the version

      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.