Path parameters

• deployment_id string Required

  Identifier for the Deployment

Query parameters

• show_security boolean

  Whether to include the Elasticsearch 2.x security information in the response - can be large per cluster and also include credentials

  Default value is false.

• show_metadata boolean

  Whether to include the full cluster metadata in the response - can be large per cluster and also include credentials

  Default value is false.

• show_plans boolean

  Whether to include the full current and pending plan information in the response - can be large per cluster

  Default value is true.

• show_plan_logs boolean

  Whether to include with the current and pending plan information the attempt log - can be very large per cluster

  Default value is false.

• show_plan_history boolean

  Whether to include the plan history with the current and pending plan information. The results can be very large per cluster. By default, if a given resource kind (e.g. Elasticsearch, Kibana, etc.) has more than 100 plans (which should be very rare, most likely caused by a bug) only 100 plans are returned for the given resource type: The first 10 plans, and the last 90 plans for that resource type. If ALL of the plans are desired, pass the force_all_plan_history parameter with a value of true.

  Default value is false.

• show_plan_defaults boolean

  If showing plans, whether to show values that are left at their default value (less readable but more informative)

  Default value is false.

• convert_legacy_plans boolean

  If showing plans, whether to leave pre-2.0.0 plans in their legacy format (the default), or whether to update them to 2.0.x+ format (if 'true')

  Default value is false.

• show_system_alerts integer

  Number of system alerts (such as forced restarts due to memory limits) to be included in the response - can be large per cluster. Negative numbers or 0 will not return field.

  Default value is 0.

• show_settings boolean

  Whether to show cluster settings in the response.

  Default value is false.

• show_instance_metrics boolean

  Whether to show resources instance metrics in the response.

  Default value is true.

• show_instance_configurations boolean

  If true, will return details for each instance configuration referenced by the deployment.

  Default value is true.

• enrich_with_template boolean

  If showing plans, whether to enrich the plan by including the missing elements from the deployment template it is based on

  Default value is true.

• force_all_plan_history boolean

  Force show the entire plan history no matter how long. As noted in the show_plan_history parameter description, by default, a maximum of 100 plans are shown per resource. If true, this parameter overrides the default, and ALL plans are returned. Use with care as the plan history can be VERY large. Consider pairing with show_plan_logs=false.

  Default value is false.

• clear_transient boolean

  If set (defaults to false) then removes the transient section from all child resources, making it safe to reapply via an update

  Default value is false.

Responses

• 200

  The Deployment info response

  Hide headers attributes Show headers attributes

  • x-cloud-resource-version string

    The resource version, which is used to avoid update conflicts with concurrent operations

  • x-cloud-resource-created string

    The date-time when the resource was created (ISO format relative to UTC)

  • x-cloud-resource-last-modified string

    The date-time when the resource was last modified (ISO format relative to UTC)

  Hide response attributes Show response 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

    Additional properties are allowed.

    Hide resources attributes Show resources attributes object

    • elasticsearch array[object] Required

      List of Elasticsearch resources in your 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.

        Additional properties are allowed.

        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.

          Additional properties are allowed.

          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.

            Additional properties are allowed.

            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

              Additional properties are allowed.

              Hide plan attributes Show plan attributes object

              • cluster_topology array[object] Required
                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.

                  Additional properties are allowed.

                  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.

                  Additional properties are allowed.

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

                    Additional properties are allowed.

                    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.

                      Additional properties are allowed.

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

                        Additional properties are allowed.

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

                        Additional properties are allowed.

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

                        Additional properties are allowed.

                        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)

                    Additional properties are allowed.

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

                    Additional properties are allowed.

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

                    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.

                    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

                    Additional properties are allowed.

                    Hide curation attributes Show curation attributes object

                    • from_instance_configuration_id string Required

                      The source instance configuration

                    • to_instance_configuration_id string Required

                      The destination instance configuration

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

                  Additional properties are allowed.

                  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.

                  Additional properties are allowed.

                  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.

                  Additional properties are allowed.

                  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.

                  Additional properties are allowed.

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

                  Additional properties are allowed.

                  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.

                    Additional properties are allowed.

                    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.

                Additional properties are allowed.

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

                  Additional properties are allowed.

                  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.

                    Additional properties are allowed.

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

                      Additional properties are allowed.

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

                      Additional properties are allowed.

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

                      Additional properties are allowed.

                      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)

                  Additional properties are allowed.

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

                  Additional properties are allowed.

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

                  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.

                  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

                  Additional properties are allowed.

                  Hide curation attributes Show curation attributes object

                  • from_instance_configuration_id string Required

                    The source instance configuration

                  • to_instance_configuration_id string Required

                    The destination instance configuration

                • 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

                Additional properties are allowed.

                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.

                Additional properties are allowed.

                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.

                  Additional properties are allowed.

                  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.

                    Additional properties are allowed.

                    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.

                    Additional properties are allowed.

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

                    Additional properties are allowed.

                  • autodetect object

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

                    Additional properties are allowed.

                • plan_configuration object

                  The configuration settings for the timeout and fallback parameters.

                  Additional properties are allowed.

                  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.

                  Additional properties are allowed.

                  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

                    Additional properties are allowed.

                    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

                      Additional properties are allowed.

                  • restore_payload object

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

                    Additional properties are allowed.

                    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

                      Additional properties are allowed.

                  • 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

                  Additional properties are allowed.

                  Hide remote_clusters attribute Show remote_clusters attribute object

                  • resources array[object] Required

                    The remote resources

                    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.

                      Additional properties are allowed.

                      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.

                  Additional properties are allowed.

              • autoscaling_enabled boolean

                Enable autoscaling for this Elasticsearch cluster.

            • plan_attempt_log array[object] Required
              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

                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

              Additional properties are allowed.

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

              Additional properties are allowed.

              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.

            Additional properties are allowed.

            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

              Additional properties are allowed.

              Hide plan attributes Show plan attributes object

              • cluster_topology array[object] Required
                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.

                  Additional properties are allowed.

                  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.

                  Additional properties are allowed.

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

                    Additional properties are allowed.

                    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.

                      Additional properties are allowed.

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

                        Additional properties are allowed.

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

                        Additional properties are allowed.

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

                        Additional properties are allowed.

                        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)

                    Additional properties are allowed.

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

                    Additional properties are allowed.

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

                    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.

                    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

                    Additional properties are allowed.

                    Hide curation attributes Show curation attributes object

                    • from_instance_configuration_id string Required

                      The source instance configuration

                    • to_instance_configuration_id string Required

                      The destination instance configuration

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

                  Additional properties are allowed.

                  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.

                  Additional properties are allowed.

                  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.

                  Additional properties are allowed.

                  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.

                  Additional properties are allowed.

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

                  Additional properties are allowed.

                  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.

                    Additional properties are allowed.

                    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.

                Additional properties are allowed.

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

                  Additional properties are allowed.

                  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.

                    Additional properties are allowed.

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

                      Additional properties are allowed.

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

                      Additional properties are allowed.

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

                      Additional properties are allowed.

                      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)

                  Additional properties are allowed.

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

                  Additional properties are allowed.

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

                  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.

                  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

                  Additional properties are allowed.

                  Hide curation attributes Show curation attributes object

                  • from_instance_configuration_id string Required

                    The source instance configuration

                  • to_instance_configuration_id string Required

                    The destination instance configuration

                • 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

                Additional properties are allowed.

                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.

                Additional properties are allowed.

                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.

                  Additional properties are allowed.

                  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.

                    Additional properties are allowed.

                    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.

                    Additional properties are allowed.

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

                    Additional properties are allowed.

                  • autodetect object

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

                    Additional properties are allowed.

                • plan_configuration object

                  The configuration settings for the timeout and fallback parameters.

                  Additional properties are allowed.

                  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.

                  Additional properties are allowed.

                  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

                    Additional properties are allowed.

                    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

                      Additional properties are allowed.

                  • restore_payload object

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

                    Additional properties are allowed.

                    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

                      Additional properties are allowed.

                  • 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

                  Additional properties are allowed.

                  Hide remote_clusters attribute Show remote_clusters attribute object

                  • resources array[object] Required

                    The remote resources

                    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.

                      Additional properties are allowed.

                      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.

                  Additional properties are allowed.

              • autoscaling_enabled boolean

                Enable autoscaling for this Elasticsearch cluster.

            • plan_attempt_log array[object] Required
              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

                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

              Additional properties are allowed.

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

              Additional properties are allowed.

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

              Additional properties are allowed.

              Hide plan attributes Show plan attributes object

              • cluster_topology array[object] Required
                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.

                  Additional properties are allowed.

                  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.

                  Additional properties are allowed.

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

                    Additional properties are allowed.

                    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.

                      Additional properties are allowed.

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

                        Additional properties are allowed.

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

                        Additional properties are allowed.

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

                        Additional properties are allowed.

                        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)

                    Additional properties are allowed.

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

                    Additional properties are allowed.

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

                    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.

                    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

                    Additional properties are allowed.

                    Hide curation attributes Show curation attributes object

                    • from_instance_configuration_id string Required

                      The source instance configuration

                    • to_instance_configuration_id string Required

                      The destination instance configuration

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

                  Additional properties are allowed.

                  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.

                  Additional properties are allowed.

                  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.

                  Additional properties are allowed.

                  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.

                  Additional properties are allowed.

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

                  Additional properties are allowed.

                  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.

                    Additional properties are allowed.

                    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.

                Additional properties are allowed.

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

                  Additional properties are allowed.

                  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.

                    Additional properties are allowed.

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

                      Additional properties are allowed.

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

                      Additional properties are allowed.

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

                      Additional properties are allowed.

                      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)

                  Additional properties are allowed.

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

                  Additional properties are allowed.

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

                  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.

                  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

                  Additional properties are allowed.

                  Hide curation attributes Show curation attributes object

                  • from_instance_configuration_id string Required

                    The source instance configuration

                  • to_instance_configuration_id string Required

                    The destination instance configuration

                • 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

                Additional properties are allowed.

                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.

                Additional properties are allowed.

                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.

                  Additional properties are allowed.

                  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.

                    Additional properties are allowed.

                    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.

                    Additional properties are allowed.

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

                    Additional properties are allowed.

                  • autodetect object

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

                    Additional properties are allowed.

                • plan_configuration object

                  The configuration settings for the timeout and fallback parameters.

                  Additional properties are allowed.

                  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.

                  Additional properties are allowed.

                  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

                    Additional properties are allowed.

                    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

                      Additional properties are allowed.

                  • restore_payload object

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

                    Additional properties are allowed.

                    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

                      Additional properties are allowed.

                  • 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

                  Additional properties are allowed.

                  Hide remote_clusters attribute Show remote_clusters attribute object

                  • resources array[object] Required

                    The remote resources

                    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.

                      Additional properties are allowed.

                      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.

                  Additional properties are allowed.

              • autoscaling_enabled boolean

                Enable autoscaling for this Elasticsearch cluster.

            • plan_attempt_log array[object] Required
              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

                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

              Additional properties are allowed.

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

              Additional properties are allowed.

              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.

          Additional properties are allowed.

          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

            Additional properties are allowed.

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

            Additional properties are allowed.

            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.

            Additional properties are allowed.

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

            Additional properties are allowed.

            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

              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

              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.

            Additional properties are allowed.

            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

              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.

          Additional properties are allowed.

          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.

            Additional properties are allowed.

          • ports object

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

            Additional properties are allowed.

            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

            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.

          Additional properties are allowed.

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

              Additional properties are allowed.

              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

              Additional properties are allowed.

              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.

              Additional properties are allowed.

              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

              Additional properties are allowed.

              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

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

              Additional properties are allowed.

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

              Additional properties are allowed.

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

              Additional properties are allowed.

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

              Additional properties are allowed.

              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.

          Additional properties are allowed.

          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
            Hide users attributes Show users attributes object

            • username string Required

              The username

            • password_hash string Required

              The hashed password

          • 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

            Additional properties are allowed.

          • users_roles array[object] Required
            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.

          Additional properties are allowed.

          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.

          Additional properties are allowed.

          Hide snapshots attributes Show snapshots attributes object

          • healthy boolean Required

            Health status of snapshots for this cluster

          • count integer(int32) Required

            Number of snapshots stored for this cluster

          • latest_successful boolean

            Latest snapshot status

          • latest_status string

            Status of the latest snapshot attempt, if any exist.

          • scheduled_time string(date-time)

            Scheduled time of next snapshot attempt

          • latest_end_time string(date-time)

            The end time of the most recently attempted snapshot

          • latest_successful_end_time string(date-time)

            The end time of the most recently successful snapshot

          • recent_success boolean Required

            Indicates whether the cluster has a relatively recent successful snapshot.

        • 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

            Additional properties are allowed.

            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

          Additional properties are allowed.

          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.

            Additional properties are allowed.

            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

              Additional properties are allowed.

              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.

            Additional properties are allowed.

            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.

            Additional properties are allowed.

            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.

            Additional properties are allowed.

            Hide curation attribute Show curation attribute object

            • specs array[object] Required

              Specifications for curation

              Hide specs attributes Show specs attributes object

              • index_pattern string Required

                Index matching pattern

              • trigger_interval_seconds integer(int32) Required

                Number of seconds after index creation to trigger this spec

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

            Additional properties are allowed.

            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.

            Additional properties are allowed.

            Hide trust attributes Show trust attributes object

            • accounts array[object]

              The list of trust relationships with different accounts

              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

              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.

              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.

                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.

                  Additional properties are allowed.

                  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.

            Additional properties are allowed.

            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.

                Additional properties are allowed.

                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.

                  Additional properties are allowed.

                • 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

      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.

        Additional properties are allowed.

        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.

          Additional properties are allowed.

          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

              Additional properties are allowed.

              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.

          Additional properties are allowed.

          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.

            Additional properties are allowed.

            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.

              Additional properties are allowed.

              Hide plan attributes Show plan attributes object

              • cluster_topology array[object]
                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.

                  Additional properties are allowed.

                  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.

                  Additional properties are allowed.

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

                    Additional properties are allowed.

                    Hide system_settings attributes Show system_settings attributes object

                    • elasticsearch_url string

                      DEPRECATED: Scheduled for removal in a future version of the API.

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

                    Additional properties are allowed.

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

                    Additional properties are allowed.

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

                Additional properties are allowed.

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

                  Additional properties are allowed.

                  Hide system_settings attributes Show system_settings attributes object

                  • elasticsearch_url string

                    DEPRECATED: Scheduled for removal in a future version of the API.

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

                  Additional properties are allowed.

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

                  Additional properties are allowed.

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

                Additional properties are allowed.

                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.

                  Additional properties are allowed.

                  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.

                    Additional properties are allowed.

                    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.

                    Additional properties are allowed.

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

                    Additional properties are allowed.

                  • autodetect object

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

                    Additional properties are allowed.

                • plan_configuration object

                  The configuration settings for the timeout and fallback parameters.

                  Additional properties are allowed.

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

                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

              Additional properties are allowed.

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

              Additional properties are allowed.

              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.

            Additional properties are allowed.

            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.

              Additional properties are allowed.

              Hide plan attributes Show plan attributes object

              • cluster_topology array[object]
                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.

                  Additional properties are allowed.

                  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.

                  Additional properties are allowed.

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

                    Additional properties are allowed.

                    Hide system_settings attributes Show system_settings attributes object

                    • elasticsearch_url string

                      DEPRECATED: Scheduled for removal in a future version of the API.

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

                    Additional properties are allowed.

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

                    Additional properties are allowed.

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

                Additional properties are allowed.

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

                  Additional properties are allowed.

                  Hide system_settings attributes Show system_settings attributes object

                  • elasticsearch_url string

                    DEPRECATED: Scheduled for removal in a future version of the API.

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

                  Additional properties are allowed.

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

                  Additional properties are allowed.

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

                Additional properties are allowed.

                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.

                  Additional properties are allowed.

                  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.

                    Additional properties are allowed.

                    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.

                    Additional properties are allowed.

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

                    Additional properties are allowed.

                  • autodetect object

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

                    Additional properties are allowed.

                • plan_configuration object

                  The configuration settings for the timeout and fallback parameters.

                  Additional properties are allowed.

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

                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

              Additional properties are allowed.

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

              Additional properties are allowed.

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

              Additional properties are allowed.

              Hide plan attributes Show plan attributes object

              • cluster_topology array[object]
                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.

                  Additional properties are allowed.

                  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.

                  Additional properties are allowed.

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

                    Additional properties are allowed.

                    Hide system_settings attributes Show system_settings attributes object

                    • elasticsearch_url string

                      DEPRECATED: Scheduled for removal in a future version of the API.

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

                    Additional properties are allowed.

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

                    Additional properties are allowed.

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

                Additional properties are allowed.

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

                  Additional properties are allowed.

                  Hide system_settings attributes Show system_settings attributes object

                  • elasticsearch_url string

                    DEPRECATED: Scheduled for removal in a future version of the API.

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

                  Additional properties are allowed.

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

                  Additional properties are allowed.

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

                Additional properties are allowed.

                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.

                  Additional properties are allowed.

                  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.

                    Additional properties are allowed.

                    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.

                    Additional properties are allowed.

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

                    Additional properties are allowed.

                  • autodetect object

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

                    Additional properties are allowed.

                • plan_configuration object

                  The configuration settings for the timeout and fallback parameters.

                  Additional properties are allowed.

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

                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

              Additional properties are allowed.

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

              Additional properties are allowed.

              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.

          Additional properties are allowed.

          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.

            Additional properties are allowed.

          • ports object

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

            Additional properties are allowed.

            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

            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.

          Additional properties are allowed.

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

              Additional properties are allowed.

              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

              Additional properties are allowed.

              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.

              Additional properties are allowed.

              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

              Additional properties are allowed.

              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

            Additional properties are allowed.

            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

          Additional properties are allowed.

          Hide settings attribute Show settings attribute object

          • metadata object

            The top-level configuration settings for the Elasticsearch cluster.

            Additional properties are allowed.

            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

      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.

        Additional properties are allowed.

        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.

          Additional properties are allowed.

          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

              Additional properties are allowed.

              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.

          Additional properties are allowed.

          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.

            Additional properties are allowed.

            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.

              Additional properties are allowed.

              Hide plan attributes Show plan attributes object

              • cluster_topology array[object]
                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.

                  Additional properties are allowed.

                  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.

                  Additional properties are allowed.

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

                    Additional properties are allowed.

                    Hide system_settings attributes Show system_settings attributes object

                    • elasticsearch_url string

                      DEPRECATED: Scheduled for removal in a future version of the API.

                      Optionally override the URL to which to send data (for advanced users only, if unspecified the system selects an internal URL)

                    • kibana_url string

                      DEPRECATED: Scheduled for removal in a future version of the API.

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

                    Additional properties are allowed.

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

                    Additional properties are allowed.

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

                Additional properties are allowed.

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

                  Additional properties are allowed.

                  Hide system_settings attributes Show system_settings attributes object

                  • elasticsearch_url string

                    DEPRECATED: Scheduled for removal in a future version of the API.

                    Optionally override the URL to which to send data (for advanced users only, if unspecified the system selects an internal URL)

                  • kibana_url string

                    DEPRECATED: Scheduled for removal in a future version of the API.

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

                  Additional properties are allowed.

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

                  Additional properties are allowed.

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

                Additional properties are allowed.

                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.

                  Additional properties are allowed.

                  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.

                    Additional properties are allowed.

                    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.

                    Additional properties are allowed.

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

                    Additional properties are allowed.

                  • autodetect object

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

                    Additional properties are allowed.

                • plan_configuration object

                  The plan control configuration options for the APM Server.

                  Additional properties are allowed.

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

                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

              Additional properties are allowed.

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

              Additional properties are allowed.

              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.

            Additional properties are allowed.

            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.

              Additional properties are allowed.

              Hide plan attributes Show plan attributes object

              • cluster_topology array[object]
                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.

                  Additional properties are allowed.

                  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.

                  Additional properties are allowed.

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

                    Additional properties are allowed.

                    Hide system_settings attributes Show system_settings attributes object

                    • elasticsearch_url string

                      DEPRECATED: Scheduled for removal in a future version of the API.

                      Optionally override the URL to which to send data (for advanced users only, if unspecified the system selects an internal URL)

                    • kibana_url string

                      DEPRECATED: Scheduled for removal in a future version of the API.

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

                    Additional properties are allowed.

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

                    Additional properties are allowed.

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

                Additional properties are allowed.

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

                  Additional properties are allowed.

                  Hide system_settings attributes Show system_settings attributes object

                  • elasticsearch_url string

                    DEPRECATED: Scheduled for removal in a future version of the API.

                    Optionally override the URL to which to send data (for advanced users only, if unspecified the system selects an internal URL)

                  • kibana_url string

                    DEPRECATED: Scheduled for removal in a future version of the API.

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

                  Additional properties are allowed.

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

                  Additional properties are allowed.

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

                Additional properties are allowed.

                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.

                  Additional properties are allowed.

                  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.

                    Additional properties are allowed.

                    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.

                    Additional properties are allowed.

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

                    Additional properties are allowed.

                  • autodetect object

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

                    Additional properties are allowed.

                • plan_configuration object

                  The plan control configuration options for the APM Server.

                  Additional properties are allowed.

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

                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

              Additional properties are allowed.

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

              Additional properties are allowed.

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

              Additional properties are allowed.

              Hide plan attributes Show plan attributes object

              • cluster_topology array[object]
                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.

                  Additional properties are allowed.

                  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.

                  Additional properties are allowed.

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

                    Additional properties are allowed.

                    Hide system_settings attributes Show system_settings attributes object

                    • elasticsearch_url string

                      DEPRECATED: Scheduled for removal in a future version of the API.

                      Optionally override the URL to which to send data (for advanced users only, if unspecified the system selects an internal URL)

                    • kibana_url string

                      DEPRECATED: Scheduled for removal in a future version of the API.

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

                    Additional properties are allowed.

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

                    Additional properties are allowed.

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

                Additional properties are allowed.

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

                  Additional properties are allowed.

                  Hide system_settings attributes Show system_settings attributes object

                  • elasticsearch_url string

                    DEPRECATED: Scheduled for removal in a future version of the API.

                    Optionally override the URL to which to send data (for advanced users only, if unspecified the system selects an internal URL)

                  • kibana_url string

                    DEPRECATED: Scheduled for removal in a future version of the API.

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

                  Additional properties are allowed.

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

                  Additional properties are allowed.

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

                Additional properties are allowed.

                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.

                  Additional properties are allowed.

                  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.

                    Additional properties are allowed.

                    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.

                    Additional properties are allowed.

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

                    Additional properties are allowed.

                  • autodetect object

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

                    Additional properties are allowed.

                • plan_configuration object

                  The plan control configuration options for the APM Server.

                  Additional properties are allowed.

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

                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

              Additional properties are allowed.

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

              Additional properties are allowed.

              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.

          Additional properties are allowed.

          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.

            Additional properties are allowed.

          • ports object

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

            Additional properties are allowed.

            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

            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.

          Additional properties are allowed.

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

              Additional properties are allowed.

              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

              Additional properties are allowed.

              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.

              Additional properties are allowed.

              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

              Additional properties are allowed.

              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

            Additional properties are allowed.

            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

          Additional properties are allowed.

          Hide settings attribute Show settings attribute object

          • metadata object

            The top-level configuration settings for the Elasticsearch cluster.

            Additional properties are allowed.

            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

      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.

        Additional properties are allowed.

        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.

          Additional properties are allowed.

          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

              Additional properties are allowed.

              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.

          Additional properties are allowed.

          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.

            Additional properties are allowed.

            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.

              Additional properties are allowed.

              Hide plan attributes Show plan attributes object

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

                • node_type object

                  Defines the AppSearch node type

                  Additional properties are allowed.

                  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.

                  Additional properties are allowed.

                  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

                  Additional properties are allowed.

                  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)

                    Additional properties are allowed.

                    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)

                    Additional properties are allowed.

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

                    Additional properties are allowed.

                  • 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

                Additional properties are allowed.

                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)

                  Additional properties are allowed.

                  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)

                  Additional properties are allowed.

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

                  Additional properties are allowed.

                • 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

                Additional properties are allowed.

                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.

                  Additional properties are allowed.

                  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.

                    Additional properties are allowed.

                    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.

                    Additional properties are allowed.

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

                    Additional properties are allowed.

                  • autodetect object

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

                    Additional properties are allowed.

                • plan_configuration object

                  Additional properties are allowed.

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

                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

              Additional properties are allowed.

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

              Additional properties are allowed.

              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.

            Additional properties are allowed.

            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.

              Additional properties are allowed.

              Hide plan attributes Show plan attributes object

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

                • node_type object

                  Defines the AppSearch node type

                  Additional properties are allowed.

                  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.

                  Additional properties are allowed.

                  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

                  Additional properties are allowed.

                  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)

                    Additional properties are allowed.

                    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)

                    Additional properties are allowed.

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

                    Additional properties are allowed.

                  • 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

                Additional properties are allowed.

                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)

                  Additional properties are allowed.

                  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)

                  Additional properties are allowed.

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

                  Additional properties are allowed.

                • 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

                Additional properties are allowed.

                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.

                  Additional properties are allowed.

                  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.

                    Additional properties are allowed.

                    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.

                    Additional properties are allowed.

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

                    Additional properties are allowed.

                  • autodetect object

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

                    Additional properties are allowed.

                • plan_configuration object

                  Additional properties are allowed.

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

                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

              Additional properties are allowed.

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

              Additional properties are allowed.

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

              Additional properties are allowed.

              Hide plan attributes Show plan attributes object

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

                • node_type object

                  Defines the AppSearch node type

                  Additional properties are allowed.

                  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.

                  Additional properties are allowed.

                  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

                  Additional properties are allowed.

                  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)

                    Additional properties are allowed.

                    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)

                    Additional properties are allowed.

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

                    Additional properties are allowed.

                  • 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

                Additional properties are allowed.

                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)

                  Additional properties are allowed.

                  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)

                  Additional properties are allowed.

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

                  Additional properties are allowed.

                • 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

                Additional properties are allowed.

                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.

                  Additional properties are allowed.

                  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.

                    Additional properties are allowed.

                    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.

                    Additional properties are allowed.

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

                    Additional properties are allowed.

                  • autodetect object

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

                    Additional properties are allowed.

                • plan_configuration object

                  Additional properties are allowed.

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

                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

              Additional properties are allowed.

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

              Additional properties are allowed.

              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.

          Additional properties are allowed.

          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.

            Additional properties are allowed.

          • ports object

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

            Additional properties are allowed.

            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

            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.

          Additional properties are allowed.

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

              Additional properties are allowed.

              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

              Additional properties are allowed.

              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.

              Additional properties are allowed.

              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

              Additional properties are allowed.

              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

            Additional properties are allowed.

            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

          Additional properties are allowed.

          Hide settings attribute Show settings attribute object

          • metadata object

            The top-level configuration settings for the Elasticsearch cluster.

            Additional properties are allowed.

            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

      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.

        Additional properties are allowed.

        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.

          Additional properties are allowed.

          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

              Additional properties are allowed.

              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.

          Additional properties are allowed.

          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.

            Additional properties are allowed.

            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.

              Additional properties are allowed.

              Hide plan attributes Show plan attributes object

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

                • node_type object

                  Defines the EnterpriseSearch node type

                  Additional properties are allowed.

                  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.

                  Additional properties are allowed.

                  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

                  Additional properties are allowed.

                  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)

                    Additional properties are allowed.

                    Hide system_settings attributes Show system_settings attributes object

                    • elasticsearch_url string

                      DEPRECATED: Scheduled for removal in a future version of the API.

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

                    Additional properties are allowed.

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

                    Additional properties are allowed.

                  • 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

                  Additional properties are allowed.

                • node_configuration string
                • memory_per_node object

                  Additional properties are allowed.

                • node_count_per_zone object

                  Additional properties are allowed.

              • enterprise_search object Required

                Additional properties are allowed.

                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)

                  Additional properties are allowed.

                  Hide system_settings attributes Show system_settings attributes object

                  • elasticsearch_url string

                    DEPRECATED: Scheduled for removal in a future version of the API.

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

                  Additional properties are allowed.

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

                  Additional properties are allowed.

                • 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

                Additional properties are allowed.

                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.

                  Additional properties are allowed.

                  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.

                    Additional properties are allowed.

                    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.

                    Additional properties are allowed.

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

                    Additional properties are allowed.

                  • autodetect object

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

                    Additional properties are allowed.

                • plan_configuration object

                  Additional properties are allowed.

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

                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

              Additional properties are allowed.

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

              Additional properties are allowed.

              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.

            Additional properties are allowed.

            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.

              Additional properties are allowed.

              Hide plan attributes Show plan attributes object

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

                • node_type object

                  Defines the EnterpriseSearch node type

                  Additional properties are allowed.

                  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.

                  Additional properties are allowed.

                  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

                  Additional properties are allowed.

                  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)

                    Additional properties are allowed.

                    Hide system_settings attributes Show system_settings attributes object

                    • elasticsearch_url string

                      DEPRECATED: Scheduled for removal in a future version of the API.

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

                    Additional properties are allowed.

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

                    Additional properties are allowed.

                  • 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

                  Additional properties are allowed.

                • node_configuration string
                • memory_per_node object

                  Additional properties are allowed.

                • node_count_per_zone object

                  Additional properties are allowed.

              • enterprise_search object Required

                Additional properties are allowed.

                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)

                  Additional properties are allowed.

                  Hide system_settings attributes Show system_settings attributes object

                  • elasticsearch_url string

                    DEPRECATED: Scheduled for removal in a future version of the API.

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

                  Additional properties are allowed.

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

                  Additional properties are allowed.

                • 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

                Additional properties are allowed.

                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.

                  Additional properties are allowed.

                  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.

                    Additional properties are allowed.

                    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.

                    Additional properties are allowed.

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

                    Additional properties are allowed.

                  • autodetect object

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

                    Additional properties are allowed.

                • plan_configuration object

                  Additional properties are allowed.

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

                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

              Additional properties are allowed.

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

              Additional properties are allowed.

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

              Additional properties are allowed.

              Hide plan attributes Show plan attributes object

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

                • node_type object

                  Defines the EnterpriseSearch node type

                  Additional properties are allowed.

                  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.

                  Additional properties are allowed.

                  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

                  Additional properties are allowed.

                  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)

                    Additional properties are allowed.

                    Hide system_settings attributes Show system_settings attributes object

                    • elasticsearch_url string

                      DEPRECATED: Scheduled for removal in a future version of the API.

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

                    Additional properties are allowed.

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

                    Additional properties are allowed.

                  • 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

                  Additional properties are allowed.

                • node_configuration string
                • memory_per_node object

                  Additional properties are allowed.

                • node_count_per_zone object

                  Additional properties are allowed.

              • enterprise_search object Required

                Additional properties are allowed.

                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)

                  Additional properties are allowed.

                  Hide system_settings attributes Show system_settings attributes object

                  • elasticsearch_url string

                    DEPRECATED: Scheduled for removal in a future version of the API.

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

                  Additional properties are allowed.

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

                  Additional properties are allowed.

                • 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

                Additional properties are allowed.

                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.

                  Additional properties are allowed.

                  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.

                    Additional properties are allowed.

                    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.

                    Additional properties are allowed.

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

                    Additional properties are allowed.

                  • autodetect object

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

                    Additional properties are allowed.

                • plan_configuration object

                  Additional properties are allowed.

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

                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

              Additional properties are allowed.

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

              Additional properties are allowed.

              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.

          Additional properties are allowed.

          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.

            Additional properties are allowed.

          • ports object

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

            Additional properties are allowed.

            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

            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.

          Additional properties are allowed.

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

              Additional properties are allowed.

              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

              Additional properties are allowed.

              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.

              Additional properties are allowed.

              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

              Additional properties are allowed.

              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

            Additional properties are allowed.

            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

          Additional properties are allowed.

          Hide settings attribute Show settings attribute object

          • metadata object

            The top-level configuration settings for the Elasticsearch cluster.

            Additional properties are allowed.

            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

      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.

        Additional properties are allowed.

        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.

          Additional properties are allowed.

          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

              Additional properties are allowed.

              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.

          Additional properties are allowed.

          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.

            Additional properties are allowed.

            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.

              Additional properties are allowed.

              Hide plan attributes Show plan attributes object

              • cluster_topology array[object]
                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.

                  Additional properties are allowed.

                  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.

                  Additional properties are allowed.

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

                    Additional properties are allowed.

                    Hide system_settings attributes Show system_settings attributes object

                    • elasticsearch_url string

                      DEPRECATED: Scheduled for removal in a future version of the API.

                      Optionally override the URL to which to send data (for advanced users only, if unspecified the system selects an internal URL)

                    • kibana_url string

                      DEPRECATED: Scheduled for removal in a future version of the API.

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

                    Additional properties are allowed.

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

                    Additional properties are allowed.

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

                Additional properties are allowed.

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

                  Additional properties are allowed.

                  Hide system_settings attributes Show system_settings attributes object

                  • elasticsearch_url string

                    DEPRECATED: Scheduled for removal in a future version of the API.

                    Optionally override the URL to which to send data (for advanced users only, if unspecified the system selects an internal URL)

                  • kibana_url string

                    DEPRECATED: Scheduled for removal in a future version of the API.

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

                  Additional properties are allowed.

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

                  Additional properties are allowed.

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

                Additional properties are allowed.

                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.

                  Additional properties are allowed.

                  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.

                    Additional properties are allowed.

                    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.

                    Additional properties are allowed.

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

                    Additional properties are allowed.

                  • autodetect object

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

                    Additional properties are allowed.

                • plan_configuration object

                  The plan control configuration options for the Integrations Server.

                  Additional properties are allowed.

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

                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

              Additional properties are allowed.

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

              Additional properties are allowed.

              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.

            Additional properties are allowed.

            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.

              Additional properties are allowed.

              Hide plan attributes Show plan attributes object

              • cluster_topology array[object]
                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.

                  Additional properties are allowed.

                  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.

                  Additional properties are allowed.

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

                    Additional properties are allowed.

                    Hide system_settings attributes Show system_settings attributes object

                    • elasticsearch_url string

                      DEPRECATED: Scheduled for removal in a future version of the API.

                      Optionally override the URL to which to send data (for advanced users only, if unspecified the system selects an internal URL)

                    • kibana_url string

                      DEPRECATED: Scheduled for removal in a future version of the API.

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

                    Additional properties are allowed.

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

                    Additional properties are allowed.

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

                Additional properties are allowed.

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

                  Additional properties are allowed.

                  Hide system_settings attributes Show system_settings attributes object

                  • elasticsearch_url string

                    DEPRECATED: Scheduled for removal in a future version of the API.

                    Optionally override the URL to which to send data (for advanced users only, if unspecified the system selects an internal URL)

                  • kibana_url string

                    DEPRECATED: Scheduled for removal in a future version of the API.

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

                  Additional properties are allowed.

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

                  Additional properties are allowed.

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

                Additional properties are allowed.

                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.

                  Additional properties are allowed.

                  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.

                    Additional properties are allowed.

                    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.

                    Additional properties are allowed.

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

                    Additional properties are allowed.

                  • autodetect object

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

                    Additional properties are allowed.

                • plan_configuration object

                  The plan control configuration options for the Integrations Server.

                  Additional properties are allowed.

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

                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

              Additional properties are allowed.

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

              Additional properties are allowed.

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

              Additional properties are allowed.

              Hide plan attributes Show plan attributes object

              • cluster_topology array[object]
                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.

                  Additional properties are allowed.

                  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.

                  Additional properties are allowed.

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

                    Additional properties are allowed.

                    Hide system_settings attributes Show system_settings attributes object

                    • elasticsearch_url string

                      DEPRECATED: Scheduled for removal in a future version of the API.

                      Optionally override the URL to which to send data (for advanced users only, if unspecified the system selects an internal URL)

                    • kibana_url string

                      DEPRECATED: Scheduled for removal in a future version of the API.

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

                    Additional properties are allowed.

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

                    Additional properties are allowed.

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

                Additional properties are allowed.

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

                  Additional properties are allowed.

                  Hide system_settings attributes Show system_settings attributes object

                  • elasticsearch_url string

                    DEPRECATED: Scheduled for removal in a future version of the API.

                    Optionally override the URL to which to send data (for advanced users only, if unspecified the system selects an internal URL)

                  • kibana_url string

                    DEPRECATED: Scheduled for removal in a future version of the API.

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

                  Additional properties are allowed.

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

                  Additional properties are allowed.

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

                Additional properties are allowed.

                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.

                  Additional properties are allowed.

                  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.

                    Additional properties are allowed.

                    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.

                    Additional properties are allowed.

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

                    Additional properties are allowed.

                  • autodetect object

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

                    Additional properties are allowed.

                • plan_configuration object

                  The plan control configuration options for the Integrations Server.

                  Additional properties are allowed.

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

                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

              Additional properties are allowed.

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

              Additional properties are allowed.

              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.

          Additional properties are allowed.

          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.

            Additional properties are allowed.

          • ports object

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

            Additional properties are allowed.

            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

            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.

          Additional properties are allowed.

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

              Additional properties are allowed.

              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

              Additional properties are allowed.

              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.

              Additional properties are allowed.

              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

              Additional properties are allowed.

              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

            Additional properties are allowed.

            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

          Additional properties are allowed.

          Hide settings attribute Show settings attribute object

          • metadata object

            The top-level configuration settings for the Elasticsearch cluster.

            Additional properties are allowed.

            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

    Additional properties are allowed.

    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.

      Additional properties are allowed.

      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

      Additional properties are allowed.

      Hide observability attributes Show observability attributes object

      • logging object

        The logging settings for the deployment

        Additional properties are allowed.

        Hide logging attribute Show logging attribute object

        • destination object Required

          The destination deployment that this deployment's logs will be sent to

          Additional properties are allowed.

          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

        Additional properties are allowed.

        Hide metrics attribute Show metrics attribute object

        • destination object Required

          The destination deployment that this deployment's logs will be sent to

          Additional properties are allowed.

          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.

      Additional properties are allowed.

      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

    Additional properties are allowed.

    Hide metadata attributes Show metadata attributes object

    • tags array[object]

      Arbitrary user-defined metadata associated with this deployment

      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

  • observability object

    The observability information for this deployment

    Additional properties are allowed.

    Hide observability attributes Show observability attributes object

    • healthy boolean Required

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

    • logging object

      The logging information for the deployment

      Additional properties are allowed.

      Hide logging attributes Show logging attributes object

      • healthy boolean Required

        Whether the deployment logging is healthy or not

      • urls object

        The URLs to view this deployment's logs in Kibana

        Hide urls attribute Show urls attribute object

        • * string Additional properties
      • issues array[object]

        Logging health issues for the deployment

        Hide issues attributes Show issues attributes object

        • description string Required

          A user-friendly description of the observability health issue

        • severity string Required

          Severity of the health issue

    • metrics object

      The metrics information for the deployment

      Additional properties are allowed.

      Hide metrics attributes Show metrics attributes object

      • healthy boolean Required

        Whether the deployment metrics are healthy or not

      • urls object

        The URLs to view this deployment's metrics in Kibana

        Hide urls attribute Show urls attribute object

        • * string Additional properties
      • issues array[object]

        Metrics health issues for the deployment

        Hide issues attributes Show issues attributes object

        • description string Required

          A user-friendly description of the observability health issue

        • severity string Required

          Severity of the health issue

    • issues array[object]

      General observability health issues for the deployment

      Hide issues attributes Show issues attributes object

      • description string Required

        A user-friendly description of the observability health issue

      • severity string Required

        Severity of the health issue

  • instance_configurations array[object]

    List of instance configurations used in the deployment.

    Hide instance_configurations attributes Show instance_configurations attributes object

    • id string

      Unique identifier for the instance configuration

    • name string Required

      Display name for the instance configuration.

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

    • description string

      Optional description for the instance configuration

    • instance_type string

      The type of instance. For instance configurations where the type is specified in the 'id', the default value of 'instance_type' will be automatically inferred.

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

    • node_types array[string]

      Node types (master, data) for the instance. For instance configurations where the type (and tier) is specified in the 'id', the default value of 'node_types' will be automatically inferred.

    • discrete_sizes object Required

      Numerics representing possible instance sizes that the instance configuration supports.

      Additional properties are allowed.

      Hide discrete_sizes attributes Show discrete_sizes attributes object

      • sizes array[integer(int32)] Required

        List of supported sizes

      • default_size integer(int32)

        The default size

      • resource string

        The unit that each size represents. If not specified, it will default to 'memory'.

        Values are memory or storage.

    • storage_multiplier number(double)

      Settings for the instance storage multiplier

    • cpu_multiplier number(double)

      Settings for the instance CPU multiplier

    • metadata object

      Optional arbitrary metadata to associate with this template.

      Additional properties are allowed.

    • max_zones integer(int32)

      The maximum number of availability zones in which this instance configuration has allocators. This field will be missing unless explicitly requested with the show_max_zones parameter.

• 401

  You are not authorized to perform this action.

  Hide response attribute Show response attribute object

  • errors array[object] Required

    A list of errors that occurred in the failing request

    Hide errors attributes Show errors attributes object

    • code string Required

      A structured code representing the error type that occurred

    • message string Required

      A human readable message describing the error that occurred

    • fields array[string]

      If the error can be tied to a specific field or fields in the user request, this lists those fields

• 404

  The Deployment specified by {deployment_id} cannot be found. (code: deployments.deployment_not_found)

  Hide headers attribute Show headers attribute

  • x-cloud-error-codes string

    The error codes associated with the response

    Value is deployments.deployment_not_found.

  Hide response attribute Show response attribute object

  • errors array[object] Required

    A list of errors that occurred in the failing request

    Hide errors attributes Show errors attributes object

    • code string Required

      A structured code representing the error type that occurred

    • message string Required

      A human readable message describing the error that occurred

    • fields array[string]

      If the error can be tied to a specific field or fields in the user request, this lists those fields