Search Deployments

POST /deployments/_search

Retrieves the information for all of the deployments that match the specified query.

Query parameters

  • minimal_metadata string

    Comma separated list of attributes to include in response for deployments found. Useful for reducing response size when retrieving many deployments. Use of this parameter moves the result to the minimal_metadata section of the response.

application/json

Body

(Optional) The search query to run. When not specified, all of the deployments are matched.

  • from integer(int32)

    Deprecated, use cursor for a more scalable approach to paging.

  • cursor string

    To retrieve the next page of hits, set this to the cursor value of the previous response. When set, all other fields are ignored.

  • size integer(int32)

    The maximum number of search results to return.

  • query object

    The container for all of the allowed Elasticsearch queries. Specify only one property each time.

    Hide query attributes Show query attributes object
    • match object
      Hide match attribute Show match attribute object
      • * object Additional properties

        Consumes and analyzes text, numbers, and dates, then constructs a query.

        Hide * attributes Show * attributes object
        • query string Required

          The text/numeric/date to query for.

        • operator string

          The operator flag can be set to or or and to control the boolean clauses (defaults to or).

        • minimum_should_match integer(int32)

          The minimum number of optional should clauses to match.

        • analyzer string

          The analyzer that will be used to perform the analysis process on the text. Defaults to the analyzer that was used to index the field.

    • match_all object

      A query that matches all documents.

    • match_none object

      A query that doesn't match any documents.

    • term object
      Hide term attribute Show term attribute object
      • * object Additional properties

        A query for documents that contain the specified term in the inverted index.

        Hide * attribute Show * attribute object
        • value string Required

          The exact value to query for.

    • bool object

      A query for documents that match boolean combinations of other queries.

      Hide bool attributes Show bool attributes object
      • must array[object]

        The container for all of the allowed Elasticsearch queries. Specify only one property each time.

        The container for all of the allowed Elasticsearch queries. Specify only one property each time.

      • should array[object]

        The container for all of the allowed Elasticsearch queries. Specify only one property each time.

        The container for all of the allowed Elasticsearch queries. Specify only one property each time.

      • must_not array[object]

        The container for all of the allowed Elasticsearch queries. Specify only one property each time.

        The container for all of the allowed Elasticsearch queries. Specify only one property each time.

      • filter array[object]

        The container for all of the allowed Elasticsearch queries. Specify only one property each time.

        The container for all of the allowed Elasticsearch queries. Specify only one property each time.

      • minimum_should_match integer(int32)

        The minimum number of optional should clauses to match.

    • query_string object

      A query that uses the strict query string syntax for parsing. Will return an error for invalid syntax.

      Hide query_string attributes Show query_string attributes object
      • query string Required

        The actual query to be parsed.

      • default_field string

        The default field for query terms if no prefix field is specified.

      • analyzer string

        The analyzer used to analyze each term of the query when creating composite queries.

      • default_operator string

        The default operator used if no explicit operator is specified.

      • allow_leading_wildcard boolean

        When set, * or ? are allowed as the first character. Defaults to false.

    • nested object

      A query that matches nested objects.

      Hide nested attributes Show nested attributes object
      • query object Required

        The container for all of the allowed Elasticsearch queries. Specify only one property each time.

      • path string Required

        The path to the nested object.

      • score_mode string

        Allows to specify how inner children matching affects score of the parent. Refer to the Elasticsearch documentation for details.

        Values are avg, sum, min, max, or none.

    • prefix object
      Hide prefix attribute Show prefix attribute object
      • * object Additional properties

        The query that matches documents with fields that contain terms with a specified, not analyzed, prefix.

        Hide * attributes Show * attributes object
        • value string Required

          The prefix to search for.

        • boost number(float)

          An optional boost value to apply to the query.

    • exists object

      Matches documents that have at least one non-null value in the original field.

      Hide exists attribute Show exists attribute object
      • field string Required

        The field to check for non-null values in.

    • range object
      Hide range attribute Show range attribute object
      • * object Additional properties

        The query that matches documents with fields that contain terms within a specified range.

        Hide * attributes Show * attributes object
        • gt object

          Greater-than

        • gte object

          Greater-than or equal to

        • lt object

          Less-than

        • lte object

          Less-than or equal to.

        • boost number(float)

          An optional boost value to apply to the query.

        • format string

          Formatted dates will be parsed using the format specified on the date field by default, but it can be overridden by passing the format parameter.

        • time_zone string

          Dates can be converted from another timezone to UTC either by specifying the time zone in the date value itself (if the format accepts it), or it can be specified as the time_zone parameter.

    • simple_query_string object

      A query that uses simple query string syntax. Will ignore invalid syntax.

      Hide simple_query_string attributes Show simple_query_string attributes object
      • query string Required

        The query expressed in simple query string syntax.

      • fields array[string]

        Array of fields to search

      • default_operator string

        The boolean operator used to combine the terms of the query. Valid values are OR (default) and AND.

      • analyze_wildcard boolean

        If true, the query attempts to analyze wildcard terms. Defaults to false.

      • analyzer string

        The name of the analyzer to use to convert the query text into tokens.

      • auto_generate_synonyms_phrase_query boolean

        If true, the parse creates a match_phrase uery for each multi-position token. Defaults to true.

      • flags string

        List of enabled operators for the simple query string syntax. Defaults to ALL.

      • fuzzy_max_expansions integer(int32)

        Maximum number of terms to which the query expands for fuzzy matching. Defaults to 50.

      • fuzzy_prefix_length integer(int32)

        Number of beginning characters left unchanged for fuzzy matching. Defaults to 0.

      • fuzzy_transpositions boolean

        If true, edits for fuzzy matching include transpositions of two adjacent characters. Defaults to false.

      • lenient boolean

        If true, format-based errors, such as providing a text value for a numeric field are ignored. Defaults to false.

      • minimum_should_match string

        Minimum number of clauses that must match for a document to be returned.

      • quote_field_suffix string

        Suffix appended to quoted text in the query string.

  • sort array[object]

    An array of fields to sort the search results by. Defaults to query rank and last modified date descending.

Responses

  • 200 application/json

    The list of deployments that match the specified query and belong to the authenticated user.

    Hide headers attributes Show headers attributes
    Hide response attributes Show response attributes object
    • return_count integer(int32) Required

      The number of deployments actually returned, either as deployment instances or as minimalMetadata objects

    • match_count integer(int32)

      If a query is supplied, then the total number of deployments that matched

    • deployments array[object] Required

      Describes a searched Deployment

      Hide deployments attributes Show deployments attributes object
      • id string Required

        A randomly-generated id of this Deployment

      • name string Required

        The name of this deployment

      • alias string

        A user-defined deployment alias for user-friendly resource URLs

      • healthy boolean Required

        Whether the deployment is overall healthy or not (one or more of the resource info subsections will have healthy: false)

      • resources object Required

        The Resources that belong to this Deployment

        Hide resources attributes Show resources attributes object
        • elasticsearch array[object] Required

          List of Elasticsearch resources in your Deployment

          Describes an Elasticsearch resource belonging to a Deployment

          Hide elasticsearch attributes Show elasticsearch attributes object
          • ref_id string Required

            The locally-unique user-specified id of a Resource

          • id string Required

            The randomly-generated id of a Resource

          • region string Required

            The region where this resource exists

          • info object Required

            Info for the resource.

            Hide info attributes Show info attributes object
            • cluster_id string Required

              The id of the cluster

            • cluster_name string Required

              The name of the cluster

            • deployment_id string

              The id of the deployment that this Elasticsearch belongs to.

            • healthy boolean Required

              Whether the cluster is healthy or not (one or more of the info subsections will have healthy: false)

            • status string Required

              Cluster status

              Values are initializing, stopping, stopped, rebooting, restarting, reconfiguring, or started.

            • plan_info object Required

              Information about the current, pending, and past Elasticsearch cluster plans.

              Hide plan_info attributes Show plan_info attributes object
              • healthy boolean Required

                Whether the plan situation is healthy (if unhealthy, means the last plan attempt failed)

              • current object

                Information about the Elasticsearch cluster plan.

                Hide current attributes Show current attributes object
                • plan_attempt_id string

                  A UUID for each plan attempt

                • plan_attempt_name string

                  A human readable name for each plan attempt, only populated when retrieving plan histories

                • healthy boolean Required

                  Either the plan ended successfully, or is not yet completed (and no errors have occurred)

                • attempt_start_time string(date-time)

                  When this plan attempt (ie to apply the plan to the cluster) started (ISO format in UTC)

                • attempt_end_time string(date-time)

                  If this plan completed or failed (ie is not pending), when the attempt ended (ISO format in UTC)

                • plan_end_time string(date-time)

                  If this plan is not current or pending, when the plan was no longer active (ISO format in UTC)

                • plan object

                  The plan for building this Elasticsearch cluster

                  Hide plan attributes Show plan attributes object
                  • cluster_topology array[object] Required

                    The topology of the Elasticsearch nodes, including the number, capacity, and type of nodes, and where they can be allocated.

                    Hide cluster_topology attributes Show cluster_topology attributes object
                    • id string

                      Unique identifier of this topology element

                    • node_type object

                      Controls the combinations of Elasticsearch node types. TIP: By default, the Elasticsearch node is master eligible, can hold data, and run ingest pipelines. WARNING: Do not set for tiebreaker topologies.

                      Hide node_type attributes Show node_type attributes object
                      • master boolean

                        Defines whether this node can be elected master (default: false)

                      • data boolean

                        Defines whether this node can hold data (default: false)

                      • ingest boolean

                        Defines whether this node can run an ingest pipeline (default: false)

                      • ml boolean

                        Defines whether this node can run ml jobs, valid only for versions 5.4.0 or greater (default: false)

                    • node_roles array[string]

                      The list of node roles for this topology element (ES version >= 7.10). Allowable values are: master, ingest, ml, data_hot, data_content, data_warm, data_cold, data_frozen, remote_cluster_client, transform

                      Values are master, ingest, ml, data_hot, data_content, data_warm, data_cold, data_frozen, remote_cluster_client, or transform.

                    • zone_count integer(int32)

                      The default number of zones in which data nodes will be placed

                    • elasticsearch object

                      The Elasticsearch cluster settings. When specified at the top level, provides a field-by-field default. When specified at the topology level, provides the override settings.

                      Hide elasticsearch attributes Show elasticsearch attributes object
                      • version string

                        The version of the Elasticsearch cluster (must be one of the ECE supported versions). Currently cannot be different across the topology (and is generally specified in the globals). Defaults to the latest version if not specified.

                      • docker_image string

                        A docker URI that allows overriding of the default docker image specified for this version

                      • system_settings object

                        A subset of Elasticsearch settings. TIP: To define the complete set of Elasticsearch settings, use ElasticsearchSystemSettings with user_settings_override* and user_settings*.

                        Hide system_settings attributes Show system_settings attributes object
                        • scripting object

                          Controls the languages supported by the Elasticsearch cluster, such as Painless, Mustache, and Expressions. Controls how the languages are used, such as file, index, and inline. TIP: For complex configurations, leave these blank and configure these settings in the user YAML or JSON.

                          Hide scripting attributes Show scripting attributes object
                          • painless_enabled boolean

                            (5.x+ only) If enabled (the default) then the painless scripting engine is allowed as a sandboxed language. Sandboxed languages are the only ones allowed if 'sandbox_mode' is set to true. NOTES: (Corresponds to the parameters 'script.engine.painless.[file|stored|inline]')

                          • mustache_enabled boolean

                            (5.x+ only) If enabled (the default) then the mustache scripting engine is allowed as a sandboxed language. Sandboxed languages are the only ones allowed if 'sandbox_mode' is set to true. NOTES: (Corresponds to the parameters 'script.engine.mustache.[file|stored|inline]')

                          • expressions_enabled boolean

                            (5.x+ only) If enabled (the default) then the expressions scripting engine is allowed as a sandboxed language. Sandboxed languages are the only ones allowed if 'sandbox_mode' is set to true. NOTES: (Corresponds to the parameters 'script.engine.expression.[file|stored|inline]')

                          • stored object

                            Enables scripting for the specified type and controls other parameters. Store scripts in indexes (stored), upload in file bundles (file), or use in API requests (inline).

                            Hide stored attributes Show stored attributes object
                            • enabled boolean

                              If enabled (default: true) then scripts are enabled, either for sandboxing languages (by default), or for all installed languages if 'sandbox_mode' is disabled (or for 6.x). NOTES: (Corresponds to the parameter 'script.file|stored/indexed|inline')

                            • sandbox_mode boolean

                              If enabled (default: true) and this script type is enabled, then only the sandbox languages are allowed. By default the sandbox languages are painless, expressions and mustache, but this can be restricted via the 'painless_enabled', 'mustache_enabled' 'expression_enabled' settings.NOTES: Not supported in 6.x. (Corresponds to the parameters 'script.engine.[painless|mustache|expressions].[file|stored|inline]')

                          • file object

                            Enables scripting for the specified type and controls other parameters. Store scripts in indexes (stored), upload in file bundles (file), or use in API requests (inline).

                            Hide file attributes Show file attributes object
                            • enabled boolean

                              If enabled (default: true) then scripts are enabled, either for sandboxing languages (by default), or for all installed languages if 'sandbox_mode' is disabled (or for 6.x). NOTES: (Corresponds to the parameter 'script.file|stored/indexed|inline')

                            • sandbox_mode boolean

                              If enabled (default: true) and this script type is enabled, then only the sandbox languages are allowed. By default the sandbox languages are painless, expressions and mustache, but this can be restricted via the 'painless_enabled', 'mustache_enabled' 'expression_enabled' settings.NOTES: Not supported in 6.x. (Corresponds to the parameters 'script.engine.[painless|mustache|expressions].[file|stored|inline]')

                          • inline object

                            Enables scripting for the specified type and controls other parameters. Store scripts in indexes (stored), upload in file bundles (file), or use in API requests (inline).

                            Hide inline attributes Show inline attributes object
                            • enabled boolean

                              If enabled (default: true) then scripts are enabled, either for sandboxing languages (by default), or for all installed languages if 'sandbox_mode' is disabled (or for 6.x). NOTES: (Corresponds to the parameter 'script.file|stored/indexed|inline')

                            • sandbox_mode boolean

                              If enabled (default: true) and this script type is enabled, then only the sandbox languages are allowed. By default the sandbox languages are painless, expressions and mustache, but this can be restricted via the 'painless_enabled', 'mustache_enabled' 'expression_enabled' settings.NOTES: Not supported in 6.x. (Corresponds to the parameters 'script.engine.[painless|mustache|expressions].[file|stored|inline]')

                        • reindex_whitelist array[string]

                          Limits remote Elasticsearch clusters that can be used as the source for '_reindex' API commands

                        • auto_create_index boolean

                          If true (the default), then any write operation on an index that does not currently exist will create it. NOTES: (Corresponds to the parameter 'action.auto_create_index')

                        • enable_close_index boolean

                          Defaults to false on versions <= 7.2.0, true otherwise. If false, then the API commands to close indices are disabled. This is important because Elasticsearch does not snapshot or migrate close indices on versions under 7.2.0, therefore standard Elastic Cloud configuration operations will cause irretrievable loss of indices' data. NOTES: (Corresponds to the parameter 'cluster.indices.close.enable')

                        • destructive_requires_name boolean

                          If true (default is false) then the index deletion API will not support wildcards or '_all'. NOTES: (Corresponds to the parameter 'action.destructive_requires_name')

                        • watcher_trigger_engine string

                          The trigger engine for Watcher, defaults to 'scheduler' - see the xpack documentation for more information. NOTES: (Corresponds to the parameter '(xpack.)watcher.trigger.schedule.engine', depending on version. Ignored from 6.x onwards.)

                        • default_shards_per_index integer(int32)

                          (2.x only - to get the same result in 5.x template mappings must be used) Sets the default number of shards per index, defaulting to 1 if not specified. (Corresponds to the parameter 'index.number_of_shards' in 2.x, not supported in 5.x)

                        • monitoring_collection_interval integer(int32)

                          The default interval at which monitoring information from the cluster if collected, if monitoring is enabled. NOTES: (Corresponds to the parameter 'marvel.agent.interval' in 2.x and 'xpack.monitoring.collection.interval' in 5.x)

                        • monitoring_history_duration string

                          The duration for which monitoring history is stored (format '(NUMBER)d' eg '3d' for 3 days). NOTES: ('Corresponds to the parameter xpack.monitoring.history.duration' in 5.x, defaults to '7d')

                      • user_settings_json object

                        An arbitrary JSON object allowing cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters arey are on the allowlist and not on the denylist. NOTES: (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Elasticsearch settings)

                      • user_settings_yaml string

                        An arbitrary YAML object allowing cluster owners to set their parameters (only one of this and 'user_settings_json' is allowed), provided the parameters arey are on the allowlist and not on the denylist. NOTES: (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Elasticsearch settings)

                      • user_settings_override_json object

                        An arbitrary JSON object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), ie in addition to the documented 'system_settings'. NOTES: (This field together with 'system_settings' and 'user_settings*' defines the total set of Elasticsearch settings)

                      • user_settings_override_yaml string

                        An arbitrary YAML object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_json' is allowed), ie in addition to the documented 'system_settings'. NOTES: (This field together with 'system_settings' and 'user_settings*' defines the total set of Elasticsearch settings)

                      • enabled_built_in_plugins array[string]

                        A list of plugin names from the Elastic-supported subset that are bundled with the version images. NOTES: (Users should consult the Elastic stack objects to see what plugins are available, this is currently only available from the UI)

                      • user_plugins array[object]

                        A list of admin-uploaded plugin objects that are available for this user.

                        A list of admin-uploaded plugin objects.

                        Hide user_plugins attributes Show user_plugins attributes object
                        • name string Required

                          The name of the plugin

                        • url string Required

                          The URL of the plugin (must be accessible from the ECE infrastructure)

                        • elasticsearch_version string Required

                          The supported Elasticsearch version (must match the version in the plan)

                      • user_bundles array[object]

                        A list of admin-uploaded bundle objects (eg scripts, synonym files) that are available for this user.

                        A list of admin-uploaded bundle objects, such as scripts and synonym files.

                        Hide user_bundles attributes Show user_bundles attributes object
                        • name string Required

                          The name of the bundle

                        • url string Required

                          The URL of the bundle, which must be accessible from the ECE infrastructure. This URL could be cached by platform, make sure to change it when updating the bundle

                        • elasticsearch_version string Required

                          The supported Elasticsearch version (must match the version in the plan)

                      • curation object

                        Defines the index curation routing for the cluster

                        Hide curation attributes Show curation attributes object
                      • node_attributes object

                        Defines the Elasticsearch node attributes for the instances in the topology

                        Hide node_attributes attribute Show node_attributes attribute object
                        • * string Additional properties
                    • instance_configuration_id string

                      Controls the allocation of this topology element as well as allowed sizes and node_types. It needs to match the id of an existing instance configuration.

                    • instance_configuration_version integer(int32)

                      The version of the Instance Configuration Id. If it is unset, the meaning depends on read vs writes. For deployment reads, it is equivalent to version 0 (or the IC is unversioned); for deployment creates and deployment template use, it is equivalent to 'the latest version'; and for deployment updates, it is equivalent to 'retain the current version'.

                    • size object

                      Measured by the amount of a resource. The final cluster size is calculated using multipliers from the topology instance configuration.

                      Hide size attributes Show size attributes object
                      • value integer(int32) Required

                        Amount of resource

                      • resource string Required

                        Type of resource. In ESS the resource used should always be memory.

                        Values are memory or storage.

                    • autoscaling_min object

                      Measured by the amount of a resource. The final cluster size is calculated using multipliers from the topology instance configuration.

                      Hide autoscaling_min attributes Show autoscaling_min attributes object
                      • value integer(int32) Required

                        Amount of resource

                      • resource string Required

                        Type of resource. In ESS the resource used should always be memory.

                        Values are memory or storage.

                    • autoscaling_max object

                      Measured by the amount of a resource. The final cluster size is calculated using multipliers from the topology instance configuration.

                      Hide autoscaling_max attributes Show autoscaling_max attributes object
                      • value integer(int32) Required

                        Amount of resource

                      • resource string Required

                        Type of resource. In ESS the resource used should always be memory.

                        Values are memory or storage.

                    • autoscaling_policy_override_json object

                      An arbitrary JSON object overriding the default autoscaling policy. Don't set unless you really know what you are doing.

                    • topology_element_control object

                      Controls for the topology element. Only used as part of the deployment template. Ignored if included as part of a deployment.

                      Hide topology_element_control attribute Show topology_element_control attribute object
                      • min object Required

                        Measured by the amount of a resource. The final cluster size is calculated using multipliers from the topology instance configuration.

                        Hide min attributes Show min attributes object
                        • value integer(int32) Required

                          Amount of resource

                        • resource string Required

                          Type of resource. In ESS the resource used should always be memory.

                          Values are memory or storage.

                    • autoscaling_tier_override boolean

                      Set to true to enable autoscaling for this topology element, even if the cluster-level 'autoscaling_enabled' field is false. Note that 'autoscaling_tier_override' cannot be set to false if cluster-level 'autoscaling_enabled' is true. Currently only supported for the 'ml' tier

                  • elasticsearch object Required

                    The Elasticsearch cluster settings. When specified at the top level, provides a field-by-field default. When specified at the topology level, provides the override settings.

                    Hide elasticsearch attributes Show elasticsearch attributes object
                    • version string

                      The version of the Elasticsearch cluster (must be one of the ECE supported versions). Currently cannot be different across the topology (and is generally specified in the globals). Defaults to the latest version if not specified.

                    • docker_image string

                      A docker URI that allows overriding of the default docker image specified for this version

                    • system_settings object

                      A subset of Elasticsearch settings. TIP: To define the complete set of Elasticsearch settings, use ElasticsearchSystemSettings with user_settings_override* and user_settings*.

                      Hide system_settings attributes Show system_settings attributes object
                      • scripting object

                        Controls the languages supported by the Elasticsearch cluster, such as Painless, Mustache, and Expressions. Controls how the languages are used, such as file, index, and inline. TIP: For complex configurations, leave these blank and configure these settings in the user YAML or JSON.

                        Hide scripting attributes Show scripting attributes object
                        • painless_enabled boolean

                          (5.x+ only) If enabled (the default) then the painless scripting engine is allowed as a sandboxed language. Sandboxed languages are the only ones allowed if 'sandbox_mode' is set to true. NOTES: (Corresponds to the parameters 'script.engine.painless.[file|stored|inline]')

                        • mustache_enabled boolean

                          (5.x+ only) If enabled (the default) then the mustache scripting engine is allowed as a sandboxed language. Sandboxed languages are the only ones allowed if 'sandbox_mode' is set to true. NOTES: (Corresponds to the parameters 'script.engine.mustache.[file|stored|inline]')

                        • expressions_enabled boolean

                          (5.x+ only) If enabled (the default) then the expressions scripting engine is allowed as a sandboxed language. Sandboxed languages are the only ones allowed if 'sandbox_mode' is set to true. NOTES: (Corresponds to the parameters 'script.engine.expression.[file|stored|inline]')

                        • stored object

                          Enables scripting for the specified type and controls other parameters. Store scripts in indexes (stored), upload in file bundles (file), or use in API requests (inline).

                          Hide stored attributes Show stored attributes object
                          • enabled boolean

                            If enabled (default: true) then scripts are enabled, either for sandboxing languages (by default), or for all installed languages if 'sandbox_mode' is disabled (or for 6.x). NOTES: (Corresponds to the parameter 'script.file|stored/indexed|inline')

                          • sandbox_mode boolean

                            If enabled (default: true) and this script type is enabled, then only the sandbox languages are allowed. By default the sandbox languages are painless, expressions and mustache, but this can be restricted via the 'painless_enabled', 'mustache_enabled' 'expression_enabled' settings.NOTES: Not supported in 6.x. (Corresponds to the parameters 'script.engine.[painless|mustache|expressions].[file|stored|inline]')

                        • file object

                          Enables scripting for the specified type and controls other parameters. Store scripts in indexes (stored), upload in file bundles (file), or use in API requests (inline).

                          Hide file attributes Show file attributes object
                          • enabled boolean

                            If enabled (default: true) then scripts are enabled, either for sandboxing languages (by default), or for all installed languages if 'sandbox_mode' is disabled (or for 6.x). NOTES: (Corresponds to the parameter 'script.file|stored/indexed|inline')

                          • sandbox_mode boolean

                            If enabled (default: true) and this script type is enabled, then only the sandbox languages are allowed. By default the sandbox languages are painless, expressions and mustache, but this can be restricted via the 'painless_enabled', 'mustache_enabled' 'expression_enabled' settings.NOTES: Not supported in 6.x. (Corresponds to the parameters 'script.engine.[painless|mustache|expressions].[file|stored|inline]')

                        • inline object

                          Enables scripting for the specified type and controls other parameters. Store scripts in indexes (stored), upload in file bundles (file), or use in API requests (inline).

                          Hide inline attributes Show inline attributes object
                          • enabled boolean

                            If enabled (default: true) then scripts are enabled, either for sandboxing languages (by default), or for all installed languages if 'sandbox_mode' is disabled (or for 6.x). NOTES: (Corresponds to the parameter 'script.file|stored/indexed|inline')

                          • sandbox_mode boolean

                            If enabled (default: true) and this script type is enabled, then only the sandbox languages are allowed. By default the sandbox languages are painless, expressions and mustache, but this can be restricted via the 'painless_enabled', 'mustache_enabled' 'expression_enabled' settings.NOTES: Not supported in 6.x. (Corresponds to the parameters 'script.engine.[painless|mustache|expressions].[file|stored|inline]')

                      • reindex_whitelist array[string]

                        Limits remote Elasticsearch clusters that can be used as the source for '_reindex' API commands

                      • auto_create_index boolean

                        If true (the default), then any write operation on an index that does not currently exist will create it. NOTES: (Corresponds to the parameter 'action.auto_create_index')

                      • enable_close_index boolean

                        Defaults to false on versions <= 7.2.0, true otherwise. If false, then the API commands to close indices are disabled. This is important because Elasticsearch does not snapshot or migrate close indices on versions under 7.2.0, therefore standard Elastic Cloud configuration operations will cause irretrievable loss of indices' data. NOTES: (Corresponds to the parameter 'cluster.indices.close.enable')

                      • destructive_requires_name boolean

                        If true (default is false) then the index deletion API will not support wildcards or '_all'. NOTES: (Corresponds to the parameter 'action.destructive_requires_name')

                      • watcher_trigger_engine string

                        The trigger engine for Watcher, defaults to 'scheduler' - see the xpack documentation for more information. NOTES: (Corresponds to the parameter '(xpack.)watcher.trigger.schedule.engine', depending on version. Ignored from 6.x onwards.)

                      • default_shards_per_index integer(int32)

                        (2.x only - to get the same result in 5.x template mappings must be used) Sets the default number of shards per index, defaulting to 1 if not specified. (Corresponds to the parameter 'index.number_of_shards' in 2.x, not supported in 5.x)

                      • monitoring_collection_interval integer(int32)

                        The default interval at which monitoring information from the cluster if collected, if monitoring is enabled. NOTES: (Corresponds to the parameter 'marvel.agent.interval' in 2.x and 'xpack.monitoring.collection.interval' in 5.x)

                      • monitoring_history_duration string

                        The duration for which monitoring history is stored (format '(NUMBER)d' eg '3d' for 3 days). NOTES: ('Corresponds to the parameter xpack.monitoring.history.duration' in 5.x, defaults to '7d')

                    • user_settings_json object

                      An arbitrary JSON object allowing cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters arey are on the allowlist and not on the denylist. NOTES: (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Elasticsearch settings)

                    • user_settings_yaml string

                      An arbitrary YAML object allowing cluster owners to set their parameters (only one of this and 'user_settings_json' is allowed), provided the parameters arey are on the allowlist and not on the denylist. NOTES: (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Elasticsearch settings)

                    • user_settings_override_json object

                      An arbitrary JSON object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), ie in addition to the documented 'system_settings'. NOTES: (This field together with 'system_settings' and 'user_settings*' defines the total set of Elasticsearch settings)

                    • user_settings_override_yaml string

                      An arbitrary YAML object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_json' is allowed), ie in addition to the documented 'system_settings'. NOTES: (This field together with 'system_settings' and 'user_settings*' defines the total set of Elasticsearch settings)

                    • enabled_built_in_plugins array[string]

                      A list of plugin names from the Elastic-supported subset that are bundled with the version images. NOTES: (Users should consult the Elastic stack objects to see what plugins are available, this is currently only available from the UI)

                    • user_plugins array[object]

                      A list of admin-uploaded plugin objects that are available for this user.

                      A list of admin-uploaded plugin objects.

                      Hide user_plugins attributes Show user_plugins attributes object
                      • name string Required

                        The name of the plugin

                      • url string Required

                        The URL of the plugin (must be accessible from the ECE infrastructure)

                      • elasticsearch_version string Required

                        The supported Elasticsearch version (must match the version in the plan)

                    • user_bundles array[object]

                      A list of admin-uploaded bundle objects (eg scripts, synonym files) that are available for this user.

                      A list of admin-uploaded bundle objects, such as scripts and synonym files.

                      Hide user_bundles attributes Show user_bundles attributes object
                      • name string Required

                        The name of the bundle

                      • url string Required

                        The URL of the bundle, which must be accessible from the ECE infrastructure. This URL could be cached by platform, make sure to change it when updating the bundle

                      • elasticsearch_version string Required

                        The supported Elasticsearch version (must match the version in the plan)

                    • curation object

                      Defines the index curation routing for the cluster

                      Hide curation attributes Show curation attributes object
                    • node_attributes object

                      Defines the Elasticsearch node attributes for the instances in the topology

                      Hide node_attributes attribute Show node_attributes attribute object
                      • * string Additional properties
                  • deployment_template object

                    Documents which deployment template was used in the creation of this plan

                    Hide deployment_template attributes Show deployment_template attributes object
                    • id string Required

                      The unique identifier of the deployment template

                    • version string

                      A version identifier to disambiguate multiple revisions of the same template

                  • transient object

                    Defines the configuration parameters that control how the plan is applied. For example, the Elasticsearch cluster topology and Elasticsearch settings.

                    Hide transient attributes Show transient attributes object
                    • strategy object

                      The options for performing a plan change. Specify only one property each time. The default is grow_and_shrink.

                      Hide strategy attributes Show strategy attributes object
                      • rolling object

                        Performs inline, rolling configuration changes that mutate existing containers. TIP: This is the fastest way to update a plan, but can fail for complex plan changes, such as topology changes. Also, this is less safe for configuration changes that leave a cluster in a non running state. NOTE: When you perform a major version upgrade, and 'group_by' is set to 'pass:macros[all]';, rolling is required.

                        Hide rolling attributes Show rolling attributes object
                        • group_by string

                          Specifies the grouping attribute to use when rolling several instances. Instances that share the same value for the provided attribute key are rolled together as a unit. Examples that make sense to use are '__all__' (roll all instances as a single unit), 'logical_zone_name' (roll instances by zone), '__name__' (roll one instance at a time, the default if not specified). Note that '__all__' is required when performing a major version upgrade

                        • allow_inline_resize boolean

                          Whether we allow changing the capacity of instances (default false). This is currently implemented by stopping, re-creating then starting the affected instance on its associated allocator when performing the changes. NOTES: This requires a round-trip through the allocation infrastructure of the active constructor, as it has to reserve the target capacity without over-committing

                        • skip_synced_flush boolean

                          Whether to skip attempting to do a synced flush on the filesystem of the container (default: false), which is less safe but may be required if the container is unhealthy

                        • shard_init_wait_time integer(int64)

                          The time, in seconds, to wait for shards that show no progress of initializing before rolling the next group (default: 10 minutes)

                      • grow_and_shrink object

                        A strategy that creates instances with the new plan, migrates data from the old instances, then shuts down the old instances. GrowShrinkStrategyConfig is safer than 'rolling' and ensures single node availability during a plan change, but can be a lot slower on larger clusters.

                      • rolling_grow_and_shrink object

                        A strategy that creates new Elasticsearch instances, Kibana instances, and APM Servers with the new plan, then migrates the node data to minimize the amount of spare capacity.

                      • autodetect object

                        A strategy that lets constructor choose the most optimal way to execute the plan.

                    • plan_configuration object

                      The configuration settings for the timeout and fallback parameters.

                      Hide plan_configuration attributes Show plan_configuration attributes object
                      • timeout integer(int64)

                        The total timeout in seconds after which the plan is cancelled even if it is not complete. Defaults to 4x the max memory capacity per node (in MB). NOTES: A 3 zone cluster with 2 nodes of 2048 each would have a timeout of 4*2048=8192 seconds. Timeout does not include time required to run rollback actions.

                      • calm_wait_time integer(int64)

                        This timeout determines how long to give a cluster after it responds to API calls before performing actual operations on it. It defaults to 5s

                      • skip_snapshot boolean

                        If true (default: false), does not take (or require) a successful snapshot to be taken before performing any potentially destructive changes to this cluster

                      • max_snapshot_attempts integer(int32)

                        If taking a snapshot (ie unless 'skip_snapshots': true) then will retry on failure at most this number of times (default: 5)

                      • max_snapshot_age integer(int64)

                        When you take a snapshot and 'skip_snapshots' is false, specifies the maximum age in seconds of the most recent snapshot before a new snapshot is created. Default is 300

                      • extended_maintenance boolean

                        If true (default false), does not clear the maintenance flag (which prevents its API from being accessed except by the constructor) on new instances added until after a snapshot has been restored, otherwise, the maintenance flag is cleared once the new instances successfully join the new cluster

                      • cluster_reboot string

                        Set to 'forced' to force a reboot as part of the upgrade plan. NOTES: (ie taking an existing plan and leaving it alone except for setting 'transient.plan_configuration.cluster_reboot': 'forced' will reboot the cluster)

                        Value is forced.

                    • restore_snapshot object

                      Restores a snapshot from a local or remote repository.

                      Hide restore_snapshot attributes Show restore_snapshot attributes object
                      • repository_name string

                        If specified, contains the name of the snapshot repository - else will default to the Elastic Cloud system repo ('found-snapshots')

                      • snapshot_name string Required

                        The name of the snapshot to restore. Use '__latest_success__' to get the most recent snapshot from the specified repository

                      • repository_config object

                        Raw remote snapshot restore settings. Do not send this if you are sending source_cluster_id

                        Hide repository_config attribute Show repository_config attribute object
                        • raw_settings object

                          The remote snapshot settings raw JSON - see the Elasticsearch '_snapshot' documentation for more details on supported formats

                      • restore_payload object

                        The configuration for the restore command, such as which indices you want to restore.

                        Hide restore_payload attributes Show restore_payload attributes object
                        • indices array[string]

                          The list of indices to restore (supports +ve and -ve selection and wildcarding - see the default Elasticsearch index format documentation)

                        • raw_settings object

                          This JSON object (merged with the 'indices' field (if present) is passed untouched into the restore command - see the Elasticsearch '_snapshot' documentation for more details on supported formats

                      • strategy string

                        The restore strategy to use. Defaults to a full restore. Partial restore will attempt to restore unavailable indices only

                        Values are partial, full, or recovery.

                      • source_cluster_id string

                        If specified, contains the name of the source cluster id. Do not send this if you are sending repository_config

                    • remote_clusters object

                      The list of resources that will be configured as remote clusters

                      Hide remote_clusters attribute Show remote_clusters attribute object
                      • resources array[object] Required

                        The remote resources

                        The Elasticsearch resource used as a Remote Cluster.

                        Hide resources attributes Show resources attributes object
                        • deployment_id string Required

                          The id of the deployment

                        • elasticsearch_ref_id string Required

                          The locally-unique user-specified id of an Elasticsearch Resource

                        • alias string Required

                          The alias for this remote cluster. Aliases must only contain letters, digits, dashes and underscores

                        • skip_unavailable boolean

                          If true, skip this cluster during search if it is disconnected. Default: false

                        • info object

                          Information about a Remote Cluster.

                          Hide info attributes Show info attributes object
                          • healthy boolean Required

                            Whether or not the remote cluster is healthy

                          • connected boolean Required

                            Whether or not there is at least one connection to the remote cluster.

                          • compatible boolean Required

                            Whether or not the remote cluster version is compatible with this cluster version.

                          • trusted boolean Required

                            Whether or not the remote cluster is trusted by this cluster.

                          • trusted_back boolean Required

                            Whether or not the remote cluster trusts this cluster back.

                    • cluster_settings_json object

                      If specified, contains transient settings to be applied to an Elasticsearch cluster during changes,default values shown below applied. These can be overridden by specifying them in the map (or null to unset). Additional settings can also be set. Settings will be cleared after the plan has finished. If not specified, no settings will be applied. NOTE: These settings are only explicitly cleared for 5.x+ clusters, they must be hand-reset to their defaults in 2.x- (or a cluster reboot will clear them).

                      • indices.store.throttle.max_bytes_per_sec: 120Mb
                      • indices.recovery.max_bytes_per_sec: 120Mb
                      • cluster.routing.allocation.cluster_concurrent_rebalance: 5
                      • cluster.routing.allocation.node_initial_primaries_recoveries: 5
                      • cluster.routing.allocation.node_concurrent_incoming_recoveries: 5 For version 8.1 and later no defaults are provided through this mechanism, but instead hardware dependent settings are provided to each instance.
                  • autoscaling_enabled boolean

                    Enable autoscaling for this Elasticsearch cluster.

                • plan_attempt_log array[object] Required

                  Information about a step in a plan.

                  Hide plan_attempt_log attributes Show plan_attempt_log attributes object
                  • step_id string Required

                    ID of current step

                  • started string(date-time) Required

                    When the step started (ISO format in UTC)

                  • completed string(date-time)

                    When the step completed (ISO format in UTC)

                  • duration_in_millis integer(int64)

                    The duration of the step in MS

                  • status string Required

                    The status of the step (success, warning, error - warning means something didn't go as expected but it was not serious enough to abort the plan)

                    Values are success, warning, error, or pending.

                  • stage string Required

                    Current stage that the step is in

                    Values are starting, completed, or in_progress.

                  • info_log array[object] Required

                    Human readable summaries of the step, including messages for each stage of the step

                    The log message from a specified stage of an executed step in a plan.

                    Hide info_log attributes Show info_log attributes object
                    • timestamp string(date-time) Required

                      Timestamp marking on info log of step

                    • delta_in_millis integer(int64)

                      Time in milliseconds since previous log message

                    • stage string Required

                      Stage that info log message takes place in

                      Values are starting, completed, or in_progress.

                    • message string Required

                      Human readable log message

                    • details object Required

                      A map with details for the log about what happened during the step execution. Keys and values for are always both strings, representing the name of the detail and its value, respectively.

                      Hide details attribute Show details attribute object
                      • * string Additional properties
                    • failure_type string

                      The failure type, in case the step failed

                • source object

                  Information describing the source that facilitated the plans current state

                  Hide source attributes Show source attributes object
                  • facilitator string Required

                    The service where the change originated from

                  • action string Required

                    The type of plan change that was initiated

                  • date string(date-time) Required

                    The time the change was initiated

                  • user_id string

                    The user that requested the change

                  • admin_id string

                    The admin user that requested the change

                  • remote_addresses array[string]

                    The host addresses of the user that originated the change

                • warnings array[object] Required

                  Information about a warning from a plan.

                  Hide warnings attributes Show warnings attributes object
                  • code string Required

                    A unique warning code

                  • message string Required

                    A description of the warning

                  • step_id string

                    The ID of the step which produced a warning, if any

                • error object

                  Information about an error during a plan attempt.

                  Hide error attributes Show error attributes object
                  • timestamp string(date-time) Required

                    Timestamp marking on info log of step

                  • message string Required

                    Human readable error message

                  • details object Required

                    A map with details regarding the error. Both the keys and values are always strings, representing the name of the detail and its value, respectively.

                    Hide details attribute Show details attribute object
                    • * string Additional properties
                  • failure_type string

                    The failure type

              • pending object

                Information about the Elasticsearch cluster plan.

                Hide pending attributes Show pending attributes object
                • plan_attempt_id string

                  A UUID for each plan attempt

                • plan_attempt_name string

                  A human readable name for each plan attempt, only populated when retrieving plan histories

                • healthy boolean Required

                  Either the plan ended successfully, or is not yet completed (and no errors have occurred)

                • attempt_start_time string(date-time)

                  When this plan attempt (ie to apply the plan to the cluster) started (ISO format in UTC)

                • attempt_end_time string(date-time)

                  If this plan completed or failed (ie is not pending), when the attempt ended (ISO format in UTC)

                • plan_end_time string(date-time)

                  If this plan is not current or pending, when the plan was no longer active (ISO format in UTC)

                • plan object

                  The plan for building this Elasticsearch cluster

                  Hide plan attributes Show plan attributes object
                  • cluster_topology array[object] Required

                    The topology of the Elasticsearch nodes, including the number, capacity, and type of nodes, and where they can be allocated.

                    Hide cluster_topology attributes Show cluster_topology attributes object
                    • id string

                      Unique identifier of this topology element

                    • node_type object

                      Controls the combinations of Elasticsearch node types. TIP: By default, the Elasticsearch node is master eligible, can hold data, and run ingest pipelines. WARNING: Do not set for tiebreaker topologies.

                      Hide node_type attributes Show node_type attributes object
                      • master boolean

                        Defines whether this node can be elected master (default: false)

                      • data boolean

                        Defines whether this node can hold data (default: false)

                      • ingest boolean

                        Defines whether this node can run an ingest pipeline (default: false)

                      • ml boolean

                        Defines whether this node can run ml jobs, valid only for versions 5.4.0 or greater (default: false)

                    • node_roles array[string]

                      The list of node roles for this topology element (ES version >= 7.10). Allowable values are: master, ingest, ml, data_hot, data_content, data_warm, data_cold, data_frozen, remote_cluster_client, transform

                      Values are master, ingest, ml, data_hot, data_content, data_warm, data_cold, data_frozen, remote_cluster_client, or transform.

                    • zone_count integer(int32)

                      The default number of zones in which data nodes will be placed

                    • elasticsearch object

                      The Elasticsearch cluster settings. When specified at the top level, provides a field-by-field default. When specified at the topology level, provides the override settings.

                      Hide elasticsearch attributes Show elasticsearch attributes object
                      • version string

                        The version of the Elasticsearch cluster (must be one of the ECE supported versions). Currently cannot be different across the topology (and is generally specified in the globals). Defaults to the latest version if not specified.

                      • docker_image string

                        A docker URI that allows overriding of the default docker image specified for this version

                      • system_settings object

                        A subset of Elasticsearch settings. TIP: To define the complete set of Elasticsearch settings, use ElasticsearchSystemSettings with user_settings_override* and user_settings*.

                        Hide system_settings attributes Show system_settings attributes object
                        • scripting object

                          Controls the languages supported by the Elasticsearch cluster, such as Painless, Mustache, and Expressions. Controls how the languages are used, such as file, index, and inline. TIP: For complex configurations, leave these blank and configure these settings in the user YAML or JSON.

                          Hide scripting attributes Show scripting attributes object
                          • painless_enabled boolean

                            (5.x+ only) If enabled (the default) then the painless scripting engine is allowed as a sandboxed language. Sandboxed languages are the only ones allowed if 'sandbox_mode' is set to true. NOTES: (Corresponds to the parameters 'script.engine.painless.[file|stored|inline]')

                          • mustache_enabled boolean

                            (5.x+ only) If enabled (the default) then the mustache scripting engine is allowed as a sandboxed language. Sandboxed languages are the only ones allowed if 'sandbox_mode' is set to true. NOTES: (Corresponds to the parameters 'script.engine.mustache.[file|stored|inline]')

                          • expressions_enabled boolean

                            (5.x+ only) If enabled (the default) then the expressions scripting engine is allowed as a sandboxed language. Sandboxed languages are the only ones allowed if 'sandbox_mode' is set to true. NOTES: (Corresponds to the parameters 'script.engine.expression.[file|stored|inline]')

                          • stored object

                            Enables scripting for the specified type and controls other parameters. Store scripts in indexes (stored), upload in file bundles (file), or use in API requests (inline).

                            Hide stored attributes Show stored attributes object
                            • enabled boolean

                              If enabled (default: true) then scripts are enabled, either for sandboxing languages (by default), or for all installed languages if 'sandbox_mode' is disabled (or for 6.x). NOTES: (Corresponds to the parameter 'script.file|stored/indexed|inline')

                            • sandbox_mode boolean

                              If enabled (default: true) and this script type is enabled, then only the sandbox languages are allowed. By default the sandbox languages are painless, expressions and mustache, but this can be restricted via the 'painless_enabled', 'mustache_enabled' 'expression_enabled' settings.NOTES: Not supported in 6.x. (Corresponds to the parameters 'script.engine.[painless|mustache|expressions].[file|stored|inline]')

                          • file object

                            Enables scripting for the specified type and controls other parameters. Store scripts in indexes (stored), upload in file bundles (file), or use in API requests (inline).

                            Hide file attributes Show file attributes object
                            • enabled boolean

                              If enabled (default: true) then scripts are enabled, either for sandboxing languages (by default), or for all installed languages if 'sandbox_mode' is disabled (or for 6.x). NOTES: (Corresponds to the parameter 'script.file|stored/indexed|inline')

                            • sandbox_mode boolean

                              If enabled (default: true) and this script type is enabled, then only the sandbox languages are allowed. By default the sandbox languages are painless, expressions and mustache, but this can be restricted via the 'painless_enabled', 'mustache_enabled' 'expression_enabled' settings.NOTES: Not supported in 6.x. (Corresponds to the parameters 'script.engine.[painless|mustache|expressions].[file|stored|inline]')

                          • inline object

                            Enables scripting for the specified type and controls other parameters. Store scripts in indexes (stored), upload in file bundles (file), or use in API requests (inline).

                            Hide inline attributes Show inline attributes object
                            • enabled boolean

                              If enabled (default: true) then scripts are enabled, either for sandboxing languages (by default), or for all installed languages if 'sandbox_mode' is disabled (or for 6.x). NOTES: (Corresponds to the parameter 'script.file|stored/indexed|inline')

                            • sandbox_mode boolean

                              If enabled (default: true) and this script type is enabled, then only the sandbox languages are allowed. By default the sandbox languages are painless, expressions and mustache, but this can be restricted via the 'painless_enabled', 'mustache_enabled' 'expression_enabled' settings.NOTES: Not supported in 6.x. (Corresponds to the parameters 'script.engine.[painless|mustache|expressions].[file|stored|inline]')

                        • reindex_whitelist array[string]

                          Limits remote Elasticsearch clusters that can be used as the source for '_reindex' API commands

                        • auto_create_index boolean

                          If true (the default), then any write operation on an index that does not currently exist will create it. NOTES: (Corresponds to the parameter 'action.auto_create_index')

                        • enable_close_index boolean

                          Defaults to false on versions <= 7.2.0, true otherwise. If false, then the API commands to close indices are disabled. This is important because Elasticsearch does not snapshot or migrate close indices on versions under 7.2.0, therefore standard Elastic Cloud configuration operations will cause irretrievable loss of indices' data. NOTES: (Corresponds to the parameter 'cluster.indices.close.enable')

                        • destructive_requires_name boolean

                          If true (default is false) then the index deletion API will not support wildcards or '_all'. NOTES: (Corresponds to the parameter 'action.destructive_requires_name')

                        • watcher_trigger_engine string

                          The trigger engine for Watcher, defaults to 'scheduler' - see the xpack documentation for more information. NOTES: (Corresponds to the parameter '(xpack.)watcher.trigger.schedule.engine', depending on version. Ignored from 6.x onwards.)

                        • default_shards_per_index integer(int32)

                          (2.x only - to get the same result in 5.x template mappings must be used) Sets the default number of shards per index, defaulting to 1 if not specified. (Corresponds to the parameter 'index.number_of_shards' in 2.x, not supported in 5.x)

                        • monitoring_collection_interval integer(int32)

                          The default interval at which monitoring information from the cluster if collected, if monitoring is enabled. NOTES: (Corresponds to the parameter 'marvel.agent.interval' in 2.x and 'xpack.monitoring.collection.interval' in 5.x)

                        • monitoring_history_duration string

                          The duration for which monitoring history is stored (format '(NUMBER)d' eg '3d' for 3 days). NOTES: ('Corresponds to the parameter xpack.monitoring.history.duration' in 5.x, defaults to '7d')

                      • user_settings_json object

                        An arbitrary JSON object allowing cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters arey are on the allowlist and not on the denylist. NOTES: (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Elasticsearch settings)

                      • user_settings_yaml string

                        An arbitrary YAML object allowing cluster owners to set their parameters (only one of this and 'user_settings_json' is allowed), provided the parameters arey are on the allowlist and not on the denylist. NOTES: (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Elasticsearch settings)

                      • user_settings_override_json object

                        An arbitrary JSON object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), ie in addition to the documented 'system_settings'. NOTES: (This field together with 'system_settings' and 'user_settings*' defines the total set of Elasticsearch settings)

                      • user_settings_override_yaml string

                        An arbitrary YAML object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_json' is allowed), ie in addition to the documented 'system_settings'. NOTES: (This field together with 'system_settings' and 'user_settings*' defines the total set of Elasticsearch settings)

                      • enabled_built_in_plugins array[string]

                        A list of plugin names from the Elastic-supported subset that are bundled with the version images. NOTES: (Users should consult the Elastic stack objects to see what plugins are available, this is currently only available from the UI)

                      • user_plugins array[object]

                        A list of admin-uploaded plugin objects that are available for this user.

                        A list of admin-uploaded plugin objects.

                        Hide user_plugins attributes Show user_plugins attributes object
                        • name string Required

                          The name of the plugin

                        • url string Required

                          The URL of the plugin (must be accessible from the ECE infrastructure)

                        • elasticsearch_version string Required

                          The supported Elasticsearch version (must match the version in the plan)

                      • user_bundles array[object]

                        A list of admin-uploaded bundle objects (eg scripts, synonym files) that are available for this user.

                        A list of admin-uploaded bundle objects, such as scripts and synonym files.

                        Hide user_bundles attributes Show user_bundles attributes object
                        • name string Required

                          The name of the bundle

                        • url string Required

                          The URL of the bundle, which must be accessible from the ECE infrastructure. This URL could be cached by platform, make sure to change it when updating the bundle

                        • elasticsearch_version string Required

                          The supported Elasticsearch version (must match the version in the plan)

                      • curation object

                        Defines the index curation routing for the cluster

                        Hide curation attributes Show curation attributes object
                      • node_attributes object

                        Defines the Elasticsearch node attributes for the instances in the topology

                        Hide node_attributes attribute Show node_attributes attribute object
                        • * string Additional properties
                    • instance_configuration_id string

                      Controls the allocation of this topology element as well as allowed sizes and node_types. It needs to match the id of an existing instance configuration.

                    • instance_configuration_version integer(int32)

                      The version of the Instance Configuration Id. If it is unset, the meaning depends on read vs writes. For deployment reads, it is equivalent to version 0 (or the IC is unversioned); for deployment creates and deployment template use, it is equivalent to 'the latest version'; and for deployment updates, it is equivalent to 'retain the current version'.

                    • size object

                      Measured by the amount of a resource. The final cluster size is calculated using multipliers from the topology instance configuration.

                      Hide size attributes Show size attributes object
                      • value integer(int32) Required

                        Amount of resource

                      • resource string Required

                        Type of resource. In ESS the resource used should always be memory.

                        Values are memory or storage.

                    • autoscaling_min object

                      Measured by the amount of a resource. The final cluster size is calculated using multipliers from the topology instance configuration.

                      Hide autoscaling_min attributes Show autoscaling_min attributes object
                      • value integer(int32) Required

                        Amount of resource

                      • resource string Required

                        Type of resource. In ESS the resource used should always be memory.

                        Values are memory or storage.

                    • autoscaling_max object

                      Measured by the amount of a resource. The final cluster size is calculated using multipliers from the topology instance configuration.

                      Hide autoscaling_max attributes Show autoscaling_max attributes object
                      • value integer(int32) Required

                        Amount of resource

                      • resource string Required

                        Type of resource. In ESS the resource used should always be memory.

                        Values are memory or storage.

                    • autoscaling_policy_override_json object

                      An arbitrary JSON object overriding the default autoscaling policy. Don't set unless you really know what you are doing.

                    • topology_element_control object

                      Controls for the topology element. Only used as part of the deployment template. Ignored if included as part of a deployment.

                      Hide topology_element_control attribute Show topology_element_control attribute object
                      • min object Required

                        Measured by the amount of a resource. The final cluster size is calculated using multipliers from the topology instance configuration.

                        Hide min attributes Show min attributes object
                        • value integer(int32) Required

                          Amount of resource

                        • resource string Required

                          Type of resource. In ESS the resource used should always be memory.

                          Values are memory or storage.

                    • autoscaling_tier_override boolean

                      Set to true to enable autoscaling for this topology element, even if the cluster-level 'autoscaling_enabled' field is false. Note that 'autoscaling_tier_override' cannot be set to false if cluster-level 'autoscaling_enabled' is true. Currently only supported for the 'ml' tier

                  • elasticsearch object Required

                    The Elasticsearch cluster settings. When specified at the top level, provides a field-by-field default. When specified at the topology level, provides the override settings.

                    Hide elasticsearch attributes Show elasticsearch attributes object
                    • version string

                      The version of the Elasticsearch cluster (must be one of the ECE supported versions). Currently cannot be different across the topology (and is generally specified in the globals). Defaults to the latest version if not specified.

                    • docker_image string

                      A docker URI that allows overriding of the default docker image specified for this version

                    • system_settings object

                      A subset of Elasticsearch settings. TIP: To define the complete set of Elasticsearch settings, use ElasticsearchSystemSettings with user_settings_override* and user_settings*.

                      Hide system_settings attributes Show system_settings attributes object
                      • scripting object

                        Controls the languages supported by the Elasticsearch cluster, such as Painless, Mustache, and Expressions. Controls how the languages are used, such as file, index, and inline. TIP: For complex configurations, leave these blank and configure these settings in the user YAML or JSON.

                        Hide scripting attributes Show scripting attributes object
                        • painless_enabled boolean

                          (5.x+ only) If enabled (the default) then the painless scripting engine is allowed as a sandboxed language. Sandboxed languages are the only ones allowed if 'sandbox_mode' is set to true. NOTES: (Corresponds to the parameters 'script.engine.painless.[file|stored|inline]')

                        • mustache_enabled boolean

                          (5.x+ only) If enabled (the default) then the mustache scripting engine is allowed as a sandboxed language. Sandboxed languages are the only ones allowed if 'sandbox_mode' is set to true. NOTES: (Corresponds to the parameters 'script.engine.mustache.[file|stored|inline]')

                        • expressions_enabled boolean

                          (5.x+ only) If enabled (the default) then the expressions scripting engine is allowed as a sandboxed language. Sandboxed languages are the only ones allowed if 'sandbox_mode' is set to true. NOTES: (Corresponds to the parameters 'script.engine.expression.[file|stored|inline]')

                        • stored object

                          Enables scripting for the specified type and controls other parameters. Store scripts in indexes (stored), upload in file bundles (file), or use in API requests (inline).

                          Hide stored attributes Show stored attributes object
                          • enabled boolean

                            If enabled (default: true) then scripts are enabled, either for sandboxing languages (by default), or for all installed languages if 'sandbox_mode' is disabled (or for 6.x). NOTES: (Corresponds to the parameter 'script.file|stored/indexed|inline')

                          • sandbox_mode boolean

                            If enabled (default: true) and this script type is enabled, then only the sandbox languages are allowed. By default the sandbox languages are painless, expressions and mustache, but this can be restricted via the 'painless_enabled', 'mustache_enabled' 'expression_enabled' settings.NOTES: Not supported in 6.x. (Corresponds to the parameters 'script.engine.[painless|mustache|expressions].[file|stored|inline]')

                        • file object

                          Enables scripting for the specified type and controls other parameters. Store scripts in indexes (stored), upload in file bundles (file), or use in API requests (inline).

                          Hide file attributes Show file attributes object
                          • enabled boolean

                            If enabled (default: true) then scripts are enabled, either for sandboxing languages (by default), or for all installed languages if 'sandbox_mode' is disabled (or for 6.x). NOTES: (Corresponds to the parameter 'script.file|stored/indexed|inline')

                          • sandbox_mode boolean

                            If enabled (default: true) and this script type is enabled, then only the sandbox languages are allowed. By default the sandbox languages are painless, expressions and mustache, but this can be restricted via the 'painless_enabled', 'mustache_enabled' 'expression_enabled' settings.NOTES: Not supported in 6.x. (Corresponds to the parameters 'script.engine.[painless|mustache|expressions].[file|stored|inline]')

                        • inline object

                          Enables scripting for the specified type and controls other parameters. Store scripts in indexes (stored), upload in file bundles (file), or use in API requests (inline).

                          Hide inline attributes Show inline attributes object
                          • enabled boolean

                            If enabled (default: true) then scripts are enabled, either for sandboxing languages (by default), or for all installed languages if 'sandbox_mode' is disabled (or for 6.x). NOTES: (Corresponds to the parameter 'script.file|stored/indexed|inline')

                          • sandbox_mode boolean

                            If enabled (default: true) and this script type is enabled, then only the sandbox languages are allowed. By default the sandbox languages are painless, expressions and mustache, but this can be restricted via the 'painless_enabled', 'mustache_enabled' 'expression_enabled' settings.NOTES: Not supported in 6.x. (Corresponds to the parameters 'script.engine.[painless|mustache|expressions].[file|stored|inline]')

                      • reindex_whitelist array[string]

                        Limits remote Elasticsearch clusters that can be used as the source for '_reindex' API commands

                      • auto_create_index boolean

                        If true (the default), then any write operation on an index that does not currently exist will create it. NOTES: (Corresponds to the parameter 'action.auto_create_index')

                      • enable_close_index boolean

                        Defaults to false on versions <= 7.2.0, true otherwise. If false, then the API commands to close indices are disabled. This is important because Elasticsearch does not snapshot or migrate close indices on versions under 7.2.0, therefore standard Elastic Cloud configuration operations will cause irretrievable loss of indices' data. NOTES: (Corresponds to the parameter 'cluster.indices.close.enable')

                      • destructive_requires_name boolean

                        If true (default is false) then the index deletion API will not support wildcards or '_all'. NOTES: (Corresponds to the parameter 'action.destructive_requires_name')

                      • watcher_trigger_engine string

                        The trigger engine for Watcher, defaults to 'scheduler' - see the xpack documentation for more information. NOTES: (Corresponds to the parameter '(xpack.)watcher.trigger.schedule.engine', depending on version. Ignored from 6.x onwards.)

                      • default_shards_per_index integer(int32)

                        (2.x only - to get the same result in 5.x template mappings must be used) Sets the default number of shards per index, defaulting to 1 if not specified. (Corresponds to the parameter 'index.number_of_shards' in 2.x, not supported in 5.x)

                      • monitoring_collection_interval integer(int32)

                        The default interval at which monitoring information from the cluster if collected, if monitoring is enabled. NOTES: (Corresponds to the parameter 'marvel.agent.interval' in 2.x and 'xpack.monitoring.collection.interval' in 5.x)

                      • monitoring_history_duration string

                        The duration for which monitoring history is stored (format '(NUMBER)d' eg '3d' for 3 days). NOTES: ('Corresponds to the parameter xpack.monitoring.history.duration' in 5.x, defaults to '7d')

                    • user_settings_json object

                      An arbitrary JSON object allowing cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters arey are on the allowlist and not on the denylist. NOTES: (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Elasticsearch settings)

                    • user_settings_yaml string

                      An arbitrary YAML object allowing cluster owners to set their parameters (only one of this and 'user_settings_json' is allowed), provided the parameters arey are on the allowlist and not on the denylist. NOTES: (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Elasticsearch settings)

                    • user_settings_override_json object

                      An arbitrary JSON object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), ie in addition to the documented 'system_settings'. NOTES: (This field together with 'system_settings' and 'user_settings*' defines the total set of Elasticsearch settings)

                    • user_settings_override_yaml string

                      An arbitrary YAML object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_json' is allowed), ie in addition to the documented 'system_settings'. NOTES: (This field together with 'system_settings' and 'user_settings*' defines the total set of Elasticsearch settings)

                    • enabled_built_in_plugins array[string]

                      A list of plugin names from the Elastic-supported subset that are bundled with the version images. NOTES: (Users should consult the Elastic stack objects to see what plugins are available, this is currently only available from the UI)

                    • user_plugins array[object]

                      A list of admin-uploaded plugin objects that are available for this user.

                      A list of admin-uploaded plugin objects.

                      Hide user_plugins attributes Show user_plugins attributes object
                      • name string Required

                        The name of the plugin

                      • url string Required

                        The URL of the plugin (must be accessible from the ECE infrastructure)

                      • elasticsearch_version string Required

                        The supported Elasticsearch version (must match the version in the plan)

                    • user_bundles array[object]

                      A list of admin-uploaded bundle objects (eg scripts, synonym files) that are available for this user.

                      A list of admin-uploaded bundle objects, such as scripts and synonym files.

                      Hide user_bundles attributes Show user_bundles attributes object
                      • name string Required

                        The name of the bundle

                      • url string Required

                        The URL of the bundle, which must be accessible from the ECE infrastructure. This URL could be cached by platform, make sure to change it when updating the bundle

                      • elasticsearch_version string Required

                        The supported Elasticsearch version (must match the version in the plan)

                    • curation object

                      Defines the index curation routing for the cluster

                      Hide curation attributes Show curation attributes object
                    • node_attributes object

                      Defines the Elasticsearch node attributes for the instances in the topology

                      Hide node_attributes attribute Show node_attributes attribute object
                      • * string Additional properties
                  • deployment_template object

                    Documents which deployment template was used in the creation of this plan

                    Hide deployment_template attributes Show deployment_template attributes object
                    • id string Required

                      The unique identifier of the deployment template

                    • version string

                      A version identifier to disambiguate multiple revisions of the same template

                  • transient object

                    Defines the configuration parameters that control how the plan is applied. For example, the Elasticsearch cluster topology and Elasticsearch settings.

                    Hide transient attributes Show transient attributes object
                    • strategy object

                      The options for performing a plan change. Specify only one property each time. The default is grow_and_shrink.

                      Hide strategy attributes Show strategy attributes object
                      • rolling object

                        Performs inline, rolling configuration changes that mutate existing containers. TIP: This is the fastest way to update a plan, but can fail for complex plan changes, such as topology changes. Also, this is less safe for configuration changes that leave a cluster in a non running state. NOTE: When you perform a major version upgrade, and 'group_by' is set to 'pass:macros[all]';, rolling is required.

                        Hide rolling attributes Show rolling attributes object
                        • group_by string

                          Specifies the grouping attribute to use when rolling several instances. Instances that share the same value for the provided attribute key are rolled together as a unit. Examples that make sense to use are '__all__' (roll all instances as a single unit), 'logical_zone_name' (roll instances by zone), '__name__' (roll one instance at a time, the default if not specified). Note that '__all__' is required when performing a major version upgrade

                        • allow_inline_resize boolean

                          Whether we allow changing the capacity of instances (default false). This is currently implemented by stopping, re-creating then starting the affected instance on its associated allocator when performing the changes. NOTES: This requires a round-trip through the allocation infrastructure of the active constructor, as it has to reserve the target capacity without over-committing

                        • skip_synced_flush boolean

                          Whether to skip attempting to do a synced flush on the filesystem of the container (default: false), which is less safe but may be required if the container is unhealthy

                        • shard_init_wait_time integer(int64)

                          The time, in seconds, to wait for shards that show no progress of initializing before rolling the next group (default: 10 minutes)

                      • grow_and_shrink object

                        A strategy that creates instances with the new plan, migrates data from the old instances, then shuts down the old instances. GrowShrinkStrategyConfig is safer than 'rolling' and ensures single node availability during a plan change, but can be a lot slower on larger clusters.

                      • rolling_grow_and_shrink object

                        A strategy that creates new Elasticsearch instances, Kibana instances, and APM Servers with the new plan, then migrates the node data to minimize the amount of spare capacity.

                      • autodetect object

                        A strategy that lets constructor choose the most optimal way to execute the plan.

                    • plan_configuration object

                      The configuration settings for the timeout and fallback parameters.

                      Hide plan_configuration attributes Show plan_configuration attributes object
                      • timeout integer(int64)

                        The total timeout in seconds after which the plan is cancelled even if it is not complete. Defaults to 4x the max memory capacity per node (in MB). NOTES: A 3 zone cluster with 2 nodes of 2048 each would have a timeout of 4*2048=8192 seconds. Timeout does not include time required to run rollback actions.

                      • calm_wait_time integer(int64)

                        This timeout determines how long to give a cluster after it responds to API calls before performing actual operations on it. It defaults to 5s

                      • skip_snapshot boolean

                        If true (default: false), does not take (or require) a successful snapshot to be taken before performing any potentially destructive changes to this cluster

                      • max_snapshot_attempts integer(int32)

                        If taking a snapshot (ie unless 'skip_snapshots': true) then will retry on failure at most this number of times (default: 5)

                      • max_snapshot_age integer(int64)

                        When you take a snapshot and 'skip_snapshots' is false, specifies the maximum age in seconds of the most recent snapshot before a new snapshot is created. Default is 300

                      • extended_maintenance boolean

                        If true (default false), does not clear the maintenance flag (which prevents its API from being accessed except by the constructor) on new instances added until after a snapshot has been restored, otherwise, the maintenance flag is cleared once the new instances successfully join the new cluster

                      • cluster_reboot string

                        Set to 'forced' to force a reboot as part of the upgrade plan. NOTES: (ie taking an existing plan and leaving it alone except for setting 'transient.plan_configuration.cluster_reboot': 'forced' will reboot the cluster)

                        Value is forced.

                    • restore_snapshot object

                      Restores a snapshot from a local or remote repository.

                      Hide restore_snapshot attributes Show restore_snapshot attributes object
                      • repository_name string

                        If specified, contains the name of the snapshot repository - else will default to the Elastic Cloud system repo ('found-snapshots')

                      • snapshot_name string Required

                        The name of the snapshot to restore. Use '__latest_success__' to get the most recent snapshot from the specified repository

                      • repository_config object

                        Raw remote snapshot restore settings. Do not send this if you are sending source_cluster_id

                        Hide repository_config attribute Show repository_config attribute object
                        • raw_settings object

                          The remote snapshot settings raw JSON - see the Elasticsearch '_snapshot' documentation for more details on supported formats

                      • restore_payload object

                        The configuration for the restore command, such as which indices you want to restore.

                        Hide restore_payload attributes Show restore_payload attributes object
                        • indices array[string]

                          The list of indices to restore (supports +ve and -ve selection and wildcarding - see the default Elasticsearch index format documentation)

                        • raw_settings object

                          This JSON object (merged with the 'indices' field (if present) is passed untouched into the restore command - see the Elasticsearch '_snapshot' documentation for more details on supported formats

                      • strategy string

                        The restore strategy to use. Defaults to a full restore. Partial restore will attempt to restore unavailable indices only

                        Values are partial, full, or recovery.

                      • source_cluster_id string

                        If specified, contains the name of the source cluster id. Do not send this if you are sending repository_config

                    • remote_clusters object

                      The list of resources that will be configured as remote clusters

                      Hide remote_clusters attribute Show remote_clusters attribute object
                      • resources array[object] Required

                        The remote resources

                        The Elasticsearch resource used as a Remote Cluster.

                        Hide resources attributes Show resources attributes object
                        • deployment_id string Required

                          The id of the deployment

                        • elasticsearch_ref_id string Required

                          The locally-unique user-specified id of an Elasticsearch Resource

                        • alias string Required

                          The alias for this remote cluster. Aliases must only contain letters, digits, dashes and underscores

                        • skip_unavailable boolean

                          If true, skip this cluster during search if it is disconnected. Default: false

                        • info object

                          Information about a Remote Cluster.

                          Hide info attributes Show info attributes object
                          • healthy boolean Required

                            Whether or not the remote cluster is healthy

                          • connected boolean Required

                            Whether or not there is at least one connection to the remote cluster.

                          • compatible boolean Required

                            Whether or not the remote cluster version is compatible with this cluster version.

                          • trusted boolean Required

                            Whether or not the remote cluster is trusted by this cluster.

                          • trusted_back boolean Required

                            Whether or not the remote cluster trusts this cluster back.

                    • cluster_settings_json object

                      If specified, contains transient settings to be applied to an Elasticsearch cluster during changes,default values shown below applied. These can be overridden by specifying them in the map (or null to unset). Additional settings can also be set. Settings will be cleared after the plan has finished. If not specified, no settings will be applied. NOTE: These settings are only explicitly cleared for 5.x+ clusters, they must be hand-reset to their defaults in 2.x- (or a cluster reboot will clear them).

                      • indices.store.throttle.max_bytes_per_sec: 120Mb
                      • indices.recovery.max_bytes_per_sec: 120Mb
                      • cluster.routing.allocation.cluster_concurrent_rebalance: 5
                      • cluster.routing.allocation.node_initial_primaries_recoveries: 5
                      • cluster.routing.allocation.node_concurrent_incoming_recoveries: 5 For version 8.1 and later no defaults are provided through this mechanism, but instead hardware dependent settings are provided to each instance.
                  • autoscaling_enabled boolean

                    Enable autoscaling for this Elasticsearch cluster.

                • plan_attempt_log array[object] Required

                  Information about a step in a plan.

                  Hide plan_attempt_log attributes Show plan_attempt_log attributes object
                  • step_id string Required

                    ID of current step

                  • started string(date-time) Required

                    When the step started (ISO format in UTC)

                  • completed string(date-time)

                    When the step completed (ISO format in UTC)

                  • duration_in_millis integer(int64)

                    The duration of the step in MS

                  • status string Required

                    The status of the step (success, warning, error - warning means something didn't go as expected but it was not serious enough to abort the plan)

                    Values are success, warning, error, or pending.

                  • stage string Required

                    Current stage that the step is in

                    Values are starting, completed, or in_progress.

                  • info_log array[object] Required

                    Human readable summaries of the step, including messages for each stage of the step

                    The log message from a specified stage of an executed step in a plan.

                    Hide info_log attributes Show info_log attributes object
                    • timestamp string(date-time) Required

                      Timestamp marking on info log of step

                    • delta_in_millis integer(int64)

                      Time in milliseconds since previous log message

                    • stage string Required

                      Stage that info log message takes place in

                      Values are starting, completed, or in_progress.

                    • message string Required

                      Human readable log message

                    • details object Required

                      A map with details for the log about what happened during the step execution. Keys and values for are always both strings, representing the name of the detail and its value, respectively.

                      Hide details attribute Show details attribute object
                      • * string Additional properties
                    • failure_type string

                      The failure type, in case the step failed

                • source object

                  Information describing the source that facilitated the plans current state

                  Hide source attributes Show source attributes object
                  • facilitator string Required

                    The service where the change originated from

                  • action string Required

                    The type of plan change that was initiated

                  • date string(date-time) Required

                    The time the change was initiated

                  • user_id string

                    The user that requested the change

                  • admin_id string

                    The admin user that requested the change

                  • remote_addresses array[string]

                    The host addresses of the user that originated the change

                • warnings array[object] Required

                  Information about a warning from a plan.

                  Hide warnings attributes Show warnings attributes object
                  • code string Required

                    A unique warning code

                  • message string Required

                    A description of the warning

                  • step_id string

                    The ID of the step which produced a warning, if any

                • error object

                  Information about an error during a plan attempt.

                  Hide error attributes Show error attributes object
                  • timestamp string(date-time) Required

                    Timestamp marking on info log of step

                  • message string Required

                    Human readable error message

                  • details object Required

                    A map with details regarding the error. Both the keys and values are always strings, representing the name of the detail and its value, respectively.

                    Hide details attribute Show details attribute object
                    • * string Additional properties
                  • failure_type string

                    The failure type

              • history array[object] Required

                Information about the Elasticsearch cluster plan.

                Hide history attributes Show history attributes object
                • plan_attempt_id string

                  A UUID for each plan attempt

                • plan_attempt_name string

                  A human readable name for each plan attempt, only populated when retrieving plan histories

                • healthy boolean Required

                  Either the plan ended successfully, or is not yet completed (and no errors have occurred)

                • attempt_start_time string(date-time)

                  When this plan attempt (ie to apply the plan to the cluster) started (ISO format in UTC)

                • attempt_end_time string(date-time)

                  If this plan completed or failed (ie is not pending), when the attempt ended (ISO format in UTC)

                • plan_end_time string(date-time)

                  If this plan is not current or pending, when the plan was no longer active (ISO format in UTC)

                • plan object

                  The plan for building this Elasticsearch cluster

                  Hide plan attributes Show plan attributes object
                  • cluster_topology array[object] Required

                    The topology of the Elasticsearch nodes, including the number, capacity, and type of nodes, and where they can be allocated.

                    Hide cluster_topology attributes Show cluster_topology attributes object
                    • id string

                      Unique identifier of this topology element

                    • node_type object

                      Controls the combinations of Elasticsearch node types. TIP: By default, the Elasticsearch node is master eligible, can hold data, and run ingest pipelines. WARNING: Do not set for tiebreaker topologies.

                      Hide node_type attributes Show node_type attributes object
                      • master boolean

                        Defines whether this node can be elected master (default: false)

                      • data boolean

                        Defines whether this node can hold data (default: false)

                      • ingest boolean

                        Defines whether this node can run an ingest pipeline (default: false)

                      • ml boolean

                        Defines whether this node can run ml jobs, valid only for versions 5.4.0 or greater (default: false)

                    • node_roles array[string]

                      The list of node roles for this topology element (ES version >= 7.10). Allowable values are: master, ingest, ml, data_hot, data_content, data_warm, data_cold, data_frozen, remote_cluster_client, transform

                      Values are master, ingest, ml, data_hot, data_content, data_warm, data_cold, data_frozen, remote_cluster_client, or transform.

                    • zone_count integer(int32)

                      The default number of zones in which data nodes will be placed

                    • elasticsearch object

                      The Elasticsearch cluster settings. When specified at the top level, provides a field-by-field default. When specified at the topology level, provides the override settings.

                      Hide elasticsearch attributes Show elasticsearch attributes object
                      • version string

                        The version of the Elasticsearch cluster (must be one of the ECE supported versions). Currently cannot be different across the topology (and is generally specified in the globals). Defaults to the latest version if not specified.

                      • docker_image string

                        A docker URI that allows overriding of the default docker image specified for this version

                      • system_settings object

                        A subset of Elasticsearch settings. TIP: To define the complete set of Elasticsearch settings, use ElasticsearchSystemSettings with user_settings_override* and user_settings*.

                        Hide system_settings attributes Show system_settings attributes object
                        • scripting object

                          Controls the languages supported by the Elasticsearch cluster, such as Painless, Mustache, and Expressions. Controls how the languages are used, such as file, index, and inline. TIP: For complex configurations, leave these blank and configure these settings in the user YAML or JSON.

                          Hide scripting attributes Show scripting attributes object
                          • painless_enabled boolean

                            (5.x+ only) If enabled (the default) then the painless scripting engine is allowed as a sandboxed language. Sandboxed languages are the only ones allowed if 'sandbox_mode' is set to true. NOTES: (Corresponds to the parameters 'script.engine.painless.[file|stored|inline]')

                          • mustache_enabled boolean

                            (5.x+ only) If enabled (the default) then the mustache scripting engine is allowed as a sandboxed language. Sandboxed languages are the only ones allowed if 'sandbox_mode' is set to true. NOTES: (Corresponds to the parameters 'script.engine.mustache.[file|stored|inline]')

                          • expressions_enabled boolean

                            (5.x+ only) If enabled (the default) then the expressions scripting engine is allowed as a sandboxed language. Sandboxed languages are the only ones allowed if 'sandbox_mode' is set to true. NOTES: (Corresponds to the parameters 'script.engine.expression.[file|stored|inline]')

                          • stored object

                            Enables scripting for the specified type and controls other parameters. Store scripts in indexes (stored), upload in file bundles (file), or use in API requests (inline).

                            Hide stored attributes Show stored attributes object
                            • enabled boolean

                              If enabled (default: true) then scripts are enabled, either for sandboxing languages (by default), or for all installed languages if 'sandbox_mode' is disabled (or for 6.x). NOTES: (Corresponds to the parameter 'script.file|stored/indexed|inline')

                            • sandbox_mode boolean

                              If enabled (default: true) and this script type is enabled, then only the sandbox languages are allowed. By default the sandbox languages are painless, expressions and mustache, but this can be restricted via the 'painless_enabled', 'mustache_enabled' 'expression_enabled' settings.NOTES: Not supported in 6.x. (Corresponds to the parameters 'script.engine.[painless|mustache|expressions].[file|stored|inline]')

                          • file object

                            Enables scripting for the specified type and controls other parameters. Store scripts in indexes (stored), upload in file bundles (file), or use in API requests (inline).

                            Hide file attributes Show file attributes object
                            • enabled boolean

                              If enabled (default: true) then scripts are enabled, either for sandboxing languages (by default), or for all installed languages if 'sandbox_mode' is disabled (or for 6.x). NOTES: (Corresponds to the parameter 'script.file|stored/indexed|inline')

                            • sandbox_mode boolean

                              If enabled (default: true) and this script type is enabled, then only the sandbox languages are allowed. By default the sandbox languages are painless, expressions and mustache, but this can be restricted via the 'painless_enabled', 'mustache_enabled' 'expression_enabled' settings.NOTES: Not supported in 6.x. (Corresponds to the parameters 'script.engine.[painless|mustache|expressions].[file|stored|inline]')

                          • inline object

                            Enables scripting for the specified type and controls other parameters. Store scripts in indexes (stored), upload in file bundles (file), or use in API requests (inline).

                            Hide inline attributes Show inline attributes object
                            • enabled boolean

                              If enabled (default: true) then scripts are enabled, either for sandboxing languages (by default), or for all installed languages if 'sandbox_mode' is disabled (or for 6.x). NOTES: (Corresponds to the parameter 'script.file|stored/indexed|inline')

                            • sandbox_mode boolean

                              If enabled (default: true) and this script type is enabled, then only the sandbox languages are allowed. By default the sandbox languages are painless, expressions and mustache, but this can be restricted via the 'painless_enabled', 'mustache_enabled' 'expression_enabled' settings.NOTES: Not supported in 6.x. (Corresponds to the parameters 'script.engine.[painless|mustache|expressions].[file|stored|inline]')

                        • reindex_whitelist array[string]

                          Limits remote Elasticsearch clusters that can be used as the source for '_reindex' API commands

                        • auto_create_index boolean

                          If true (the default), then any write operation on an index that does not currently exist will create it. NOTES: (Corresponds to the parameter 'action.auto_create_index')

                        • enable_close_index boolean

                          Defaults to false on versions <= 7.2.0, true otherwise. If false, then the API commands to close indices are disabled. This is important because Elasticsearch does not snapshot or migrate close indices on versions under 7.2.0, therefore standard Elastic Cloud configuration operations will cause irretrievable loss of indices' data. NOTES: (Corresponds to the parameter 'cluster.indices.close.enable')

                        • destructive_requires_name boolean

                          If true (default is false) then the index deletion API will not support wildcards or '_all'. NOTES: (Corresponds to the parameter 'action.destructive_requires_name')

                        • watcher_trigger_engine string

                          The trigger engine for Watcher, defaults to 'scheduler' - see the xpack documentation for more information. NOTES: (Corresponds to the parameter '(xpack.)watcher.trigger.schedule.engine', depending on version. Ignored from 6.x onwards.)

                        • default_shards_per_index integer(int32)

                          (2.x only - to get the same result in 5.x template mappings must be used) Sets the default number of shards per index, defaulting to 1 if not specified. (Corresponds to the parameter 'index.number_of_shards' in 2.x, not supported in 5.x)

                        • monitoring_collection_interval integer(int32)

                          The default interval at which monitoring information from the cluster if collected, if monitoring is enabled. NOTES: (Corresponds to the parameter 'marvel.agent.interval' in 2.x and 'xpack.monitoring.collection.interval' in 5.x)

                        • monitoring_history_duration string

                          The duration for which monitoring history is stored (format '(NUMBER)d' eg '3d' for 3 days). NOTES: ('Corresponds to the parameter xpack.monitoring.history.duration' in 5.x, defaults to '7d')

                      • user_settings_json object

                        An arbitrary JSON object allowing cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters arey are on the allowlist and not on the denylist. NOTES: (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Elasticsearch settings)

                      • user_settings_yaml string

                        An arbitrary YAML object allowing cluster owners to set their parameters (only one of this and 'user_settings_json' is allowed), provided the parameters arey are on the allowlist and not on the denylist. NOTES: (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Elasticsearch settings)

                      • user_settings_override_json object

                        An arbitrary JSON object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), ie in addition to the documented 'system_settings'. NOTES: (This field together with 'system_settings' and 'user_settings*' defines the total set of Elasticsearch settings)

                      • user_settings_override_yaml string

                        An arbitrary YAML object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_json' is allowed), ie in addition to the documented 'system_settings'. NOTES: (This field together with 'system_settings' and 'user_settings*' defines the total set of Elasticsearch settings)

                      • enabled_built_in_plugins array[string]

                        A list of plugin names from the Elastic-supported subset that are bundled with the version images. NOTES: (Users should consult the Elastic stack objects to see what plugins are available, this is currently only available from the UI)

                      • user_plugins array[object]

                        A list of admin-uploaded plugin objects that are available for this user.

                        A list of admin-uploaded plugin objects.

                        Hide user_plugins attributes Show user_plugins attributes object
                        • name string Required

                          The name of the plugin

                        • url string Required

                          The URL of the plugin (must be accessible from the ECE infrastructure)

                        • elasticsearch_version string Required

                          The supported Elasticsearch version (must match the version in the plan)

                      • user_bundles array[object]

                        A list of admin-uploaded bundle objects (eg scripts, synonym files) that are available for this user.

                        A list of admin-uploaded bundle objects, such as scripts and synonym files.

                        Hide user_bundles attributes Show user_bundles attributes object
                        • name string Required

                          The name of the bundle

                        • url string Required

                          The URL of the bundle, which must be accessible from the ECE infrastructure. This URL could be cached by platform, make sure to change it when updating the bundle

                        • elasticsearch_version string Required

                          The supported Elasticsearch version (must match the version in the plan)

                      • curation object

                        Defines the index curation routing for the cluster

                        Hide curation attributes Show curation attributes object
                      • node_attributes object

                        Defines the Elasticsearch node attributes for the instances in the topology

                        Hide node_attributes attribute Show node_attributes attribute object
                        • * string Additional properties
                    • instance_configuration_id string

                      Controls the allocation of this topology element as well as allowed sizes and node_types. It needs to match the id of an existing instance configuration.

                    • instance_configuration_version integer(int32)

                      The version of the Instance Configuration Id. If it is unset, the meaning depends on read vs writes. For deployment reads, it is equivalent to version 0 (or the IC is unversioned); for deployment creates and deployment template use, it is equivalent to 'the latest version'; and for deployment updates, it is equivalent to 'retain the current version'.

                    • size object

                      Measured by the amount of a resource. The final cluster size is calculated using multipliers from the topology instance configuration.

                      Hide size attributes Show size attributes object
                      • value integer(int32) Required

                        Amount of resource

                      • resource string Required

                        Type of resource. In ESS the resource used should always be memory.

                        Values are memory or storage.

                    • autoscaling_min object

                      Measured by the amount of a resource. The final cluster size is calculated using multipliers from the topology instance configuration.

                      Hide autoscaling_min attributes Show autoscaling_min attributes object
                      • value integer(int32) Required

                        Amount of resource

                      • resource string Required

                        Type of resource. In ESS the resource used should always be memory.

                        Values are memory or storage.

                    • autoscaling_max object

                      Measured by the amount of a resource. The final cluster size is calculated using multipliers from the topology instance configuration.

                      Hide autoscaling_max attributes Show autoscaling_max attributes object
                      • value integer(int32) Required

                        Amount of resource

                      • resource string Required

                        Type of resource. In ESS the resource used should always be memory.

                        Values are memory or storage.

                    • autoscaling_policy_override_json object

                      An arbitrary JSON object overriding the default autoscaling policy. Don't set unless you really know what you are doing.

                    • topology_element_control object

                      Controls for the topology element. Only used as part of the deployment template. Ignored if included as part of a deployment.

                      Hide topology_element_control attribute Show topology_element_control attribute object
                      • min object Required

                        Measured by the amount of a resource. The final cluster size is calculated using multipliers from the topology instance configuration.

                        Hide min attributes Show min attributes object
                        • value integer(int32) Required

                          Amount of resource

                        • resource string Required

                          Type of resource. In ESS the resource used should always be memory.

                          Values are memory or storage.

                    • autoscaling_tier_override boolean

                      Set to true to enable autoscaling for this topology element, even if the cluster-level 'autoscaling_enabled' field is false. Note that 'autoscaling_tier_override' cannot be set to false if cluster-level 'autoscaling_enabled' is true. Currently only supported for the 'ml' tier

                  • elasticsearch object Required

                    The Elasticsearch cluster settings. When specified at the top level, provides a field-by-field default. When specified at the topology level, provides the override settings.

                    Hide elasticsearch attributes Show elasticsearch attributes object
                    • version string

                      The version of the Elasticsearch cluster (must be one of the ECE supported versions). Currently cannot be different across the topology (and is generally specified in the globals). Defaults to the latest version if not specified.

                    • docker_image string

                      A docker URI that allows overriding of the default docker image specified for this version

                    • system_settings object

                      A subset of Elasticsearch settings. TIP: To define the complete set of Elasticsearch settings, use ElasticsearchSystemSettings with user_settings_override* and user_settings*.

                      Hide system_settings attributes Show system_settings attributes object
                      • scripting object

                        Controls the languages supported by the Elasticsearch cluster, such as Painless, Mustache, and Expressions. Controls how the languages are used, such as file, index, and inline. TIP: For complex configurations, leave these blank and configure these settings in the user YAML or JSON.

                        Hide scripting attributes Show scripting attributes object
                        • painless_enabled boolean

                          (5.x+ only) If enabled (the default) then the painless scripting engine is allowed as a sandboxed language. Sandboxed languages are the only ones allowed if 'sandbox_mode' is set to true. NOTES: (Corresponds to the parameters 'script.engine.painless.[file|stored|inline]')

                        • mustache_enabled boolean

                          (5.x+ only) If enabled (the default) then the mustache scripting engine is allowed as a sandboxed language. Sandboxed languages are the only ones allowed if 'sandbox_mode' is set to true. NOTES: (Corresponds to the parameters 'script.engine.mustache.[file|stored|inline]')

                        • expressions_enabled boolean

                          (5.x+ only) If enabled (the default) then the expressions scripting engine is allowed as a sandboxed language. Sandboxed languages are the only ones allowed if 'sandbox_mode' is set to true. NOTES: (Corresponds to the parameters 'script.engine.expression.[file|stored|inline]')

                        • stored object

                          Enables scripting for the specified type and controls other parameters. Store scripts in indexes (stored), upload in file bundles (file), or use in API requests (inline).

                          Hide stored attributes Show stored attributes object
                          • enabled boolean

                            If enabled (default: true) then scripts are enabled, either for sandboxing languages (by default), or for all installed languages if 'sandbox_mode' is disabled (or for 6.x). NOTES: (Corresponds to the parameter 'script.file|stored/indexed|inline')

                          • sandbox_mode boolean

                            If enabled (default: true) and this script type is enabled, then only the sandbox languages are allowed. By default the sandbox languages are painless, expressions and mustache, but this can be restricted via the 'painless_enabled', 'mustache_enabled' 'expression_enabled' settings.NOTES: Not supported in 6.x. (Corresponds to the parameters 'script.engine.[painless|mustache|expressions].[file|stored|inline]')

                        • file object

                          Enables scripting for the specified type and controls other parameters. Store scripts in indexes (stored), upload in file bundles (file), or use in API requests (inline).

                          Hide file attributes Show file attributes object
                          • enabled boolean

                            If enabled (default: true) then scripts are enabled, either for sandboxing languages (by default), or for all installed languages if 'sandbox_mode' is disabled (or for 6.x). NOTES: (Corresponds to the parameter 'script.file|stored/indexed|inline')

                          • sandbox_mode boolean

                            If enabled (default: true) and this script type is enabled, then only the sandbox languages are allowed. By default the sandbox languages are painless, expressions and mustache, but this can be restricted via the 'painless_enabled', 'mustache_enabled' 'expression_enabled' settings.NOTES: Not supported in 6.x. (Corresponds to the parameters 'script.engine.[painless|mustache|expressions].[file|stored|inline]')

                        • inline object

                          Enables scripting for the specified type and controls other parameters. Store scripts in indexes (stored), upload in file bundles (file), or use in API requests (inline).

                          Hide inline attributes Show inline attributes object
                          • enabled boolean

                            If enabled (default: true) then scripts are enabled, either for sandboxing languages (by default), or for all installed languages if 'sandbox_mode' is disabled (or for 6.x). NOTES: (Corresponds to the parameter 'script.file|stored/indexed|inline')

                          • sandbox_mode boolean

                            If enabled (default: true) and this script type is enabled, then only the sandbox languages are allowed. By default the sandbox languages are painless, expressions and mustache, but this can be restricted via the 'painless_enabled', 'mustache_enabled' 'expression_enabled' settings.NOTES: Not supported in 6.x. (Corresponds to the parameters 'script.engine.[painless|mustache|expressions].[file|stored|inline]')

                      • reindex_whitelist array[string]

                        Limits remote Elasticsearch clusters that can be used as the source for '_reindex' API commands

                      • auto_create_index boolean

                        If true (the default), then any write operation on an index that does not currently exist will create it. NOTES: (Corresponds to the parameter 'action.auto_create_index')

                      • enable_close_index boolean

                        Defaults to false on versions <= 7.2.0, true otherwise. If false, then the API commands to close indices are disabled. This is important because Elasticsearch does not snapshot or migrate close indices on versions under 7.2.0, therefore standard Elastic Cloud configuration operations will cause irretrievable loss of indices' data. NOTES: (Corresponds to the parameter 'cluster.indices.close.enable')

                      • destructive_requires_name boolean

                        If true (default is false) then the index deletion API will not support wildcards or '_all'. NOTES: (Corresponds to the parameter 'action.destructive_requires_name')

                      • watcher_trigger_engine string

                        The trigger engine for Watcher, defaults to 'scheduler' - see the xpack documentation for more information. NOTES: (Corresponds to the parameter '(xpack.)watcher.trigger.schedule.engine', depending on version. Ignored from 6.x onwards.)

                      • default_shards_per_index integer(int32)

                        (2.x only - to get the same result in 5.x template mappings must be used) Sets the default number of shards per index, defaulting to 1 if not specified. (Corresponds to the parameter 'index.number_of_shards' in 2.x, not supported in 5.x)

                      • monitoring_collection_interval integer(int32)

                        The default interval at which monitoring information from the cluster if collected, if monitoring is enabled. NOTES: (Corresponds to the parameter 'marvel.agent.interval' in 2.x and 'xpack.monitoring.collection.interval' in 5.x)

                      • monitoring_history_duration string

                        The duration for which monitoring history is stored (format '(NUMBER)d' eg '3d' for 3 days). NOTES: ('Corresponds to the parameter xpack.monitoring.history.duration' in 5.x, defaults to '7d')

                    • user_settings_json object

                      An arbitrary JSON object allowing cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters arey are on the allowlist and not on the denylist. NOTES: (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Elasticsearch settings)

                    • user_settings_yaml string

                      An arbitrary YAML object allowing cluster owners to set their parameters (only one of this and 'user_settings_json' is allowed), provided the parameters arey are on the allowlist and not on the denylist. NOTES: (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Elasticsearch settings)

                    • user_settings_override_json object

                      An arbitrary JSON object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), ie in addition to the documented 'system_settings'. NOTES: (This field together with 'system_settings' and 'user_settings*' defines the total set of Elasticsearch settings)

                    • user_settings_override_yaml string

                      An arbitrary YAML object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_json' is allowed), ie in addition to the documented 'system_settings'. NOTES: (This field together with 'system_settings' and 'user_settings*' defines the total set of Elasticsearch settings)

                    • enabled_built_in_plugins array[string]

                      A list of plugin names from the Elastic-supported subset that are bundled with the version images. NOTES: (Users should consult the Elastic stack objects to see what plugins are available, this is currently only available from the UI)

                    • user_plugins array[object]

                      A list of admin-uploaded plugin objects that are available for this user.

                      A list of admin-uploaded plugin objects.

                      Hide user_plugins attributes Show user_plugins attributes object
                      • name string Required

                        The name of the plugin

                      • url string Required

                        The URL of the plugin (must be accessible from the ECE infrastructure)

                      • elasticsearch_version string Required

                        The supported Elasticsearch version (must match the version in the plan)

                    • user_bundles array[object]

                      A list of admin-uploaded bundle objects (eg scripts, synonym files) that are available for this user.

                      A list of admin-uploaded bundle objects, such as scripts and synonym files.

                      Hide user_bundles attributes Show user_bundles attributes object
                      • name string Required

                        The name of the bundle

                      • url string Required

                        The URL of the bundle, which must be accessible from the ECE infrastructure. This URL could be cached by platform, make sure to change it when updating the bundle

                      • elasticsearch_version string Required

                        The supported Elasticsearch version (must match the version in the plan)

                    • curation object

                      Defines the index curation routing for the cluster

                      Hide curation attributes Show curation attributes object
                    • node_attributes object

                      Defines the Elasticsearch node attributes for the instances in the topology

                      Hide node_attributes attribute Show node_attributes attribute object
                      • * string Additional properties
                  • deployment_template object

                    Documents which deployment template was used in the creation of this plan

                    Hide deployment_template attributes Show deployment_template attributes object
                    • id string Required

                      The unique identifier of the deployment template

                    • version string

                      A version identifier to disambiguate multiple revisions of the same template

                  • transient object

                    Defines the configuration parameters that control how the plan is applied. For example, the Elasticsearch cluster topology and Elasticsearch settings.

                    Hide transient attributes Show transient attributes object
                    • strategy object

                      The options for performing a plan change. Specify only one property each time. The default is grow_and_shrink.

                      Hide strategy attributes Show strategy attributes object
                      • rolling object

                        Performs inline, rolling configuration changes that mutate existing containers. TIP: This is the fastest way to update a plan, but can fail for complex plan changes, such as topology changes. Also, this is less safe for configuration changes that leave a cluster in a non running state. NOTE: When you perform a major version upgrade, and 'group_by' is set to 'pass:macros[all]';, rolling is required.

                        Hide rolling attributes Show rolling attributes object
                        • group_by string

                          Specifies the grouping attribute to use when rolling several instances. Instances that share the same value for the provided attribute key are rolled together as a unit. Examples that make sense to use are '__all__' (roll all instances as a single unit), 'logical_zone_name' (roll instances by zone), '__name__' (roll one instance at a time, the default if not specified). Note that '__all__' is required when performing a major version upgrade

                        • allow_inline_resize boolean

                          Whether we allow changing the capacity of instances (default false). This is currently implemented by stopping, re-creating then starting the affected instance on its associated allocator when performing the changes. NOTES: This requires a round-trip through the allocation infrastructure of the active constructor, as it has to reserve the target capacity without over-committing

                        • skip_synced_flush boolean

                          Whether to skip attempting to do a synced flush on the filesystem of the container (default: false), which is less safe but may be required if the container is unhealthy

                        • shard_init_wait_time integer(int64)

                          The time, in seconds, to wait for shards that show no progress of initializing before rolling the next group (default: 10 minutes)

                      • grow_and_shrink object

                        A strategy that creates instances with the new plan, migrates data from the old instances, then shuts down the old instances. GrowShrinkStrategyConfig is safer than 'rolling' and ensures single node availability during a plan change, but can be a lot slower on larger clusters.

                      • rolling_grow_and_shrink object

                        A strategy that creates new Elasticsearch instances, Kibana instances, and APM Servers with the new plan, then migrates the node data to minimize the amount of spare capacity.

                      • autodetect object

                        A strategy that lets constructor choose the most optimal way to execute the plan.

                    • plan_configuration object

                      The configuration settings for the timeout and fallback parameters.

                      Hide plan_configuration attributes Show plan_configuration attributes object
                      • timeout integer(int64)

                        The total timeout in seconds after which the plan is cancelled even if it is not complete. Defaults to 4x the max memory capacity per node (in MB). NOTES: A 3 zone cluster with 2 nodes of 2048 each would have a timeout of 4*2048=8192 seconds. Timeout does not include time required to run rollback actions.

                      • calm_wait_time integer(int64)

                        This timeout determines how long to give a cluster after it responds to API calls before performing actual operations on it. It defaults to 5s

                      • skip_snapshot boolean

                        If true (default: false), does not take (or require) a successful snapshot to be taken before performing any potentially destructive changes to this cluster

                      • max_snapshot_attempts integer(int32)

                        If taking a snapshot (ie unless 'skip_snapshots': true) then will retry on failure at most this number of times (default: 5)

                      • max_snapshot_age integer(int64)

                        When you take a snapshot and 'skip_snapshots' is false, specifies the maximum age in seconds of the most recent snapshot before a new snapshot is created. Default is 300

                      • extended_maintenance boolean

                        If true (default false), does not clear the maintenance flag (which prevents its API from being accessed except by the constructor) on new instances added until after a snapshot has been restored, otherwise, the maintenance flag is cleared once the new instances successfully join the new cluster

                      • cluster_reboot string

                        Set to 'forced' to force a reboot as part of the upgrade plan. NOTES: (ie taking an existing plan and leaving it alone except for setting 'transient.plan_configuration.cluster_reboot': 'forced' will reboot the cluster)

                        Value is forced.

                    • restore_snapshot object

                      Restores a snapshot from a local or remote repository.

                      Hide restore_snapshot attributes Show restore_snapshot attributes object
                      • repository_name string

                        If specified, contains the name of the snapshot repository - else will default to the Elastic Cloud system repo ('found-snapshots')

                      • snapshot_name string Required

                        The name of the snapshot to restore. Use '__latest_success__' to get the most recent snapshot from the specified repository

                      • repository_config object

                        Raw remote snapshot restore settings. Do not send this if you are sending source_cluster_id

                        Hide repository_config attribute Show repository_config attribute object
                        • raw_settings object

                          The remote snapshot settings raw JSON - see the Elasticsearch '_snapshot' documentation for more details on supported formats

                      • restore_payload object

                        The configuration for the restore command, such as which indices you want to restore.

                        Hide restore_payload attributes Show restore_payload attributes object
                        • indices array[string]

                          The list of indices to restore (supports +ve and -ve selection and wildcarding - see the default Elasticsearch index format documentation)

                        • raw_settings object

                          This JSON object (merged with the 'indices' field (if present) is passed untouched into the restore command - see the Elasticsearch '_snapshot' documentation for more details on supported formats

                      • strategy string

                        The restore strategy to use. Defaults to a full restore. Partial restore will attempt to restore unavailable indices only

                        Values are partial, full, or recovery.

                      • source_cluster_id string

                        If specified, contains the name of the source cluster id. Do not send this if you are sending repository_config

                    • remote_clusters object

                      The list of resources that will be configured as remote clusters

                      Hide remote_clusters attribute Show remote_clusters attribute object
                      • resources array[object] Required

                        The remote resources

                        The Elasticsearch resource used as a Remote Cluster.

                        Hide resources attributes Show resources attributes object
                        • deployment_id string Required

                          The id of the deployment

                        • elasticsearch_ref_id string Required

                          The locally-unique user-specified id of an Elasticsearch Resource

                        • alias string Required

                          The alias for this remote cluster. Aliases must only contain letters, digits, dashes and underscores

                        • skip_unavailable boolean

                          If true, skip this cluster during search if it is disconnected. Default: false

                        • info object

                          Information about a Remote Cluster.

                          Hide info attributes Show info attributes object
                          • healthy boolean Required

                            Whether or not the remote cluster is healthy

                          • connected boolean Required

                            Whether or not there is at least one connection to the remote cluster.

                          • compatible boolean Required

                            Whether or not the remote cluster version is compatible with this cluster version.

                          • trusted boolean Required

                            Whether or not the remote cluster is trusted by this cluster.

                          • trusted_back boolean Required

                            Whether or not the remote cluster trusts this cluster back.

                    • cluster_settings_json object

                      If specified, contains transient settings to be applied to an Elasticsearch cluster during changes,default values shown below applied. These can be overridden by specifying them in the map (or null to unset). Additional settings can also be set. Settings will be cleared after the plan has finished. If not specified, no settings will be applied. NOTE: These settings are only explicitly cleared for 5.x+ clusters, they must be hand-reset to their defaults in 2.x- (or a cluster reboot will clear them).

                      • indices.store.throttle.max_bytes_per_sec: 120Mb
                      • indices.recovery.max_bytes_per_sec: 120Mb
                      • cluster.routing.allocation.cluster_concurrent_rebalance: 5
                      • cluster.routing.allocation.node_initial_primaries_recoveries: 5
                      • cluster.routing.allocation.node_concurrent_incoming_recoveries: 5 For version 8.1 and later no defaults are provided through this mechanism, but instead hardware dependent settings are provided to each instance.
                  • autoscaling_enabled boolean

                    Enable autoscaling for this Elasticsearch cluster.

                • plan_attempt_log array[object] Required

                  Information about a step in a plan.

                  Hide plan_attempt_log attributes Show plan_attempt_log attributes object
                  • step_id string Required

                    ID of current step

                  • started string(date-time) Required

                    When the step started (ISO format in UTC)

                  • completed string(date-time)

                    When the step completed (ISO format in UTC)

                  • duration_in_millis integer(int64)

                    The duration of the step in MS

                  • status string Required

                    The status of the step (success, warning, error - warning means something didn't go as expected but it was not serious enough to abort the plan)

                    Values are success, warning, error, or pending.

                  • stage string Required

                    Current stage that the step is in

                    Values are starting, completed, or in_progress.

                  • info_log array[object] Required

                    Human readable summaries of the step, including messages for each stage of the step

                    The log message from a specified stage of an executed step in a plan.

                    Hide info_log attributes Show info_log attributes object
                    • timestamp string(date-time) Required

                      Timestamp marking on info log of step

                    • delta_in_millis integer(int64)

                      Time in milliseconds since previous log message

                    • stage string Required

                      Stage that info log message takes place in

                      Values are starting, completed, or in_progress.

                    • message string Required

                      Human readable log message

                    • details object Required

                      A map with details for the log about what happened during the step execution. Keys and values for are always both strings, representing the name of the detail and its value, respectively.

                      Hide details attribute Show details attribute object
                      • * string Additional properties
                    • failure_type string

                      The failure type, in case the step failed

                • source object

                  Information describing the source that facilitated the plans current state

                  Hide source attributes Show source attributes object
                  • facilitator string Required

                    The service where the change originated from

                  • action string Required

                    The type of plan change that was initiated

                  • date string(date-time) Required

                    The time the change was initiated

                  • user_id string

                    The user that requested the change

                  • admin_id string

                    The admin user that requested the change

                  • remote_addresses array[string]

                    The host addresses of the user that originated the change

                • warnings array[object] Required

                  Information about a warning from a plan.

                  Hide warnings attributes Show warnings attributes object
                  • code string Required

                    A unique warning code

                  • message string Required

                    A description of the warning

                  • step_id string

                    The ID of the step which produced a warning, if any

                • error object

                  Information about an error during a plan attempt.

                  Hide error attributes Show error attributes object
                  • timestamp string(date-time) Required

                    Timestamp marking on info log of step

                  • message string Required

                    Human readable error message

                  • details object Required

                    A map with details regarding the error. Both the keys and values are always strings, representing the name of the detail and its value, respectively.

                    Hide details attribute Show details attribute object
                    • * string Additional properties
                  • failure_type string

                    The failure type

            • elasticsearch object Required

              Information about the Elasticsearch cluster.

              Hide elasticsearch attributes Show elasticsearch attributes object
              • healthy boolean Required

                Whether the Elasticsearch cluster is healthy (check the sub-objects for more details if not)

              • shard_info object Required

                WARNING This endpoint is deprecated and scheduled to be removed in the next major version. Use shards_status instead.

                Elasticsearch shard info

                Hide shard_info attributes Show shard_info attributes object
                • healthy boolean Required

                  Whether the shard situation is healthy (any unavailable shards is unhealthy)

                • available_shards array[object] Required

                  Information about the shards for each Elasticsearch instance container that hosts an Elasticsearch node. TIP: When the shard is unavailable, the cluster is unable to serve all of the data.

                  Hide available_shards attributes Show available_shards attributes object
                  • instance_name string Required

                    The Elastic Cloud name/id of the instance (container)

                  • shard_count integer(int32) Required

                    The number of shards of the given type (available/unavailable) on this instance

                • unavailable_shards array[object] Required

                  Information about the shards for each Elasticsearch instance container that hosts an Elasticsearch node. TIP: When the shard is unavailable, the cluster is unable to serve all of the data.

                  Hide unavailable_shards attributes Show unavailable_shards attributes object
                  • instance_name string Required

                    The Elastic Cloud name/id of the instance (container)

                  • shard_count integer(int32) Required

                    The number of shards of the given type (available/unavailable) on this instance

                • unavailable_replicas array[object] Required

                  Information about the unavailable replicas. NOTE: Unlike shards, unavailable replicas indicate a loss of redundancy rather than a loss of availability.

                  Hide unavailable_replicas attributes Show unavailable_replicas attributes object
                  • instance_name string Required

                    The Elastic Cloud name/id of the instance (container)

                  • replica_count integer(int32) Required

                    The number of unavailable replicas on this instance

              • shards_status object

                Shards status represented as green, yellow, or red, as returned by the Elasticsearch cluster health API

                Hide shards_status attribute Show shards_status attribute object
                • status string Required

                  Indicates the elasticsearch cluster health status as a color

                  Values are green, red, or yellow.

              • master_info object Required

                Information about the master nodes in the Elasticsearch cluster.

                Hide master_info attributes Show master_info attributes object
                • healthy boolean Required

                  Whether the master situation in the cluster is healthy (ie is the number of masters != 1), or do any instances have no master

                • masters array[object] Required

                  Information about the Elasticsearch instances. For split-brain cases, this also includes sub-clusters.

                  Hide masters attributes Show masters attributes object
                  • master_node_id string Required

                    The Elasticsearch node id of a master node

                  • master_instance_name string

                    The corresponding instance name of the container hosting the Elasticsearch master node, if available

                  • instances array[string] Required

                    The names of the instance/container hosting the node belong to the cluster with the given master

                • instances_with_no_master array[string] Required

                  A list of any instances with no master

              • blocking_issues object Required

                WARNING This endpoint is deprecated and scheduled to be removed in the next major version. Use cluster_blocking_issues instead.

                cluster-wide and/or index blocks

                Hide blocking_issues attributes Show blocking_issues attributes object
                • healthy boolean Required

                  Whether the cluster has issues (false) or not (true)

                • cluster_level array[object] Required

                  A list of issues that affect availability of entire cluster

                  WARNING This endpoint is deprecated and scheduled to be removed in the next major version. Use blocks in cluster_blocking_issues instead

                  Information about an issue and the Elasticsearch instance it affects.

                  Hide cluster_level attributes Show cluster_level attributes object
                  • description string Required

                    Description of the issue

                  • instances array[string] Required

                    A list of instances that are affected by the issue

                • index_level array[object] Required

                  A list of issues that affect availability of the cluster's indices

                  WARNING This endpoint is deprecated and scheduled to be removed in the next major version. Use blocks in cluster_blocking_issues instead

                  Information about an issue and the Elasticsearch instance it affects.

                  Hide index_level attributes Show index_level attributes object
                  • description string Required

                    Description of the issue

                  • instances array[string] Required

                    A list of instances that are affected by the issue

              • cluster_blocking_issues object

                Issues that prevent the Elasticsearch cluster or index from correctly operating.

                Hide cluster_blocking_issues attributes Show cluster_blocking_issues attributes object
                • healthy boolean Required

                  Whether the cluster has issues (false) or not (true)

                • blocks array[object] Required

                  A list of blocks that affect the availability of the cluster

                  Information about index or cluster blocks

                  Hide blocks attributes Show blocks attributes object
                  • description string Required

                    Description of the block

                  • level string Required

                    Applicable level for the block. Either global ie. cluster-wide or index level

                    Values are index or global.

            • metadata object Required

              Information about the public and internal state, and the configuration settings of an Elasticsearch cluster.

              Hide metadata attributes Show metadata attributes object
              • version integer(int32) Required

                The resource version number of the cluster metadata

              • last_modified string(date-time) Required

                The most recent time the cluster metadata was changed (ISO format in UTC)

              • endpoint string

                The DNS name of the cluster endpoint, if available

              • service_url string

                The full URL to access this deployment resource

              • aliased_endpoint string

                The DNS name of the cluster endpoint derived from the deployment alias, if available

              • aliased_url string

                The full aliased URL to access this deployment resource

              • cloud_id string

                The cloud ID, an encoded string that provides other Elastic services with the necessary information to connect to this Elasticsearch and Kibana (only present if both exist)

              • raw object

                An unstructured JSON representation of the public and internal state (can be filtered out via URL parameter). The contents and structure of the raw field can change at any time.

              • ports object

                The ports that allow communication with the cluster using various protocols.

                Hide ports attributes Show ports attributes object
                • http integer(int32) Required

                  Port where the cluster listens for HTTP traffic

                • https integer(int32) Required

                  Port where the cluster listens for HTTPS traffic

                • transport_passthrough integer(int32) Required

                  Port where the cluster listens for transport traffic using TLS

              • services_urls array[object]

                A list of the URLs to access services that the resource provides at this time. Note that if the service is not running or has not started yet, the URL to access it won't be available

                A URL to access the service of a resource

                Hide services_urls attributes Show services_urls attributes object
                • service string Required

                  Name of the service

                • url string Required

                  The full URL to access the service

            • topology object Required

              The topology for Elasticsearch clusters, multiple Kibana instances, or multiple APM Servers. The ClusterTopologyInfo also includes the instances and containers, and where they are located.

              Hide topology attributes Show topology attributes object
              • healthy boolean Required

                Whether the cluster topology is healthy (ie all instances are started and the services they run - ie elasticsearch - are available

              • instances array[object] Required

                Information about each Kibana instance and APM Server in the Elasticsearch cluster.

                Hide instances attributes Show instances attributes object
                • instance_name string Required

                  The name of the instance in Elastic Cloud

                • instance_configuration object

                  Information about a configuration that creates a Kibana instance or APM Server.

                  Hide instance_configuration attributes Show instance_configuration attributes object
                  • id string Required

                    The id of the configuration used to create the instance

                  • name string Required

                    The name of the configuration used to create the instance

                  • config_version integer(int32)

                    If the IC is configuration controlled, this field is the version either being read back (reads return the latest IC unless specified by the 'config_version' URL param), or the version to update. Cannot be used in creates. For unversioned IC reads it is left empty.

                  • resource string Required

                    The resource type of the instance configuration

                    Values are memory or storage.

                • service_version string

                  The version of the service that the instance is running (eg Elasticsearch or Kibana), if available

                • healthy boolean Required

                  Whether the instance is healthy (ie started and running)

                • container_started boolean Required

                  Whether the container has started (does not tell you anything about the service -ie Elasticsearch- running inside the container)

                • service_running boolean Required

                  Whether the service launched inside the container -ie Elasticsearch- is actually running

                • maintenance_mode boolean Required

                  Whether the service is is maintenance mode (meaning that the proxy is not routing external traffic to it)

                • zone string

                  The zone in which this instance is being allocated

                • allocator_id string

                  The id of the allocator on which this instance is running (if the container is started or starting)

                • memory object

                  Information about the specific instances memory capacity and its usage

                  Hide memory attributes Show memory attributes object
                  • instance_capacity integer(int32) Required

                    The memory capacity in MB of the instance

                  • instance_capacity_planned integer(int32)

                    The planned memory capacity in MB of the instance (only shown when an override is present)

                  • memory_pressure integer(int32)

                    The % memory pressure of Elasticsearch JVM heap space if available (60-75% consider increasing capacity, >75% can incur significant performance and stability issues)

                  • native_memory_pressure integer(int32)

                    The % memory pressure of the instance Docker container (if available)

                • disk object

                  Information about the use and storage capacity of a Kibana instance or APM Server.

                  Hide disk attributes Show disk attributes object
                  • disk_space_available integer(int64)

                    If known, the amount of total disk space available to the container in MB

                  • disk_space_used integer(int64) Required

                    The amount of disk space being used by the service in MB

                  • storage_multiplier number(double) Required

                    The storage multiplier originally defined to calculate disk space.

                • service_roles array[string]

                  List of roles assigned to the service running in the instance. Currently only populated for Elasticsearch, with possible values: master,data,ingest,ml

                • node_roles array[string]

                  A list of the node roles assigned to the service running in the instance. Currently populated only for Elasticsearch.

                  Values are master, ingest, ml, data_hot, data_content, data_warm, data_cold, data_frozen, remote_cluster_client, transform, or voting_only.

                • instance_overrides object

                  Instance overrides

                  Hide instance_overrides attributes Show instance_overrides attributes object
                  • capacity integer(int32)

                    Sets the memory capacity for the instances container. Requires a restart to take effect.

                  • storage_multiplier number(double)

                    Overrides the disk quota multiplier for the instance

            • system_alerts array[object]

              List of cluster system alerts

              Information about a system alert on an Elasticsearch cluster.

              Hide system_alerts attributes Show system_alerts attributes object
              • timestamp string(date-time) Required

                Timestamp marking the system alert

              • instance_name string Required

                Instance that caused the system alert

              • alert_type string Required

                Type of system alert

                Values are automatic_restart, heap_dump, or unknown_event.

              • url string

                The URL related to the event. Only applicable for alert_type: heap_dump

              • exit_code integer(int32)

                The exit_code related to the event. Only applicable for alert_type: slain

            • associated_kibana_clusters array[object] Required

              Information about the Kibana instances associated with the Elasticsearch cluster.

              Hide associated_kibana_clusters attributes Show associated_kibana_clusters attributes object
              • kibana_id string Required

                The Kibana cluster Id

              • enabled boolean Required

                Whether the associated Kibana cluster is currently available

              • links object

                A map of application-specific operations (which map to 'operationId's in the Swagger API) to metadata about that operation

                Hide links attribute Show links attribute object
                • * object Additional properties
                  Hide * attribute Show * attribute object
                  • need_elevated_permissions boolean

                    Whether the operation requires elevated permissions (when the field is present, elevated permissions are required).

            • associated_apm_clusters array[object] Required

              Information about the APM Servers associated with the Elasticsearch cluster.

              Hide associated_apm_clusters attributes Show associated_apm_clusters attributes object
              • apm_id string Required

                The APM cluster Id

              • enabled boolean Required

                Whether the associated APM cluster is currently available

              • links object

                A map of application-specific operations (which map to 'operationId's in the Swagger API) to metadata about that operation

                Hide links attribute Show links attribute object
                • * object Additional properties
                  Hide * attribute Show * attribute object
                  • need_elevated_permissions boolean

                    Whether the operation requires elevated permissions (when the field is present, elevated permissions are required).

            • associated_appsearch_clusters array[object] Required

              Information about the APM Servers associated with the Elasticsearch cluster.

              Hide associated_appsearch_clusters attributes Show associated_appsearch_clusters attributes object
              • app_search_id string Required

                The App Search Id

              • enabled boolean Required

                Whether the associated App Search is currently available

              • links object

                A map of application-specific operations (which map to 'operationId's in the Swagger API) to metadata about that operation

                Hide links attribute Show links attribute object
                • * object Additional properties
                  Hide * attribute Show * attribute object
                  • need_elevated_permissions boolean

                    Whether the operation requires elevated permissions (when the field is present, elevated permissions are required).

            • associated_enterprise_search_clusters array[object] Required

              Information about the APM Servers associated with the Elasticsearch cluster.

              Hide associated_enterprise_search_clusters attributes Show associated_enterprise_search_clusters attributes object
              • enterprise_search_id string Required

                The Enterprise Search Id

              • enabled boolean Required

                Whether the associated Enterprise Search is currently available

              • links object

                A map of application-specific operations (which map to 'operationId's in the Swagger API) to metadata about that operation

                Hide links attribute Show links attribute object
                • * object Additional properties
                  Hide * attribute Show * attribute object
                  • need_elevated_permissions boolean

                    Whether the operation requires elevated permissions (when the field is present, elevated permissions are required).

            • security object

              For 2.x Elasticsearch clusters, specifies the information about the users and roles. For 5.x Elasticsearch clusters, use the Kibana management UI.

              Hide security attributes Show security attributes object
              • version integer(int32) Required

                The resource version number of the security settings

              • last_modified string(date-time) Required

                The most recent time the security settings were changed (ISO format in UTC)

              • users array[object] Required

                The information about an Elasticsearch cluster user.

                Hide users attributes Show users attributes object
              • roles object Required

                An arbitrarily nested JSON object mapping roles to sets of resources and permissions - see the Elasticsearch security documentation for more details on roles

              • users_roles array[object] Required

                The authorization information for an Elasticsearch cluster user.

                Hide users_roles attributes Show users_roles attributes object
                • username string Required

                  The username

                • roles array[string] Required

                  The list of roles for this user

            • elasticsearch_monitoring_info object

              Information about the monitoring status for the Elasticsearch cluster.

              Hide elasticsearch_monitoring_info attributes Show elasticsearch_monitoring_info attributes object
              • healthy boolean Required

                Whether the Monitoring configuration has been successfully applied

              • last_modified string(date-time) Required

                The time the monitoring configuration was last changed

              • last_update_status string Required

                The status message from the last update (successful or not)

              • source_cluster_ids array[string] Required

                The list of clusters Ids from which this cluster is currently receiving monitoring data

              • destination_cluster_ids array[string] Required

                The list of clusters Ids to which this cluster is currently sending monitoring data

            • snapshots object Required

              Information about the snapshot status for the Elasticsearch cluster. For example, the health status.

              Hide snapshots attributes Show snapshots attributes object
            • external_links array[object] Required

              External resources related to the cluster

              Hide external_links attributes Show external_links attributes object
              • id string Required

                Identifier of the external link

              • label string Required

                Human-readable description of the external link

              • uri string

                hyperlink to an external resource

            • links object

              A map of application-specific operations (which map to 'operationId's in the Swagger API) to metadata about that operation

              Hide links attribute Show links attribute object
              • * object Additional properties
                Hide * attribute Show * attribute object
                • need_elevated_permissions boolean

                  Whether the operation requires elevated permissions (when the field is present, elevated permissions are required).

            • settings object

              The settings for building this Elasticsearch cluster

              Hide settings attributes Show settings attributes object
              • snapshot object

                The snapshot settings for this deployment. When provided, snapshot settings are changed as specified. A null value reverts the field to the default value. Otherwise, all snapshot settings remain as they were set previously.

                Hide snapshot attributes Show snapshot attributes object
                • interval string

                  Interval between snapshots, with the format 'length unit' (space is optional), where unit can be one of: d (day), h (hour), min (minute). Default is 30 minutes

                • retention object

                  Cluster snapshot retention information

                  Hide retention attributes Show retention attributes object
                  • snapshots integer(int32)

                    Number of snapshots to retain

                  • max_age string

                    Total retention period for all snapshots, with the format 'length unit' (space is optional), where unit can be one of: d (day), h (hour), min (minute)

                • slm boolean

                  When set to true, the deployment will have SLM enabled. Default value is true.

                • cron_expression string

                  Cron expression indicating when should snapshots be taken. This can be enabled only if SLM is enabled for the deployment and 'interval' is not present

              • monitoring object

                The monitoring settings for this deployment. When provided, monitoring settings are changed as specified. A null value reverts the field to the default value. Otherwise, all monitoring settings remain as they were set previously.

                Hide monitoring attribute Show monitoring attribute object
                • target_cluster_id string Required

                  The Id of the target cluster to which to send monitoring information

              • metadata object

                The top-level configuration settings for the Elasticsearch cluster.

                Hide metadata attribute Show metadata attribute object
                • name string

                  The display name of the cluster

              • curation object

                The curation settings for this deployment. When provided, curation settings are changed as specified. A null value reverts the field to the default value. Otherwise, all curation settings remain as they were set previously.

                Hide curation attribute Show curation attribute object
                • specs array[object] Required

                  Specifications for curation

                  Specifies the conditions to trigger an Elasticsearch cluster curation.

                  Hide specs attributes Show specs attributes object
              • dedicated_masters_threshold integer(int32)

                Threshold starting from which the number of instances in the cluster results in the introduction of dedicated masters. If the cluster is downscaled to a number of nodes below this one, dedicated masters will be removed. Limit is inclusive. When provided the threshold setting is updated. A null value removes the field. Otherwise, the setting remains as it was set previously.

              • traffic_filter object

                The rulesets to apply to all resources in this cluster. When specified, the set of rulesets is updated and the same rulesets will be applied to Kibana and APM clusters as well. If not specified, the rulesets remain as they were set previously.

                Hide traffic_filter attribute Show traffic_filter attribute object
                • rulesets array[string] Required

                  IDs of the traffic filter rulesets

              • trust object

                Configuration of trust with other clusters. When provided, trust settings are changed as specified. A null value reverts the field to the default value. Otherwise, all trust settings remain as they were set previously.

                Hide trust attributes Show trust attributes object
                • accounts array[object]

                  The list of trust relationships with different accounts

                  The trust relationship with the clusters of one account.

                  Hide accounts attributes Show accounts attributes object
                  • account_id string Required

                    the ID of the Account

                  • name string

                    A human readable name of the trust relationship

                  • trust_all boolean Required

                    If true, all clusters in this account will by default be trusted and the trust_allowlist is ignored.

                  • trust_allowlist array[string]

                    The list of clusters to trust. Only used when trust_all is false.

                • external array[object]

                  The list of trust relationships with external entities

                  The trust relationship with external entities (remote environments, remote accounts...).

                  Hide external attributes Show external attributes object
                  • trust_relationship_id string Required

                    The ID of the external trust relationship

                  • name string

                    The name of the external trust relationship. Retrieved from the TrustRelationship and ignored on write.

                  • trust_all boolean Required

                    If true, all clusters in this external entity will be trusted and the trust_allowlist is ignored.

                  • trust_allowlist array[string]

                    The list of clusters to trust. Only used when trust_all is false.

                • direct array[object]

                  The list of trust relationships where the certificate is bundled with the trust setting. Allows configuring trust for clusters running outside of an Elastic Cloud managed environment or in an Elastic Cloud environment without an environment level trust established.

                  The trust relationship with entities trusted directly having their certificate bundled together with the trust settings.

                  Hide direct attributes Show direct attributes object
                  • uid string

                    Auto generated identifier for this trust, allows distinguishing between update vs remove and add.

                  • name string Required

                    a human readable name of the trust relationship

                  • type string

                    The type can either be ESS, ECE, generic or proxy. If none is specified, then generic is assumed. If proxy is specified, trust_all should be false and trust_allowlist, scope_id and additional_node_names should be omitted.

                    Values are ECE, ESS, generic, or proxy.

                  • trust_all boolean Required

                    If true, scope_id is required and the trust_allowlist is ignored and all clusters matching the scope id will be trusted.

                  • trust_allowlist array[string]

                    The list of clusters with matching scope to trust. Only used when trust_all is false. Providing one or more clusters makes scope_id mandatory.

                  • scope_id string

                    A lowercase alphanumerical string of max 32 characters. Usually an organization id or an environment id, but could really be any suitable suffix for clusters using the CA certificate of this trust. Required unless trust_all is false and trust_allowlist is empty.

                  • additional_node_names array[string]

                    A list of node names trusted in addition to those deducible from trust_allowlist and scope id. Allows trusting nodes that don't have a scoped name at the cost of maintaining the list. Mandatory if scope id is not defined. Wildcards are not allowed.

                  • certificates array[object] Required

                    The public ca certificate(s) to trust. Only one is required, but it is possible to specify multiple certificates in order to facilitate key rotation.

                    An x509 certificate used by a DirectTrustRelationship

                    Hide certificates attributes Show certificates attributes object
                    • pem string Required

                      The public ca certificate as string in PEM format.

                    • metadata object

                      Metadata about the certificate, including fingerprint and expiry date. Generated by the Cloud service and ignored on write.

                      Hide metadata attributes Show metadata attributes object
                      • fingerprint string Required

                        The fingerprint of the certificate

                      • valid_to string(date-time) Required

                        The expiry date of the certificate in UTC

                      • valid_from string(date-time) Required

                        The valid from date of the certificate in UTC

                      • also_trusted_by array[string]

                        Other deployments also trusting this certificate

              • keystore_contents object

                The contents of the Elasticsearch keystore. It's a write only field.

                Hide keystore_contents attribute Show keystore_contents attribute object
                • secrets object Required

                  List of secrets

                  Hide secrets attribute Show secrets attribute object
                  • * object Additional properties

                    The value that you configure for the Elasticsearch keystore secret.

                    Hide * attributes Show * attributes object
                    • value object

                      Value of this setting. This can either be a string or a JSON object that is stored as a JSON string in the keystore. NOTE: When the keystore secret is unspecified, it is removed.

                    • as_file boolean

                      Stores the keystore secret as a file. The default is false, which stores the keystore secret as string when value is a plain string, or true when value is an object.

            • region string

              The region that this cluster belongs to. Only populated in SaaS or federated ECE.

        • kibana array[object] Required

          List of Kibana resources in your Deployment

          Describes an Kibana resource belonging to a Deployment

          Hide kibana attributes Show kibana attributes object
          • ref_id string Required

            The locally-unique user-specified id of a Resource

          • elasticsearch_cluster_ref_id string Required

            The Elasticsearch cluster that this resource depends on.

          • id string Required

            The randomly-generated id of a Resource

          • region string Required

            The region where this resource exists

          • info object Required

            Info for the resource.

            Hide info attributes Show info attributes object
            • cluster_id string Required

              The id of the cluster

            • cluster_name string Required

              The name of the cluster

            • elasticsearch_cluster object Required

              Information about the specified Elasticsearch cluster.

              Hide elasticsearch_cluster attributes Show elasticsearch_cluster attributes object
              • elasticsearch_id string Required

                The Elasticsearch cluster Id

              • links object

                A map of application-specific operations (which map to 'operationId's in the Swagger API) to metadata about that operation

                Hide links attribute Show links attribute object
                • * object Additional properties
                  Hide * attribute Show * attribute object
                  • need_elevated_permissions boolean

                    Whether the operation requires elevated permissions (when the field is present, elevated permissions are required).

            • deployment_id string

              The id of the deployment to which this Kibana Server belongs to.

            • healthy boolean Required

              Whether the cluster is healthy or not (one or more of the info subsections will have healthy: false)

            • status string Required

              Cluster status

              Values are initializing, stopping, stopped, rebooting, restarting, reconfiguring, or started.

            • plan_info object Required

              Information about the current, pending, or past Kibana instance plans.

              Hide plan_info attributes Show plan_info attributes object
              • healthy boolean Required

                Whether the plan situation is healthy (if unhealthy, means the last plan attempt failed)

              • current object

                Information about the current, pending, or past Kibana instance plan.

                Hide current attributes Show current attributes object
                • plan_attempt_id string

                  A UUID for each plan attempt

                • plan_attempt_name string

                  A human readable name for each plan attempt, only populated when retrieving plan histories

                • healthy boolean Required

                  Either the plan ended successfully, or is not yet completed (and no errors have occurred)

                • attempt_start_time string(date-time)

                  When this plan attempt (ie to apply the plan to the cluster) started (ISO format in UTC)

                • attempt_end_time string(date-time)

                  If this plan completed or failed (ie is not pending), when the attempt ended (ISO format in UTC)

                • plan_end_time string(date-time)

                  If this plan is not current or pending, when the plan was no longer active (ISO format in UTC)

                • plan object

                  The plan for the Kibana instance.

                  Hide plan attributes Show plan attributes object
                  • cluster_topology array[object]

                    The topology of the Kibana nodes, including the number, capacity, and type of nodes, and where they can be allocated.

                    Hide cluster_topology attributes Show cluster_topology attributes object
                    • instance_configuration_id string

                      Controls the allocation of this topology element as well as allowed sizes and node_types. It needs to match the id of an existing instance configuration.

                    • instance_configuration_version integer(int32)

                      The version of the Instance Configuration Id. If it is unset, the meaning depends on read vs writes. For deployment reads, it is equivalent to version 0 (or the IC is unversioned); for deployment creates and deployment template use, it is equivalent to 'the latest version'; and for deployment updates, it is equivalent to 'retain the current version'.

                    • size object

                      Measured by the amount of a resource. The final cluster size is calculated using multipliers from the topology instance configuration.

                      Hide size attributes Show size attributes object
                      • value integer(int32) Required

                        Amount of resource

                      • resource string Required

                        Type of resource. In ESS the resource used should always be memory.

                        Values are memory or storage.

                    • zone_count integer(int32)

                      number of zones in which nodes will be placed

                    • kibana object

                      The Kibana instance settings. When specified at the top level, provides a field-by-field default. When specified at the topology level, provides the override settings.

                      Hide kibana attributes Show kibana attributes object
                      • version string

                        The version of the Kibana cluster (must be one of the ECE supported versions, and won't work unless it matches the Elasticsearch version. Leave blank to auto-detect version.)

                      • docker_image string

                        A docker URI that allows overriding of the default docker image specified for this version

                      • system_settings object

                        A subset of Kibana settings. TIP: To define the complete set of Elasticsearch settings, use KibanaSystemSettings with user_settings_override_ and user_settings_.

                        Hide system_settings attributes Show system_settings attributes object
                        • elasticsearch_username string

                          Optionally override the account within Elasticsearch - defaults to a system account that always exists (if specified, the password must also be specified). Note that this field is never returned from the API, it is write only.

                        • elasticsearch_password string

                          Optionally override the account within Elasticsearch - defaults to a system account that always exists (if specified, the username must also be specified). Note that this field is never returned from the API, it is write only.

                      • user_settings_json object

                        An arbitrary JSON object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters are on the allowlist and not on the denylist. (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Kibana settings)

                      • user_settings_yaml string

                        An arbitrary YAML object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_json' is allowed), provided the parameters are on the allowlist and not on the denylist. (These field together with 'user_settings_override*' and 'system_settings' defines the total set of Kibana settings)

                      • user_settings_override_json object

                        An arbitrary JSON object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Kibana settings)

                      • user_settings_override_yaml string

                        An arbitrary YAML object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_json' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Kibana settings)

                  • kibana object Required

                    The Kibana instance settings. When specified at the top level, provides a field-by-field default. When specified at the topology level, provides the override settings.

                    Hide kibana attributes Show kibana attributes object
                    • version string

                      The version of the Kibana cluster (must be one of the ECE supported versions, and won't work unless it matches the Elasticsearch version. Leave blank to auto-detect version.)

                    • docker_image string

                      A docker URI that allows overriding of the default docker image specified for this version

                    • system_settings object

                      A subset of Kibana settings. TIP: To define the complete set of Elasticsearch settings, use KibanaSystemSettings with user_settings_override_ and user_settings_.

                      Hide system_settings attributes Show system_settings attributes object
                      • elasticsearch_username string

                        Optionally override the account within Elasticsearch - defaults to a system account that always exists (if specified, the password must also be specified). Note that this field is never returned from the API, it is write only.

                      • elasticsearch_password string

                        Optionally override the account within Elasticsearch - defaults to a system account that always exists (if specified, the username must also be specified). Note that this field is never returned from the API, it is write only.

                    • user_settings_json object

                      An arbitrary JSON object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters are on the allowlist and not on the denylist. (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Kibana settings)

                    • user_settings_yaml string

                      An arbitrary YAML object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_json' is allowed), provided the parameters are on the allowlist and not on the denylist. (These field together with 'user_settings_override*' and 'system_settings' defines the total set of Kibana settings)

                    • user_settings_override_json object

                      An arbitrary JSON object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Kibana settings)

                    • user_settings_override_yaml string

                      An arbitrary YAML object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_json' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Kibana settings)

                  • transient object

                    Defines the configuration parameters that control how the plan is applied. For example, the Elasticsearch cluster topology and Kibana instance settings.

                    Hide transient attributes Show transient attributes object
                    • strategy object

                      The options for performing a plan change. Specify only one property each time. The default is grow_and_shrink.

                      Hide strategy attributes Show strategy attributes object
                      • rolling object

                        Performs inline, rolling configuration changes that mutate existing containers. TIP: This is the fastest way to update a plan, but can fail for complex plan changes, such as topology changes. Also, this is less safe for configuration changes that leave a cluster in a non running state. NOTE: When you perform a major version upgrade, and 'group_by' is set to 'pass:macros[all]';, rolling is required.

                        Hide rolling attributes Show rolling attributes object
                        • group_by string

                          Specifies the grouping attribute to use when rolling several instances. Instances that share the same value for the provided attribute key are rolled together as a unit. Examples that make sense to use are '__all__' (roll all instances as a single unit), 'logical_zone_name' (roll instances by zone), '__name__' (roll one instance at a time, the default if not specified). Note that '__all__' is required when performing a major version upgrade

                        • allow_inline_resize boolean

                          Whether we allow changing the capacity of instances (default false). This is currently implemented by stopping, re-creating then starting the affected instance on its associated allocator when performing the changes. NOTES: This requires a round-trip through the allocation infrastructure of the active constructor, as it has to reserve the target capacity without over-committing

                        • skip_synced_flush boolean

                          Whether to skip attempting to do a synced flush on the filesystem of the container (default: false), which is less safe but may be required if the container is unhealthy

                        • shard_init_wait_time integer(int64)

                          The time, in seconds, to wait for shards that show no progress of initializing before rolling the next group (default: 10 minutes)

                      • grow_and_shrink object

                        A strategy that creates instances with the new plan, migrates data from the old instances, then shuts down the old instances. GrowShrinkStrategyConfig is safer than 'rolling' and ensures single node availability during a plan change, but can be a lot slower on larger clusters.

                      • rolling_grow_and_shrink object

                        A strategy that creates new Elasticsearch instances, Kibana instances, and APM Servers with the new plan, then migrates the node data to minimize the amount of spare capacity.

                      • autodetect object

                        A strategy that lets constructor choose the most optimal way to execute the plan.

                    • plan_configuration object

                      The configuration settings for the timeout and fallback parameters.

                      Hide plan_configuration attributes Show plan_configuration attributes object
                      • timeout integer(int64)

                        The total timeout in seconds after which the plan is cancelled even if it is not complete. Defaults to 4x the max memory capacity per node (in MB)

                      • calm_wait_time integer(int64)

                        This timeout determines how long to give a cluster after it responds to API calls before performing actual operations on it. It defaults to 5s

                      • extended_maintenance boolean

                        If true (default false), does not clear the maintenance flag (which prevents its API from being accessed except by the constructor) on new instances added until after a snapshot has been restored, otherwise, the maintenance flag is cleared once the new instances successfully join the new cluster

                      • cluster_reboot string

                        Set to 'forced' to force a reboot as part of the upgrade plan

                        Value is forced.

                • plan_attempt_log array[object] Required

                  Information about a step in a plan.

                  Hide plan_attempt_log attributes Show plan_attempt_log attributes object
                  • step_id string Required

                    ID of current step

                  • started string(date-time) Required

                    When the step started (ISO format in UTC)

                  • completed string(date-time)

                    When the step completed (ISO format in UTC)

                  • duration_in_millis integer(int64)

                    The duration of the step in MS

                  • status string Required

                    The status of the step (success, warning, error - warning means something didn't go as expected but it was not serious enough to abort the plan)

                    Values are success, warning, error, or pending.

                  • stage string Required

                    Current stage that the step is in

                    Values are starting, completed, or in_progress.

                  • info_log array[object] Required

                    Human readable summaries of the step, including messages for each stage of the step

                    The log message from a specified stage of an executed step in a plan.

                    Hide info_log attributes Show info_log attributes object
                    • timestamp string(date-time) Required

                      Timestamp marking on info log of step

                    • delta_in_millis integer(int64)

                      Time in milliseconds since previous log message

                    • stage string Required

                      Stage that info log message takes place in

                      Values are starting, completed, or in_progress.

                    • message string Required

                      Human readable log message

                    • details object Required

                      A map with details for the log about what happened during the step execution. Keys and values for are always both strings, representing the name of the detail and its value, respectively.

                      Hide details attribute Show details attribute object
                      • * string Additional properties
                    • failure_type string

                      The failure type, in case the step failed

                • source object

                  Information describing the source that facilitated the plans current state

                  Hide source attributes Show source attributes object
                  • facilitator string Required

                    The service where the change originated from

                  • action string Required

                    The type of plan change that was initiated

                  • date string(date-time) Required

                    The time the change was initiated

                  • user_id string

                    The user that requested the change

                  • admin_id string

                    The admin user that requested the change

                  • remote_addresses array[string]

                    The host addresses of the user that originated the change

                • warnings array[object] Required

                  Information about a warning from a plan.

                  Hide warnings attributes Show warnings attributes object
                  • code string Required

                    A unique warning code

                  • message string Required

                    A description of the warning

                  • step_id string

                    The ID of the step which produced a warning, if any

                • error object

                  Information about an error during a plan attempt.

                  Hide error attributes Show error attributes object
                  • timestamp string(date-time) Required

                    Timestamp marking on info log of step

                  • message string Required

                    Human readable error message

                  • details object Required

                    A map with details regarding the error. Both the keys and values are always strings, representing the name of the detail and its value, respectively.

                    Hide details attribute Show details attribute object
                    • * string Additional properties
                  • failure_type string

                    The failure type

              • pending object

                Information about the current, pending, or past Kibana instance plan.

                Hide pending attributes Show pending attributes object
                • plan_attempt_id string

                  A UUID for each plan attempt

                • plan_attempt_name string

                  A human readable name for each plan attempt, only populated when retrieving plan histories

                • healthy boolean Required

                  Either the plan ended successfully, or is not yet completed (and no errors have occurred)

                • attempt_start_time string(date-time)

                  When this plan attempt (ie to apply the plan to the cluster) started (ISO format in UTC)

                • attempt_end_time string(date-time)

                  If this plan completed or failed (ie is not pending), when the attempt ended (ISO format in UTC)

                • plan_end_time string(date-time)

                  If this plan is not current or pending, when the plan was no longer active (ISO format in UTC)

                • plan object

                  The plan for the Kibana instance.

                  Hide plan attributes Show plan attributes object
                  • cluster_topology array[object]

                    The topology of the Kibana nodes, including the number, capacity, and type of nodes, and where they can be allocated.

                    Hide cluster_topology attributes Show cluster_topology attributes object
                    • instance_configuration_id string

                      Controls the allocation of this topology element as well as allowed sizes and node_types. It needs to match the id of an existing instance configuration.

                    • instance_configuration_version integer(int32)

                      The version of the Instance Configuration Id. If it is unset, the meaning depends on read vs writes. For deployment reads, it is equivalent to version 0 (or the IC is unversioned); for deployment creates and deployment template use, it is equivalent to 'the latest version'; and for deployment updates, it is equivalent to 'retain the current version'.

                    • size object

                      Measured by the amount of a resource. The final cluster size is calculated using multipliers from the topology instance configuration.

                      Hide size attributes Show size attributes object
                      • value integer(int32) Required

                        Amount of resource

                      • resource string Required

                        Type of resource. In ESS the resource used should always be memory.

                        Values are memory or storage.

                    • zone_count integer(int32)

                      number of zones in which nodes will be placed

                    • kibana object

                      The Kibana instance settings. When specified at the top level, provides a field-by-field default. When specified at the topology level, provides the override settings.

                      Hide kibana attributes Show kibana attributes object
                      • version string

                        The version of the Kibana cluster (must be one of the ECE supported versions, and won't work unless it matches the Elasticsearch version. Leave blank to auto-detect version.)

                      • docker_image string

                        A docker URI that allows overriding of the default docker image specified for this version

                      • system_settings object

                        A subset of Kibana settings. TIP: To define the complete set of Elasticsearch settings, use KibanaSystemSettings with user_settings_override_ and user_settings_.

                        Hide system_settings attributes Show system_settings attributes object
                        • elasticsearch_username string

                          Optionally override the account within Elasticsearch - defaults to a system account that always exists (if specified, the password must also be specified). Note that this field is never returned from the API, it is write only.

                        • elasticsearch_password string

                          Optionally override the account within Elasticsearch - defaults to a system account that always exists (if specified, the username must also be specified). Note that this field is never returned from the API, it is write only.

                      • user_settings_json object

                        An arbitrary JSON object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters are on the allowlist and not on the denylist. (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Kibana settings)

                      • user_settings_yaml string

                        An arbitrary YAML object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_json' is allowed), provided the parameters are on the allowlist and not on the denylist. (These field together with 'user_settings_override*' and 'system_settings' defines the total set of Kibana settings)

                      • user_settings_override_json object

                        An arbitrary JSON object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Kibana settings)

                      • user_settings_override_yaml string

                        An arbitrary YAML object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_json' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Kibana settings)

                  • kibana object Required

                    The Kibana instance settings. When specified at the top level, provides a field-by-field default. When specified at the topology level, provides the override settings.

                    Hide kibana attributes Show kibana attributes object
                    • version string

                      The version of the Kibana cluster (must be one of the ECE supported versions, and won't work unless it matches the Elasticsearch version. Leave blank to auto-detect version.)

                    • docker_image string

                      A docker URI that allows overriding of the default docker image specified for this version

                    • system_settings object

                      A subset of Kibana settings. TIP: To define the complete set of Elasticsearch settings, use KibanaSystemSettings with user_settings_override_ and user_settings_.

                      Hide system_settings attributes Show system_settings attributes object
                      • elasticsearch_username string

                        Optionally override the account within Elasticsearch - defaults to a system account that always exists (if specified, the password must also be specified). Note that this field is never returned from the API, it is write only.

                      • elasticsearch_password string

                        Optionally override the account within Elasticsearch - defaults to a system account that always exists (if specified, the username must also be specified). Note that this field is never returned from the API, it is write only.

                    • user_settings_json object

                      An arbitrary JSON object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters are on the allowlist and not on the denylist. (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Kibana settings)

                    • user_settings_yaml string

                      An arbitrary YAML object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_json' is allowed), provided the parameters are on the allowlist and not on the denylist. (These field together with 'user_settings_override*' and 'system_settings' defines the total set of Kibana settings)

                    • user_settings_override_json object

                      An arbitrary JSON object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Kibana settings)

                    • user_settings_override_yaml string

                      An arbitrary YAML object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_json' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Kibana settings)

                  • transient object

                    Defines the configuration parameters that control how the plan is applied. For example, the Elasticsearch cluster topology and Kibana instance settings.

                    Hide transient attributes Show transient attributes object
                    • strategy object

                      The options for performing a plan change. Specify only one property each time. The default is grow_and_shrink.

                      Hide strategy attributes Show strategy attributes object
                      • rolling object

                        Performs inline, rolling configuration changes that mutate existing containers. TIP: This is the fastest way to update a plan, but can fail for complex plan changes, such as topology changes. Also, this is less safe for configuration changes that leave a cluster in a non running state. NOTE: When you perform a major version upgrade, and 'group_by' is set to 'pass:macros[all]';, rolling is required.

                        Hide rolling attributes Show rolling attributes object
                        • group_by string

                          Specifies the grouping attribute to use when rolling several instances. Instances that share the same value for the provided attribute key are rolled together as a unit. Examples that make sense to use are '__all__' (roll all instances as a single unit), 'logical_zone_name' (roll instances by zone), '__name__' (roll one instance at a time, the default if not specified). Note that '__all__' is required when performing a major version upgrade

                        • allow_inline_resize boolean

                          Whether we allow changing the capacity of instances (default false). This is currently implemented by stopping, re-creating then starting the affected instance on its associated allocator when performing the changes. NOTES: This requires a round-trip through the allocation infrastructure of the active constructor, as it has to reserve the target capacity without over-committing

                        • skip_synced_flush boolean

                          Whether to skip attempting to do a synced flush on the filesystem of the container (default: false), which is less safe but may be required if the container is unhealthy

                        • shard_init_wait_time integer(int64)

                          The time, in seconds, to wait for shards that show no progress of initializing before rolling the next group (default: 10 minutes)

                      • grow_and_shrink object

                        A strategy that creates instances with the new plan, migrates data from the old instances, then shuts down the old instances. GrowShrinkStrategyConfig is safer than 'rolling' and ensures single node availability during a plan change, but can be a lot slower on larger clusters.

                      • rolling_grow_and_shrink object

                        A strategy that creates new Elasticsearch instances, Kibana instances, and APM Servers with the new plan, then migrates the node data to minimize the amount of spare capacity.

                      • autodetect object

                        A strategy that lets constructor choose the most optimal way to execute the plan.

                    • plan_configuration object

                      The configuration settings for the timeout and fallback parameters.

                      Hide plan_configuration attributes Show plan_configuration attributes object
                      • timeout integer(int64)

                        The total timeout in seconds after which the plan is cancelled even if it is not complete. Defaults to 4x the max memory capacity per node (in MB)

                      • calm_wait_time integer(int64)

                        This timeout determines how long to give a cluster after it responds to API calls before performing actual operations on it. It defaults to 5s

                      • extended_maintenance boolean

                        If true (default false), does not clear the maintenance flag (which prevents its API from being accessed except by the constructor) on new instances added until after a snapshot has been restored, otherwise, the maintenance flag is cleared once the new instances successfully join the new cluster

                      • cluster_reboot string

                        Set to 'forced' to force a reboot as part of the upgrade plan

                        Value is forced.

                • plan_attempt_log array[object] Required

                  Information about a step in a plan.

                  Hide plan_attempt_log attributes Show plan_attempt_log attributes object
                  • step_id string Required

                    ID of current step

                  • started string(date-time) Required

                    When the step started (ISO format in UTC)

                  • completed string(date-time)

                    When the step completed (ISO format in UTC)

                  • duration_in_millis integer(int64)

                    The duration of the step in MS

                  • status string Required

                    The status of the step (success, warning, error - warning means something didn't go as expected but it was not serious enough to abort the plan)

                    Values are success, warning, error, or pending.

                  • stage string Required

                    Current stage that the step is in

                    Values are starting, completed, or in_progress.

                  • info_log array[object] Required

                    Human readable summaries of the step, including messages for each stage of the step

                    The log message from a specified stage of an executed step in a plan.

                    Hide info_log attributes Show info_log attributes object
                    • timestamp string(date-time) Required

                      Timestamp marking on info log of step

                    • delta_in_millis integer(int64)

                      Time in milliseconds since previous log message

                    • stage string Required

                      Stage that info log message takes place in

                      Values are starting, completed, or in_progress.

                    • message string Required

                      Human readable log message

                    • details object Required

                      A map with details for the log about what happened during the step execution. Keys and values for are always both strings, representing the name of the detail and its value, respectively.

                      Hide details attribute Show details attribute object
                      • * string Additional properties
                    • failure_type string

                      The failure type, in case the step failed

                • source object

                  Information describing the source that facilitated the plans current state

                  Hide source attributes Show source attributes object
                  • facilitator string Required

                    The service where the change originated from

                  • action string Required

                    The type of plan change that was initiated

                  • date string(date-time) Required

                    The time the change was initiated

                  • user_id string

                    The user that requested the change

                  • admin_id string

                    The admin user that requested the change

                  • remote_addresses array[string]

                    The host addresses of the user that originated the change

                • warnings array[object] Required

                  Information about a warning from a plan.

                  Hide warnings attributes Show warnings attributes object
                  • code string Required

                    A unique warning code

                  • message string Required

                    A description of the warning

                  • step_id string

                    The ID of the step which produced a warning, if any

                • error object

                  Information about an error during a plan attempt.

                  Hide error attributes Show error attributes object
                  • timestamp string(date-time) Required

                    Timestamp marking on info log of step

                  • message string Required

                    Human readable error message

                  • details object Required

                    A map with details regarding the error. Both the keys and values are always strings, representing the name of the detail and its value, respectively.

                    Hide details attribute Show details attribute object
                    • * string Additional properties
                  • failure_type string

                    The failure type

              • history array[object] Required

                Information about the current, pending, or past Kibana instance plan.

                Hide history attributes Show history attributes object
                • plan_attempt_id string

                  A UUID for each plan attempt

                • plan_attempt_name string

                  A human readable name for each plan attempt, only populated when retrieving plan histories

                • healthy boolean Required

                  Either the plan ended successfully, or is not yet completed (and no errors have occurred)

                • attempt_start_time string(date-time)

                  When this plan attempt (ie to apply the plan to the cluster) started (ISO format in UTC)

                • attempt_end_time string(date-time)

                  If this plan completed or failed (ie is not pending), when the attempt ended (ISO format in UTC)

                • plan_end_time string(date-time)

                  If this plan is not current or pending, when the plan was no longer active (ISO format in UTC)

                • plan object

                  The plan for the Kibana instance.

                  Hide plan attributes Show plan attributes object
                  • cluster_topology array[object]

                    The topology of the Kibana nodes, including the number, capacity, and type of nodes, and where they can be allocated.

                    Hide cluster_topology attributes Show cluster_topology attributes object
                    • instance_configuration_id string

                      Controls the allocation of this topology element as well as allowed sizes and node_types. It needs to match the id of an existing instance configuration.

                    • instance_configuration_version integer(int32)

                      The version of the Instance Configuration Id. If it is unset, the meaning depends on read vs writes. For deployment reads, it is equivalent to version 0 (or the IC is unversioned); for deployment creates and deployment template use, it is equivalent to 'the latest version'; and for deployment updates, it is equivalent to 'retain the current version'.

                    • size object

                      Measured by the amount of a resource. The final cluster size is calculated using multipliers from the topology instance configuration.

                      Hide size attributes Show size attributes object
                      • value integer(int32) Required

                        Amount of resource

                      • resource string Required

                        Type of resource. In ESS the resource used should always be memory.

                        Values are memory or storage.

                    • zone_count integer(int32)

                      number of zones in which nodes will be placed

                    • kibana object

                      The Kibana instance settings. When specified at the top level, provides a field-by-field default. When specified at the topology level, provides the override settings.

                      Hide kibana attributes Show kibana attributes object
                      • version string

                        The version of the Kibana cluster (must be one of the ECE supported versions, and won't work unless it matches the Elasticsearch version. Leave blank to auto-detect version.)

                      • docker_image string

                        A docker URI that allows overriding of the default docker image specified for this version

                      • system_settings object

                        A subset of Kibana settings. TIP: To define the complete set of Elasticsearch settings, use KibanaSystemSettings with user_settings_override_ and user_settings_.

                        Hide system_settings attributes Show system_settings attributes object
                        • elasticsearch_username string

                          Optionally override the account within Elasticsearch - defaults to a system account that always exists (if specified, the password must also be specified). Note that this field is never returned from the API, it is write only.

                        • elasticsearch_password string

                          Optionally override the account within Elasticsearch - defaults to a system account that always exists (if specified, the username must also be specified). Note that this field is never returned from the API, it is write only.

                      • user_settings_json object

                        An arbitrary JSON object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters are on the allowlist and not on the denylist. (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Kibana settings)

                      • user_settings_yaml string

                        An arbitrary YAML object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_json' is allowed), provided the parameters are on the allowlist and not on the denylist. (These field together with 'user_settings_override*' and 'system_settings' defines the total set of Kibana settings)

                      • user_settings_override_json object

                        An arbitrary JSON object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Kibana settings)

                      • user_settings_override_yaml string

                        An arbitrary YAML object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_json' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Kibana settings)

                  • kibana object Required

                    The Kibana instance settings. When specified at the top level, provides a field-by-field default. When specified at the topology level, provides the override settings.

                    Hide kibana attributes Show kibana attributes object
                    • version string

                      The version of the Kibana cluster (must be one of the ECE supported versions, and won't work unless it matches the Elasticsearch version. Leave blank to auto-detect version.)

                    • docker_image string

                      A docker URI that allows overriding of the default docker image specified for this version

                    • system_settings object

                      A subset of Kibana settings. TIP: To define the complete set of Elasticsearch settings, use KibanaSystemSettings with user_settings_override_ and user_settings_.

                      Hide system_settings attributes Show system_settings attributes object
                      • elasticsearch_username string

                        Optionally override the account within Elasticsearch - defaults to a system account that always exists (if specified, the password must also be specified). Note that this field is never returned from the API, it is write only.

                      • elasticsearch_password string

                        Optionally override the account within Elasticsearch - defaults to a system account that always exists (if specified, the username must also be specified). Note that this field is never returned from the API, it is write only.

                    • user_settings_json object

                      An arbitrary JSON object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters are on the allowlist and not on the denylist. (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Kibana settings)

                    • user_settings_yaml string

                      An arbitrary YAML object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_json' is allowed), provided the parameters are on the allowlist and not on the denylist. (These field together with 'user_settings_override*' and 'system_settings' defines the total set of Kibana settings)

                    • user_settings_override_json object

                      An arbitrary JSON object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Kibana settings)

                    • user_settings_override_yaml string

                      An arbitrary YAML object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_json' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Kibana settings)

                  • transient object

                    Defines the configuration parameters that control how the plan is applied. For example, the Elasticsearch cluster topology and Kibana instance settings.

                    Hide transient attributes Show transient attributes object
                    • strategy object

                      The options for performing a plan change. Specify only one property each time. The default is grow_and_shrink.

                      Hide strategy attributes Show strategy attributes object
                      • rolling object

                        Performs inline, rolling configuration changes that mutate existing containers. TIP: This is the fastest way to update a plan, but can fail for complex plan changes, such as topology changes. Also, this is less safe for configuration changes that leave a cluster in a non running state. NOTE: When you perform a major version upgrade, and 'group_by' is set to 'pass:macros[all]';, rolling is required.

                        Hide rolling attributes Show rolling attributes object
                        • group_by string

                          Specifies the grouping attribute to use when rolling several instances. Instances that share the same value for the provided attribute key are rolled together as a unit. Examples that make sense to use are '__all__' (roll all instances as a single unit), 'logical_zone_name' (roll instances by zone), '__name__' (roll one instance at a time, the default if not specified). Note that '__all__' is required when performing a major version upgrade

                        • allow_inline_resize boolean

                          Whether we allow changing the capacity of instances (default false). This is currently implemented by stopping, re-creating then starting the affected instance on its associated allocator when performing the changes. NOTES: This requires a round-trip through the allocation infrastructure of the active constructor, as it has to reserve the target capacity without over-committing

                        • skip_synced_flush boolean

                          Whether to skip attempting to do a synced flush on the filesystem of the container (default: false), which is less safe but may be required if the container is unhealthy

                        • shard_init_wait_time integer(int64)

                          The time, in seconds, to wait for shards that show no progress of initializing before rolling the next group (default: 10 minutes)

                      • grow_and_shrink object

                        A strategy that creates instances with the new plan, migrates data from the old instances, then shuts down the old instances. GrowShrinkStrategyConfig is safer than 'rolling' and ensures single node availability during a plan change, but can be a lot slower on larger clusters.

                      • rolling_grow_and_shrink object

                        A strategy that creates new Elasticsearch instances, Kibana instances, and APM Servers with the new plan, then migrates the node data to minimize the amount of spare capacity.

                      • autodetect object

                        A strategy that lets constructor choose the most optimal way to execute the plan.

                    • plan_configuration object

                      The configuration settings for the timeout and fallback parameters.

                      Hide plan_configuration attributes Show plan_configuration attributes object
                      • timeout integer(int64)

                        The total timeout in seconds after which the plan is cancelled even if it is not complete. Defaults to 4x the max memory capacity per node (in MB)

                      • calm_wait_time integer(int64)

                        This timeout determines how long to give a cluster after it responds to API calls before performing actual operations on it. It defaults to 5s

                      • extended_maintenance boolean

                        If true (default false), does not clear the maintenance flag (which prevents its API from being accessed except by the constructor) on new instances added until after a snapshot has been restored, otherwise, the maintenance flag is cleared once the new instances successfully join the new cluster

                      • cluster_reboot string

                        Set to 'forced' to force a reboot as part of the upgrade plan

                        Value is forced.

                • plan_attempt_log array[object] Required

                  Information about a step in a plan.

                  Hide plan_attempt_log attributes Show plan_attempt_log attributes object
                  • step_id string Required

                    ID of current step

                  • started string(date-time) Required

                    When the step started (ISO format in UTC)

                  • completed string(date-time)

                    When the step completed (ISO format in UTC)

                  • duration_in_millis integer(int64)

                    The duration of the step in MS

                  • status string Required

                    The status of the step (success, warning, error - warning means something didn't go as expected but it was not serious enough to abort the plan)

                    Values are success, warning, error, or pending.

                  • stage string Required

                    Current stage that the step is in

                    Values are starting, completed, or in_progress.

                  • info_log array[object] Required

                    Human readable summaries of the step, including messages for each stage of the step

                    The log message from a specified stage of an executed step in a plan.

                    Hide info_log attributes Show info_log attributes object
                    • timestamp string(date-time) Required

                      Timestamp marking on info log of step

                    • delta_in_millis integer(int64)

                      Time in milliseconds since previous log message

                    • stage string Required

                      Stage that info log message takes place in

                      Values are starting, completed, or in_progress.

                    • message string Required

                      Human readable log message

                    • details object Required

                      A map with details for the log about what happened during the step execution. Keys and values for are always both strings, representing the name of the detail and its value, respectively.

                      Hide details attribute Show details attribute object
                      • * string Additional properties
                    • failure_type string

                      The failure type, in case the step failed

                • source object

                  Information describing the source that facilitated the plans current state

                  Hide source attributes Show source attributes object
                  • facilitator string Required

                    The service where the change originated from

                  • action string Required

                    The type of plan change that was initiated

                  • date string(date-time) Required

                    The time the change was initiated

                  • user_id string

                    The user that requested the change

                  • admin_id string

                    The admin user that requested the change

                  • remote_addresses array[string]

                    The host addresses of the user that originated the change

                • warnings array[object] Required

                  Information about a warning from a plan.

                  Hide warnings attributes Show warnings attributes object
                  • code string Required

                    A unique warning code

                  • message string Required

                    A description of the warning

                  • step_id string

                    The ID of the step which produced a warning, if any

                • error object

                  Information about an error during a plan attempt.

                  Hide error attributes Show error attributes object
                  • timestamp string(date-time) Required

                    Timestamp marking on info log of step

                  • message string Required

                    Human readable error message

                  • details object Required

                    A map with details regarding the error. Both the keys and values are always strings, representing the name of the detail and its value, respectively.

                    Hide details attribute Show details attribute object
                    • * string Additional properties
                  • failure_type string

                    The failure type

            • metadata object Required

              Information about the public and internal state, and the configuration settings of an Elasticsearch cluster.

              Hide metadata attributes Show metadata attributes object
              • version integer(int32) Required

                The resource version number of the cluster metadata

              • last_modified string(date-time) Required

                The most recent time the cluster metadata was changed (ISO format in UTC)

              • endpoint string

                The DNS name of the cluster endpoint, if available

              • service_url string

                The full URL to access this deployment resource

              • aliased_endpoint string

                The DNS name of the cluster endpoint derived from the deployment alias, if available

              • aliased_url string

                The full aliased URL to access this deployment resource

              • cloud_id string

                The cloud ID, an encoded string that provides other Elastic services with the necessary information to connect to this Elasticsearch and Kibana (only present if both exist)

              • raw object

                An unstructured JSON representation of the public and internal state (can be filtered out via URL parameter). The contents and structure of the raw field can change at any time.

              • ports object

                The ports that allow communication with the cluster using various protocols.

                Hide ports attributes Show ports attributes object
                • http integer(int32) Required

                  Port where the cluster listens for HTTP traffic

                • https integer(int32) Required

                  Port where the cluster listens for HTTPS traffic

                • transport_passthrough integer(int32) Required

                  Port where the cluster listens for transport traffic using TLS

              • services_urls array[object]

                A list of the URLs to access services that the resource provides at this time. Note that if the service is not running or has not started yet, the URL to access it won't be available

                A URL to access the service of a resource

                Hide services_urls attributes Show services_urls attributes object
                • service string Required

                  Name of the service

                • url string Required

                  The full URL to access the service

            • topology object Required

              The topology for Elasticsearch clusters, multiple Kibana instances, or multiple APM Servers. The ClusterTopologyInfo also includes the instances and containers, and where they are located.

              Hide topology attributes Show topology attributes object
              • healthy boolean Required

                Whether the cluster topology is healthy (ie all instances are started and the services they run - ie elasticsearch - are available

              • instances array[object] Required

                Information about each Kibana instance and APM Server in the Elasticsearch cluster.

                Hide instances attributes Show instances attributes object
                • instance_name string Required

                  The name of the instance in Elastic Cloud

                • instance_configuration object

                  Information about a configuration that creates a Kibana instance or APM Server.

                  Hide instance_configuration attributes Show instance_configuration attributes object
                  • id string Required

                    The id of the configuration used to create the instance

                  • name string Required

                    The name of the configuration used to create the instance

                  • config_version integer(int32)

                    If the IC is configuration controlled, this field is the version either being read back (reads return the latest IC unless specified by the 'config_version' URL param), or the version to update. Cannot be used in creates. For unversioned IC reads it is left empty.

                  • resource string Required

                    The resource type of the instance configuration

                    Values are memory or storage.

                • service_version string

                  The version of the service that the instance is running (eg Elasticsearch or Kibana), if available

                • healthy boolean Required

                  Whether the instance is healthy (ie started and running)

                • container_started boolean Required

                  Whether the container has started (does not tell you anything about the service -ie Elasticsearch- running inside the container)

                • service_running boolean Required

                  Whether the service launched inside the container -ie Elasticsearch- is actually running

                • maintenance_mode boolean Required

                  Whether the service is is maintenance mode (meaning that the proxy is not routing external traffic to it)

                • zone string

                  The zone in which this instance is being allocated

                • allocator_id string

                  The id of the allocator on which this instance is running (if the container is started or starting)

                • memory object

                  Information about the specific instances memory capacity and its usage

                  Hide memory attributes Show memory attributes object
                  • instance_capacity integer(int32) Required

                    The memory capacity in MB of the instance

                  • instance_capacity_planned integer(int32)

                    The planned memory capacity in MB of the instance (only shown when an override is present)

                  • memory_pressure integer(int32)

                    The % memory pressure of Elasticsearch JVM heap space if available (60-75% consider increasing capacity, >75% can incur significant performance and stability issues)

                  • native_memory_pressure integer(int32)

                    The % memory pressure of the instance Docker container (if available)

                • disk object

                  Information about the use and storage capacity of a Kibana instance or APM Server.

                  Hide disk attributes Show disk attributes object
                  • disk_space_available integer(int64)

                    If known, the amount of total disk space available to the container in MB

                  • disk_space_used integer(int64) Required

                    The amount of disk space being used by the service in MB

                  • storage_multiplier number(double) Required

                    The storage multiplier originally defined to calculate disk space.

                • service_roles array[string]

                  List of roles assigned to the service running in the instance. Currently only populated for Elasticsearch, with possible values: master,data,ingest,ml

                • node_roles array[string]

                  A list of the node roles assigned to the service running in the instance. Currently populated only for Elasticsearch.

                  Values are master, ingest, ml, data_hot, data_content, data_warm, data_cold, data_frozen, remote_cluster_client, transform, or voting_only.

                • instance_overrides object

                  Instance overrides

                  Hide instance_overrides attributes Show instance_overrides attributes object
                  • capacity integer(int32)

                    Sets the memory capacity for the instances container. Requires a restart to take effect.

                  • storage_multiplier number(double)

                    Overrides the disk quota multiplier for the instance

            • external_links array[object] Required

              External resources related to the cluster

              Hide external_links attributes Show external_links attributes object
              • id string Required

                Identifier of the external link

              • label string Required

                Human-readable description of the external link

              • uri string

                hyperlink to an external resource

            • links object

              A map of application-specific operations (which map to 'operationId's in the Swagger API) to metadata about that operation

              Hide links attribute Show links attribute object
              • * object Additional properties
                Hide * attribute Show * attribute object
                • need_elevated_permissions boolean

                  Whether the operation requires elevated permissions (when the field is present, elevated permissions are required).

            • settings object

              The settings for building this Kibana cluster

              Hide settings attribute Show settings attribute object
              • metadata object

                The top-level configuration settings for the Elasticsearch cluster.

                Hide metadata attribute Show metadata attribute object
                • name string

                  The display name of the cluster

            • region string

              The region that this cluster belongs to. Only populated in SaaS or federated ECE.

        • apm array[object] Required

          List of Apm resources in your Deployment

          Describes an APM resource belonging to a Deployment

          Hide apm attributes Show apm attributes object
          • ref_id string Required

            The locally-unique user-specified id of a Resource

          • elasticsearch_cluster_ref_id string Required

            The Elasticsearch cluster that this resource depends on.

          • id string Required

            The randomly-generated id of a Resource

          • region string Required

            The region where this resource exists

          • info object Required

            Info for the resource.

            Hide info attributes Show info attributes object
            • id string Required

              The id of the APM

            • name string Required

              The name of the APM

            • elasticsearch_cluster object Required

              Information about the specified Elasticsearch cluster.

              Hide elasticsearch_cluster attributes Show elasticsearch_cluster attributes object
              • elasticsearch_id string Required

                The Elasticsearch cluster Id

              • links object

                A map of application-specific operations (which map to 'operationId's in the Swagger API) to metadata about that operation

                Hide links attribute Show links attribute object
                • * object Additional properties
                  Hide * attribute Show * attribute object
                  • need_elevated_permissions boolean

                    Whether the operation requires elevated permissions (when the field is present, elevated permissions are required).

            • deployment_id string

              The id of the deployment that this APM Server belongs to.

            • healthy boolean Required

              Whether the APM is healthy or not (one or more of the info subsections will have healthy: false)

            • status string Required

              APM status

              Values are initializing, stopping, stopped, rebooting, restarting, reconfiguring, or started.

            • plan_info object Required

              Information about current, pending, and past APM Server plans.

              Hide plan_info attributes Show plan_info attributes object
              • healthy boolean Required

                Whether the plan situation is healthy (if unhealthy, means the last plan attempt failed)

              • current object

                Information about the APM Server plan.

                Hide current attributes Show current attributes object
                • plan_attempt_id string

                  A UUID for each plan attempt

                • plan_attempt_name string

                  A human readable name for each plan attempt, only populated when retrieving plan histories

                • healthy boolean Required

                  Either the plan ended successfully, or is not yet completed (and no errors have occurred)

                • attempt_start_time string(date-time)

                  When this plan attempt (ie to apply the plan to the APM) started (ISO format in UTC)

                • attempt_end_time string(date-time)

                  If this plan completed or failed (ie is not pending), when the attempt ended (ISO format in UTC)

                • plan_end_time string(date-time)

                  If this plan is not current or pending, when the plan was no longer active (ISO format in UTC)

                • plan object

                  The plan for the APM Server.

                  Hide plan attributes Show plan attributes object
                  • cluster_topology array[object]

                    Defines the topology of the APM Server nodes. For example, the number or capacity of the nodes, and where you can allocate the nodes.

                    Hide cluster_topology attributes Show cluster_topology attributes object
                    • instance_configuration_id string

                      Controls the allocation of this topology element as well as allowed sizes and node_types. It needs to match the id of an existing instance configuration.

                    • instance_configuration_version integer(int32)

                      The version of the Instance Configuration Id. If it is unset, the meaning depends on read vs writes. For deployment reads, it is equivalent to version 0 (or the IC is unversioned); for deployment creates and deployment template use, it is equivalent to 'the latest version'; and for deployment updates, it is equivalent to 'retain the current version'.

                    • size object

                      Measured by the amount of a resource. The final cluster size is calculated using multipliers from the topology instance configuration.

                      Hide size attributes Show size attributes object
                      • value integer(int32) Required

                        Amount of resource

                      • resource string Required

                        Type of resource. In ESS the resource used should always be memory.

                        Values are memory or storage.

                    • zone_count integer(int32)

                      number of zones in which nodes will be placed

                    • apm object

                      The configuration options for the APM Server.

                      Hide apm attributes Show apm attributes object
                      • version string

                        The version of the Apm cluster (must be one of the ECE supported versions, and won't work unless it matches the APM version. Leave blank to auto-detect version.)

                      • docker_image string

                        A docker URI that allows overriding of the default docker image specified for this version

                      • system_settings object

                        A structure that defines a curated subset of the APM Server settings. TIP: To define the complete set of APM Server setting, use ApmSystemSettings with user_settings_override_ and user_settings_.

                        Hide system_settings attributes Show system_settings attributes object
                        • elasticsearch_username string

                          Optionally override the account within APM - defaults to a system account that always exists (if specified, the password must also be specified). Note that this field is never returned from the API, it is write only.

                        • elasticsearch_password string

                          Optionally override the account within APM - defaults to a system account that always exists (if specified, the username must also be specified). Note that this field is never returned from the API, it is write only.

                        • secret_token string

                          Optionally override the secret token within APM - defaults to the previously existing secretToken

                        • debug_enabled boolean

                          Optionally enable debug mode for APM servers - defaults false

                      • user_settings_json object

                        An arbitrary JSON object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters are on the allowlist and not on the denylist. (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Apm settings)

                      • user_settings_yaml string

                        An arbitrary YAML object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_json' is allowed), provided the parameters are on the allowlist and not on the denylist. (These field together with 'user_settings_override*' and 'system_settings' defines the total set of Apm settings)

                      • user_settings_override_json object

                        An arbitrary JSON object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Apm settings)

                      • user_settings_override_yaml string

                        An arbitrary YAML object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_json' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Apm settings)

                  • apm object Required

                    The configuration options for the APM Server.

                    Hide apm attributes Show apm attributes object
                    • version string

                      The version of the Apm cluster (must be one of the ECE supported versions, and won't work unless it matches the APM version. Leave blank to auto-detect version.)

                    • docker_image string

                      A docker URI that allows overriding of the default docker image specified for this version

                    • system_settings object

                      A structure that defines a curated subset of the APM Server settings. TIP: To define the complete set of APM Server setting, use ApmSystemSettings with user_settings_override_ and user_settings_.

                      Hide system_settings attributes Show system_settings attributes object
                      • elasticsearch_username string

                        Optionally override the account within APM - defaults to a system account that always exists (if specified, the password must also be specified). Note that this field is never returned from the API, it is write only.

                      • elasticsearch_password string

                        Optionally override the account within APM - defaults to a system account that always exists (if specified, the username must also be specified). Note that this field is never returned from the API, it is write only.

                      • secret_token string

                        Optionally override the secret token within APM - defaults to the previously existing secretToken

                      • debug_enabled boolean

                        Optionally enable debug mode for APM servers - defaults false

                    • user_settings_json object

                      An arbitrary JSON object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters are on the allowlist and not on the denylist. (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Apm settings)

                    • user_settings_yaml string

                      An arbitrary YAML object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_json' is allowed), provided the parameters are on the allowlist and not on the denylist. (These field together with 'user_settings_override*' and 'system_settings' defines the total set of Apm settings)

                    • user_settings_override_json object

                      An arbitrary JSON object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Apm settings)

                    • user_settings_override_yaml string

                      An arbitrary YAML object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_json' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Apm settings)

                  • transient object

                    Defines the configuration parameters that control how the plan is applied. For example, the Elasticsearch cluster topology and APM Server settings.

                    Hide transient attributes Show transient attributes object
                    • strategy object

                      The options for performing a plan change. Specify only one property each time. The default is grow_and_shrink.

                      Hide strategy attributes Show strategy attributes object
                      • rolling object

                        Performs inline, rolling configuration changes that mutate existing containers. TIP: This is the fastest way to update a plan, but can fail for complex plan changes, such as topology changes. Also, this is less safe for configuration changes that leave a cluster in a non running state. NOTE: When you perform a major version upgrade, and 'group_by' is set to 'pass:macros[all]';, rolling is required.

                        Hide rolling attributes Show rolling attributes object
                        • group_by string

                          Specifies the grouping attribute to use when rolling several instances. Instances that share the same value for the provided attribute key are rolled together as a unit. Examples that make sense to use are '__all__' (roll all instances as a single unit), 'logical_zone_name' (roll instances by zone), '__name__' (roll one instance at a time, the default if not specified). Note that '__all__' is required when performing a major version upgrade

                        • allow_inline_resize boolean

                          Whether we allow changing the capacity of instances (default false). This is currently implemented by stopping, re-creating then starting the affected instance on its associated allocator when performing the changes. NOTES: This requires a round-trip through the allocation infrastructure of the active constructor, as it has to reserve the target capacity without over-committing

                        • skip_synced_flush boolean

                          Whether to skip attempting to do a synced flush on the filesystem of the container (default: false), which is less safe but may be required if the container is unhealthy

                        • shard_init_wait_time integer(int64)

                          The time, in seconds, to wait for shards that show no progress of initializing before rolling the next group (default: 10 minutes)

                      • grow_and_shrink object

                        A strategy that creates instances with the new plan, migrates data from the old instances, then shuts down the old instances. GrowShrinkStrategyConfig is safer than 'rolling' and ensures single node availability during a plan change, but can be a lot slower on larger clusters.

                      • rolling_grow_and_shrink object

                        A strategy that creates new Elasticsearch instances, Kibana instances, and APM Servers with the new plan, then migrates the node data to minimize the amount of spare capacity.

                      • autodetect object

                        A strategy that lets constructor choose the most optimal way to execute the plan.

                    • plan_configuration object

                      The plan control configuration options for the APM Server.

                      Hide plan_configuration attributes Show plan_configuration attributes object
                      • timeout integer(int64)

                        The total timeout in seconds after which the plan is cancelled even if it is not complete. Defaults to 4x the max memory capacity per node (in MB)

                      • calm_wait_time integer(int64)

                        This timeout determines how long to give a cluster after it responds to API calls before performing actual operations on it. It defaults to 5s

                      • extended_maintenance boolean

                        If true (default false), does not clear the maintenance flag (which prevents its API from being accessed except by the constructor) on new instances added until after a snapshot has been restored, otherwise, the maintenance flag is cleared once the new instances successfully join the new cluster

                      • cluster_reboot string

                        Set to 'forced' to force a reboot as part of the upgrade plan

                        Value is forced.

                • plan_attempt_log array[object] Required

                  Information about a step in a plan.

                  Hide plan_attempt_log attributes Show plan_attempt_log attributes object
                  • step_id string Required

                    ID of current step

                  • started string(date-time) Required

                    When the step started (ISO format in UTC)

                  • completed string(date-time)

                    When the step completed (ISO format in UTC)

                  • duration_in_millis integer(int64)

                    The duration of the step in MS

                  • status string Required

                    The status of the step (success, warning, error - warning means something didn't go as expected but it was not serious enough to abort the plan)

                    Values are success, warning, error, or pending.

                  • stage string Required

                    Current stage that the step is in

                    Values are starting, completed, or in_progress.

                  • info_log array[object] Required

                    Human readable summaries of the step, including messages for each stage of the step

                    The log message from a specified stage of an executed step in a plan.

                    Hide info_log attributes Show info_log attributes object
                    • timestamp string(date-time) Required

                      Timestamp marking on info log of step

                    • delta_in_millis integer(int64)

                      Time in milliseconds since previous log message

                    • stage string Required

                      Stage that info log message takes place in

                      Values are starting, completed, or in_progress.

                    • message string Required

                      Human readable log message

                    • details object Required

                      A map with details for the log about what happened during the step execution. Keys and values for are always both strings, representing the name of the detail and its value, respectively.

                      Hide details attribute Show details attribute object
                      • * string Additional properties
                    • failure_type string

                      The failure type, in case the step failed

                • source object

                  Information describing the source that facilitated the plans current state

                  Hide source attributes Show source attributes object
                  • facilitator string Required

                    The service where the change originated from

                  • action string Required

                    The type of plan change that was initiated

                  • date string(date-time) Required

                    The time the change was initiated

                  • user_id string

                    The user that requested the change

                  • admin_id string

                    The admin user that requested the change

                  • remote_addresses array[string]

                    The host addresses of the user that originated the change

                • warnings array[object] Required

                  Information about a warning from a plan.

                  Hide warnings attributes Show warnings attributes object
                  • code string Required

                    A unique warning code

                  • message string Required

                    A description of the warning

                  • step_id string

                    The ID of the step which produced a warning, if any

                • error object

                  Information about an error during a plan attempt.

                  Hide error attributes Show error attributes object
                  • timestamp string(date-time) Required

                    Timestamp marking on info log of step

                  • message string Required

                    Human readable error message

                  • details object Required

                    A map with details regarding the error. Both the keys and values are always strings, representing the name of the detail and its value, respectively.

                    Hide details attribute Show details attribute object
                    • * string Additional properties
                  • failure_type string

                    The failure type

              • pending object

                Information about the APM Server plan.

                Hide pending attributes Show pending attributes object
                • plan_attempt_id string

                  A UUID for each plan attempt

                • plan_attempt_name string

                  A human readable name for each plan attempt, only populated when retrieving plan histories

                • healthy boolean Required

                  Either the plan ended successfully, or is not yet completed (and no errors have occurred)

                • attempt_start_time string(date-time)

                  When this plan attempt (ie to apply the plan to the APM) started (ISO format in UTC)

                • attempt_end_time string(date-time)

                  If this plan completed or failed (ie is not pending), when the attempt ended (ISO format in UTC)

                • plan_end_time string(date-time)

                  If this plan is not current or pending, when the plan was no longer active (ISO format in UTC)

                • plan object

                  The plan for the APM Server.

                  Hide plan attributes Show plan attributes object
                  • cluster_topology array[object]

                    Defines the topology of the APM Server nodes. For example, the number or capacity of the nodes, and where you can allocate the nodes.

                    Hide cluster_topology attributes Show cluster_topology attributes object
                    • instance_configuration_id string

                      Controls the allocation of this topology element as well as allowed sizes and node_types. It needs to match the id of an existing instance configuration.

                    • instance_configuration_version integer(int32)

                      The version of the Instance Configuration Id. If it is unset, the meaning depends on read vs writes. For deployment reads, it is equivalent to version 0 (or the IC is unversioned); for deployment creates and deployment template use, it is equivalent to 'the latest version'; and for deployment updates, it is equivalent to 'retain the current version'.

                    • size object

                      Measured by the amount of a resource. The final cluster size is calculated using multipliers from the topology instance configuration.

                      Hide size attributes Show size attributes object
                      • value integer(int32) Required

                        Amount of resource

                      • resource string Required

                        Type of resource. In ESS the resource used should always be memory.

                        Values are memory or storage.

                    • zone_count integer(int32)

                      number of zones in which nodes will be placed

                    • apm object

                      The configuration options for the APM Server.

                      Hide apm attributes Show apm attributes object
                      • version string

                        The version of the Apm cluster (must be one of the ECE supported versions, and won't work unless it matches the APM version. Leave blank to auto-detect version.)

                      • docker_image string

                        A docker URI that allows overriding of the default docker image specified for this version

                      • system_settings object

                        A structure that defines a curated subset of the APM Server settings. TIP: To define the complete set of APM Server setting, use ApmSystemSettings with user_settings_override_ and user_settings_.

                        Hide system_settings attributes Show system_settings attributes object
                        • elasticsearch_username string

                          Optionally override the account within APM - defaults to a system account that always exists (if specified, the password must also be specified). Note that this field is never returned from the API, it is write only.

                        • elasticsearch_password string

                          Optionally override the account within APM - defaults to a system account that always exists (if specified, the username must also be specified). Note that this field is never returned from the API, it is write only.

                        • secret_token string

                          Optionally override the secret token within APM - defaults to the previously existing secretToken

                        • debug_enabled boolean

                          Optionally enable debug mode for APM servers - defaults false

                      • user_settings_json object

                        An arbitrary JSON object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters are on the allowlist and not on the denylist. (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Apm settings)

                      • user_settings_yaml string

                        An arbitrary YAML object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_json' is allowed), provided the parameters are on the allowlist and not on the denylist. (These field together with 'user_settings_override*' and 'system_settings' defines the total set of Apm settings)

                      • user_settings_override_json object

                        An arbitrary JSON object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Apm settings)

                      • user_settings_override_yaml string

                        An arbitrary YAML object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_json' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Apm settings)

                  • apm object Required

                    The configuration options for the APM Server.

                    Hide apm attributes Show apm attributes object
                    • version string

                      The version of the Apm cluster (must be one of the ECE supported versions, and won't work unless it matches the APM version. Leave blank to auto-detect version.)

                    • docker_image string

                      A docker URI that allows overriding of the default docker image specified for this version

                    • system_settings object

                      A structure that defines a curated subset of the APM Server settings. TIP: To define the complete set of APM Server setting, use ApmSystemSettings with user_settings_override_ and user_settings_.

                      Hide system_settings attributes Show system_settings attributes object
                      • elasticsearch_username string

                        Optionally override the account within APM - defaults to a system account that always exists (if specified, the password must also be specified). Note that this field is never returned from the API, it is write only.

                      • elasticsearch_password string

                        Optionally override the account within APM - defaults to a system account that always exists (if specified, the username must also be specified). Note that this field is never returned from the API, it is write only.

                      • secret_token string

                        Optionally override the secret token within APM - defaults to the previously existing secretToken

                      • debug_enabled boolean

                        Optionally enable debug mode for APM servers - defaults false

                    • user_settings_json object

                      An arbitrary JSON object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters are on the allowlist and not on the denylist. (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Apm settings)

                    • user_settings_yaml string

                      An arbitrary YAML object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_json' is allowed), provided the parameters are on the allowlist and not on the denylist. (These field together with 'user_settings_override*' and 'system_settings' defines the total set of Apm settings)

                    • user_settings_override_json object

                      An arbitrary JSON object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Apm settings)

                    • user_settings_override_yaml string

                      An arbitrary YAML object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_json' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Apm settings)

                  • transient object

                    Defines the configuration parameters that control how the plan is applied. For example, the Elasticsearch cluster topology and APM Server settings.

                    Hide transient attributes Show transient attributes object
                    • strategy object

                      The options for performing a plan change. Specify only one property each time. The default is grow_and_shrink.

                      Hide strategy attributes Show strategy attributes object
                      • rolling object

                        Performs inline, rolling configuration changes that mutate existing containers. TIP: This is the fastest way to update a plan, but can fail for complex plan changes, such as topology changes. Also, this is less safe for configuration changes that leave a cluster in a non running state. NOTE: When you perform a major version upgrade, and 'group_by' is set to 'pass:macros[all]';, rolling is required.

                        Hide rolling attributes Show rolling attributes object
                        • group_by string

                          Specifies the grouping attribute to use when rolling several instances. Instances that share the same value for the provided attribute key are rolled together as a unit. Examples that make sense to use are '__all__' (roll all instances as a single unit), 'logical_zone_name' (roll instances by zone), '__name__' (roll one instance at a time, the default if not specified). Note that '__all__' is required when performing a major version upgrade

                        • allow_inline_resize boolean

                          Whether we allow changing the capacity of instances (default false). This is currently implemented by stopping, re-creating then starting the affected instance on its associated allocator when performing the changes. NOTES: This requires a round-trip through the allocation infrastructure of the active constructor, as it has to reserve the target capacity without over-committing

                        • skip_synced_flush boolean

                          Whether to skip attempting to do a synced flush on the filesystem of the container (default: false), which is less safe but may be required if the container is unhealthy

                        • shard_init_wait_time integer(int64)

                          The time, in seconds, to wait for shards that show no progress of initializing before rolling the next group (default: 10 minutes)

                      • grow_and_shrink object

                        A strategy that creates instances with the new plan, migrates data from the old instances, then shuts down the old instances. GrowShrinkStrategyConfig is safer than 'rolling' and ensures single node availability during a plan change, but can be a lot slower on larger clusters.

                      • rolling_grow_and_shrink object

                        A strategy that creates new Elasticsearch instances, Kibana instances, and APM Servers with the new plan, then migrates the node data to minimize the amount of spare capacity.

                      • autodetect object

                        A strategy that lets constructor choose the most optimal way to execute the plan.

                    • plan_configuration object

                      The plan control configuration options for the APM Server.

                      Hide plan_configuration attributes Show plan_configuration attributes object
                      • timeout integer(int64)

                        The total timeout in seconds after which the plan is cancelled even if it is not complete. Defaults to 4x the max memory capacity per node (in MB)

                      • calm_wait_time integer(int64)

                        This timeout determines how long to give a cluster after it responds to API calls before performing actual operations on it. It defaults to 5s

                      • extended_maintenance boolean

                        If true (default false), does not clear the maintenance flag (which prevents its API from being accessed except by the constructor) on new instances added until after a snapshot has been restored, otherwise, the maintenance flag is cleared once the new instances successfully join the new cluster

                      • cluster_reboot string

                        Set to 'forced' to force a reboot as part of the upgrade plan

                        Value is forced.

                • plan_attempt_log array[object] Required

                  Information about a step in a plan.

                  Hide plan_attempt_log attributes Show plan_attempt_log attributes object
                  • step_id string Required

                    ID of current step

                  • started string(date-time) Required

                    When the step started (ISO format in UTC)

                  • completed string(date-time)

                    When the step completed (ISO format in UTC)

                  • duration_in_millis integer(int64)

                    The duration of the step in MS

                  • status string Required

                    The status of the step (success, warning, error - warning means something didn't go as expected but it was not serious enough to abort the plan)

                    Values are success, warning, error, or pending.

                  • stage string Required

                    Current stage that the step is in

                    Values are starting, completed, or in_progress.

                  • info_log array[object] Required

                    Human readable summaries of the step, including messages for each stage of the step

                    The log message from a specified stage of an executed step in a plan.

                    Hide info_log attributes Show info_log attributes object
                    • timestamp string(date-time) Required

                      Timestamp marking on info log of step

                    • delta_in_millis integer(int64)

                      Time in milliseconds since previous log message

                    • stage string Required

                      Stage that info log message takes place in

                      Values are starting, completed, or in_progress.

                    • message string Required

                      Human readable log message

                    • details object Required

                      A map with details for the log about what happened during the step execution. Keys and values for are always both strings, representing the name of the detail and its value, respectively.

                      Hide details attribute Show details attribute object
                      • * string Additional properties
                    • failure_type string

                      The failure type, in case the step failed

                • source object

                  Information describing the source that facilitated the plans current state

                  Hide source attributes Show source attributes object
                  • facilitator string Required

                    The service where the change originated from

                  • action string Required

                    The type of plan change that was initiated

                  • date string(date-time) Required

                    The time the change was initiated

                  • user_id string

                    The user that requested the change

                  • admin_id string

                    The admin user that requested the change

                  • remote_addresses array[string]

                    The host addresses of the user that originated the change

                • warnings array[object] Required

                  Information about a warning from a plan.

                  Hide warnings attributes Show warnings attributes object
                  • code string Required

                    A unique warning code

                  • message string Required

                    A description of the warning

                  • step_id string

                    The ID of the step which produced a warning, if any

                • error object

                  Information about an error during a plan attempt.

                  Hide error attributes Show error attributes object
                  • timestamp string(date-time) Required

                    Timestamp marking on info log of step

                  • message string Required

                    Human readable error message

                  • details object Required

                    A map with details regarding the error. Both the keys and values are always strings, representing the name of the detail and its value, respectively.

                    Hide details attribute Show details attribute object
                    • * string Additional properties
                  • failure_type string

                    The failure type

              • history array[object] Required

                Information about the APM Server plan.

                Hide history attributes Show history attributes object
                • plan_attempt_id string

                  A UUID for each plan attempt

                • plan_attempt_name string

                  A human readable name for each plan attempt, only populated when retrieving plan histories

                • healthy boolean Required

                  Either the plan ended successfully, or is not yet completed (and no errors have occurred)

                • attempt_start_time string(date-time)

                  When this plan attempt (ie to apply the plan to the APM) started (ISO format in UTC)

                • attempt_end_time string(date-time)

                  If this plan completed or failed (ie is not pending), when the attempt ended (ISO format in UTC)

                • plan_end_time string(date-time)

                  If this plan is not current or pending, when the plan was no longer active (ISO format in UTC)

                • plan object

                  The plan for the APM Server.

                  Hide plan attributes Show plan attributes object
                  • cluster_topology array[object]

                    Defines the topology of the APM Server nodes. For example, the number or capacity of the nodes, and where you can allocate the nodes.

                    Hide cluster_topology attributes Show cluster_topology attributes object
                    • instance_configuration_id string

                      Controls the allocation of this topology element as well as allowed sizes and node_types. It needs to match the id of an existing instance configuration.

                    • instance_configuration_version integer(int32)

                      The version of the Instance Configuration Id. If it is unset, the meaning depends on read vs writes. For deployment reads, it is equivalent to version 0 (or the IC is unversioned); for deployment creates and deployment template use, it is equivalent to 'the latest version'; and for deployment updates, it is equivalent to 'retain the current version'.

                    • size object

                      Measured by the amount of a resource. The final cluster size is calculated using multipliers from the topology instance configuration.

                      Hide size attributes Show size attributes object
                      • value integer(int32) Required

                        Amount of resource

                      • resource string Required

                        Type of resource. In ESS the resource used should always be memory.

                        Values are memory or storage.

                    • zone_count integer(int32)

                      number of zones in which nodes will be placed

                    • apm object

                      The configuration options for the APM Server.

                      Hide apm attributes Show apm attributes object
                      • version string

                        The version of the Apm cluster (must be one of the ECE supported versions, and won't work unless it matches the APM version. Leave blank to auto-detect version.)

                      • docker_image string

                        A docker URI that allows overriding of the default docker image specified for this version

                      • system_settings object

                        A structure that defines a curated subset of the APM Server settings. TIP: To define the complete set of APM Server setting, use ApmSystemSettings with user_settings_override_ and user_settings_.

                        Hide system_settings attributes Show system_settings attributes object
                        • elasticsearch_username string

                          Optionally override the account within APM - defaults to a system account that always exists (if specified, the password must also be specified). Note that this field is never returned from the API, it is write only.

                        • elasticsearch_password string

                          Optionally override the account within APM - defaults to a system account that always exists (if specified, the username must also be specified). Note that this field is never returned from the API, it is write only.

                        • secret_token string

                          Optionally override the secret token within APM - defaults to the previously existing secretToken

                        • debug_enabled boolean

                          Optionally enable debug mode for APM servers - defaults false

                      • user_settings_json object

                        An arbitrary JSON object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters are on the allowlist and not on the denylist. (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Apm settings)

                      • user_settings_yaml string

                        An arbitrary YAML object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_json' is allowed), provided the parameters are on the allowlist and not on the denylist. (These field together with 'user_settings_override*' and 'system_settings' defines the total set of Apm settings)

                      • user_settings_override_json object

                        An arbitrary JSON object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Apm settings)

                      • user_settings_override_yaml string

                        An arbitrary YAML object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_json' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Apm settings)

                  • apm object Required

                    The configuration options for the APM Server.

                    Hide apm attributes Show apm attributes object
                    • version string

                      The version of the Apm cluster (must be one of the ECE supported versions, and won't work unless it matches the APM version. Leave blank to auto-detect version.)

                    • docker_image string

                      A docker URI that allows overriding of the default docker image specified for this version

                    • system_settings object

                      A structure that defines a curated subset of the APM Server settings. TIP: To define the complete set of APM Server setting, use ApmSystemSettings with user_settings_override_ and user_settings_.

                      Hide system_settings attributes Show system_settings attributes object
                      • elasticsearch_username string

                        Optionally override the account within APM - defaults to a system account that always exists (if specified, the password must also be specified). Note that this field is never returned from the API, it is write only.

                      • elasticsearch_password string

                        Optionally override the account within APM - defaults to a system account that always exists (if specified, the username must also be specified). Note that this field is never returned from the API, it is write only.

                      • secret_token string

                        Optionally override the secret token within APM - defaults to the previously existing secretToken

                      • debug_enabled boolean

                        Optionally enable debug mode for APM servers - defaults false

                    • user_settings_json object

                      An arbitrary JSON object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters are on the allowlist and not on the denylist. (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Apm settings)

                    • user_settings_yaml string

                      An arbitrary YAML object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_json' is allowed), provided the parameters are on the allowlist and not on the denylist. (These field together with 'user_settings_override*' and 'system_settings' defines the total set of Apm settings)

                    • user_settings_override_json object

                      An arbitrary JSON object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Apm settings)

                    • user_settings_override_yaml string

                      An arbitrary YAML object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_json' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Apm settings)

                  • transient object

                    Defines the configuration parameters that control how the plan is applied. For example, the Elasticsearch cluster topology and APM Server settings.

                    Hide transient attributes Show transient attributes object
                    • strategy object

                      The options for performing a plan change. Specify only one property each time. The default is grow_and_shrink.

                      Hide strategy attributes Show strategy attributes object
                      • rolling object

                        Performs inline, rolling configuration changes that mutate existing containers. TIP: This is the fastest way to update a plan, but can fail for complex plan changes, such as topology changes. Also, this is less safe for configuration changes that leave a cluster in a non running state. NOTE: When you perform a major version upgrade, and 'group_by' is set to 'pass:macros[all]';, rolling is required.

                        Hide rolling attributes Show rolling attributes object
                        • group_by string

                          Specifies the grouping attribute to use when rolling several instances. Instances that share the same value for the provided attribute key are rolled together as a unit. Examples that make sense to use are '__all__' (roll all instances as a single unit), 'logical_zone_name' (roll instances by zone), '__name__' (roll one instance at a time, the default if not specified). Note that '__all__' is required when performing a major version upgrade

                        • allow_inline_resize boolean

                          Whether we allow changing the capacity of instances (default false). This is currently implemented by stopping, re-creating then starting the affected instance on its associated allocator when performing the changes. NOTES: This requires a round-trip through the allocation infrastructure of the active constructor, as it has to reserve the target capacity without over-committing

                        • skip_synced_flush boolean

                          Whether to skip attempting to do a synced flush on the filesystem of the container (default: false), which is less safe but may be required if the container is unhealthy

                        • shard_init_wait_time integer(int64)

                          The time, in seconds, to wait for shards that show no progress of initializing before rolling the next group (default: 10 minutes)

                      • grow_and_shrink object

                        A strategy that creates instances with the new plan, migrates data from the old instances, then shuts down the old instances. GrowShrinkStrategyConfig is safer than 'rolling' and ensures single node availability during a plan change, but can be a lot slower on larger clusters.

                      • rolling_grow_and_shrink object

                        A strategy that creates new Elasticsearch instances, Kibana instances, and APM Servers with the new plan, then migrates the node data to minimize the amount of spare capacity.

                      • autodetect object

                        A strategy that lets constructor choose the most optimal way to execute the plan.

                    • plan_configuration object

                      The plan control configuration options for the APM Server.

                      Hide plan_configuration attributes Show plan_configuration attributes object
                      • timeout integer(int64)

                        The total timeout in seconds after which the plan is cancelled even if it is not complete. Defaults to 4x the max memory capacity per node (in MB)

                      • calm_wait_time integer(int64)

                        This timeout determines how long to give a cluster after it responds to API calls before performing actual operations on it. It defaults to 5s

                      • extended_maintenance boolean

                        If true (default false), does not clear the maintenance flag (which prevents its API from being accessed except by the constructor) on new instances added until after a snapshot has been restored, otherwise, the maintenance flag is cleared once the new instances successfully join the new cluster

                      • cluster_reboot string

                        Set to 'forced' to force a reboot as part of the upgrade plan

                        Value is forced.

                • plan_attempt_log array[object] Required

                  Information about a step in a plan.

                  Hide plan_attempt_log attributes Show plan_attempt_log attributes object
                  • step_id string Required

                    ID of current step

                  • started string(date-time) Required

                    When the step started (ISO format in UTC)

                  • completed string(date-time)

                    When the step completed (ISO format in UTC)

                  • duration_in_millis integer(int64)

                    The duration of the step in MS

                  • status string Required

                    The status of the step (success, warning, error - warning means something didn't go as expected but it was not serious enough to abort the plan)

                    Values are success, warning, error, or pending.

                  • stage string Required

                    Current stage that the step is in

                    Values are starting, completed, or in_progress.

                  • info_log array[object] Required

                    Human readable summaries of the step, including messages for each stage of the step

                    The log message from a specified stage of an executed step in a plan.

                    Hide info_log attributes Show info_log attributes object
                    • timestamp string(date-time) Required

                      Timestamp marking on info log of step

                    • delta_in_millis integer(int64)

                      Time in milliseconds since previous log message

                    • stage string Required

                      Stage that info log message takes place in

                      Values are starting, completed, or in_progress.

                    • message string Required

                      Human readable log message

                    • details object Required

                      A map with details for the log about what happened during the step execution. Keys and values for are always both strings, representing the name of the detail and its value, respectively.

                      Hide details attribute Show details attribute object
                      • * string Additional properties
                    • failure_type string

                      The failure type, in case the step failed

                • source object

                  Information describing the source that facilitated the plans current state

                  Hide source attributes Show source attributes object
                  • facilitator string Required

                    The service where the change originated from

                  • action string Required

                    The type of plan change that was initiated

                  • date string(date-time) Required

                    The time the change was initiated

                  • user_id string

                    The user that requested the change

                  • admin_id string

                    The admin user that requested the change

                  • remote_addresses array[string]

                    The host addresses of the user that originated the change

                • warnings array[object] Required

                  Information about a warning from a plan.

                  Hide warnings attributes Show warnings attributes object
                  • code string Required

                    A unique warning code

                  • message string Required

                    A description of the warning

                  • step_id string

                    The ID of the step which produced a warning, if any

                • error object

                  Information about an error during a plan attempt.

                  Hide error attributes Show error attributes object
                  • timestamp string(date-time) Required

                    Timestamp marking on info log of step

                  • message string Required

                    Human readable error message

                  • details object Required

                    A map with details regarding the error. Both the keys and values are always strings, representing the name of the detail and its value, respectively.

                    Hide details attribute Show details attribute object
                    • * string Additional properties
                  • failure_type string

                    The failure type

            • metadata object

              Information about the public and internal state, and the configuration settings of an Elasticsearch cluster.

              Hide metadata attributes Show metadata attributes object
              • version integer(int32) Required

                The resource version number of the cluster metadata

              • last_modified string(date-time) Required

                The most recent time the cluster metadata was changed (ISO format in UTC)

              • endpoint string

                The DNS name of the cluster endpoint, if available

              • service_url string

                The full URL to access this deployment resource

              • aliased_endpoint string

                The DNS name of the cluster endpoint derived from the deployment alias, if available

              • aliased_url string

                The full aliased URL to access this deployment resource

              • cloud_id string

                The cloud ID, an encoded string that provides other Elastic services with the necessary information to connect to this Elasticsearch and Kibana (only present if both exist)

              • raw object

                An unstructured JSON representation of the public and internal state (can be filtered out via URL parameter). The contents and structure of the raw field can change at any time.

              • ports object

                The ports that allow communication with the cluster using various protocols.

                Hide ports attributes Show ports attributes object
                • http integer(int32) Required

                  Port where the cluster listens for HTTP traffic

                • https integer(int32) Required

                  Port where the cluster listens for HTTPS traffic

                • transport_passthrough integer(int32) Required

                  Port where the cluster listens for transport traffic using TLS

              • services_urls array[object]

                A list of the URLs to access services that the resource provides at this time. Note that if the service is not running or has not started yet, the URL to access it won't be available

                A URL to access the service of a resource

                Hide services_urls attributes Show services_urls attributes object
                • service string Required

                  Name of the service

                • url string Required

                  The full URL to access the service

            • topology object Required

              The topology for Elasticsearch clusters, multiple Kibana instances, or multiple APM Servers. The ClusterTopologyInfo also includes the instances and containers, and where they are located.

              Hide topology attributes Show topology attributes object
              • healthy boolean Required

                Whether the cluster topology is healthy (ie all instances are started and the services they run - ie elasticsearch - are available

              • instances array[object] Required

                Information about each Kibana instance and APM Server in the Elasticsearch cluster.

                Hide instances attributes Show instances attributes object
                • instance_name string Required

                  The name of the instance in Elastic Cloud

                • instance_configuration object

                  Information about a configuration that creates a Kibana instance or APM Server.

                  Hide instance_configuration attributes Show instance_configuration attributes object
                  • id string Required

                    The id of the configuration used to create the instance

                  • name string Required

                    The name of the configuration used to create the instance

                  • config_version integer(int32)

                    If the IC is configuration controlled, this field is the version either being read back (reads return the latest IC unless specified by the 'config_version' URL param), or the version to update. Cannot be used in creates. For unversioned IC reads it is left empty.

                  • resource string Required

                    The resource type of the instance configuration

                    Values are memory or storage.

                • service_version string

                  The version of the service that the instance is running (eg Elasticsearch or Kibana), if available

                • healthy boolean Required

                  Whether the instance is healthy (ie started and running)

                • container_started boolean Required

                  Whether the container has started (does not tell you anything about the service -ie Elasticsearch- running inside the container)

                • service_running boolean Required

                  Whether the service launched inside the container -ie Elasticsearch- is actually running

                • maintenance_mode boolean Required

                  Whether the service is is maintenance mode (meaning that the proxy is not routing external traffic to it)

                • zone string

                  The zone in which this instance is being allocated

                • allocator_id string

                  The id of the allocator on which this instance is running (if the container is started or starting)

                • memory object

                  Information about the specific instances memory capacity and its usage

                  Hide memory attributes Show memory attributes object
                  • instance_capacity integer(int32) Required

                    The memory capacity in MB of the instance

                  • instance_capacity_planned integer(int32)

                    The planned memory capacity in MB of the instance (only shown when an override is present)

                  • memory_pressure integer(int32)

                    The % memory pressure of Elasticsearch JVM heap space if available (60-75% consider increasing capacity, >75% can incur significant performance and stability issues)

                  • native_memory_pressure integer(int32)

                    The % memory pressure of the instance Docker container (if available)

                • disk object

                  Information about the use and storage capacity of a Kibana instance or APM Server.

                  Hide disk attributes Show disk attributes object
                  • disk_space_available integer(int64)

                    If known, the amount of total disk space available to the container in MB

                  • disk_space_used integer(int64) Required

                    The amount of disk space being used by the service in MB

                  • storage_multiplier number(double) Required

                    The storage multiplier originally defined to calculate disk space.

                • service_roles array[string]

                  List of roles assigned to the service running in the instance. Currently only populated for Elasticsearch, with possible values: master,data,ingest,ml

                • node_roles array[string]

                  A list of the node roles assigned to the service running in the instance. Currently populated only for Elasticsearch.

                  Values are master, ingest, ml, data_hot, data_content, data_warm, data_cold, data_frozen, remote_cluster_client, transform, or voting_only.

                • instance_overrides object

                  Instance overrides

                  Hide instance_overrides attributes Show instance_overrides attributes object
                  • capacity integer(int32)

                    Sets the memory capacity for the instances container. Requires a restart to take effect.

                  • storage_multiplier number(double)

                    Overrides the disk quota multiplier for the instance

            • external_links array[object] Required

              External resources related to the APM

              Hide external_links attributes Show external_links attributes object
              • id string Required

                Identifier of the external link

              • label string Required

                Human-readable description of the external link

              • uri string

                hyperlink to an external resource

            • links object

              A map of application-specific operations (which map to 'operationId's in the Swagger API) to metadata about that operation

              Hide links attribute Show links attribute object
              • * object Additional properties
                Hide * attribute Show * attribute object
                • need_elevated_permissions boolean

                  Whether the operation requires elevated permissions (when the field is present, elevated permissions are required).

            • settings object

              The settings for building this APM cluster

              Hide settings attribute Show settings attribute object
              • metadata object

                The top-level configuration settings for the Elasticsearch cluster.

                Hide metadata attribute Show metadata attribute object
                • name string

                  The display name of the cluster

            • region string

              The region that this APM belongs to. Only populated in SaaS or federated ECE.

            • apm_server_mode string

              The mode APM is operating in.

              Values are standalone or managed.

        • appsearch array[object] Required

          List of App Search resources in your Deployment

          Describes an App Search resource belonging to a Deployment

          Hide appsearch attributes Show appsearch attributes object
          • ref_id string Required

            The locally-unique user-specified id of a Resource

          • elasticsearch_cluster_ref_id string Required

            The Elasticsearch cluster that this resource depends on.

          • id string Required

            The randomly-generated id of a Resource

          • region string Required

            The region where this resource exists

          • info object Required

            Info for the resource.

            Hide info attributes Show info attributes object
            • id string Required

              The id of the App Search

            • name string Required

              The name of the App Search

            • elasticsearch_cluster object Required

              Information about the specified Elasticsearch cluster.

              Hide elasticsearch_cluster attributes Show elasticsearch_cluster attributes object
              • elasticsearch_id string Required

                The Elasticsearch cluster Id

              • links object

                A map of application-specific operations (which map to 'operationId's in the Swagger API) to metadata about that operation

                Hide links attribute Show links attribute object
                • * object Additional properties
                  Hide * attribute Show * attribute object
                  • need_elevated_permissions boolean

                    Whether the operation requires elevated permissions (when the field is present, elevated permissions are required).

            • deployment_id string

              The id of the deployment that this App Search belongs to.

            • healthy boolean Required

              Whether the App Search is healthy or not (one or more of the info subsections will have healthy: false)

            • status string Required

              App Search status

              Values are initializing, stopping, stopped, rebooting, restarting, reconfiguring, or started.

            • plan_info object Required

              Information about current, pending, and past App Search Server plans.

              Hide plan_info attributes Show plan_info attributes object
              • healthy boolean Required

                Whether the plan situation is healthy (if unhealthy, means the last plan attempt failed)

              • current object

                Information about the App Search Server plan.

                Hide current attributes Show current attributes object
                • plan_attempt_id string

                  A UUID for each plan attempt

                • plan_attempt_name string

                  A human readable name for each plan attempt, only populated when retrieving plan histories

                • healthy boolean Required

                  Either the plan ended successfully, or is not yet completed (and no errors have occurred)

                • attempt_start_time string(date-time)

                  When this plan attempt (ie to apply the plan to the App Search) started (ISO format in UTC)

                • attempt_end_time string(date-time)

                  If this plan completed or failed (ie is not pending), when the attempt ended (ISO format in UTC)

                • plan_end_time string(date-time)

                  If this plan is not current or pending, when the plan was no longer active (ISO format in UTC)

                • plan object

                  The plan for the App Search cluster.

                  Hide plan attributes Show plan attributes object
                  • cluster_topology array[object]

                    Defines the topology of the AppSearch nodes (eg number/capacity of nodes, and where they can be allocated)

                    Hide cluster_topology attributes Show cluster_topology attributes object
                    • node_type object

                      Defines the AppSearch node type

                      Hide node_type attributes Show node_type attributes object
                      • appserver boolean Required

                        Defines whether this instance should run as Application/API server

                      • worker boolean Required

                        Defines whether this instance should run as background worker

                    • instance_configuration_id string

                      Controls the allocation of this topology element as well as allowed sizes and node_types. It needs to match the id of an existing instance configuration.

                    • instance_configuration_version integer(int32)

                      The version of the Instance Configuration Id. If it is unset, the meaning depends on read vs writes. For deployment reads, it is equivalent to version 0 (or the IC is unversioned); for deployment creates and deployment template use, it is equivalent to 'the latest version'; and for deployment updates, it is equivalent to 'retain the current version'.

                    • size object

                      Measured by the amount of a resource. The final cluster size is calculated using multipliers from the topology instance configuration.

                      Hide size attributes Show size attributes object
                      • value integer(int32) Required

                        Amount of resource

                      • resource string Required

                        Type of resource. In ESS the resource used should always be memory.

                        Values are memory or storage.

                    • zone_count integer(int32)

                      number of zones in which nodes will be placed

                    • appsearch object
                      Hide appsearch attributes Show appsearch attributes object
                      • version string

                        The version of the AppSearch cluster (must be one of the ECE supported versions, and won't work unless it matches the Elasticsearch version. Leave blank to auto-detect version.)

                      • docker_image string

                        A docker URI that allows overriding of the default docker image specified for this version

                      • system_settings object

                        This structure defines a curated subset of the AppSearch settings. (This field together with 'user_settings_override*' and 'user_settings*' defines the total set of AppSearch settings)

                        Hide system_settings attributes Show system_settings attributes object
                        • elasticsearch_url string

                          Optionally override the URL to which to send data (for advanced users only, if unspecified the system selects an internal URL)

                        • elasticsearch_username string

                          Optionally override the account within App Search - defaults to a system account that always exists (if specified, the password must also be specified). Note that this field is never returned from the API, it is write only.

                        • elasticsearch_password string

                          Optionally override the account within App Search - defaults to a system account that always exists (if specified, the username must also be specified). Note that this field is never returned from the API, it is write only.

                        • secret_session_key string

                          Optionally override the secret session key within App Search - defaults to the previously existing secretSession. Note that this field is never returned from the API, it is write only.

                      • user_settings_json object

                        An arbitrary JSON object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters are on the allowlist and not on the denylist. (This field together with 'user_settings_override*' and 'system_settings' defines the total set of AppSearch settings)

                      • user_settings_yaml string

                        An arbitrary YAML object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_json' is allowed), provided the parameters are on the allowlist and not on the denylist. (These field together with 'user_settings_override*' and 'system_settings' defines the total set of AppSearch settings)

                      • user_settings_override_json object

                        An arbitrary JSON object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of AppSearch settings)

                      • user_settings_override_yaml string

                        An arbitrary YAML object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_json' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of AppSearch settings)

                  • appsearch object Required
                    Hide appsearch attributes Show appsearch attributes object
                    • version string

                      The version of the AppSearch cluster (must be one of the ECE supported versions, and won't work unless it matches the Elasticsearch version. Leave blank to auto-detect version.)

                    • docker_image string

                      A docker URI that allows overriding of the default docker image specified for this version

                    • system_settings object

                      This structure defines a curated subset of the AppSearch settings. (This field together with 'user_settings_override*' and 'user_settings*' defines the total set of AppSearch settings)

                      Hide system_settings attributes Show system_settings attributes object
                      • elasticsearch_url string

                        Optionally override the URL to which to send data (for advanced users only, if unspecified the system selects an internal URL)

                      • elasticsearch_username string

                        Optionally override the account within App Search - defaults to a system account that always exists (if specified, the password must also be specified). Note that this field is never returned from the API, it is write only.

                      • elasticsearch_password string

                        Optionally override the account within App Search - defaults to a system account that always exists (if specified, the username must also be specified). Note that this field is never returned from the API, it is write only.

                      • secret_session_key string

                        Optionally override the secret session key within App Search - defaults to the previously existing secretSession. Note that this field is never returned from the API, it is write only.

                    • user_settings_json object

                      An arbitrary JSON object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters are on the allowlist and not on the denylist. (This field together with 'user_settings_override*' and 'system_settings' defines the total set of AppSearch settings)

                    • user_settings_yaml string

                      An arbitrary YAML object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_json' is allowed), provided the parameters are on the allowlist and not on the denylist. (These field together with 'user_settings_override*' and 'system_settings' defines the total set of AppSearch settings)

                    • user_settings_override_json object

                      An arbitrary JSON object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of AppSearch settings)

                    • user_settings_override_yaml string

                      An arbitrary YAML object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_json' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of AppSearch settings)

                  • transient object

                    Defines configuration parameters that control how the plan (ie consisting of the cluster topology and AppSearch settings) is applied

                    Hide transient attributes Show transient attributes object
                    • strategy object

                      The options for performing a plan change. Specify only one property each time. The default is grow_and_shrink.

                      Hide strategy attributes Show strategy attributes object
                      • rolling object

                        Performs inline, rolling configuration changes that mutate existing containers. TIP: This is the fastest way to update a plan, but can fail for complex plan changes, such as topology changes. Also, this is less safe for configuration changes that leave a cluster in a non running state. NOTE: When you perform a major version upgrade, and 'group_by' is set to 'pass:macros[all]';, rolling is required.

                        Hide rolling attributes Show rolling attributes object
                        • group_by string

                          Specifies the grouping attribute to use when rolling several instances. Instances that share the same value for the provided attribute key are rolled together as a unit. Examples that make sense to use are '__all__' (roll all instances as a single unit), 'logical_zone_name' (roll instances by zone), '__name__' (roll one instance at a time, the default if not specified). Note that '__all__' is required when performing a major version upgrade

                        • allow_inline_resize boolean

                          Whether we allow changing the capacity of instances (default false). This is currently implemented by stopping, re-creating then starting the affected instance on its associated allocator when performing the changes. NOTES: This requires a round-trip through the allocation infrastructure of the active constructor, as it has to reserve the target capacity without over-committing

                        • skip_synced_flush boolean

                          Whether to skip attempting to do a synced flush on the filesystem of the container (default: false), which is less safe but may be required if the container is unhealthy

                        • shard_init_wait_time integer(int64)

                          The time, in seconds, to wait for shards that show no progress of initializing before rolling the next group (default: 10 minutes)

                      • grow_and_shrink object

                        A strategy that creates instances with the new plan, migrates data from the old instances, then shuts down the old instances. GrowShrinkStrategyConfig is safer than 'rolling' and ensures single node availability during a plan change, but can be a lot slower on larger clusters.

                      • rolling_grow_and_shrink object

                        A strategy that creates new Elasticsearch instances, Kibana instances, and APM Servers with the new plan, then migrates the node data to minimize the amount of spare capacity.

                      • autodetect object

                        A strategy that lets constructor choose the most optimal way to execute the plan.

                    • plan_configuration object
                      Hide plan_configuration attributes Show plan_configuration attributes object
                      • timeout integer(int64)

                        The total timeout in seconds after which the plan is cancelled even if it is not complete. Defaults to 4x the max memory capacity per node (in MB)

                      • calm_wait_time integer(int64)

                        This timeout determines how long to give a cluster after it responds to API calls before performing actual operations on it. It defaults to 5s

                      • move_instances array[object]

                        The request that specifies the Elasticsearch or stateless (eg Kibana) instances to move to allocators as part of the upgrade plan. When used in conjunction with '__all__' (roll all instances as a single unit) strategy, these instances are not restarted, which can sometimes enable recovery plans when these instances are boot-looping.

                        Hide move_instances attributes Show move_instances attributes object
                        • from string Required

                          The instance id that is going to be moved

                        • to array[string]

                          An optional list of allocator ids to which the instance should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)

                        • instance_down boolean

                          Tells the infrastructure that the instance should be considered as permanently down when deciding how to migrate data to new nodes. If left blank then the system will automatically decide (currently: will treat the instances as up)

                      • move_allocators array[object]

                        As part of the upgrade plan, identifies the move requests for the Kibana instances or APM Servers on the allocators.

                        Hide move_allocators attributes Show move_allocators attributes object
                        • from string Required

                          The allocator id off which all instances in the cluster should be moved

                        • to array[string]

                          An optional list of allocator ids to which the instance(s) should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)

                        • allocator_down boolean

                          Tells the infrastructure that all instances on the allocator should be considered as permanently down when deciding how to migrate data to new nodes. If left blank then the system will auto-decide (currently: will treat the allocator as up)

                      • reallocate_instances boolean

                        If true (default: false) does not allow re-using any existing instances currently in the cluster, ie even unchanged instances will be re-created

                      • preferred_allocators array[string]

                        List of allocators on which instances are placed if possible (if not possible/not specified then any available allocator with space is used)

                      • extended_maintenance boolean

                        If true (default false), does not clear the maintenance flag (which prevents its API from being accessed except by the constructor) on new instances added until after a snapshot has been restored, otherwise, the maintenance flag is cleared once the new instances successfully join the new cluster

                      • cluster_reboot string

                        Set to 'forced' to force a reboot as part of the upgrade plan

                        Value is forced.

                • plan_attempt_log array[object] Required

                  Information about a step in a plan.

                  Hide plan_attempt_log attributes Show plan_attempt_log attributes object
                  • step_id string Required

                    ID of current step

                  • started string(date-time) Required

                    When the step started (ISO format in UTC)

                  • completed string(date-time)

                    When the step completed (ISO format in UTC)

                  • duration_in_millis integer(int64)

                    The duration of the step in MS

                  • status string Required

                    The status of the step (success, warning, error - warning means something didn't go as expected but it was not serious enough to abort the plan)

                    Values are success, warning, error, or pending.

                  • stage string Required

                    Current stage that the step is in

                    Values are starting, completed, or in_progress.

                  • info_log array[object] Required

                    Human readable summaries of the step, including messages for each stage of the step

                    The log message from a specified stage of an executed step in a plan.

                    Hide info_log attributes Show info_log attributes object
                    • timestamp string(date-time) Required

                      Timestamp marking on info log of step

                    • delta_in_millis integer(int64)

                      Time in milliseconds since previous log message

                    • stage string Required

                      Stage that info log message takes place in

                      Values are starting, completed, or in_progress.

                    • message string Required

                      Human readable log message

                    • details object Required

                      A map with details for the log about what happened during the step execution. Keys and values for are always both strings, representing the name of the detail and its value, respectively.

                      Hide details attribute Show details attribute object
                      • * string Additional properties
                    • failure_type string

                      The failure type, in case the step failed

                • source object

                  Information describing the source that facilitated the plans current state

                  Hide source attributes Show source attributes object
                  • facilitator string Required

                    The service where the change originated from

                  • action string Required

                    The type of plan change that was initiated

                  • date string(date-time) Required

                    The time the change was initiated

                  • user_id string

                    The user that requested the change

                  • admin_id string

                    The admin user that requested the change

                  • remote_addresses array[string]

                    The host addresses of the user that originated the change

                • warnings array[object] Required

                  Information about a warning from a plan.

                  Hide warnings attributes Show warnings attributes object
                  • code string Required

                    A unique warning code

                  • message string Required

                    A description of the warning

                  • step_id string

                    The ID of the step which produced a warning, if any

                • error object

                  Information about an error during a plan attempt.

                  Hide error attributes Show error attributes object
                  • timestamp string(date-time) Required

                    Timestamp marking on info log of step

                  • message string Required

                    Human readable error message

                  • details object Required

                    A map with details regarding the error. Both the keys and values are always strings, representing the name of the detail and its value, respectively.

                    Hide details attribute Show details attribute object
                    • * string Additional properties
                  • failure_type string

                    The failure type

              • pending object

                Information about the App Search Server plan.

                Hide pending attributes Show pending attributes object
                • plan_attempt_id string

                  A UUID for each plan attempt

                • plan_attempt_name string

                  A human readable name for each plan attempt, only populated when retrieving plan histories

                • healthy boolean Required

                  Either the plan ended successfully, or is not yet completed (and no errors have occurred)

                • attempt_start_time string(date-time)

                  When this plan attempt (ie to apply the plan to the App Search) started (ISO format in UTC)

                • attempt_end_time string(date-time)

                  If this plan completed or failed (ie is not pending), when the attempt ended (ISO format in UTC)

                • plan_end_time string(date-time)

                  If this plan is not current or pending, when the plan was no longer active (ISO format in UTC)

                • plan object

                  The plan for the App Search cluster.

                  Hide plan attributes Show plan attributes object
                  • cluster_topology array[object]

                    Defines the topology of the AppSearch nodes (eg number/capacity of nodes, and where they can be allocated)

                    Hide cluster_topology attributes Show cluster_topology attributes object
                    • node_type object

                      Defines the AppSearch node type

                      Hide node_type attributes Show node_type attributes object
                      • appserver boolean Required

                        Defines whether this instance should run as Application/API server

                      • worker boolean Required

                        Defines whether this instance should run as background worker

                    • instance_configuration_id string

                      Controls the allocation of this topology element as well as allowed sizes and node_types. It needs to match the id of an existing instance configuration.

                    • instance_configuration_version integer(int32)

                      The version of the Instance Configuration Id. If it is unset, the meaning depends on read vs writes. For deployment reads, it is equivalent to version 0 (or the IC is unversioned); for deployment creates and deployment template use, it is equivalent to 'the latest version'; and for deployment updates, it is equivalent to 'retain the current version'.

                    • size object

                      Measured by the amount of a resource. The final cluster size is calculated using multipliers from the topology instance configuration.

                      Hide size attributes Show size attributes object
                      • value integer(int32) Required

                        Amount of resource

                      • resource string Required

                        Type of resource. In ESS the resource used should always be memory.

                        Values are memory or storage.

                    • zone_count integer(int32)

                      number of zones in which nodes will be placed

                    • appsearch object
                      Hide appsearch attributes Show appsearch attributes object
                      • version string

                        The version of the AppSearch cluster (must be one of the ECE supported versions, and won't work unless it matches the Elasticsearch version. Leave blank to auto-detect version.)

                      • docker_image string

                        A docker URI that allows overriding of the default docker image specified for this version

                      • system_settings object

                        This structure defines a curated subset of the AppSearch settings. (This field together with 'user_settings_override*' and 'user_settings*' defines the total set of AppSearch settings)

                        Hide system_settings attributes Show system_settings attributes object
                        • elasticsearch_url string

                          Optionally override the URL to which to send data (for advanced users only, if unspecified the system selects an internal URL)

                        • elasticsearch_username string

                          Optionally override the account within App Search - defaults to a system account that always exists (if specified, the password must also be specified). Note that this field is never returned from the API, it is write only.

                        • elasticsearch_password string

                          Optionally override the account within App Search - defaults to a system account that always exists (if specified, the username must also be specified). Note that this field is never returned from the API, it is write only.

                        • secret_session_key string

                          Optionally override the secret session key within App Search - defaults to the previously existing secretSession. Note that this field is never returned from the API, it is write only.

                      • user_settings_json object

                        An arbitrary JSON object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters are on the allowlist and not on the denylist. (This field together with 'user_settings_override*' and 'system_settings' defines the total set of AppSearch settings)

                      • user_settings_yaml string

                        An arbitrary YAML object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_json' is allowed), provided the parameters are on the allowlist and not on the denylist. (These field together with 'user_settings_override*' and 'system_settings' defines the total set of AppSearch settings)

                      • user_settings_override_json object

                        An arbitrary JSON object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of AppSearch settings)

                      • user_settings_override_yaml string

                        An arbitrary YAML object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_json' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of AppSearch settings)

                  • appsearch object Required
                    Hide appsearch attributes Show appsearch attributes object
                    • version string

                      The version of the AppSearch cluster (must be one of the ECE supported versions, and won't work unless it matches the Elasticsearch version. Leave blank to auto-detect version.)

                    • docker_image string

                      A docker URI that allows overriding of the default docker image specified for this version

                    • system_settings object

                      This structure defines a curated subset of the AppSearch settings. (This field together with 'user_settings_override*' and 'user_settings*' defines the total set of AppSearch settings)

                      Hide system_settings attributes Show system_settings attributes object
                      • elasticsearch_url string

                        Optionally override the URL to which to send data (for advanced users only, if unspecified the system selects an internal URL)

                      • elasticsearch_username string

                        Optionally override the account within App Search - defaults to a system account that always exists (if specified, the password must also be specified). Note that this field is never returned from the API, it is write only.

                      • elasticsearch_password string

                        Optionally override the account within App Search - defaults to a system account that always exists (if specified, the username must also be specified). Note that this field is never returned from the API, it is write only.

                      • secret_session_key string

                        Optionally override the secret session key within App Search - defaults to the previously existing secretSession. Note that this field is never returned from the API, it is write only.

                    • user_settings_json object

                      An arbitrary JSON object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters are on the allowlist and not on the denylist. (This field together with 'user_settings_override*' and 'system_settings' defines the total set of AppSearch settings)

                    • user_settings_yaml string

                      An arbitrary YAML object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_json' is allowed), provided the parameters are on the allowlist and not on the denylist. (These field together with 'user_settings_override*' and 'system_settings' defines the total set of AppSearch settings)

                    • user_settings_override_json object

                      An arbitrary JSON object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of AppSearch settings)

                    • user_settings_override_yaml string

                      An arbitrary YAML object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_json' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of AppSearch settings)

                  • transient object

                    Defines configuration parameters that control how the plan (ie consisting of the cluster topology and AppSearch settings) is applied

                    Hide transient attributes Show transient attributes object
                    • strategy object

                      The options for performing a plan change. Specify only one property each time. The default is grow_and_shrink.

                      Hide strategy attributes Show strategy attributes object
                      • rolling object

                        Performs inline, rolling configuration changes that mutate existing containers. TIP: This is the fastest way to update a plan, but can fail for complex plan changes, such as topology changes. Also, this is less safe for configuration changes that leave a cluster in a non running state. NOTE: When you perform a major version upgrade, and 'group_by' is set to 'pass:macros[all]';, rolling is required.

                        Hide rolling attributes Show rolling attributes object
                        • group_by string

                          Specifies the grouping attribute to use when rolling several instances. Instances that share the same value for the provided attribute key are rolled together as a unit. Examples that make sense to use are '__all__' (roll all instances as a single unit), 'logical_zone_name' (roll instances by zone), '__name__' (roll one instance at a time, the default if not specified). Note that '__all__' is required when performing a major version upgrade

                        • allow_inline_resize boolean

                          Whether we allow changing the capacity of instances (default false). This is currently implemented by stopping, re-creating then starting the affected instance on its associated allocator when performing the changes. NOTES: This requires a round-trip through the allocation infrastructure of the active constructor, as it has to reserve the target capacity without over-committing

                        • skip_synced_flush boolean

                          Whether to skip attempting to do a synced flush on the filesystem of the container (default: false), which is less safe but may be required if the container is unhealthy

                        • shard_init_wait_time integer(int64)

                          The time, in seconds, to wait for shards that show no progress of initializing before rolling the next group (default: 10 minutes)

                      • grow_and_shrink object

                        A strategy that creates instances with the new plan, migrates data from the old instances, then shuts down the old instances. GrowShrinkStrategyConfig is safer than 'rolling' and ensures single node availability during a plan change, but can be a lot slower on larger clusters.

                      • rolling_grow_and_shrink object

                        A strategy that creates new Elasticsearch instances, Kibana instances, and APM Servers with the new plan, then migrates the node data to minimize the amount of spare capacity.

                      • autodetect object

                        A strategy that lets constructor choose the most optimal way to execute the plan.

                    • plan_configuration object
                      Hide plan_configuration attributes Show plan_configuration attributes object
                      • timeout integer(int64)

                        The total timeout in seconds after which the plan is cancelled even if it is not complete. Defaults to 4x the max memory capacity per node (in MB)

                      • calm_wait_time integer(int64)

                        This timeout determines how long to give a cluster after it responds to API calls before performing actual operations on it. It defaults to 5s

                      • move_instances array[object]

                        The request that specifies the Elasticsearch or stateless (eg Kibana) instances to move to allocators as part of the upgrade plan. When used in conjunction with '__all__' (roll all instances as a single unit) strategy, these instances are not restarted, which can sometimes enable recovery plans when these instances are boot-looping.

                        Hide move_instances attributes Show move_instances attributes object
                        • from string Required

                          The instance id that is going to be moved

                        • to array[string]

                          An optional list of allocator ids to which the instance should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)

                        • instance_down boolean

                          Tells the infrastructure that the instance should be considered as permanently down when deciding how to migrate data to new nodes. If left blank then the system will automatically decide (currently: will treat the instances as up)

                      • move_allocators array[object]

                        As part of the upgrade plan, identifies the move requests for the Kibana instances or APM Servers on the allocators.

                        Hide move_allocators attributes Show move_allocators attributes object
                        • from string Required

                          The allocator id off which all instances in the cluster should be moved

                        • to array[string]

                          An optional list of allocator ids to which the instance(s) should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)

                        • allocator_down boolean

                          Tells the infrastructure that all instances on the allocator should be considered as permanently down when deciding how to migrate data to new nodes. If left blank then the system will auto-decide (currently: will treat the allocator as up)

                      • reallocate_instances boolean

                        If true (default: false) does not allow re-using any existing instances currently in the cluster, ie even unchanged instances will be re-created

                      • preferred_allocators array[string]

                        List of allocators on which instances are placed if possible (if not possible/not specified then any available allocator with space is used)

                      • extended_maintenance boolean

                        If true (default false), does not clear the maintenance flag (which prevents its API from being accessed except by the constructor) on new instances added until after a snapshot has been restored, otherwise, the maintenance flag is cleared once the new instances successfully join the new cluster

                      • cluster_reboot string

                        Set to 'forced' to force a reboot as part of the upgrade plan

                        Value is forced.

                • plan_attempt_log array[object] Required

                  Information about a step in a plan.

                  Hide plan_attempt_log attributes Show plan_attempt_log attributes object
                  • step_id string Required

                    ID of current step

                  • started string(date-time) Required

                    When the step started (ISO format in UTC)

                  • completed string(date-time)

                    When the step completed (ISO format in UTC)

                  • duration_in_millis integer(int64)

                    The duration of the step in MS

                  • status string Required

                    The status of the step (success, warning, error - warning means something didn't go as expected but it was not serious enough to abort the plan)

                    Values are success, warning, error, or pending.

                  • stage string Required

                    Current stage that the step is in

                    Values are starting, completed, or in_progress.

                  • info_log array[object] Required

                    Human readable summaries of the step, including messages for each stage of the step

                    The log message from a specified stage of an executed step in a plan.

                    Hide info_log attributes Show info_log attributes object
                    • timestamp string(date-time) Required

                      Timestamp marking on info log of step

                    • delta_in_millis integer(int64)

                      Time in milliseconds since previous log message

                    • stage string Required

                      Stage that info log message takes place in

                      Values are starting, completed, or in_progress.

                    • message string Required

                      Human readable log message

                    • details object Required

                      A map with details for the log about what happened during the step execution. Keys and values for are always both strings, representing the name of the detail and its value, respectively.

                      Hide details attribute Show details attribute object
                      • * string Additional properties
                    • failure_type string

                      The failure type, in case the step failed

                • source object

                  Information describing the source that facilitated the plans current state

                  Hide source attributes Show source attributes object
                  • facilitator string Required

                    The service where the change originated from

                  • action string Required

                    The type of plan change that was initiated

                  • date string(date-time) Required

                    The time the change was initiated

                  • user_id string

                    The user that requested the change

                  • admin_id string

                    The admin user that requested the change

                  • remote_addresses array[string]

                    The host addresses of the user that originated the change

                • warnings array[object] Required

                  Information about a warning from a plan.

                  Hide warnings attributes Show warnings attributes object
                  • code string Required

                    A unique warning code

                  • message string Required

                    A description of the warning

                  • step_id string

                    The ID of the step which produced a warning, if any

                • error object

                  Information about an error during a plan attempt.

                  Hide error attributes Show error attributes object
                  • timestamp string(date-time) Required

                    Timestamp marking on info log of step

                  • message string Required

                    Human readable error message

                  • details object Required

                    A map with details regarding the error. Both the keys and values are always strings, representing the name of the detail and its value, respectively.

                    Hide details attribute Show details attribute object
                    • * string Additional properties
                  • failure_type string

                    The failure type

              • history array[object] Required

                Information about the App Search Server plan.

                Hide history attributes Show history attributes object
                • plan_attempt_id string

                  A UUID for each plan attempt

                • plan_attempt_name string

                  A human readable name for each plan attempt, only populated when retrieving plan histories

                • healthy boolean Required

                  Either the plan ended successfully, or is not yet completed (and no errors have occurred)

                • attempt_start_time string(date-time)

                  When this plan attempt (ie to apply the plan to the App Search) started (ISO format in UTC)

                • attempt_end_time string(date-time)

                  If this plan completed or failed (ie is not pending), when the attempt ended (ISO format in UTC)

                • plan_end_time string(date-time)

                  If this plan is not current or pending, when the plan was no longer active (ISO format in UTC)

                • plan object

                  The plan for the App Search cluster.

                  Hide plan attributes Show plan attributes object
                  • cluster_topology array[object]

                    Defines the topology of the AppSearch nodes (eg number/capacity of nodes, and where they can be allocated)

                    Hide cluster_topology attributes Show cluster_topology attributes object
                    • node_type object

                      Defines the AppSearch node type

                      Hide node_type attributes Show node_type attributes object
                      • appserver boolean Required

                        Defines whether this instance should run as Application/API server

                      • worker boolean Required

                        Defines whether this instance should run as background worker

                    • instance_configuration_id string

                      Controls the allocation of this topology element as well as allowed sizes and node_types. It needs to match the id of an existing instance configuration.

                    • instance_configuration_version integer(int32)

                      The version of the Instance Configuration Id. If it is unset, the meaning depends on read vs writes. For deployment reads, it is equivalent to version 0 (or the IC is unversioned); for deployment creates and deployment template use, it is equivalent to 'the latest version'; and for deployment updates, it is equivalent to 'retain the current version'.

                    • size object

                      Measured by the amount of a resource. The final cluster size is calculated using multipliers from the topology instance configuration.

                      Hide size attributes Show size attributes object
                      • value integer(int32) Required

                        Amount of resource

                      • resource string Required

                        Type of resource. In ESS the resource used should always be memory.

                        Values are memory or storage.

                    • zone_count integer(int32)

                      number of zones in which nodes will be placed

                    • appsearch object
                      Hide appsearch attributes Show appsearch attributes object
                      • version string

                        The version of the AppSearch cluster (must be one of the ECE supported versions, and won't work unless it matches the Elasticsearch version. Leave blank to auto-detect version.)

                      • docker_image string

                        A docker URI that allows overriding of the default docker image specified for this version

                      • system_settings object

                        This structure defines a curated subset of the AppSearch settings. (This field together with 'user_settings_override*' and 'user_settings*' defines the total set of AppSearch settings)

                        Hide system_settings attributes Show system_settings attributes object
                        • elasticsearch_url string

                          Optionally override the URL to which to send data (for advanced users only, if unspecified the system selects an internal URL)

                        • elasticsearch_username string

                          Optionally override the account within App Search - defaults to a system account that always exists (if specified, the password must also be specified). Note that this field is never returned from the API, it is write only.

                        • elasticsearch_password string

                          Optionally override the account within App Search - defaults to a system account that always exists (if specified, the username must also be specified). Note that this field is never returned from the API, it is write only.

                        • secret_session_key string

                          Optionally override the secret session key within App Search - defaults to the previously existing secretSession. Note that this field is never returned from the API, it is write only.

                      • user_settings_json object

                        An arbitrary JSON object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters are on the allowlist and not on the denylist. (This field together with 'user_settings_override*' and 'system_settings' defines the total set of AppSearch settings)

                      • user_settings_yaml string

                        An arbitrary YAML object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_json' is allowed), provided the parameters are on the allowlist and not on the denylist. (These field together with 'user_settings_override*' and 'system_settings' defines the total set of AppSearch settings)

                      • user_settings_override_json object

                        An arbitrary JSON object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of AppSearch settings)

                      • user_settings_override_yaml string

                        An arbitrary YAML object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_json' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of AppSearch settings)

                  • appsearch object Required
                    Hide appsearch attributes Show appsearch attributes object
                    • version string

                      The version of the AppSearch cluster (must be one of the ECE supported versions, and won't work unless it matches the Elasticsearch version. Leave blank to auto-detect version.)

                    • docker_image string

                      A docker URI that allows overriding of the default docker image specified for this version

                    • system_settings object

                      This structure defines a curated subset of the AppSearch settings. (This field together with 'user_settings_override*' and 'user_settings*' defines the total set of AppSearch settings)

                      Hide system_settings attributes Show system_settings attributes object
                      • elasticsearch_url string

                        Optionally override the URL to which to send data (for advanced users only, if unspecified the system selects an internal URL)

                      • elasticsearch_username string

                        Optionally override the account within App Search - defaults to a system account that always exists (if specified, the password must also be specified). Note that this field is never returned from the API, it is write only.

                      • elasticsearch_password string

                        Optionally override the account within App Search - defaults to a system account that always exists (if specified, the username must also be specified). Note that this field is never returned from the API, it is write only.

                      • secret_session_key string

                        Optionally override the secret session key within App Search - defaults to the previously existing secretSession. Note that this field is never returned from the API, it is write only.

                    • user_settings_json object

                      An arbitrary JSON object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters are on the allowlist and not on the denylist. (This field together with 'user_settings_override*' and 'system_settings' defines the total set of AppSearch settings)

                    • user_settings_yaml string

                      An arbitrary YAML object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_json' is allowed), provided the parameters are on the allowlist and not on the denylist. (These field together with 'user_settings_override*' and 'system_settings' defines the total set of AppSearch settings)

                    • user_settings_override_json object

                      An arbitrary JSON object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of AppSearch settings)

                    • user_settings_override_yaml string

                      An arbitrary YAML object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_json' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of AppSearch settings)

                  • transient object

                    Defines configuration parameters that control how the plan (ie consisting of the cluster topology and AppSearch settings) is applied

                    Hide transient attributes Show transient attributes object
                    • strategy object

                      The options for performing a plan change. Specify only one property each time. The default is grow_and_shrink.

                      Hide strategy attributes Show strategy attributes object
                      • rolling object

                        Performs inline, rolling configuration changes that mutate existing containers. TIP: This is the fastest way to update a plan, but can fail for complex plan changes, such as topology changes. Also, this is less safe for configuration changes that leave a cluster in a non running state. NOTE: When you perform a major version upgrade, and 'group_by' is set to 'pass:macros[all]';, rolling is required.

                        Hide rolling attributes Show rolling attributes object
                        • group_by string

                          Specifies the grouping attribute to use when rolling several instances. Instances that share the same value for the provided attribute key are rolled together as a unit. Examples that make sense to use are '__all__' (roll all instances as a single unit), 'logical_zone_name' (roll instances by zone), '__name__' (roll one instance at a time, the default if not specified). Note that '__all__' is required when performing a major version upgrade

                        • allow_inline_resize boolean

                          Whether we allow changing the capacity of instances (default false). This is currently implemented by stopping, re-creating then starting the affected instance on its associated allocator when performing the changes. NOTES: This requires a round-trip through the allocation infrastructure of the active constructor, as it has to reserve the target capacity without over-committing

                        • skip_synced_flush boolean

                          Whether to skip attempting to do a synced flush on the filesystem of the container (default: false), which is less safe but may be required if the container is unhealthy

                        • shard_init_wait_time integer(int64)

                          The time, in seconds, to wait for shards that show no progress of initializing before rolling the next group (default: 10 minutes)

                      • grow_and_shrink object

                        A strategy that creates instances with the new plan, migrates data from the old instances, then shuts down the old instances. GrowShrinkStrategyConfig is safer than 'rolling' and ensures single node availability during a plan change, but can be a lot slower on larger clusters.

                      • rolling_grow_and_shrink object

                        A strategy that creates new Elasticsearch instances, Kibana instances, and APM Servers with the new plan, then migrates the node data to minimize the amount of spare capacity.

                      • autodetect object

                        A strategy that lets constructor choose the most optimal way to execute the plan.

                    • plan_configuration object
                      Hide plan_configuration attributes Show plan_configuration attributes object
                      • timeout integer(int64)

                        The total timeout in seconds after which the plan is cancelled even if it is not complete. Defaults to 4x the max memory capacity per node (in MB)

                      • calm_wait_time integer(int64)

                        This timeout determines how long to give a cluster after it responds to API calls before performing actual operations on it. It defaults to 5s

                      • move_instances array[object]

                        The request that specifies the Elasticsearch or stateless (eg Kibana) instances to move to allocators as part of the upgrade plan. When used in conjunction with '__all__' (roll all instances as a single unit) strategy, these instances are not restarted, which can sometimes enable recovery plans when these instances are boot-looping.

                        Hide move_instances attributes Show move_instances attributes object
                        • from string Required

                          The instance id that is going to be moved

                        • to array[string]

                          An optional list of allocator ids to which the instance should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)

                        • instance_down boolean

                          Tells the infrastructure that the instance should be considered as permanently down when deciding how to migrate data to new nodes. If left blank then the system will automatically decide (currently: will treat the instances as up)

                      • move_allocators array[object]

                        As part of the upgrade plan, identifies the move requests for the Kibana instances or APM Servers on the allocators.

                        Hide move_allocators attributes Show move_allocators attributes object
                        • from string Required

                          The allocator id off which all instances in the cluster should be moved

                        • to array[string]

                          An optional list of allocator ids to which the instance(s) should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)

                        • allocator_down boolean

                          Tells the infrastructure that all instances on the allocator should be considered as permanently down when deciding how to migrate data to new nodes. If left blank then the system will auto-decide (currently: will treat the allocator as up)

                      • reallocate_instances boolean

                        If true (default: false) does not allow re-using any existing instances currently in the cluster, ie even unchanged instances will be re-created

                      • preferred_allocators array[string]

                        List of allocators on which instances are placed if possible (if not possible/not specified then any available allocator with space is used)

                      • extended_maintenance boolean

                        If true (default false), does not clear the maintenance flag (which prevents its API from being accessed except by the constructor) on new instances added until after a snapshot has been restored, otherwise, the maintenance flag is cleared once the new instances successfully join the new cluster

                      • cluster_reboot string

                        Set to 'forced' to force a reboot as part of the upgrade plan

                        Value is forced.

                • plan_attempt_log array[object] Required

                  Information about a step in a plan.

                  Hide plan_attempt_log attributes Show plan_attempt_log attributes object
                  • step_id string Required

                    ID of current step

                  • started string(date-time) Required

                    When the step started (ISO format in UTC)

                  • completed string(date-time)

                    When the step completed (ISO format in UTC)

                  • duration_in_millis integer(int64)

                    The duration of the step in MS

                  • status string Required

                    The status of the step (success, warning, error - warning means something didn't go as expected but it was not serious enough to abort the plan)

                    Values are success, warning, error, or pending.

                  • stage string Required

                    Current stage that the step is in

                    Values are starting, completed, or in_progress.

                  • info_log array[object] Required

                    Human readable summaries of the step, including messages for each stage of the step

                    The log message from a specified stage of an executed step in a plan.

                    Hide info_log attributes Show info_log attributes object
                    • timestamp string(date-time) Required

                      Timestamp marking on info log of step

                    • delta_in_millis integer(int64)

                      Time in milliseconds since previous log message

                    • stage string Required

                      Stage that info log message takes place in

                      Values are starting, completed, or in_progress.

                    • message string Required

                      Human readable log message

                    • details object Required

                      A map with details for the log about what happened during the step execution. Keys and values for are always both strings, representing the name of the detail and its value, respectively.

                      Hide details attribute Show details attribute object
                      • * string Additional properties
                    • failure_type string

                      The failure type, in case the step failed

                • source object

                  Information describing the source that facilitated the plans current state

                  Hide source attributes Show source attributes object
                  • facilitator string Required

                    The service where the change originated from

                  • action string Required

                    The type of plan change that was initiated

                  • date string(date-time) Required

                    The time the change was initiated

                  • user_id string

                    The user that requested the change

                  • admin_id string

                    The admin user that requested the change

                  • remote_addresses array[string]

                    The host addresses of the user that originated the change

                • warnings array[object] Required

                  Information about a warning from a plan.

                  Hide warnings attributes Show warnings attributes object
                  • code string Required

                    A unique warning code

                  • message string Required

                    A description of the warning

                  • step_id string

                    The ID of the step which produced a warning, if any

                • error object

                  Information about an error during a plan attempt.

                  Hide error attributes Show error attributes object
                  • timestamp string(date-time) Required

                    Timestamp marking on info log of step

                  • message string Required

                    Human readable error message

                  • details object Required

                    A map with details regarding the error. Both the keys and values are always strings, representing the name of the detail and its value, respectively.

                    Hide details attribute Show details attribute object
                    • * string Additional properties
                  • failure_type string

                    The failure type

            • metadata object

              Information about the public and internal state, and the configuration settings of an Elasticsearch cluster.

              Hide metadata attributes Show metadata attributes object
              • version integer(int32) Required

                The resource version number of the cluster metadata

              • last_modified string(date-time) Required

                The most recent time the cluster metadata was changed (ISO format in UTC)

              • endpoint string

                The DNS name of the cluster endpoint, if available

              • service_url string

                The full URL to access this deployment resource

              • aliased_endpoint string

                The DNS name of the cluster endpoint derived from the deployment alias, if available

              • aliased_url string

                The full aliased URL to access this deployment resource

              • cloud_id string

                The cloud ID, an encoded string that provides other Elastic services with the necessary information to connect to this Elasticsearch and Kibana (only present if both exist)

              • raw object

                An unstructured JSON representation of the public and internal state (can be filtered out via URL parameter). The contents and structure of the raw field can change at any time.

              • ports object

                The ports that allow communication with the cluster using various protocols.

                Hide ports attributes Show ports attributes object
                • http integer(int32) Required

                  Port where the cluster listens for HTTP traffic

                • https integer(int32) Required

                  Port where the cluster listens for HTTPS traffic

                • transport_passthrough integer(int32) Required

                  Port where the cluster listens for transport traffic using TLS

              • services_urls array[object]

                A list of the URLs to access services that the resource provides at this time. Note that if the service is not running or has not started yet, the URL to access it won't be available

                A URL to access the service of a resource

                Hide services_urls attributes Show services_urls attributes object
                • service string Required

                  Name of the service

                • url string Required

                  The full URL to access the service

            • topology object Required

              The topology for Elasticsearch clusters, multiple Kibana instances, or multiple APM Servers. The ClusterTopologyInfo also includes the instances and containers, and where they are located.

              Hide topology attributes Show topology attributes object
              • healthy boolean Required

                Whether the cluster topology is healthy (ie all instances are started and the services they run - ie elasticsearch - are available

              • instances array[object] Required

                Information about each Kibana instance and APM Server in the Elasticsearch cluster.

                Hide instances attributes Show instances attributes object
                • instance_name string Required

                  The name of the instance in Elastic Cloud

                • instance_configuration object

                  Information about a configuration that creates a Kibana instance or APM Server.

                  Hide instance_configuration attributes Show instance_configuration attributes object
                  • id string Required

                    The id of the configuration used to create the instance

                  • name string Required

                    The name of the configuration used to create the instance

                  • config_version integer(int32)

                    If the IC is configuration controlled, this field is the version either being read back (reads return the latest IC unless specified by the 'config_version' URL param), or the version to update. Cannot be used in creates. For unversioned IC reads it is left empty.

                  • resource string Required

                    The resource type of the instance configuration

                    Values are memory or storage.

                • service_version string

                  The version of the service that the instance is running (eg Elasticsearch or Kibana), if available

                • healthy boolean Required

                  Whether the instance is healthy (ie started and running)

                • container_started boolean Required

                  Whether the container has started (does not tell you anything about the service -ie Elasticsearch- running inside the container)

                • service_running boolean Required

                  Whether the service launched inside the container -ie Elasticsearch- is actually running

                • maintenance_mode boolean Required

                  Whether the service is is maintenance mode (meaning that the proxy is not routing external traffic to it)

                • zone string

                  The zone in which this instance is being allocated

                • allocator_id string

                  The id of the allocator on which this instance is running (if the container is started or starting)

                • memory object

                  Information about the specific instances memory capacity and its usage

                  Hide memory attributes Show memory attributes object
                  • instance_capacity integer(int32) Required

                    The memory capacity in MB of the instance

                  • instance_capacity_planned integer(int32)

                    The planned memory capacity in MB of the instance (only shown when an override is present)

                  • memory_pressure integer(int32)

                    The % memory pressure of Elasticsearch JVM heap space if available (60-75% consider increasing capacity, >75% can incur significant performance and stability issues)

                  • native_memory_pressure integer(int32)

                    The % memory pressure of the instance Docker container (if available)

                • disk object

                  Information about the use and storage capacity of a Kibana instance or APM Server.

                  Hide disk attributes Show disk attributes object
                  • disk_space_available integer(int64)

                    If known, the amount of total disk space available to the container in MB

                  • disk_space_used integer(int64) Required

                    The amount of disk space being used by the service in MB

                  • storage_multiplier number(double) Required

                    The storage multiplier originally defined to calculate disk space.

                • service_roles array[string]

                  List of roles assigned to the service running in the instance. Currently only populated for Elasticsearch, with possible values: master,data,ingest,ml

                • node_roles array[string]

                  A list of the node roles assigned to the service running in the instance. Currently populated only for Elasticsearch.

                  Values are master, ingest, ml, data_hot, data_content, data_warm, data_cold, data_frozen, remote_cluster_client, transform, or voting_only.

                • instance_overrides object

                  Instance overrides

                  Hide instance_overrides attributes Show instance_overrides attributes object
                  • capacity integer(int32)

                    Sets the memory capacity for the instances container. Requires a restart to take effect.

                  • storage_multiplier number(double)

                    Overrides the disk quota multiplier for the instance

            • external_links array[object] Required

              External resources related to the App Search

              Hide external_links attributes Show external_links attributes object
              • id string Required

                Identifier of the external link

              • label string Required

                Human-readable description of the external link

              • uri string

                hyperlink to an external resource

            • links object

              A map of application-specific operations (which map to 'operationId's in the Swagger API) to metadata about that operation

              Hide links attribute Show links attribute object
              • * object Additional properties
                Hide * attribute Show * attribute object
                • need_elevated_permissions boolean

                  Whether the operation requires elevated permissions (when the field is present, elevated permissions are required).

            • settings object

              The settings for building this AppSearch cluster

              Hide settings attribute Show settings attribute object
              • metadata object

                The top-level configuration settings for the Elasticsearch cluster.

                Hide metadata attribute Show metadata attribute object
                • name string

                  The display name of the cluster

            • region string

              The region that this App Search belongs to. Only populated in SaaS or federated ECE.

        • enterprise_search array[object] Required

          List of Enterprise Search resources in your Deployment

          Describes an Enterprise Search resource belonging to a Deployment

          Hide enterprise_search attributes Show enterprise_search attributes object
          • ref_id string Required

            The locally-unique user-specified id of a Resource

          • elasticsearch_cluster_ref_id string Required

            The Elasticsearch cluster that this resource depends on.

          • id string Required

            The randomly-generated id of a Resource

          • region string Required

            The region where this resource exists

          • info object Required

            Info for the resource.

            Hide info attributes Show info attributes object
            • id string Required

              The id of the Enterprise Search

            • name string Required

              The name of the Enterprise Search

            • elasticsearch_cluster object Required

              Information about the specified Elasticsearch cluster.

              Hide elasticsearch_cluster attributes Show elasticsearch_cluster attributes object
              • elasticsearch_id string Required

                The Elasticsearch cluster Id

              • links object

                A map of application-specific operations (which map to 'operationId's in the Swagger API) to metadata about that operation

                Hide links attribute Show links attribute object
                • * object Additional properties
                  Hide * attribute Show * attribute object
                  • need_elevated_permissions boolean

                    Whether the operation requires elevated permissions (when the field is present, elevated permissions are required).

            • deployment_id string

              The id of the deployment that this Enterprise Search belongs to.

            • healthy boolean Required

              Whether the Enterprise Search is healthy or not (one or more of the info subsections will have healthy: false)

            • status string Required

              Enterprise Search status

              Values are initializing, stopping, stopped, rebooting, restarting, reconfiguring, or started.

            • plan_info object Required

              Information about current, pending, and past Enterprise Search Server plans.

              Hide plan_info attributes Show plan_info attributes object
              • healthy boolean Required

                Whether the plan situation is healthy (if unhealthy, means the last plan attempt failed)

              • current object

                Information about the Enterprise Search Server plan.

                Hide current attributes Show current attributes object
                • plan_attempt_id string

                  A UUID for each plan attempt

                • plan_attempt_name string

                  A human readable name for each plan attempt, only populated when retrieving plan histories

                • healthy boolean Required

                  Either the plan ended successfully, or is not yet completed (and no errors have occurred)

                • attempt_start_time string(date-time)

                  When this plan attempt (ie to apply the plan to the Enterprise Search) started (ISO format in UTC)

                • attempt_end_time string(date-time)

                  If this plan completed or failed (ie is not pending), when the attempt ended (ISO format in UTC)

                • plan_end_time string(date-time)

                  If this plan is not current or pending, when the plan was no longer active (ISO format in UTC)

                • plan object

                  The plan for the Enterprise Search cluster.

                  Hide plan attributes Show plan attributes object
                  • cluster_topology array[object]

                    Defines the topology of the Enterprise Search nodes (e.g. number/capacity of nodes, and where they can be allocated)

                    Hide cluster_topology attributes Show cluster_topology attributes object
                    • node_type object

                      Defines the EnterpriseSearch node type

                      Hide node_type attributes Show node_type attributes object
                      • appserver boolean Required

                        Defines whether this instance should run as Application/API server

                      • worker boolean Required

                        Defines whether this instance should run as background worker

                      • connector boolean Required

                        Defines whether this instance should run as Connector

                    • instance_configuration_id string

                      Controls the allocation of this topology element as well as allowed sizes and node_types. It needs to match the id of an existing instance configuration.

                    • instance_configuration_version integer(int32)

                      The version of the Instance Configuration Id. If it is unset, the meaning depends on read vs writes. For deployment reads, it is equivalent to version 0 (or the IC is unversioned); for deployment creates and deployment template use, it is equivalent to 'the latest version'; and for deployment updates, it is equivalent to 'retain the current version'.

                    • size object

                      Measured by the amount of a resource. The final cluster size is calculated using multipliers from the topology instance configuration.

                      Hide size attributes Show size attributes object
                      • value integer(int32) Required

                        Amount of resource

                      • resource string Required

                        Type of resource. In ESS the resource used should always be memory.

                        Values are memory or storage.

                    • zone_count integer(int32)

                      number of zones in which nodes will be placed

                    • enterprise_search object
                      Hide enterprise_search attributes Show enterprise_search attributes object
                      • version string

                        The version of the Enterprise Search cluster (must be one of the ECE supported versions, and won't work unless it matches the Elasticsearch version. Leave blank to auto-detect version.)

                      • docker_image string

                        A docker URI that allows overriding of the default docker image specified for this version

                      • system_settings object

                        This structure defines a curated subset of the Enterprise Search settings. (This field together with 'user_settings_override*' and 'user_settings*' defines the total set of Enterprise Search settings)

                        Hide system_settings attributes Show system_settings attributes object
                        • elasticsearch_username string

                          Optionally override the account within Enterprise Search - defaults to a system account that always exists (if specified, the password must also be specified). Note that this field is never returned from the API, it is write only.

                        • elasticsearch_password string

                          Optionally override the account within Enterprise Search - defaults to a system account that always exists (if specified, the username must also be specified). Note that this field is never returned from the API, it is write only.

                        • secret_session_key string

                          Optionally override the secret session key within Enterprise Search - defaults to the previously existing secretSession. Note that this field is never returned from the API, it is write only.

                      • user_settings_json object

                        An arbitrary JSON object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters are on the allowlist and not on the denylist. (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Enterprise Search settings)

                      • user_settings_yaml string

                        An arbitrary YAML object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_json' is allowed), provided the parameters are on the allowlist and not on the denylist. (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Enterprise Search settings)

                      • user_settings_override_json object

                        An arbitrary JSON object allowing ECE admins to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), i.e. in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Enterprise Search settings)

                      • user_settings_override_yaml string

                        An arbitrary YAML object allowing ECE admins to set clusters' parameters (only one of this and 'user_settings_override_json' is allowed), i.e. in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Enterprise Search settings)

                    • allocator_filter object
                    • node_configuration string
                    • memory_per_node object
                    • node_count_per_zone object
                  • enterprise_search object Required
                    Hide enterprise_search attributes Show enterprise_search attributes object
                    • version string

                      The version of the Enterprise Search cluster (must be one of the ECE supported versions, and won't work unless it matches the Elasticsearch version. Leave blank to auto-detect version.)

                    • docker_image string

                      A docker URI that allows overriding of the default docker image specified for this version

                    • system_settings object

                      This structure defines a curated subset of the Enterprise Search settings. (This field together with 'user_settings_override*' and 'user_settings*' defines the total set of Enterprise Search settings)

                      Hide system_settings attributes Show system_settings attributes object
                      • elasticsearch_username string

                        Optionally override the account within Enterprise Search - defaults to a system account that always exists (if specified, the password must also be specified). Note that this field is never returned from the API, it is write only.

                      • elasticsearch_password string

                        Optionally override the account within Enterprise Search - defaults to a system account that always exists (if specified, the username must also be specified). Note that this field is never returned from the API, it is write only.

                      • secret_session_key string

                        Optionally override the secret session key within Enterprise Search - defaults to the previously existing secretSession. Note that this field is never returned from the API, it is write only.

                    • user_settings_json object

                      An arbitrary JSON object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters are on the allowlist and not on the denylist. (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Enterprise Search settings)

                    • user_settings_yaml string

                      An arbitrary YAML object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_json' is allowed), provided the parameters are on the allowlist and not on the denylist. (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Enterprise Search settings)

                    • user_settings_override_json object

                      An arbitrary JSON object allowing ECE admins to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), i.e. in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Enterprise Search settings)

                    • user_settings_override_yaml string

                      An arbitrary YAML object allowing ECE admins to set clusters' parameters (only one of this and 'user_settings_override_json' is allowed), i.e. in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Enterprise Search settings)

                  • transient object

                    Defines configuration parameters that control how the plan (i.e. consisting of the cluster topology and Enterprise Search settings) is applied

                    Hide transient attributes Show transient attributes object
                    • strategy object

                      The options for performing a plan change. Specify only one property each time. The default is grow_and_shrink.

                      Hide strategy attributes Show strategy attributes object
                      • rolling object

                        Performs inline, rolling configuration changes that mutate existing containers. TIP: This is the fastest way to update a plan, but can fail for complex plan changes, such as topology changes. Also, this is less safe for configuration changes that leave a cluster in a non running state. NOTE: When you perform a major version upgrade, and 'group_by' is set to 'pass:macros[all]';, rolling is required.

                        Hide rolling attributes Show rolling attributes object
                        • group_by string

                          Specifies the grouping attribute to use when rolling several instances. Instances that share the same value for the provided attribute key are rolled together as a unit. Examples that make sense to use are '__all__' (roll all instances as a single unit), 'logical_zone_name' (roll instances by zone), '__name__' (roll one instance at a time, the default if not specified). Note that '__all__' is required when performing a major version upgrade

                        • allow_inline_resize boolean

                          Whether we allow changing the capacity of instances (default false). This is currently implemented by stopping, re-creating then starting the affected instance on its associated allocator when performing the changes. NOTES: This requires a round-trip through the allocation infrastructure of the active constructor, as it has to reserve the target capacity without over-committing

                        • skip_synced_flush boolean

                          Whether to skip attempting to do a synced flush on the filesystem of the container (default: false), which is less safe but may be required if the container is unhealthy

                        • shard_init_wait_time integer(int64)

                          The time, in seconds, to wait for shards that show no progress of initializing before rolling the next group (default: 10 minutes)

                      • grow_and_shrink object

                        A strategy that creates instances with the new plan, migrates data from the old instances, then shuts down the old instances. GrowShrinkStrategyConfig is safer than 'rolling' and ensures single node availability during a plan change, but can be a lot slower on larger clusters.

                      • rolling_grow_and_shrink object

                        A strategy that creates new Elasticsearch instances, Kibana instances, and APM Servers with the new plan, then migrates the node data to minimize the amount of spare capacity.

                      • autodetect object

                        A strategy that lets constructor choose the most optimal way to execute the plan.

                    • plan_configuration object
                      Hide plan_configuration attributes Show plan_configuration attributes object
                      • timeout integer(int64)

                        The total timeout in seconds after which the plan is cancelled even if it is not complete. Defaults to 4x the max memory capacity per node (in MB)

                      • calm_wait_time integer(int64)

                        This timeout determines how long to give a cluster after it responds to API calls before performing actual operations on it. It defaults to 5s

                      • move_instances array[object]

                        The request that specifies the Elasticsearch or stateless (eg Kibana) instances to move to allocators as part of the upgrade plan. When used in conjunction with '__all__' (roll all instances as a single unit) strategy, these instances are not restarted, which can sometimes enable recovery plans when these instances are boot-looping.

                        Hide move_instances attributes Show move_instances attributes object
                        • from string Required

                          The instance id that is going to be moved

                        • to array[string]

                          An optional list of allocator ids to which the instance should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)

                        • instance_down boolean

                          Tells the infrastructure that the instance should be considered as permanently down when deciding how to migrate data to new nodes. If left blank then the system will automatically decide (currently: will treat the instances as up)

                      • move_allocators array[object]

                        As part of the upgrade plan, identifies the move requests for the Kibana instances or APM Servers on the allocators.

                        Hide move_allocators attributes Show move_allocators attributes object
                        • from string Required

                          The allocator id off which all instances in the cluster should be moved

                        • to array[string]

                          An optional list of allocator ids to which the instance(s) should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)

                        • allocator_down boolean

                          Tells the infrastructure that all instances on the allocator should be considered as permanently down when deciding how to migrate data to new nodes. If left blank then the system will auto-decide (currently: will treat the allocator as up)

                      • reallocate_instances boolean

                        If true (default: false) does not allow re-using any existing instances currently in the cluster, i.e. even unchanged instances will be re-created

                      • preferred_allocators array[string]

                        List of allocators on which instances are placed if possible (if not possible/not specified then any available allocator with space is used)

                      • extended_maintenance boolean

                        If true (default false), does not clear the maintenance flag (which prevents its API from being accessed except by the constructor) on new instances added until after a snapshot has been restored, otherwise, the maintenance flag is cleared once the new instances successfully join the new cluster

                      • cluster_reboot string

                        Set to 'forced' to force a reboot as part of the upgrade plan

                        Value is forced.

                • plan_attempt_log array[object] Required

                  Information about a step in a plan.

                  Hide plan_attempt_log attributes Show plan_attempt_log attributes object
                  • step_id string Required

                    ID of current step

                  • started string(date-time) Required

                    When the step started (ISO format in UTC)

                  • completed string(date-time)

                    When the step completed (ISO format in UTC)

                  • duration_in_millis integer(int64)

                    The duration of the step in MS

                  • status string Required

                    The status of the step (success, warning, error - warning means something didn't go as expected but it was not serious enough to abort the plan)

                    Values are success, warning, error, or pending.

                  • stage string Required

                    Current stage that the step is in

                    Values are starting, completed, or in_progress.

                  • info_log array[object] Required

                    Human readable summaries of the step, including messages for each stage of the step

                    The log message from a specified stage of an executed step in a plan.

                    Hide info_log attributes Show info_log attributes object
                    • timestamp string(date-time) Required

                      Timestamp marking on info log of step

                    • delta_in_millis integer(int64)

                      Time in milliseconds since previous log message

                    • stage string Required

                      Stage that info log message takes place in

                      Values are starting, completed, or in_progress.

                    • message string Required

                      Human readable log message

                    • details object Required

                      A map with details for the log about what happened during the step execution. Keys and values for are always both strings, representing the name of the detail and its value, respectively.

                      Hide details attribute Show details attribute object
                      • * string Additional properties
                    • failure_type string

                      The failure type, in case the step failed

                • source object

                  Information describing the source that facilitated the plans current state

                  Hide source attributes Show source attributes object
                  • facilitator string Required

                    The service where the change originated from

                  • action string Required

                    The type of plan change that was initiated

                  • date string(date-time) Required

                    The time the change was initiated

                  • user_id string

                    The user that requested the change

                  • admin_id string

                    The admin user that requested the change

                  • remote_addresses array[string]

                    The host addresses of the user that originated the change

                • warnings array[object] Required

                  Information about a warning from a plan.

                  Hide warnings attributes Show warnings attributes object
                  • code string Required

                    A unique warning code

                  • message string Required

                    A description of the warning

                  • step_id string

                    The ID of the step which produced a warning, if any

                • error object

                  Information about an error during a plan attempt.

                  Hide error attributes Show error attributes object
                  • timestamp string(date-time) Required

                    Timestamp marking on info log of step

                  • message string Required

                    Human readable error message

                  • details object Required

                    A map with details regarding the error. Both the keys and values are always strings, representing the name of the detail and its value, respectively.

                    Hide details attribute Show details attribute object
                    • * string Additional properties
                  • failure_type string

                    The failure type

              • pending object

                Information about the Enterprise Search Server plan.

                Hide pending attributes Show pending attributes object
                • plan_attempt_id string

                  A UUID for each plan attempt

                • plan_attempt_name string

                  A human readable name for each plan attempt, only populated when retrieving plan histories

                • healthy boolean Required

                  Either the plan ended successfully, or is not yet completed (and no errors have occurred)

                • attempt_start_time string(date-time)

                  When this plan attempt (ie to apply the plan to the Enterprise Search) started (ISO format in UTC)

                • attempt_end_time string(date-time)

                  If this plan completed or failed (ie is not pending), when the attempt ended (ISO format in UTC)

                • plan_end_time string(date-time)

                  If this plan is not current or pending, when the plan was no longer active (ISO format in UTC)

                • plan object

                  The plan for the Enterprise Search cluster.

                  Hide plan attributes Show plan attributes object
                  • cluster_topology array[object]

                    Defines the topology of the Enterprise Search nodes (e.g. number/capacity of nodes, and where they can be allocated)

                    Hide cluster_topology attributes Show cluster_topology attributes object
                    • node_type object

                      Defines the EnterpriseSearch node type

                      Hide node_type attributes Show node_type attributes object
                      • appserver boolean Required

                        Defines whether this instance should run as Application/API server

                      • worker boolean Required

                        Defines whether this instance should run as background worker

                      • connector boolean Required

                        Defines whether this instance should run as Connector

                    • instance_configuration_id string

                      Controls the allocation of this topology element as well as allowed sizes and node_types. It needs to match the id of an existing instance configuration.

                    • instance_configuration_version integer(int32)

                      The version of the Instance Configuration Id. If it is unset, the meaning depends on read vs writes. For deployment reads, it is equivalent to version 0 (or the IC is unversioned); for deployment creates and deployment template use, it is equivalent to 'the latest version'; and for deployment updates, it is equivalent to 'retain the current version'.

                    • size object

                      Measured by the amount of a resource. The final cluster size is calculated using multipliers from the topology instance configuration.

                      Hide size attributes Show size attributes object
                      • value integer(int32) Required

                        Amount of resource

                      • resource string Required

                        Type of resource. In ESS the resource used should always be memory.

                        Values are memory or storage.

                    • zone_count integer(int32)

                      number of zones in which nodes will be placed

                    • enterprise_search object
                      Hide enterprise_search attributes Show enterprise_search attributes object
                      • version string

                        The version of the Enterprise Search cluster (must be one of the ECE supported versions, and won't work unless it matches the Elasticsearch version. Leave blank to auto-detect version.)

                      • docker_image string

                        A docker URI that allows overriding of the default docker image specified for this version

                      • system_settings object

                        This structure defines a curated subset of the Enterprise Search settings. (This field together with 'user_settings_override*' and 'user_settings*' defines the total set of Enterprise Search settings)

                        Hide system_settings attributes Show system_settings attributes object
                        • elasticsearch_username string

                          Optionally override the account within Enterprise Search - defaults to a system account that always exists (if specified, the password must also be specified). Note that this field is never returned from the API, it is write only.

                        • elasticsearch_password string

                          Optionally override the account within Enterprise Search - defaults to a system account that always exists (if specified, the username must also be specified). Note that this field is never returned from the API, it is write only.

                        • secret_session_key string

                          Optionally override the secret session key within Enterprise Search - defaults to the previously existing secretSession. Note that this field is never returned from the API, it is write only.

                      • user_settings_json object

                        An arbitrary JSON object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters are on the allowlist and not on the denylist. (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Enterprise Search settings)

                      • user_settings_yaml string

                        An arbitrary YAML object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_json' is allowed), provided the parameters are on the allowlist and not on the denylist. (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Enterprise Search settings)

                      • user_settings_override_json object

                        An arbitrary JSON object allowing ECE admins to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), i.e. in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Enterprise Search settings)

                      • user_settings_override_yaml string

                        An arbitrary YAML object allowing ECE admins to set clusters' parameters (only one of this and 'user_settings_override_json' is allowed), i.e. in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Enterprise Search settings)

                    • allocator_filter object
                    • node_configuration string
                    • memory_per_node object
                    • node_count_per_zone object
                  • enterprise_search object Required
                    Hide enterprise_search attributes Show enterprise_search attributes object
                    • version string

                      The version of the Enterprise Search cluster (must be one of the ECE supported versions, and won't work unless it matches the Elasticsearch version. Leave blank to auto-detect version.)

                    • docker_image string

                      A docker URI that allows overriding of the default docker image specified for this version

                    • system_settings object

                      This structure defines a curated subset of the Enterprise Search settings. (This field together with 'user_settings_override*' and 'user_settings*' defines the total set of Enterprise Search settings)

                      Hide system_settings attributes Show system_settings attributes object
                      • elasticsearch_username string

                        Optionally override the account within Enterprise Search - defaults to a system account that always exists (if specified, the password must also be specified). Note that this field is never returned from the API, it is write only.

                      • elasticsearch_password string

                        Optionally override the account within Enterprise Search - defaults to a system account that always exists (if specified, the username must also be specified). Note that this field is never returned from the API, it is write only.

                      • secret_session_key string

                        Optionally override the secret session key within Enterprise Search - defaults to the previously existing secretSession. Note that this field is never returned from the API, it is write only.

                    • user_settings_json object

                      An arbitrary JSON object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters are on the allowlist and not on the denylist. (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Enterprise Search settings)

                    • user_settings_yaml string

                      An arbitrary YAML object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_json' is allowed), provided the parameters are on the allowlist and not on the denylist. (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Enterprise Search settings)

                    • user_settings_override_json object

                      An arbitrary JSON object allowing ECE admins to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), i.e. in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Enterprise Search settings)

                    • user_settings_override_yaml string

                      An arbitrary YAML object allowing ECE admins to set clusters' parameters (only one of this and 'user_settings_override_json' is allowed), i.e. in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Enterprise Search settings)

                  • transient object

                    Defines configuration parameters that control how the plan (i.e. consisting of the cluster topology and Enterprise Search settings) is applied

                    Hide transient attributes Show transient attributes object
                    • strategy object

                      The options for performing a plan change. Specify only one property each time. The default is grow_and_shrink.

                      Hide strategy attributes Show strategy attributes object
                      • rolling object

                        Performs inline, rolling configuration changes that mutate existing containers. TIP: This is the fastest way to update a plan, but can fail for complex plan changes, such as topology changes. Also, this is less safe for configuration changes that leave a cluster in a non running state. NOTE: When you perform a major version upgrade, and 'group_by' is set to 'pass:macros[all]';, rolling is required.

                        Hide rolling attributes Show rolling attributes object
                        • group_by string

                          Specifies the grouping attribute to use when rolling several instances. Instances that share the same value for the provided attribute key are rolled together as a unit. Examples that make sense to use are '__all__' (roll all instances as a single unit), 'logical_zone_name' (roll instances by zone), '__name__' (roll one instance at a time, the default if not specified). Note that '__all__' is required when performing a major version upgrade

                        • allow_inline_resize boolean

                          Whether we allow changing the capacity of instances (default false). This is currently implemented by stopping, re-creating then starting the affected instance on its associated allocator when performing the changes. NOTES: This requires a round-trip through the allocation infrastructure of the active constructor, as it has to reserve the target capacity without over-committing

                        • skip_synced_flush boolean

                          Whether to skip attempting to do a synced flush on the filesystem of the container (default: false), which is less safe but may be required if the container is unhealthy

                        • shard_init_wait_time integer(int64)

                          The time, in seconds, to wait for shards that show no progress of initializing before rolling the next group (default: 10 minutes)

                      • grow_and_shrink object

                        A strategy that creates instances with the new plan, migrates data from the old instances, then shuts down the old instances. GrowShrinkStrategyConfig is safer than 'rolling' and ensures single node availability during a plan change, but can be a lot slower on larger clusters.

                      • rolling_grow_and_shrink object

                        A strategy that creates new Elasticsearch instances, Kibana instances, and APM Servers with the new plan, then migrates the node data to minimize the amount of spare capacity.

                      • autodetect object

                        A strategy that lets constructor choose the most optimal way to execute the plan.

                    • plan_configuration object
                      Hide plan_configuration attributes Show plan_configuration attributes object
                      • timeout integer(int64)

                        The total timeout in seconds after which the plan is cancelled even if it is not complete. Defaults to 4x the max memory capacity per node (in MB)

                      • calm_wait_time integer(int64)

                        This timeout determines how long to give a cluster after it responds to API calls before performing actual operations on it. It defaults to 5s

                      • move_instances array[object]

                        The request that specifies the Elasticsearch or stateless (eg Kibana) instances to move to allocators as part of the upgrade plan. When used in conjunction with '__all__' (roll all instances as a single unit) strategy, these instances are not restarted, which can sometimes enable recovery plans when these instances are boot-looping.

                        Hide move_instances attributes Show move_instances attributes object
                        • from string Required

                          The instance id that is going to be moved

                        • to array[string]

                          An optional list of allocator ids to which the instance should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)

                        • instance_down boolean

                          Tells the infrastructure that the instance should be considered as permanently down when deciding how to migrate data to new nodes. If left blank then the system will automatically decide (currently: will treat the instances as up)

                      • move_allocators array[object]

                        As part of the upgrade plan, identifies the move requests for the Kibana instances or APM Servers on the allocators.

                        Hide move_allocators attributes Show move_allocators attributes object
                        • from string Required

                          The allocator id off which all instances in the cluster should be moved

                        • to array[string]

                          An optional list of allocator ids to which the instance(s) should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)

                        • allocator_down boolean

                          Tells the infrastructure that all instances on the allocator should be considered as permanently down when deciding how to migrate data to new nodes. If left blank then the system will auto-decide (currently: will treat the allocator as up)

                      • reallocate_instances boolean

                        If true (default: false) does not allow re-using any existing instances currently in the cluster, i.e. even unchanged instances will be re-created

                      • preferred_allocators array[string]

                        List of allocators on which instances are placed if possible (if not possible/not specified then any available allocator with space is used)

                      • extended_maintenance boolean

                        If true (default false), does not clear the maintenance flag (which prevents its API from being accessed except by the constructor) on new instances added until after a snapshot has been restored, otherwise, the maintenance flag is cleared once the new instances successfully join the new cluster

                      • cluster_reboot string

                        Set to 'forced' to force a reboot as part of the upgrade plan

                        Value is forced.

                • plan_attempt_log array[object] Required

                  Information about a step in a plan.

                  Hide plan_attempt_log attributes Show plan_attempt_log attributes object
                  • step_id string Required

                    ID of current step

                  • started string(date-time) Required

                    When the step started (ISO format in UTC)

                  • completed string(date-time)

                    When the step completed (ISO format in UTC)

                  • duration_in_millis integer(int64)

                    The duration of the step in MS

                  • status string Required

                    The status of the step (success, warning, error - warning means something didn't go as expected but it was not serious enough to abort the plan)

                    Values are success, warning, error, or pending.

                  • stage string Required

                    Current stage that the step is in

                    Values are starting, completed, or in_progress.

                  • info_log array[object] Required

                    Human readable summaries of the step, including messages for each stage of the step

                    The log message from a specified stage of an executed step in a plan.

                    Hide info_log attributes Show info_log attributes object
                    • timestamp string(date-time) Required

                      Timestamp marking on info log of step

                    • delta_in_millis integer(int64)

                      Time in milliseconds since previous log message

                    • stage string Required

                      Stage that info log message takes place in

                      Values are starting, completed, or in_progress.

                    • message string Required

                      Human readable log message

                    • details object Required

                      A map with details for the log about what happened during the step execution. Keys and values for are always both strings, representing the name of the detail and its value, respectively.

                      Hide details attribute Show details attribute object
                      • * string Additional properties
                    • failure_type string

                      The failure type, in case the step failed

                • source object

                  Information describing the source that facilitated the plans current state

                  Hide source attributes Show source attributes object
                  • facilitator string Required

                    The service where the change originated from

                  • action string Required

                    The type of plan change that was initiated

                  • date string(date-time) Required

                    The time the change was initiated

                  • user_id string

                    The user that requested the change

                  • admin_id string

                    The admin user that requested the change

                  • remote_addresses array[string]

                    The host addresses of the user that originated the change

                • warnings array[object] Required

                  Information about a warning from a plan.

                  Hide warnings attributes Show warnings attributes object
                  • code string Required

                    A unique warning code

                  • message string Required

                    A description of the warning

                  • step_id string

                    The ID of the step which produced a warning, if any

                • error object

                  Information about an error during a plan attempt.

                  Hide error attributes Show error attributes object
                  • timestamp string(date-time) Required

                    Timestamp marking on info log of step

                  • message string Required

                    Human readable error message

                  • details object Required

                    A map with details regarding the error. Both the keys and values are always strings, representing the name of the detail and its value, respectively.

                    Hide details attribute Show details attribute object
                    • * string Additional properties
                  • failure_type string

                    The failure type

              • history array[object] Required

                Information about the Enterprise Search Server plan.

                Hide history attributes Show history attributes object
                • plan_attempt_id string

                  A UUID for each plan attempt

                • plan_attempt_name string

                  A human readable name for each plan attempt, only populated when retrieving plan histories

                • healthy boolean Required

                  Either the plan ended successfully, or is not yet completed (and no errors have occurred)

                • attempt_start_time string(date-time)

                  When this plan attempt (ie to apply the plan to the Enterprise Search) started (ISO format in UTC)

                • attempt_end_time string(date-time)

                  If this plan completed or failed (ie is not pending), when the attempt ended (ISO format in UTC)

                • plan_end_time string(date-time)

                  If this plan is not current or pending, when the plan was no longer active (ISO format in UTC)

                • plan object

                  The plan for the Enterprise Search cluster.

                  Hide plan attributes Show plan attributes object
                  • cluster_topology array[object]

                    Defines the topology of the Enterprise Search nodes (e.g. number/capacity of nodes, and where they can be allocated)

                    Hide cluster_topology attributes Show cluster_topology attributes object
                    • node_type object

                      Defines the EnterpriseSearch node type

                      Hide node_type attributes Show node_type attributes object
                      • appserver boolean Required

                        Defines whether this instance should run as Application/API server

                      • worker boolean Required

                        Defines whether this instance should run as background worker

                      • connector boolean Required

                        Defines whether this instance should run as Connector

                    • instance_configuration_id string

                      Controls the allocation of this topology element as well as allowed sizes and node_types. It needs to match the id of an existing instance configuration.

                    • instance_configuration_version integer(int32)

                      The version of the Instance Configuration Id. If it is unset, the meaning depends on read vs writes. For deployment reads, it is equivalent to version 0 (or the IC is unversioned); for deployment creates and deployment template use, it is equivalent to 'the latest version'; and for deployment updates, it is equivalent to 'retain the current version'.

                    • size object

                      Measured by the amount of a resource. The final cluster size is calculated using multipliers from the topology instance configuration.

                      Hide size attributes Show size attributes object
                      • value integer(int32) Required

                        Amount of resource

                      • resource string Required

                        Type of resource. In ESS the resource used should always be memory.

                        Values are memory or storage.

                    • zone_count integer(int32)

                      number of zones in which nodes will be placed

                    • enterprise_search object
                      Hide enterprise_search attributes Show enterprise_search attributes object
                      • version string

                        The version of the Enterprise Search cluster (must be one of the ECE supported versions, and won't work unless it matches the Elasticsearch version. Leave blank to auto-detect version.)

                      • docker_image string

                        A docker URI that allows overriding of the default docker image specified for this version

                      • system_settings object

                        This structure defines a curated subset of the Enterprise Search settings. (This field together with 'user_settings_override*' and 'user_settings*' defines the total set of Enterprise Search settings)

                        Hide system_settings attributes Show system_settings attributes object
                        • elasticsearch_username string

                          Optionally override the account within Enterprise Search - defaults to a system account that always exists (if specified, the password must also be specified). Note that this field is never returned from the API, it is write only.

                        • elasticsearch_password string

                          Optionally override the account within Enterprise Search - defaults to a system account that always exists (if specified, the username must also be specified). Note that this field is never returned from the API, it is write only.

                        • secret_session_key string

                          Optionally override the secret session key within Enterprise Search - defaults to the previously existing secretSession. Note that this field is never returned from the API, it is write only.

                      • user_settings_json object

                        An arbitrary JSON object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters are on the allowlist and not on the denylist. (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Enterprise Search settings)

                      • user_settings_yaml string

                        An arbitrary YAML object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_json' is allowed), provided the parameters are on the allowlist and not on the denylist. (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Enterprise Search settings)

                      • user_settings_override_json object

                        An arbitrary JSON object allowing ECE admins to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), i.e. in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Enterprise Search settings)

                      • user_settings_override_yaml string

                        An arbitrary YAML object allowing ECE admins to set clusters' parameters (only one of this and 'user_settings_override_json' is allowed), i.e. in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Enterprise Search settings)

                    • allocator_filter object
                    • node_configuration string
                    • memory_per_node object
                    • node_count_per_zone object
                  • enterprise_search object Required
                    Hide enterprise_search attributes Show enterprise_search attributes object
                    • version string

                      The version of the Enterprise Search cluster (must be one of the ECE supported versions, and won't work unless it matches the Elasticsearch version. Leave blank to auto-detect version.)

                    • docker_image string

                      A docker URI that allows overriding of the default docker image specified for this version

                    • system_settings object

                      This structure defines a curated subset of the Enterprise Search settings. (This field together with 'user_settings_override*' and 'user_settings*' defines the total set of Enterprise Search settings)

                      Hide system_settings attributes Show system_settings attributes object
                      • elasticsearch_username string

                        Optionally override the account within Enterprise Search - defaults to a system account that always exists (if specified, the password must also be specified). Note that this field is never returned from the API, it is write only.

                      • elasticsearch_password string

                        Optionally override the account within Enterprise Search - defaults to a system account that always exists (if specified, the username must also be specified). Note that this field is never returned from the API, it is write only.

                      • secret_session_key string

                        Optionally override the secret session key within Enterprise Search - defaults to the previously existing secretSession. Note that this field is never returned from the API, it is write only.

                    • user_settings_json object

                      An arbitrary JSON object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters are on the allowlist and not on the denylist. (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Enterprise Search settings)

                    • user_settings_yaml string

                      An arbitrary YAML object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_json' is allowed), provided the parameters are on the allowlist and not on the denylist. (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Enterprise Search settings)

                    • user_settings_override_json object

                      An arbitrary JSON object allowing ECE admins to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), i.e. in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Enterprise Search settings)

                    • user_settings_override_yaml string

                      An arbitrary YAML object allowing ECE admins to set clusters' parameters (only one of this and 'user_settings_override_json' is allowed), i.e. in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Enterprise Search settings)

                  • transient object

                    Defines configuration parameters that control how the plan (i.e. consisting of the cluster topology and Enterprise Search settings) is applied

                    Hide transient attributes Show transient attributes object
                    • strategy object

                      The options for performing a plan change. Specify only one property each time. The default is grow_and_shrink.

                      Hide strategy attributes Show strategy attributes object
                      • rolling object

                        Performs inline, rolling configuration changes that mutate existing containers. TIP: This is the fastest way to update a plan, but can fail for complex plan changes, such as topology changes. Also, this is less safe for configuration changes that leave a cluster in a non running state. NOTE: When you perform a major version upgrade, and 'group_by' is set to 'pass:macros[all]';, rolling is required.

                        Hide rolling attributes Show rolling attributes object
                        • group_by string

                          Specifies the grouping attribute to use when rolling several instances. Instances that share the same value for the provided attribute key are rolled together as a unit. Examples that make sense to use are '__all__' (roll all instances as a single unit), 'logical_zone_name' (roll instances by zone), '__name__' (roll one instance at a time, the default if not specified). Note that '__all__' is required when performing a major version upgrade

                        • allow_inline_resize boolean

                          Whether we allow changing the capacity of instances (default false). This is currently implemented by stopping, re-creating then starting the affected instance on its associated allocator when performing the changes. NOTES: This requires a round-trip through the allocation infrastructure of the active constructor, as it has to reserve the target capacity without over-committing

                        • skip_synced_flush boolean

                          Whether to skip attempting to do a synced flush on the filesystem of the container (default: false), which is less safe but may be required if the container is unhealthy

                        • shard_init_wait_time integer(int64)

                          The time, in seconds, to wait for shards that show no progress of initializing before rolling the next group (default: 10 minutes)

                      • grow_and_shrink object

                        A strategy that creates instances with the new plan, migrates data from the old instances, then shuts down the old instances. GrowShrinkStrategyConfig is safer than 'rolling' and ensures single node availability during a plan change, but can be a lot slower on larger clusters.

                      • rolling_grow_and_shrink object

                        A strategy that creates new Elasticsearch instances, Kibana instances, and APM Servers with the new plan, then migrates the node data to minimize the amount of spare capacity.

                      • autodetect object

                        A strategy that lets constructor choose the most optimal way to execute the plan.

                    • plan_configuration object
                      Hide plan_configuration attributes Show plan_configuration attributes object
                      • timeout integer(int64)

                        The total timeout in seconds after which the plan is cancelled even if it is not complete. Defaults to 4x the max memory capacity per node (in MB)

                      • calm_wait_time integer(int64)

                        This timeout determines how long to give a cluster after it responds to API calls before performing actual operations on it. It defaults to 5s

                      • move_instances array[object]

                        The request that specifies the Elasticsearch or stateless (eg Kibana) instances to move to allocators as part of the upgrade plan. When used in conjunction with '__all__' (roll all instances as a single unit) strategy, these instances are not restarted, which can sometimes enable recovery plans when these instances are boot-looping.

                        Hide move_instances attributes Show move_instances attributes object
                        • from string Required

                          The instance id that is going to be moved

                        • to array[string]

                          An optional list of allocator ids to which the instance should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)

                        • instance_down boolean

                          Tells the infrastructure that the instance should be considered as permanently down when deciding how to migrate data to new nodes. If left blank then the system will automatically decide (currently: will treat the instances as up)

                      • move_allocators array[object]

                        As part of the upgrade plan, identifies the move requests for the Kibana instances or APM Servers on the allocators.

                        Hide move_allocators attributes Show move_allocators attributes object
                        • from string Required

                          The allocator id off which all instances in the cluster should be moved

                        • to array[string]

                          An optional list of allocator ids to which the instance(s) should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)

                        • allocator_down boolean

                          Tells the infrastructure that all instances on the allocator should be considered as permanently down when deciding how to migrate data to new nodes. If left blank then the system will auto-decide (currently: will treat the allocator as up)

                      • reallocate_instances boolean

                        If true (default: false) does not allow re-using any existing instances currently in the cluster, i.e. even unchanged instances will be re-created

                      • preferred_allocators array[string]

                        List of allocators on which instances are placed if possible (if not possible/not specified then any available allocator with space is used)

                      • extended_maintenance boolean

                        If true (default false), does not clear the maintenance flag (which prevents its API from being accessed except by the constructor) on new instances added until after a snapshot has been restored, otherwise, the maintenance flag is cleared once the new instances successfully join the new cluster

                      • cluster_reboot string

                        Set to 'forced' to force a reboot as part of the upgrade plan

                        Value is forced.

                • plan_attempt_log array[object] Required

                  Information about a step in a plan.

                  Hide plan_attempt_log attributes Show plan_attempt_log attributes object
                  • step_id string Required

                    ID of current step

                  • started string(date-time) Required

                    When the step started (ISO format in UTC)

                  • completed string(date-time)

                    When the step completed (ISO format in UTC)

                  • duration_in_millis integer(int64)

                    The duration of the step in MS

                  • status string Required

                    The status of the step (success, warning, error - warning means something didn't go as expected but it was not serious enough to abort the plan)

                    Values are success, warning, error, or pending.

                  • stage string Required

                    Current stage that the step is in

                    Values are starting, completed, or in_progress.

                  • info_log array[object] Required

                    Human readable summaries of the step, including messages for each stage of the step

                    The log message from a specified stage of an executed step in a plan.

                    Hide info_log attributes Show info_log attributes object
                    • timestamp string(date-time) Required

                      Timestamp marking on info log of step

                    • delta_in_millis integer(int64)

                      Time in milliseconds since previous log message

                    • stage string Required

                      Stage that info log message takes place in

                      Values are starting, completed, or in_progress.

                    • message string Required

                      Human readable log message

                    • details object Required

                      A map with details for the log about what happened during the step execution. Keys and values for are always both strings, representing the name of the detail and its value, respectively.

                      Hide details attribute Show details attribute object
                      • * string Additional properties
                    • failure_type string

                      The failure type, in case the step failed

                • source object

                  Information describing the source that facilitated the plans current state

                  Hide source attributes Show source attributes object
                  • facilitator string Required

                    The service where the change originated from

                  • action string Required

                    The type of plan change that was initiated

                  • date string(date-time) Required

                    The time the change was initiated

                  • user_id string

                    The user that requested the change

                  • admin_id string

                    The admin user that requested the change

                  • remote_addresses array[string]

                    The host addresses of the user that originated the change

                • warnings array[object] Required

                  Information about a warning from a plan.

                  Hide warnings attributes Show warnings attributes object
                  • code string Required

                    A unique warning code

                  • message string Required

                    A description of the warning

                  • step_id string

                    The ID of the step which produced a warning, if any

                • error object

                  Information about an error during a plan attempt.

                  Hide error attributes Show error attributes object
                  • timestamp string(date-time) Required

                    Timestamp marking on info log of step

                  • message string Required

                    Human readable error message

                  • details object Required

                    A map with details regarding the error. Both the keys and values are always strings, representing the name of the detail and its value, respectively.

                    Hide details attribute Show details attribute object
                    • * string Additional properties
                  • failure_type string

                    The failure type

            • metadata object

              Information about the public and internal state, and the configuration settings of an Elasticsearch cluster.

              Hide metadata attributes Show metadata attributes object
              • version integer(int32) Required

                The resource version number of the cluster metadata

              • last_modified string(date-time) Required

                The most recent time the cluster metadata was changed (ISO format in UTC)

              • endpoint string

                The DNS name of the cluster endpoint, if available

              • service_url string

                The full URL to access this deployment resource

              • aliased_endpoint string

                The DNS name of the cluster endpoint derived from the deployment alias, if available

              • aliased_url string

                The full aliased URL to access this deployment resource

              • cloud_id string

                The cloud ID, an encoded string that provides other Elastic services with the necessary information to connect to this Elasticsearch and Kibana (only present if both exist)

              • raw object

                An unstructured JSON representation of the public and internal state (can be filtered out via URL parameter). The contents and structure of the raw field can change at any time.

              • ports object

                The ports that allow communication with the cluster using various protocols.

                Hide ports attributes Show ports attributes object
                • http integer(int32) Required

                  Port where the cluster listens for HTTP traffic

                • https integer(int32) Required

                  Port where the cluster listens for HTTPS traffic

                • transport_passthrough integer(int32) Required

                  Port where the cluster listens for transport traffic using TLS

              • services_urls array[object]

                A list of the URLs to access services that the resource provides at this time. Note that if the service is not running or has not started yet, the URL to access it won't be available

                A URL to access the service of a resource

                Hide services_urls attributes Show services_urls attributes object
                • service string Required

                  Name of the service

                • url string Required

                  The full URL to access the service

            • topology object Required

              The topology for Elasticsearch clusters, multiple Kibana instances, or multiple APM Servers. The ClusterTopologyInfo also includes the instances and containers, and where they are located.

              Hide topology attributes Show topology attributes object
              • healthy boolean Required

                Whether the cluster topology is healthy (ie all instances are started and the services they run - ie elasticsearch - are available

              • instances array[object] Required

                Information about each Kibana instance and APM Server in the Elasticsearch cluster.

                Hide instances attributes Show instances attributes object
                • instance_name string Required

                  The name of the instance in Elastic Cloud

                • instance_configuration object

                  Information about a configuration that creates a Kibana instance or APM Server.

                  Hide instance_configuration attributes Show instance_configuration attributes object
                  • id string Required

                    The id of the configuration used to create the instance

                  • name string Required

                    The name of the configuration used to create the instance

                  • config_version integer(int32)

                    If the IC is configuration controlled, this field is the version either being read back (reads return the latest IC unless specified by the 'config_version' URL param), or the version to update. Cannot be used in creates. For unversioned IC reads it is left empty.

                  • resource string Required

                    The resource type of the instance configuration

                    Values are memory or storage.

                • service_version string

                  The version of the service that the instance is running (eg Elasticsearch or Kibana), if available

                • healthy boolean Required

                  Whether the instance is healthy (ie started and running)

                • container_started boolean Required

                  Whether the container has started (does not tell you anything about the service -ie Elasticsearch- running inside the container)

                • service_running boolean Required

                  Whether the service launched inside the container -ie Elasticsearch- is actually running

                • maintenance_mode boolean Required

                  Whether the service is is maintenance mode (meaning that the proxy is not routing external traffic to it)

                • zone string

                  The zone in which this instance is being allocated

                • allocator_id string

                  The id of the allocator on which this instance is running (if the container is started or starting)

                • memory object

                  Information about the specific instances memory capacity and its usage

                  Hide memory attributes Show memory attributes object
                  • instance_capacity integer(int32) Required

                    The memory capacity in MB of the instance

                  • instance_capacity_planned integer(int32)

                    The planned memory capacity in MB of the instance (only shown when an override is present)

                  • memory_pressure integer(int32)

                    The % memory pressure of Elasticsearch JVM heap space if available (60-75% consider increasing capacity, >75% can incur significant performance and stability issues)

                  • native_memory_pressure integer(int32)

                    The % memory pressure of the instance Docker container (if available)

                • disk object

                  Information about the use and storage capacity of a Kibana instance or APM Server.

                  Hide disk attributes Show disk attributes object
                  • disk_space_available integer(int64)

                    If known, the amount of total disk space available to the container in MB

                  • disk_space_used integer(int64) Required

                    The amount of disk space being used by the service in MB

                  • storage_multiplier number(double) Required

                    The storage multiplier originally defined to calculate disk space.

                • service_roles array[string]

                  List of roles assigned to the service running in the instance. Currently only populated for Elasticsearch, with possible values: master,data,ingest,ml

                • node_roles array[string]

                  A list of the node roles assigned to the service running in the instance. Currently populated only for Elasticsearch.

                  Values are master, ingest, ml, data_hot, data_content, data_warm, data_cold, data_frozen, remote_cluster_client, transform, or voting_only.

                • instance_overrides object

                  Instance overrides

                  Hide instance_overrides attributes Show instance_overrides attributes object
                  • capacity integer(int32)

                    Sets the memory capacity for the instances container. Requires a restart to take effect.

                  • storage_multiplier number(double)

                    Overrides the disk quota multiplier for the instance

            • external_links array[object] Required

              External resources related to the Enterprise Search

              Hide external_links attributes Show external_links attributes object
              • id string Required

                Identifier of the external link

              • label string Required

                Human-readable description of the external link

              • uri string

                hyperlink to an external resource

            • links object

              A map of application-specific operations (which map to 'operationId's in the Swagger API) to metadata about that operation

              Hide links attribute Show links attribute object
              • * object Additional properties
                Hide * attribute Show * attribute object
                • need_elevated_permissions boolean

                  Whether the operation requires elevated permissions (when the field is present, elevated permissions are required).

            • settings object

              The settings for building this Enterprise Search cluster

              Hide settings attribute Show settings attribute object
              • metadata object

                The top-level configuration settings for the Elasticsearch cluster.

                Hide metadata attribute Show metadata attribute object
                • name string

                  The display name of the cluster

            • region string

              The region that this Enterprise Search belongs to. Only populated in SaaS or federated ECE.

        • integrations_server array[object] Required

          List of Integrations Server resources in your Deployment

          Describes an Integrations Server resource belonging to a Deployment

          Hide integrations_server attributes Show integrations_server attributes object
          • ref_id string Required

            The locally-unique user-specified id of a Resource

          • elasticsearch_cluster_ref_id string Required

            The Elasticsearch cluster that this resource depends on.

          • id string Required

            The randomly-generated id of a Resource

          • region string Required

            The region where this resource exists

          • info object Required

            Info for the resource.

            Hide info attributes Show info attributes object
            • id string Required

              The id of the Integrations Server

            • name string Required

              The name of the Integrations Server

            • elasticsearch_cluster object Required

              Information about the specified Elasticsearch cluster.

              Hide elasticsearch_cluster attributes Show elasticsearch_cluster attributes object
              • elasticsearch_id string Required

                The Elasticsearch cluster Id

              • links object

                A map of application-specific operations (which map to 'operationId's in the Swagger API) to metadata about that operation

                Hide links attribute Show links attribute object
                • * object Additional properties
                  Hide * attribute Show * attribute object
                  • need_elevated_permissions boolean

                    Whether the operation requires elevated permissions (when the field is present, elevated permissions are required).

            • deployment_id string

              The id of the deployment that this Integrations Server belongs to.

            • healthy boolean Required

              Whether the Integrations Server is healthy or not (one or more of the info subsections will have healthy: false)

            • status string Required

              Integrations Server status

              Values are initializing, stopping, stopped, rebooting, restarting, reconfiguring, or started.

            • plan_info object Required

              Information about current, pending, and past Integrations Server plans.

              Hide plan_info attributes Show plan_info attributes object
              • healthy boolean Required

                Whether the plan situation is healthy (if unhealthy, means the last plan attempt failed)

              • current object

                Information about the Integrations Server plan.

                Hide current attributes Show current attributes object
                • plan_attempt_id string

                  A UUID for each plan attempt

                • plan_attempt_name string

                  A human readable name for each plan attempt, only populated when retrieving plan histories

                • healthy boolean Required

                  Either the plan ended successfully, or is not yet completed (and no errors have occurred)

                • attempt_start_time string(date-time)

                  When this plan attempt (ie to apply the plan to the Integrations Server) started (ISO format in UTC)

                • attempt_end_time string(date-time)

                  If this plan completed or failed (ie is not pending), when the attempt ended (ISO format in UTC)

                • plan_end_time string(date-time)

                  If this plan is not current or pending, when the plan was no longer active (ISO format in UTC)

                • plan object

                  The plan for the Integrations Server.

                  Hide plan attributes Show plan attributes object
                  • cluster_topology array[object]

                    Defines the topology of the Integrations Server nodes. For example, the number or capacity of the nodes, and where you can allocate the nodes.

                    Hide cluster_topology attributes Show cluster_topology attributes object
                    • instance_configuration_id string

                      Controls the allocation of this topology element as well as allowed sizes and node_types. It needs to match the id of an existing instance configuration.

                    • instance_configuration_version integer(int32)

                      The version of the Instance Configuration Id. If it is unset, the meaning depends on read vs writes. For deployment reads, it is equivalent to version 0 (or the IC is unversioned); for deployment creates and deployment template use, it is equivalent to 'the latest version'; and for deployment updates, it is equivalent to 'retain the current version'.

                    • size object

                      Measured by the amount of a resource. The final cluster size is calculated using multipliers from the topology instance configuration.

                      Hide size attributes Show size attributes object
                      • value integer(int32) Required

                        Amount of resource

                      • resource string Required

                        Type of resource. In ESS the resource used should always be memory.

                        Values are memory or storage.

                    • zone_count integer(int32)

                      number of zones in which nodes will be placed

                    • integrations_server object

                      The configuration options for the Integrations Server.

                      Hide integrations_server attributes Show integrations_server attributes object
                      • version string

                        The version of the Integrations Server cluster (must be one of the ECE supported versions, and won't work unless it matches the Integrations Server version. Leave blank to auto-detect version.)

                      • docker_image string

                        A docker URI that allows overriding of the default docker image specified for this version

                      • system_settings object

                        A structure that defines a curated subset of the Integrations Server settings. TIP: To define the complete set of Integrations Server setting, use IntegrationsSystemSettings with user_settings_override_ and user_settings_.

                        Hide system_settings attributes Show system_settings attributes object
                        • elasticsearch_username string

                          Optionally override the account within Integrations Server - defaults to a system account that always exists (if specified, the password must also be specified). Note that this field is never returned from the API, it is write only.

                        • elasticsearch_password string

                          Optionally override the account within Integrations Server - defaults to a system account that always exists (if specified, the username must also be specified). Note that this field is never returned from the API, it is write only.

                        • secret_token string

                          Optionally override the secret token within Integrations Server - defaults to the previously existing secretToken

                        • debug_enabled boolean

                          Optionally enable debug mode for Integrations Server - defaults false

                      • user_settings_json object

                        An arbitrary JSON object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters are on the allowlist and not on the denylist. (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Integrations Server settings)

                      • user_settings_yaml string

                        An arbitrary YAML object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_json' is allowed), provided the parameters are on the allowlist and not on the denylist. (These field together with 'user_settings_override*' and 'system_settings' defines the total set of Integrations Server settings)

                      • user_settings_override_json object

                        An arbitrary JSON object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Integrations Server settings)

                      • user_settings_override_yaml string

                        An arbitrary YAML object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_json' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Integrations Server settings)

                      • mode string

                        The mode the Integrations Server is operating in.

                        Values are standalone or managed.

                  • integrations_server object Required

                    The configuration options for the Integrations Server.

                    Hide integrations_server attributes Show integrations_server attributes object
                    • version string

                      The version of the Integrations Server cluster (must be one of the ECE supported versions, and won't work unless it matches the Integrations Server version. Leave blank to auto-detect version.)

                    • docker_image string

                      A docker URI that allows overriding of the default docker image specified for this version

                    • system_settings object

                      A structure that defines a curated subset of the Integrations Server settings. TIP: To define the complete set of Integrations Server setting, use IntegrationsSystemSettings with user_settings_override_ and user_settings_.

                      Hide system_settings attributes Show system_settings attributes object
                      • elasticsearch_username string

                        Optionally override the account within Integrations Server - defaults to a system account that always exists (if specified, the password must also be specified). Note that this field is never returned from the API, it is write only.

                      • elasticsearch_password string

                        Optionally override the account within Integrations Server - defaults to a system account that always exists (if specified, the username must also be specified). Note that this field is never returned from the API, it is write only.

                      • secret_token string

                        Optionally override the secret token within Integrations Server - defaults to the previously existing secretToken

                      • debug_enabled boolean

                        Optionally enable debug mode for Integrations Server - defaults false

                    • user_settings_json object

                      An arbitrary JSON object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters are on the allowlist and not on the denylist. (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Integrations Server settings)

                    • user_settings_yaml string

                      An arbitrary YAML object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_json' is allowed), provided the parameters are on the allowlist and not on the denylist. (These field together with 'user_settings_override*' and 'system_settings' defines the total set of Integrations Server settings)

                    • user_settings_override_json object

                      An arbitrary JSON object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Integrations Server settings)

                    • user_settings_override_yaml string

                      An arbitrary YAML object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_json' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Integrations Server settings)

                    • mode string

                      The mode the Integrations Server is operating in.

                      Values are standalone or managed.

                  • transient object

                    Defines the configuration parameters that control how the plan is applied. For example, the Elasticsearch cluster topology and Integrations Server settings.

                    Hide transient attributes Show transient attributes object
                    • strategy object

                      The options for performing a plan change. Specify only one property each time. The default is grow_and_shrink.

                      Hide strategy attributes Show strategy attributes object
                      • rolling object

                        Performs inline, rolling configuration changes that mutate existing containers. TIP: This is the fastest way to update a plan, but can fail for complex plan changes, such as topology changes. Also, this is less safe for configuration changes that leave a cluster in a non running state. NOTE: When you perform a major version upgrade, and 'group_by' is set to 'pass:macros[all]';, rolling is required.

                        Hide rolling attributes Show rolling attributes object
                        • group_by string

                          Specifies the grouping attribute to use when rolling several instances. Instances that share the same value for the provided attribute key are rolled together as a unit. Examples that make sense to use are '__all__' (roll all instances as a single unit), 'logical_zone_name' (roll instances by zone), '__name__' (roll one instance at a time, the default if not specified). Note that '__all__' is required when performing a major version upgrade

                        • allow_inline_resize boolean

                          Whether we allow changing the capacity of instances (default false). This is currently implemented by stopping, re-creating then starting the affected instance on its associated allocator when performing the changes. NOTES: This requires a round-trip through the allocation infrastructure of the active constructor, as it has to reserve the target capacity without over-committing

                        • skip_synced_flush boolean

                          Whether to skip attempting to do a synced flush on the filesystem of the container (default: false), which is less safe but may be required if the container is unhealthy

                        • shard_init_wait_time integer(int64)

                          The time, in seconds, to wait for shards that show no progress of initializing before rolling the next group (default: 10 minutes)

                      • grow_and_shrink object

                        A strategy that creates instances with the new plan, migrates data from the old instances, then shuts down the old instances. GrowShrinkStrategyConfig is safer than 'rolling' and ensures single node availability during a plan change, but can be a lot slower on larger clusters.

                      • rolling_grow_and_shrink object

                        A strategy that creates new Elasticsearch instances, Kibana instances, and APM Servers with the new plan, then migrates the node data to minimize the amount of spare capacity.

                      • autodetect object

                        A strategy that lets constructor choose the most optimal way to execute the plan.

                    • plan_configuration object

                      The plan control configuration options for the Integrations Server.

                      Hide plan_configuration attributes Show plan_configuration attributes object
                      • timeout integer(int64)

                        The total timeout in seconds after which the plan is cancelled even if it is not complete. Defaults to 4x the max memory capacity per node (in MB)

                      • calm_wait_time integer(int64)

                        This timeout determines how long to give a cluster after it responds to API calls before performing actual operations on it. It defaults to 5s

                      • extended_maintenance boolean

                        If true (default false), does not clear the maintenance flag (which prevents its API from being accessed except by the constructor) on new instances added until after a snapshot has been restored, otherwise, the maintenance flag is cleared once the new instances successfully join the new cluster

                      • cluster_reboot string

                        Set to 'forced' to force a reboot as part of the upgrade plan

                        Value is forced.

                • plan_attempt_log array[object] Required

                  Information about a step in a plan.

                  Hide plan_attempt_log attributes Show plan_attempt_log attributes object
                  • step_id string Required

                    ID of current step

                  • started string(date-time) Required

                    When the step started (ISO format in UTC)

                  • completed string(date-time)

                    When the step completed (ISO format in UTC)

                  • duration_in_millis integer(int64)

                    The duration of the step in MS

                  • status string Required

                    The status of the step (success, warning, error - warning means something didn't go as expected but it was not serious enough to abort the plan)

                    Values are success, warning, error, or pending.

                  • stage string Required

                    Current stage that the step is in

                    Values are starting, completed, or in_progress.

                  • info_log array[object] Required

                    Human readable summaries of the step, including messages for each stage of the step

                    The log message from a specified stage of an executed step in a plan.

                    Hide info_log attributes Show info_log attributes object
                    • timestamp string(date-time) Required

                      Timestamp marking on info log of step

                    • delta_in_millis integer(int64)

                      Time in milliseconds since previous log message

                    • stage string Required

                      Stage that info log message takes place in

                      Values are starting, completed, or in_progress.

                    • message string Required

                      Human readable log message

                    • details object Required

                      A map with details for the log about what happened during the step execution. Keys and values for are always both strings, representing the name of the detail and its value, respectively.

                      Hide details attribute Show details attribute object
                      • * string Additional properties
                    • failure_type string

                      The failure type, in case the step failed

                • source object

                  Information describing the source that facilitated the plans current state

                  Hide source attributes Show source attributes object
                  • facilitator string Required

                    The service where the change originated from

                  • action string Required

                    The type of plan change that was initiated

                  • date string(date-time) Required

                    The time the change was initiated

                  • user_id string

                    The user that requested the change

                  • admin_id string

                    The admin user that requested the change

                  • remote_addresses array[string]

                    The host addresses of the user that originated the change

                • warnings array[object] Required

                  Information about a warning from a plan.

                  Hide warnings attributes Show warnings attributes object
                  • code string Required

                    A unique warning code

                  • message string Required

                    A description of the warning

                  • step_id string

                    The ID of the step which produced a warning, if any

                • error object

                  Information about an error during a plan attempt.

                  Hide error attributes Show error attributes object
                  • timestamp string(date-time) Required

                    Timestamp marking on info log of step

                  • message string Required

                    Human readable error message

                  • details object Required

                    A map with details regarding the error. Both the keys and values are always strings, representing the name of the detail and its value, respectively.

                    Hide details attribute Show details attribute object
                    • * string Additional properties
                  • failure_type string

                    The failure type

              • pending object

                Information about the Integrations Server plan.

                Hide pending attributes Show pending attributes object
                • plan_attempt_id string

                  A UUID for each plan attempt

                • plan_attempt_name string

                  A human readable name for each plan attempt, only populated when retrieving plan histories

                • healthy boolean Required

                  Either the plan ended successfully, or is not yet completed (and no errors have occurred)

                • attempt_start_time string(date-time)

                  When this plan attempt (ie to apply the plan to the Integrations Server) started (ISO format in UTC)

                • attempt_end_time string(date-time)

                  If this plan completed or failed (ie is not pending), when the attempt ended (ISO format in UTC)

                • plan_end_time string(date-time)

                  If this plan is not current or pending, when the plan was no longer active (ISO format in UTC)

                • plan object

                  The plan for the Integrations Server.

                  Hide plan attributes Show plan attributes object
                  • cluster_topology array[object]

                    Defines the topology of the Integrations Server nodes. For example, the number or capacity of the nodes, and where you can allocate the nodes.

                    Hide cluster_topology attributes Show cluster_topology attributes object
                    • instance_configuration_id string

                      Controls the allocation of this topology element as well as allowed sizes and node_types. It needs to match the id of an existing instance configuration.

                    • instance_configuration_version integer(int32)

                      The version of the Instance Configuration Id. If it is unset, the meaning depends on read vs writes. For deployment reads, it is equivalent to version 0 (or the IC is unversioned); for deployment creates and deployment template use, it is equivalent to 'the latest version'; and for deployment updates, it is equivalent to 'retain the current version'.

                    • size object

                      Measured by the amount of a resource. The final cluster size is calculated using multipliers from the topology instance configuration.

                      Hide size attributes Show size attributes object
                      • value integer(int32) Required

                        Amount of resource

                      • resource string Required

                        Type of resource. In ESS the resource used should always be memory.

                        Values are memory or storage.

                    • zone_count integer(int32)

                      number of zones in which nodes will be placed

                    • integrations_server object

                      The configuration options for the Integrations Server.

                      Hide integrations_server attributes Show integrations_server attributes object
                      • version string

                        The version of the Integrations Server cluster (must be one of the ECE supported versions, and won't work unless it matches the Integrations Server version. Leave blank to auto-detect version.)

                      • docker_image string

                        A docker URI that allows overriding of the default docker image specified for this version

                      • system_settings object

                        A structure that defines a curated subset of the Integrations Server settings. TIP: To define the complete set of Integrations Server setting, use IntegrationsSystemSettings with user_settings_override_ and user_settings_.

                        Hide system_settings attributes Show system_settings attributes object
                        • elasticsearch_username string

                          Optionally override the account within Integrations Server - defaults to a system account that always exists (if specified, the password must also be specified). Note that this field is never returned from the API, it is write only.

                        • elasticsearch_password string

                          Optionally override the account within Integrations Server - defaults to a system account that always exists (if specified, the username must also be specified). Note that this field is never returned from the API, it is write only.

                        • secret_token string

                          Optionally override the secret token within Integrations Server - defaults to the previously existing secretToken

                        • debug_enabled boolean

                          Optionally enable debug mode for Integrations Server - defaults false

                      • user_settings_json object

                        An arbitrary JSON object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters are on the allowlist and not on the denylist. (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Integrations Server settings)

                      • user_settings_yaml string

                        An arbitrary YAML object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_json' is allowed), provided the parameters are on the allowlist and not on the denylist. (These field together with 'user_settings_override*' and 'system_settings' defines the total set of Integrations Server settings)

                      • user_settings_override_json object

                        An arbitrary JSON object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Integrations Server settings)

                      • user_settings_override_yaml string

                        An arbitrary YAML object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_json' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Integrations Server settings)

                      • mode string

                        The mode the Integrations Server is operating in.

                        Values are standalone or managed.

                  • integrations_server object Required

                    The configuration options for the Integrations Server.

                    Hide integrations_server attributes Show integrations_server attributes object
                    • version string

                      The version of the Integrations Server cluster (must be one of the ECE supported versions, and won't work unless it matches the Integrations Server version. Leave blank to auto-detect version.)

                    • docker_image string

                      A docker URI that allows overriding of the default docker image specified for this version

                    • system_settings object

                      A structure that defines a curated subset of the Integrations Server settings. TIP: To define the complete set of Integrations Server setting, use IntegrationsSystemSettings with user_settings_override_ and user_settings_.

                      Hide system_settings attributes Show system_settings attributes object
                      • elasticsearch_username string

                        Optionally override the account within Integrations Server - defaults to a system account that always exists (if specified, the password must also be specified). Note that this field is never returned from the API, it is write only.

                      • elasticsearch_password string

                        Optionally override the account within Integrations Server - defaults to a system account that always exists (if specified, the username must also be specified). Note that this field is never returned from the API, it is write only.

                      • secret_token string

                        Optionally override the secret token within Integrations Server - defaults to the previously existing secretToken

                      • debug_enabled boolean

                        Optionally enable debug mode for Integrations Server - defaults false

                    • user_settings_json object

                      An arbitrary JSON object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters are on the allowlist and not on the denylist. (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Integrations Server settings)

                    • user_settings_yaml string

                      An arbitrary YAML object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_json' is allowed), provided the parameters are on the allowlist and not on the denylist. (These field together with 'user_settings_override*' and 'system_settings' defines the total set of Integrations Server settings)

                    • user_settings_override_json object

                      An arbitrary JSON object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Integrations Server settings)

                    • user_settings_override_yaml string

                      An arbitrary YAML object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_json' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Integrations Server settings)

                    • mode string

                      The mode the Integrations Server is operating in.

                      Values are standalone or managed.

                  • transient object

                    Defines the configuration parameters that control how the plan is applied. For example, the Elasticsearch cluster topology and Integrations Server settings.

                    Hide transient attributes Show transient attributes object
                    • strategy object

                      The options for performing a plan change. Specify only one property each time. The default is grow_and_shrink.

                      Hide strategy attributes Show strategy attributes object
                      • rolling object

                        Performs inline, rolling configuration changes that mutate existing containers. TIP: This is the fastest way to update a plan, but can fail for complex plan changes, such as topology changes. Also, this is less safe for configuration changes that leave a cluster in a non running state. NOTE: When you perform a major version upgrade, and 'group_by' is set to 'pass:macros[all]';, rolling is required.

                        Hide rolling attributes Show rolling attributes object
                        • group_by string

                          Specifies the grouping attribute to use when rolling several instances. Instances that share the same value for the provided attribute key are rolled together as a unit. Examples that make sense to use are '__all__' (roll all instances as a single unit), 'logical_zone_name' (roll instances by zone), '__name__' (roll one instance at a time, the default if not specified). Note that '__all__' is required when performing a major version upgrade

                        • allow_inline_resize boolean

                          Whether we allow changing the capacity of instances (default false). This is currently implemented by stopping, re-creating then starting the affected instance on its associated allocator when performing the changes. NOTES: This requires a round-trip through the allocation infrastructure of the active constructor, as it has to reserve the target capacity without over-committing

                        • skip_synced_flush boolean

                          Whether to skip attempting to do a synced flush on the filesystem of the container (default: false), which is less safe but may be required if the container is unhealthy

                        • shard_init_wait_time integer(int64)

                          The time, in seconds, to wait for shards that show no progress of initializing before rolling the next group (default: 10 minutes)

                      • grow_and_shrink object

                        A strategy that creates instances with the new plan, migrates data from the old instances, then shuts down the old instances. GrowShrinkStrategyConfig is safer than 'rolling' and ensures single node availability during a plan change, but can be a lot slower on larger clusters.

                      • rolling_grow_and_shrink object

                        A strategy that creates new Elasticsearch instances, Kibana instances, and APM Servers with the new plan, then migrates the node data to minimize the amount of spare capacity.

                      • autodetect object

                        A strategy that lets constructor choose the most optimal way to execute the plan.

                    • plan_configuration object

                      The plan control configuration options for the Integrations Server.

                      Hide plan_configuration attributes Show plan_configuration attributes object
                      • timeout integer(int64)

                        The total timeout in seconds after which the plan is cancelled even if it is not complete. Defaults to 4x the max memory capacity per node (in MB)

                      • calm_wait_time integer(int64)

                        This timeout determines how long to give a cluster after it responds to API calls before performing actual operations on it. It defaults to 5s

                      • extended_maintenance boolean

                        If true (default false), does not clear the maintenance flag (which prevents its API from being accessed except by the constructor) on new instances added until after a snapshot has been restored, otherwise, the maintenance flag is cleared once the new instances successfully join the new cluster

                      • cluster_reboot string

                        Set to 'forced' to force a reboot as part of the upgrade plan

                        Value is forced.

                • plan_attempt_log array[object] Required

                  Information about a step in a plan.

                  Hide plan_attempt_log attributes Show plan_attempt_log attributes object
                  • step_id string Required

                    ID of current step

                  • started string(date-time) Required

                    When the step started (ISO format in UTC)

                  • completed string(date-time)

                    When the step completed (ISO format in UTC)

                  • duration_in_millis integer(int64)

                    The duration of the step in MS

                  • status string Required

                    The status of the step (success, warning, error - warning means something didn't go as expected but it was not serious enough to abort the plan)

                    Values are success, warning, error, or pending.

                  • stage string Required

                    Current stage that the step is in

                    Values are starting, completed, or in_progress.

                  • info_log array[object] Required

                    Human readable summaries of the step, including messages for each stage of the step

                    The log message from a specified stage of an executed step in a plan.

                    Hide info_log attributes Show info_log attributes object
                    • timestamp string(date-time) Required

                      Timestamp marking on info log of step

                    • delta_in_millis integer(int64)

                      Time in milliseconds since previous log message

                    • stage string Required

                      Stage that info log message takes place in

                      Values are starting, completed, or in_progress.

                    • message string Required

                      Human readable log message

                    • details object Required

                      A map with details for the log about what happened during the step execution. Keys and values for are always both strings, representing the name of the detail and its value, respectively.

                      Hide details attribute Show details attribute object
                      • * string Additional properties
                    • failure_type string

                      The failure type, in case the step failed

                • source object

                  Information describing the source that facilitated the plans current state

                  Hide source attributes Show source attributes object
                  • facilitator string Required

                    The service where the change originated from

                  • action string Required

                    The type of plan change that was initiated

                  • date string(date-time) Required

                    The time the change was initiated

                  • user_id string

                    The user that requested the change

                  • admin_id string

                    The admin user that requested the change

                  • remote_addresses array[string]

                    The host addresses of the user that originated the change

                • warnings array[object] Required

                  Information about a warning from a plan.

                  Hide warnings attributes Show warnings attributes object
                  • code string Required

                    A unique warning code

                  • message string Required

                    A description of the warning

                  • step_id string

                    The ID of the step which produced a warning, if any

                • error object

                  Information about an error during a plan attempt.

                  Hide error attributes Show error attributes object
                  • timestamp string(date-time) Required

                    Timestamp marking on info log of step

                  • message string Required

                    Human readable error message

                  • details object Required

                    A map with details regarding the error. Both the keys and values are always strings, representing the name of the detail and its value, respectively.

                    Hide details attribute Show details attribute object
                    • * string Additional properties
                  • failure_type string

                    The failure type

              • history array[object] Required

                Information about the Integrations Server plan.

                Hide history attributes Show history attributes object
                • plan_attempt_id string

                  A UUID for each plan attempt

                • plan_attempt_name string

                  A human readable name for each plan attempt, only populated when retrieving plan histories

                • healthy boolean Required

                  Either the plan ended successfully, or is not yet completed (and no errors have occurred)

                • attempt_start_time string(date-time)

                  When this plan attempt (ie to apply the plan to the Integrations Server) started (ISO format in UTC)

                • attempt_end_time string(date-time)

                  If this plan completed or failed (ie is not pending), when the attempt ended (ISO format in UTC)

                • plan_end_time string(date-time)

                  If this plan is not current or pending, when the plan was no longer active (ISO format in UTC)

                • plan object

                  The plan for the Integrations Server.

                  Hide plan attributes Show plan attributes object
                  • cluster_topology array[object]

                    Defines the topology of the Integrations Server nodes. For example, the number or capacity of the nodes, and where you can allocate the nodes.

                    Hide cluster_topology attributes Show cluster_topology attributes object
                    • instance_configuration_id string

                      Controls the allocation of this topology element as well as allowed sizes and node_types. It needs to match the id of an existing instance configuration.

                    • instance_configuration_version integer(int32)

                      The version of the Instance Configuration Id. If it is unset, the meaning depends on read vs writes. For deployment reads, it is equivalent to version 0 (or the IC is unversioned); for deployment creates and deployment template use, it is equivalent to 'the latest version'; and for deployment updates, it is equivalent to 'retain the current version'.

                    • size object

                      Measured by the amount of a resource. The final cluster size is calculated using multipliers from the topology instance configuration.

                      Hide size attributes Show size attributes object
                      • value integer(int32) Required

                        Amount of resource

                      • resource string Required

                        Type of resource. In ESS the resource used should always be memory.

                        Values are memory or storage.

                    • zone_count integer(int32)

                      number of zones in which nodes will be placed

                    • integrations_server object

                      The configuration options for the Integrations Server.

                      Hide integrations_server attributes Show integrations_server attributes object
                      • version string

                        The version of the Integrations Server cluster (must be one of the ECE supported versions, and won't work unless it matches the Integrations Server version. Leave blank to auto-detect version.)

                      • docker_image string

                        A docker URI that allows overriding of the default docker image specified for this version

                      • system_settings object

                        A structure that defines a curated subset of the Integrations Server settings. TIP: To define the complete set of Integrations Server setting, use IntegrationsSystemSettings with user_settings_override_ and user_settings_.

                        Hide system_settings attributes Show system_settings attributes object
                        • elasticsearch_username string

                          Optionally override the account within Integrations Server - defaults to a system account that always exists (if specified, the password must also be specified). Note that this field is never returned from the API, it is write only.

                        • elasticsearch_password string

                          Optionally override the account within Integrations Server - defaults to a system account that always exists (if specified, the username must also be specified). Note that this field is never returned from the API, it is write only.

                        • secret_token string

                          Optionally override the secret token within Integrations Server - defaults to the previously existing secretToken

                        • debug_enabled boolean

                          Optionally enable debug mode for Integrations Server - defaults false

                      • user_settings_json object

                        An arbitrary JSON object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters are on the allowlist and not on the denylist. (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Integrations Server settings)

                      • user_settings_yaml string

                        An arbitrary YAML object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_json' is allowed), provided the parameters are on the allowlist and not on the denylist. (These field together with 'user_settings_override*' and 'system_settings' defines the total set of Integrations Server settings)

                      • user_settings_override_json object

                        An arbitrary JSON object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Integrations Server settings)

                      • user_settings_override_yaml string

                        An arbitrary YAML object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_json' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Integrations Server settings)

                      • mode string

                        The mode the Integrations Server is operating in.

                        Values are standalone or managed.

                  • integrations_server object Required

                    The configuration options for the Integrations Server.

                    Hide integrations_server attributes Show integrations_server attributes object
                    • version string

                      The version of the Integrations Server cluster (must be one of the ECE supported versions, and won't work unless it matches the Integrations Server version. Leave blank to auto-detect version.)

                    • docker_image string

                      A docker URI that allows overriding of the default docker image specified for this version

                    • system_settings object

                      A structure that defines a curated subset of the Integrations Server settings. TIP: To define the complete set of Integrations Server setting, use IntegrationsSystemSettings with user_settings_override_ and user_settings_.

                      Hide system_settings attributes Show system_settings attributes object
                      • elasticsearch_username string

                        Optionally override the account within Integrations Server - defaults to a system account that always exists (if specified, the password must also be specified). Note that this field is never returned from the API, it is write only.

                      • elasticsearch_password string

                        Optionally override the account within Integrations Server - defaults to a system account that always exists (if specified, the username must also be specified). Note that this field is never returned from the API, it is write only.

                      • secret_token string

                        Optionally override the secret token within Integrations Server - defaults to the previously existing secretToken

                      • debug_enabled boolean

                        Optionally enable debug mode for Integrations Server - defaults false

                    • user_settings_json object

                      An arbitrary JSON object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters are on the allowlist and not on the denylist. (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Integrations Server settings)

                    • user_settings_yaml string

                      An arbitrary YAML object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_json' is allowed), provided the parameters are on the allowlist and not on the denylist. (These field together with 'user_settings_override*' and 'system_settings' defines the total set of Integrations Server settings)

                    • user_settings_override_json object

                      An arbitrary JSON object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Integrations Server settings)

                    • user_settings_override_yaml string

                      An arbitrary YAML object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_json' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Integrations Server settings)

                    • mode string

                      The mode the Integrations Server is operating in.

                      Values are standalone or managed.

                  • transient object

                    Defines the configuration parameters that control how the plan is applied. For example, the Elasticsearch cluster topology and Integrations Server settings.

                    Hide transient attributes Show transient attributes object
                    • strategy object

                      The options for performing a plan change. Specify only one property each time. The default is grow_and_shrink.

                      Hide strategy attributes Show strategy attributes object
                      • rolling object

                        Performs inline, rolling configuration changes that mutate existing containers. TIP: This is the fastest way to update a plan, but can fail for complex plan changes, such as topology changes. Also, this is less safe for configuration changes that leave a cluster in a non running state. NOTE: When you perform a major version upgrade, and 'group_by' is set to 'pass:macros[all]';, rolling is required.

                        Hide rolling attributes Show rolling attributes object
                        • group_by string

                          Specifies the grouping attribute to use when rolling several instances. Instances that share the same value for the provided attribute key are rolled together as a unit. Examples that make sense to use are '__all__' (roll all instances as a single unit), 'logical_zone_name' (roll instances by zone), '__name__' (roll one instance at a time, the default if not specified). Note that '__all__' is required when performing a major version upgrade

                        • allow_inline_resize boolean

                          Whether we allow changing the capacity of instances (default false). This is currently implemented by stopping, re-creating then starting the affected instance on its associated allocator when performing the changes. NOTES: This requires a round-trip through the allocation infrastructure of the active constructor, as it has to reserve the target capacity without over-committing

                        • skip_synced_flush boolean

                          Whether to skip attempting to do a synced flush on the filesystem of the container (default: false), which is less safe but may be required if the container is unhealthy

                        • shard_init_wait_time integer(int64)

                          The time, in seconds, to wait for shards that show no progress of initializing before rolling the next group (default: 10 minutes)

                      • grow_and_shrink object

                        A strategy that creates instances with the new plan, migrates data from the old instances, then shuts down the old instances. GrowShrinkStrategyConfig is safer than 'rolling' and ensures single node availability during a plan change, but can be a lot slower on larger clusters.

                      • rolling_grow_and_shrink object

                        A strategy that creates new Elasticsearch instances, Kibana instances, and APM Servers with the new plan, then migrates the node data to minimize the amount of spare capacity.

                      • autodetect object

                        A strategy that lets constructor choose the most optimal way to execute the plan.

                    • plan_configuration object

                      The plan control configuration options for the Integrations Server.

                      Hide plan_configuration attributes Show plan_configuration attributes object
                      • timeout integer(int64)

                        The total timeout in seconds after which the plan is cancelled even if it is not complete. Defaults to 4x the max memory capacity per node (in MB)

                      • calm_wait_time integer(int64)

                        This timeout determines how long to give a cluster after it responds to API calls before performing actual operations on it. It defaults to 5s

                      • extended_maintenance boolean

                        If true (default false), does not clear the maintenance flag (which prevents its API from being accessed except by the constructor) on new instances added until after a snapshot has been restored, otherwise, the maintenance flag is cleared once the new instances successfully join the new cluster

                      • cluster_reboot string

                        Set to 'forced' to force a reboot as part of the upgrade plan

                        Value is forced.

                • plan_attempt_log array[object] Required

                  Information about a step in a plan.

                  Hide plan_attempt_log attributes Show plan_attempt_log attributes object
                  • step_id string Required

                    ID of current step

                  • started string(date-time) Required

                    When the step started (ISO format in UTC)

                  • completed string(date-time)

                    When the step completed (ISO format in UTC)

                  • duration_in_millis integer(int64)

                    The duration of the step in MS

                  • status string Required

                    The status of the step (success, warning, error - warning means something didn't go as expected but it was not serious enough to abort the plan)

                    Values are success, warning, error, or pending.

                  • stage string Required

                    Current stage that the step is in

                    Values are starting, completed, or in_progress.

                  • info_log array[object] Required

                    Human readable summaries of the step, including messages for each stage of the step

                    The log message from a specified stage of an executed step in a plan.

                    Hide info_log attributes Show info_log attributes object
                    • timestamp string(date-time) Required

                      Timestamp marking on info log of step

                    • delta_in_millis integer(int64)

                      Time in milliseconds since previous log message

                    • stage string Required

                      Stage that info log message takes place in

                      Values are starting, completed, or in_progress.

                    • message string Required

                      Human readable log message

                    • details object Required

                      A map with details for the log about what happened during the step execution. Keys and values for are always both strings, representing the name of the detail and its value, respectively.

                      Hide details attribute Show details attribute object
                      • * string Additional properties
                    • failure_type string

                      The failure type, in case the step failed

                • source object

                  Information describing the source that facilitated the plans current state

                  Hide source attributes Show source attributes object
                  • facilitator string Required

                    The service where the change originated from

                  • action string Required

                    The type of plan change that was initiated

                  • date string(date-time) Required

                    The time the change was initiated

                  • user_id string

                    The user that requested the change

                  • admin_id string

                    The admin user that requested the change

                  • remote_addresses array[string]

                    The host addresses of the user that originated the change

                • warnings array[object] Required

                  Information about a warning from a plan.

                  Hide warnings attributes Show warnings attributes object
                  • code string Required

                    A unique warning code

                  • message string Required

                    A description of the warning

                  • step_id string

                    The ID of the step which produced a warning, if any

                • error object

                  Information about an error during a plan attempt.

                  Hide error attributes Show error attributes object
                  • timestamp string(date-time) Required

                    Timestamp marking on info log of step

                  • message string Required

                    Human readable error message

                  • details object Required

                    A map with details regarding the error. Both the keys and values are always strings, representing the name of the detail and its value, respectively.

                    Hide details attribute Show details attribute object
                    • * string Additional properties
                  • failure_type string

                    The failure type

            • metadata object

              Information about the public and internal state, and the configuration settings of an Elasticsearch cluster.

              Hide metadata attributes Show metadata attributes object
              • version integer(int32) Required

                The resource version number of the cluster metadata

              • last_modified string(date-time) Required

                The most recent time the cluster metadata was changed (ISO format in UTC)

              • endpoint string

                The DNS name of the cluster endpoint, if available

              • service_url string

                The full URL to access this deployment resource

              • aliased_endpoint string

                The DNS name of the cluster endpoint derived from the deployment alias, if available

              • aliased_url string

                The full aliased URL to access this deployment resource

              • cloud_id string

                The cloud ID, an encoded string that provides other Elastic services with the necessary information to connect to this Elasticsearch and Kibana (only present if both exist)

              • raw object

                An unstructured JSON representation of the public and internal state (can be filtered out via URL parameter). The contents and structure of the raw field can change at any time.

              • ports object

                The ports that allow communication with the cluster using various protocols.

                Hide ports attributes Show ports attributes object
                • http integer(int32) Required

                  Port where the cluster listens for HTTP traffic

                • https integer(int32) Required

                  Port where the cluster listens for HTTPS traffic

                • transport_passthrough integer(int32) Required

                  Port where the cluster listens for transport traffic using TLS

              • services_urls array[object]

                A list of the URLs to access services that the resource provides at this time. Note that if the service is not running or has not started yet, the URL to access it won't be available

                A URL to access the service of a resource

                Hide services_urls attributes Show services_urls attributes object
                • service string Required

                  Name of the service

                • url string Required

                  The full URL to access the service

            • topology object Required

              The topology for Elasticsearch clusters, multiple Kibana instances, or multiple APM Servers. The ClusterTopologyInfo also includes the instances and containers, and where they are located.

              Hide topology attributes Show topology attributes object
              • healthy boolean Required

                Whether the cluster topology is healthy (ie all instances are started and the services they run - ie elasticsearch - are available

              • instances array[object] Required

                Information about each Kibana instance and APM Server in the Elasticsearch cluster.

                Hide instances attributes Show instances attributes object
                • instance_name string Required

                  The name of the instance in Elastic Cloud

                • instance_configuration object

                  Information about a configuration that creates a Kibana instance or APM Server.

                  Hide instance_configuration attributes Show instance_configuration attributes object
                  • id string Required

                    The id of the configuration used to create the instance

                  • name string Required

                    The name of the configuration used to create the instance

                  • config_version integer(int32)

                    If the IC is configuration controlled, this field is the version either being read back (reads return the latest IC unless specified by the 'config_version' URL param), or the version to update. Cannot be used in creates. For unversioned IC reads it is left empty.

                  • resource string Required

                    The resource type of the instance configuration

                    Values are memory or storage.

                • service_version string

                  The version of the service that the instance is running (eg Elasticsearch or Kibana), if available

                • healthy boolean Required

                  Whether the instance is healthy (ie started and running)

                • container_started boolean Required

                  Whether the container has started (does not tell you anything about the service -ie Elasticsearch- running inside the container)

                • service_running boolean Required

                  Whether the service launched inside the container -ie Elasticsearch- is actually running

                • maintenance_mode boolean Required

                  Whether the service is is maintenance mode (meaning that the proxy is not routing external traffic to it)

                • zone string

                  The zone in which this instance is being allocated

                • allocator_id string

                  The id of the allocator on which this instance is running (if the container is started or starting)

                • memory object

                  Information about the specific instances memory capacity and its usage

                  Hide memory attributes Show memory attributes object
                  • instance_capacity integer(int32) Required

                    The memory capacity in MB of the instance

                  • instance_capacity_planned integer(int32)

                    The planned memory capacity in MB of the instance (only shown when an override is present)

                  • memory_pressure integer(int32)

                    The % memory pressure of Elasticsearch JVM heap space if available (60-75% consider increasing capacity, >75% can incur significant performance and stability issues)

                  • native_memory_pressure integer(int32)

                    The % memory pressure of the instance Docker container (if available)

                • disk object

                  Information about the use and storage capacity of a Kibana instance or APM Server.

                  Hide disk attributes Show disk attributes object
                  • disk_space_available integer(int64)

                    If known, the amount of total disk space available to the container in MB

                  • disk_space_used integer(int64) Required

                    The amount of disk space being used by the service in MB

                  • storage_multiplier number(double) Required

                    The storage multiplier originally defined to calculate disk space.

                • service_roles array[string]

                  List of roles assigned to the service running in the instance. Currently only populated for Elasticsearch, with possible values: master,data,ingest,ml

                • node_roles array[string]

                  A list of the node roles assigned to the service running in the instance. Currently populated only for Elasticsearch.

                  Values are master, ingest, ml, data_hot, data_content, data_warm, data_cold, data_frozen, remote_cluster_client, transform, or voting_only.

                • instance_overrides object

                  Instance overrides

                  Hide instance_overrides attributes Show instance_overrides attributes object
                  • capacity integer(int32)

                    Sets the memory capacity for the instances container. Requires a restart to take effect.

                  • storage_multiplier number(double)

                    Overrides the disk quota multiplier for the instance

            • external_links array[object] Required

              External resources related to the Integrations Server

              Hide external_links attributes Show external_links attributes object
              • id string Required

                Identifier of the external link

              • label string Required

                Human-readable description of the external link

              • uri string

                hyperlink to an external resource

            • links object

              A map of application-specific operations (which map to 'operationId's in the Swagger API) to metadata about that operation

              Hide links attribute Show links attribute object
              • * object Additional properties
                Hide * attribute Show * attribute object
                • need_elevated_permissions boolean

                  Whether the operation requires elevated permissions (when the field is present, elevated permissions are required).

            • settings object

              The settings for building this Integrations Server cluster

              Hide settings attribute Show settings attribute object
              • metadata object

                The top-level configuration settings for the Elasticsearch cluster.

                Hide metadata attribute Show metadata attribute object
                • name string

                  The display name of the cluster

            • region string

              The region that this Integrations Server belongs to. Only populated in SaaS or federated ECE.

            • apm_server_mode string

              The mode APM is operating in.

              Values are standalone or managed.

      • settings object

        Additional configuration for this Deployment

        Hide settings attributes Show settings attributes object
        • traffic_filter_settings object

          The rulesets to apply to all resources in this cluster. When specified, the set of rulesets is updated and the same rulesets will be applied to Kibana and APM clusters as well. If not specified, the rulesets remain as they were set previously.

          Hide traffic_filter_settings attribute Show traffic_filter_settings attribute object
          • rulesets array[string] Required

            IDs of the traffic filter rulesets

        • observability object

          Observability settings for this deployment

          Hide observability attributes Show observability attributes object
          • logging object

            The logging settings for the deployment

            Hide logging attribute Show logging attribute object
            • destination object Required

              The destination deployment that this deployment's logs will be sent to

              Hide destination attributes Show destination attributes object
              • deployment_id string Required

                The deployment to send logs and/or metrics to. Contains either the deployment's ID or 'self'.

              • ref_id string

                RefId of the Elasticsearch cluster to send logs and/or metrics to. If not specified, refId is resolved automatically as long as the destination deployment contains a single Elasticsearch resource.

          • metrics object

            The metrics settings for the deployment

            Hide metrics attribute Show metrics attribute object
            • destination object Required

              The destination deployment that this deployment's logs will be sent to

              Hide destination attributes Show destination attributes object
              • deployment_id string Required

                The deployment to send logs and/or metrics to. Contains either the deployment's ID or 'self'.

              • ref_id string

                RefId of the Elasticsearch cluster to send logs and/or metrics to. If not specified, refId is resolved automatically as long as the destination deployment contains a single Elasticsearch resource.

        • autoscaling_enabled boolean

          If autoscaling is enabled for this deployment.

        • auto_ops object Required

          See AutoOps integration status for this deployment.

          Hide auto_ops attribute Show auto_ops attribute object
          • status string Required

            See AutoOps integration status for this deployment.

            Values are connected, not_connected, or excluded.

        • solution_type string

          An optional string that declares the deployment's expected application. Example supported values are: elasticsearch, observability, security.

      • metadata object

        Additional information about this deployment

        Hide metadata attributes Show metadata attributes object
        • tags array[object]

          Arbitrary user-defined metadata associated with this deployment

          The key-value pair.

          Hide tags attributes Show tags attributes object
          • key string Required

            The metadata field name

          • value string Required

            The metadata value

        • byok_enabled boolean

          Indicates if the Deployment is BYOK enabled or not

    • minimal_metadata array[object]
    • cursor string

      To retrieve the next batch of deployments from this search, specify this value in the cursor field of the next search request. For paginated searches, it is recommended to sort on a static and unique field, like deployment or cluster id. A static and unique sort avoids concurrent updates causing a deployment to move across pages and becoming a duplicate or lost entry. The default sort of rank and modified date is often good for getting a particular deployment into the first page, but if a not yet seen deployment is modified in between page requests, then it would be left out from the next page.
POST /deployments/_search 
curl \
 --request POST 'https://api.elastic-cloud.com/api/v1/deployments/_search' \
 --header "Content-Type: application/json" \
 --data '{"from":42,"cursor":"string","size":42,"query":{"match":{"additionalProperty1":{"query":"string","operator":"string","minimum_should_match":42,"analyzer":"string"},"additionalProperty2":{"query":"string","operator":"string","minimum_should_match":42,"analyzer":"string"}},"match_all":{},"match_none":{},"term":{"additionalProperty1":{"value":"string"},"additionalProperty2":{"value":"string"}},"bool":{"must":[{}],"should":[{}],"must_not":[{}],"filter":[{}],"minimum_should_match":42},"query_string":{"query":"string","default_field":"string","analyzer":"string","default_operator":"string","allow_leading_wildcard":true},"nested":{"query":{},"path":"string","score_mode":"avg"},"prefix":{"additionalProperty1":{"value":"string","boost":42.0},"additionalProperty2":{"value":"string","boost":42.0}},"exists":{"field":"string"},"range":{"additionalProperty1":{"gt":{},"gte":{},"lt":{},"lte":{},"boost":42.0,"format":"string","time_zone":"string"},"additionalProperty2":{"gt":{},"gte":{},"lt":{},"lte":{},"boost":42.0,"format":"string","time_zone":"string"}},"simple_query_string":{"query":"string","fields":["string"],"default_operator":"string","analyze_wildcard":true,"analyzer":"string","auto_generate_synonyms_phrase_query":true,"flags":"string","fuzzy_max_expansions":42,"fuzzy_prefix_length":42,"fuzzy_transpositions":true,"lenient":true,"minimum_should_match":"string","quote_field_suffix":"string"}},"sort":[{}]}'