Path parameters

• deployment_id string Required

  Identifier for the Deployment

• ref_id string Required

  User-specified RefId for the Resource (or '_main' if there is only one).

Query parameters

• 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 with the current and pending plan information the plan history- can be very large per cluster.

  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.

• show_settings boolean

  Whether to show cluster settings in the response.

  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

  Standard response.

  Hide response attributes Show response attributes object

  Describes an APM resource belonging to a Deployment

  • ref_id string Required

    The locally-unique user-specified id of a Resource

  • elasticsearch_cluster_ref_id string Required

    The Elasticsearch cluster that this resource depends on.

  • id string Required

    The randomly-generated id of a Resource

  • region string Required

    The region where this resource exists

  • info object Required

    Info for the resource.

    Hide info attributes Show info attributes object

    • id string Required

      The id of the APM

    • name string Required

      The name of the APM

    • elasticsearch_cluster object Required

      Information about the specified Elasticsearch cluster.

      Hide elasticsearch_cluster attributes Show elasticsearch_cluster attributes object

      • elasticsearch_id string Required

        The Elasticsearch cluster Id

      • links object

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

        Hide links attributes Show links attributes object

        • Additional properties
        • need_elevated_permissions boolean

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

    • deployment_id string

      The id of the deployment that this APM Server belongs to.

    • healthy boolean Required

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

    • status string Required

      APM status

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

    • plan_info object Required

      Information about current, pending, and past APM Server plans.

      Hide plan_info attributes Show plan_info attributes object

      • healthy boolean Required

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

      • current object

        Information about the APM Server plan.

        Hide current attributes Show current attributes object

        • plan_attempt_id string

          A UUID for each plan attempt

        • plan_attempt_name string

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

        • healthy boolean Required

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

        • attempt_start_time string(date-time)

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

        • attempt_end_time string(date-time)

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

        • plan_end_time string(date-time)

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

        • plan object

          The plan for the APM Server.

          Hide plan attributes Show plan attributes object

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

            Defines the topology of the APM Server nodes. For example, the number or capacity of the nodes, and where you can allocate the nodes.

            • instance_configuration_id string

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

            • instance_configuration_version integer(int32)

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

            • size object

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

              Hide size attributes Show size attributes object

              • value integer(int32) Required

                Amount of resource

              • resource string Required

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

                Values are memory or storage.

            • zone_count integer(int32)

              number of zones in which nodes will be placed

            • apm object

              The configuration options for the APM Server.

              Hide apm attributes Show apm attributes object

              • version string

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

              • docker_image string

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

              • system_settings object

                A structure that defines a curated subset of the APM Server settings. TIP: To define the complete set of APM Server setting, use ApmSystemSettings with user_settings_override_ and user_settings_.

                Hide system_settings attributes Show system_settings attributes object

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

              • user_settings_yaml string

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

              • user_settings_override_json object

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

              • user_settings_override_yaml string

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

          • apm object Required

            The configuration options for the APM Server.

            Hide apm attributes Show apm attributes object

            • version string

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

            • docker_image string

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

            • system_settings object

              A structure that defines a curated subset of the APM Server settings. TIP: To define the complete set of APM Server setting, use ApmSystemSettings with user_settings_override_ and user_settings_.

              Hide system_settings attributes Show system_settings attributes object

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

            • user_settings_yaml string

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

            • user_settings_override_json object

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

            • user_settings_override_yaml string

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

          • transient object

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

            Hide transient attributes Show transient attributes object

            • strategy object

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

              Hide strategy attributes Show strategy attributes object

              • rolling object

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

                Hide rolling attributes Show rolling attributes object

                • group_by string

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

                • allow_inline_resize boolean

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

                • skip_synced_flush boolean

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

                • shard_init_wait_time integer(int64)

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

              • grow_and_shrink object

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

              • rolling_grow_and_shrink object

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

              • autodetect object

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

            • plan_configuration object

              The plan control configuration options for the APM Server.

              Hide plan_configuration attributes Show plan_configuration attributes object

              • timeout integer(int64)

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

              • calm_wait_time integer(int64)

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

              • extended_maintenance boolean

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

              • cluster_reboot string

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

                Value is forced.

        • plan_attempt_log array[object] Required
          Hide plan_attempt_log attributes Show plan_attempt_log attributes object

          Information about a step in a plan.

          • 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

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

            • 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 attributes Show details attributes object

              • Additional properties
              • key string
            • failure_type string

              The failure type, in case the step failed

        • source object

          Information describing the source that facilitated the plans current state

          Hide source attributes Show source attributes object

          • facilitator string Required

            The service where the change originated from

          • action string Required

            The type of plan change that was initiated

          • date string(date-time) Required

            The time the change was initiated

          • user_id string

            The user that requested the change

          • admin_id string

            The admin user that requested the change

          • remote_addresses array[string]

            The host addresses of the user that originated the change

        • warnings array[object] Required
          Hide warnings attributes Show warnings attributes object

          Information about a warning from a plan.

          • code string Required

            A unique warning code

          • message string Required

            A description of the warning

          • step_id string

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

        • error object

          Information about an error during a plan attempt.

          Hide error attributes Show error attributes object

          • timestamp string(date-time) Required

            Timestamp marking on info log of step

          • message string Required

            Human readable error message

          • details object Required

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

            Hide details attributes Show details attributes object

            • Additional properties
            • key string
          • failure_type string

            The failure type

      • pending object

        Information about the APM Server plan.

        Hide pending attributes Show pending attributes object

        • plan_attempt_id string

          A UUID for each plan attempt

        • plan_attempt_name string

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

        • healthy boolean Required

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

        • attempt_start_time string(date-time)

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

        • attempt_end_time string(date-time)

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

        • plan_end_time string(date-time)

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

        • plan object

          The plan for the APM Server.

          Hide plan attributes Show plan attributes object

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

            Defines the topology of the APM Server nodes. For example, the number or capacity of the nodes, and where you can allocate the nodes.

            • instance_configuration_id string

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

            • instance_configuration_version integer(int32)

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

            • size object

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

              Hide size attributes Show size attributes object

              • value integer(int32) Required

                Amount of resource

              • resource string Required

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

                Values are memory or storage.

            • zone_count integer(int32)

              number of zones in which nodes will be placed

            • apm object

              The configuration options for the APM Server.

              Hide apm attributes Show apm attributes object

              • version string

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

              • docker_image string

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

              • system_settings object

                A structure that defines a curated subset of the APM Server settings. TIP: To define the complete set of APM Server setting, use ApmSystemSettings with user_settings_override_ and user_settings_.

                Hide system_settings attributes Show system_settings attributes object

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

              • user_settings_yaml string

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

              • user_settings_override_json object

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

              • user_settings_override_yaml string

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

          • apm object Required

            The configuration options for the APM Server.

            Hide apm attributes Show apm attributes object

            • version string

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

            • docker_image string

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

            • system_settings object

              A structure that defines a curated subset of the APM Server settings. TIP: To define the complete set of APM Server setting, use ApmSystemSettings with user_settings_override_ and user_settings_.

              Hide system_settings attributes Show system_settings attributes object

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

            • user_settings_yaml string

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

            • user_settings_override_json object

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

            • user_settings_override_yaml string

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

          • transient object

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

            Hide transient attributes Show transient attributes object

            • strategy object

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

              Hide strategy attributes Show strategy attributes object

              • rolling object

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

                Hide rolling attributes Show rolling attributes object

                • group_by string

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

                • allow_inline_resize boolean

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

                • skip_synced_flush boolean

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

                • shard_init_wait_time integer(int64)

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

              • grow_and_shrink object

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

              • rolling_grow_and_shrink object

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

              • autodetect object

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

            • plan_configuration object

              The plan control configuration options for the APM Server.

              Hide plan_configuration attributes Show plan_configuration attributes object

              • timeout integer(int64)

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

              • calm_wait_time integer(int64)

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

              • extended_maintenance boolean

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

              • cluster_reboot string

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

                Value is forced.

        • plan_attempt_log array[object] Required
          Hide plan_attempt_log attributes Show plan_attempt_log attributes object

          Information about a step in a plan.

          • 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

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

            • 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 attributes Show details attributes object

              • Additional properties
              • key string
            • failure_type string

              The failure type, in case the step failed

        • source object

          Information describing the source that facilitated the plans current state

          Hide source attributes Show source attributes object

          • facilitator string Required

            The service where the change originated from

          • action string Required

            The type of plan change that was initiated

          • date string(date-time) Required

            The time the change was initiated

          • user_id string

            The user that requested the change

          • admin_id string

            The admin user that requested the change

          • remote_addresses array[string]

            The host addresses of the user that originated the change

        • warnings array[object] Required
          Hide warnings attributes Show warnings attributes object

          Information about a warning from a plan.

          • code string Required

            A unique warning code

          • message string Required

            A description of the warning

          • step_id string

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

        • error object

          Information about an error during a plan attempt.

          Hide error attributes Show error attributes object

          • timestamp string(date-time) Required

            Timestamp marking on info log of step

          • message string Required

            Human readable error message

          • details object Required

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

            Hide details attributes Show details attributes object

            • Additional properties
            • key string
          • failure_type string

            The failure type

      • history array[object] Required
        Hide history attributes Show history attributes object

        Information about the APM Server plan.

        • plan_attempt_id string

          A UUID for each plan attempt

        • plan_attempt_name string

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

        • healthy boolean Required

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

        • attempt_start_time string(date-time)

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

        • attempt_end_time string(date-time)

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

        • plan_end_time string(date-time)

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

        • plan object

          The plan for the APM Server.

          Hide plan attributes Show plan attributes object

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

            Defines the topology of the APM Server nodes. For example, the number or capacity of the nodes, and where you can allocate the nodes.

            • instance_configuration_id string

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

            • instance_configuration_version integer(int32)

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

            • size object

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

              Hide size attributes Show size attributes object

              • value integer(int32) Required

                Amount of resource

              • resource string Required

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

                Values are memory or storage.

            • zone_count integer(int32)

              number of zones in which nodes will be placed

            • apm object

              The configuration options for the APM Server.

              Hide apm attributes Show apm attributes object

              • version string

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

              • docker_image string

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

              • system_settings object

                A structure that defines a curated subset of the APM Server settings. TIP: To define the complete set of APM Server setting, use ApmSystemSettings with user_settings_override_ and user_settings_.

                Hide system_settings attributes Show system_settings attributes object

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

              • user_settings_yaml string

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

              • user_settings_override_json object

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

              • user_settings_override_yaml string

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

          • apm object Required

            The configuration options for the APM Server.

            Hide apm attributes Show apm attributes object

            • version string

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

            • docker_image string

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

            • system_settings object

              A structure that defines a curated subset of the APM Server settings. TIP: To define the complete set of APM Server setting, use ApmSystemSettings with user_settings_override_ and user_settings_.

              Hide system_settings attributes Show system_settings attributes object

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

            • user_settings_yaml string

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

            • user_settings_override_json object

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

            • user_settings_override_yaml string

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

          • transient object

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

            Hide transient attributes Show transient attributes object

            • strategy object

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

              Hide strategy attributes Show strategy attributes object

              • rolling object

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

                Hide rolling attributes Show rolling attributes object

                • group_by string

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

                • allow_inline_resize boolean

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

                • skip_synced_flush boolean

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

                • shard_init_wait_time integer(int64)

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

              • grow_and_shrink object

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

              • rolling_grow_and_shrink object

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

              • autodetect object

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

            • plan_configuration object

              The plan control configuration options for the APM Server.

              Hide plan_configuration attributes Show plan_configuration attributes object

              • timeout integer(int64)

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

              • calm_wait_time integer(int64)

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

              • extended_maintenance boolean

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

              • cluster_reboot string

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

                Value is forced.

        • plan_attempt_log array[object] Required
          Hide plan_attempt_log attributes Show plan_attempt_log attributes object

          Information about a step in a plan.

          • 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

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

            • 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 attributes Show details attributes object

              • Additional properties
              • key string
            • failure_type string

              The failure type, in case the step failed

        • source object

          Information describing the source that facilitated the plans current state

          Hide source attributes Show source attributes object

          • facilitator string Required

            The service where the change originated from

          • action string Required

            The type of plan change that was initiated

          • date string(date-time) Required

            The time the change was initiated

          • user_id string

            The user that requested the change

          • admin_id string

            The admin user that requested the change

          • remote_addresses array[string]

            The host addresses of the user that originated the change

        • warnings array[object] Required
          Hide warnings attributes Show warnings attributes object

          Information about a warning from a plan.

          • code string Required

            A unique warning code

          • message string Required

            A description of the warning

          • step_id string

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

        • error object

          Information about an error during a plan attempt.

          Hide error attributes Show error attributes object

          • timestamp string(date-time) Required

            Timestamp marking on info log of step

          • message string Required

            Human readable error message

          • details object Required

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

            Hide details attributes Show details attributes object

            • Additional properties
            • key string
          • failure_type string

            The failure type

    • metadata object

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

      Hide metadata attributes Show metadata attributes object

      • version integer(int32) Required

        The resource version number of the cluster metadata

      • last_modified string(date-time) Required

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

      • endpoint string

        The DNS name of the cluster endpoint, if available

      • service_url string

        The full URL to access this deployment resource

      • aliased_endpoint string

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

      • aliased_url string

        The full aliased URL to access this deployment resource

      • cloud_id string

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

      • raw object

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

      • ports object

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

        Hide ports attributes Show ports attributes object

        • http integer(int32) Required

          Port where the cluster listens for HTTP traffic

        • https integer(int32) Required

          Port where the cluster listens for HTTPS traffic

        • transport_passthrough integer(int32) Required

          Port where the cluster listens for transport traffic using TLS

      • services_urls array[object]

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

        Hide services_urls attributes Show services_urls attributes object

        A URL to access the service of a resource

        • service string Required

          Name of the service

        • url string Required

          The full URL to access the service

    • topology object Required

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

      Hide topology attributes Show topology attributes object

      • healthy boolean Required

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

      • instances array[object] Required
        Hide instances attributes Show instances attributes object

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

        • instance_name string Required

          The name of the instance in Elastic Cloud

        • instance_configuration object

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

          Hide instance_configuration attributes Show instance_configuration attributes object

          • id string Required

            The id of the configuration used to create the instance

          • name string Required

            The name of the configuration used to create the instance

          • config_version integer(int32)

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

          • resource string Required

            The resource type of the instance configuration

            Values are memory or storage.

        • service_version string

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

        • healthy boolean Required

          Whether the instance is healthy (ie started and running)

        • container_started boolean Required

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

        • service_running boolean Required

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

        • maintenance_mode boolean Required

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

        • zone string

          The zone in which this instance is being allocated

        • allocator_id string

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

        • memory object

          Information about the specific instances memory capacity and its usage

          Hide memory attributes Show memory attributes object

          • instance_capacity integer(int32) Required

            The memory capacity in MB of the instance

          • instance_capacity_planned integer(int32)

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

          • memory_pressure integer(int32)

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

          • native_memory_pressure integer(int32)

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

        • disk object

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

          Hide disk attributes Show disk attributes object

          • disk_space_available integer(int64)

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

          • disk_space_used integer(int64) Required

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

          • storage_multiplier number(double) Required

            The storage multiplier originally defined to calculate disk space.

        • service_roles array[string]

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

        • node_roles array[string]

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

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

        • instance_overrides object

          Instance overrides

          Hide instance_overrides attributes Show instance_overrides attributes object

          • capacity integer(int32)

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

          • storage_multiplier number(double)

            Overrides the disk quota multiplier for the instance

    • external_links array[object] Required

      External resources related to the APM

      Hide external_links attributes Show external_links attributes object

      • id string Required

        Identifier of the external link

      • label string Required

        Human-readable description of the external link

      • uri string

        hyperlink to an external resource

    • links object

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

      Hide links attributes Show links attributes object

      • Additional properties
      • need_elevated_permissions boolean

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

    • settings object

      The settings for building this APM cluster

      Hide settings attribute Show settings attribute object

      • metadata object

        The top-level configuration settings for the Elasticsearch cluster.

        Hide metadata attribute Show metadata attribute object

        • name string

          The display name of the cluster

    • region string

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

    • apm_server_mode string

      The mode APM is operating in.

      Values are standalone or managed.

• 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

• 500

  We have failed you. (code: deployments.deployment_resource_no_longer_exists)

  Hide headers attribute Show headers attribute

  • x-cloud-error-codes string

    The error codes associated with the response

    Value is deployments.deployment_resource_no_longer_exists.

  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