Get Deployment Enterprise Search Resource Info

GET /deployments/{deployment_id}/enterprise_search/{ref_id}

Get info about an Enterprise Search Resource belonging to a given Deployment.

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
- 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
  
  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)
  
  preferred_allocator_tags object
  
  Map containing allocators tags in form of key value pairs, increasing the likelihood during move requests for allocators with matching tags, to be selected as target allocators
  
  Hide preferred_allocator_tags attribute Show preferred_allocator_tags attribute object
  
  * string Additional properties
  
  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.
  
  override_failsafe boolean
  
  If false (the default), the plan fails if it determines that the request can result in unsafe operations. Setting this flag overrides some of these check restraints.
  
  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
  
  internal_details object
  
  A json object with sensitive details for the log, visible only to admins. May contain nested json objects.
  
  Hide internal_details attribute Show internal_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
  
  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)
  
  preferred_allocator_tags object
  
  Map containing allocators tags in form of key value pairs, increasing the likelihood during move requests for allocators with matching tags, to be selected as target allocators
  
  Hide preferred_allocator_tags attribute Show preferred_allocator_tags attribute object
  
  * string Additional properties
  
  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.
  
  override_failsafe boolean
  
  If false (the default), the plan fails if it determines that the request can result in unsafe operations. Setting this flag overrides some of these check restraints.
  
  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
  
  internal_details object
  
  A json object with sensitive details for the log, visible only to admins. May contain nested json objects.
  
  Hide internal_details attribute Show internal_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
  
  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)
  
  preferred_allocator_tags object
  
  Map containing allocators tags in form of key value pairs, increasing the likelihood during move requests for allocators with matching tags, to be selected as target allocators
  
  Hide preferred_allocator_tags attribute Show preferred_allocator_tags attribute object
  
  * string Additional properties
  
  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.
  
  override_failsafe boolean
  
  If false (the default), the plan fails if it determines that the request can result in unsafe operations. Setting this flag overrides some of these check restraints.
  
  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
  
  internal_details object
  
  A json object with sensitive details for the log, visible only to admins. May contain nested json objects.
  
  Hide internal_details attribute Show internal_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 attributes Show metadata attributes object
  
  name string
  
  The display name of the cluster
  
  owner_id string
  
  The user id (referencing whatever user database is in use) of the cluster owner
  
  organization_id string
  
  The organization that owns the deployment
  
  subscription_level string
  
  Subscription level of the cluster
  
  system_owned boolean
  
  Indicates if a cluster is system owned (restricts the set of operations that can be performed on it)
  
  contact_email string
  
  Contact email for the cluster
  
  hidden boolean
  
  Whether or not this cluster is hidden from the normal clusters list
  
  resources object
  
  The top-level configuration settings for the Elasticsearch cluster resources.
  
  Additional properties are allowed.
  
  Hide resources attribute Show resources attribute object
  
  cpu object
  
  Specifies the CPU resource settings for the Elasticsearch cluster.
  
  Additional properties are allowed.
  
  Hide cpu attributes Show cpu attributes object
  
  boost boolean
  
  Indicates if the CPU boost flag is enabled or not.
  
  hard_limit boolean
  
  Indicates if the CPU hard limit flag is enabled or not. When set to true (default), allocates CPU timeshare based on the total CPU time multiplied by the relative RAM capacity of the instance on a given host. When set to false, delegates CPU allocation to the operating system to schedule CPU timeshares.
  
  region string
  
  The region that this Enterprise Search belongs to. Only populated in SaaS or federated ECE.
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

GET /deployments/{deployment_id}/enterprise_search/{ref_id}

curl \
 -X GET https://{{hostname}}/api/v1/deployments/{deployment_id}/enterprise_search/{ref_id}

Response examples (200)

{
  "ref_id": "string",
  "elasticsearch_cluster_ref_id": "string",
  "id": "string",
  "region": "string",
  "info": {
    "id": "string",
    "name": "string",
    "elasticsearch_cluster": {
      "elasticsearch_id": "string",
      "links": {
        "additionalProperty1": {
          "need_elevated_permissions": true
        },
        "additionalProperty2": {
          "need_elevated_permissions": true
        }
      }
    },
    "deployment_id": "string",
    "healthy": true,
    "status": "initializing",
    "plan_info": {
      "healthy": true,
      "current": {
        "plan_attempt_id": "string",
        "plan_attempt_name": "string",
        "healthy": true,
        "attempt_start_time": "2024-05-04T09:42:00+00:00",
        "attempt_end_time": "2024-05-04T09:42:00+00:00",
        "plan_end_time": "2024-05-04T09:42:00+00:00",
        "plan": {
          "cluster_topology": [
            {
              "node_type": {
                "appserver": true,
                "worker": true,
                "connector": true
              },
              "instance_configuration_id": "string",
              "instance_configuration_version": 42,
              "size": {
                "value": 42,
                "resource": "memory"
              },
              "zone_count": 42,
              "enterprise_search": {
                "version": "string",
                "docker_image": "string",
                "system_settings": {
                  "elasticsearch_url": "string",
                  "elasticsearch_username": "string",
                  "elasticsearch_password": "string",
                  "secret_session_key": "string"
                },
                "user_settings_json": {},
                "user_settings_yaml": "string",
                "user_settings_override_json": {},
                "user_settings_override_yaml": "string"
              },
              "allocator_filter": {},
              "node_configuration": "string",
              "memory_per_node": {},
              "node_count_per_zone": {}
            }
          ],
          "enterprise_search": {
            "version": "string",
            "docker_image": "string",
            "system_settings": {
              "elasticsearch_url": "string",
              "elasticsearch_username": "string",
              "elasticsearch_password": "string",
              "secret_session_key": "string"
            },
            "user_settings_json": {},
            "user_settings_yaml": "string",
            "user_settings_override_json": {},
            "user_settings_override_yaml": "string"
          },
          "transient": {
            "strategy": {
              "rolling": {
                "group_by": "string",
                "allow_inline_resize": true,
                "skip_synced_flush": true,
                "shard_init_wait_time": 42
              },
              "grow_and_shrink": {},
              "rolling_grow_and_shrink": {},
              "autodetect": {}
            },
            "plan_configuration": {
              "timeout": 42,
              "calm_wait_time": 42,
              "move_instances": [
                {
                  "from": "string",
                  "to": [
                    "string"
                  ],
                  "instance_down": true
                }
              ],
              "move_allocators": [
                {
                  "from": "string",
                  "to": [
                    "string"
                  ],
                  "allocator_down": true
                }
              ],
              "reallocate_instances": true,
              "preferred_allocators": [
                "string"
              ],
              "preferred_allocator_tags": {
                "additionalProperty1": "string",
                "additionalProperty2": "string"
              },
              "extended_maintenance": true,
              "cluster_reboot": "forced",
              "override_failsafe": true
            }
          }
        },
        "plan_attempt_log": [
          {
            "step_id": "string",
            "started": "2024-05-04T09:42:00+00:00",
            "completed": "2024-05-04T09:42:00+00:00",
            "duration_in_millis": 42,
            "status": "success",
            "stage": "starting",
            "info_log": [
              {
                "timestamp": "2024-05-04T09:42:00+00:00",
                "delta_in_millis": 42,
                "stage": "starting",
                "message": "string",
                "details": {
                  "additionalProperty1": "string",
                  "additionalProperty2": "string"
                },
                "internal_details": {
                  "additionalProperty1": "string",
                  "additionalProperty2": "string"
                },
                "failure_type": "string"
              }
            ]
          }
        ],
        "source": {
          "facilitator": "string",
          "action": "string",
          "date": "2024-05-04T09:42:00+00:00",
          "user_id": "string",
          "admin_id": "string",
          "remote_addresses": [
            "string"
          ]
        },
        "warnings": [
          {
            "code": "string",
            "message": "string",
            "step_id": "string"
          }
        ],
        "error": {
          "timestamp": "2024-05-04T09:42:00+00:00",
          "message": "string",
          "details": {
            "additionalProperty1": "string",
            "additionalProperty2": "string"
          },
          "failure_type": "string"
        }
      },
      "pending": {
        "plan_attempt_id": "string",
        "plan_attempt_name": "string",
        "healthy": true,
        "attempt_start_time": "2024-05-04T09:42:00+00:00",
        "attempt_end_time": "2024-05-04T09:42:00+00:00",
        "plan_end_time": "2024-05-04T09:42:00+00:00",
        "plan": {
          "cluster_topology": [
            {
              "node_type": {
                "appserver": true,
                "worker": true,
                "connector": true
              },
              "instance_configuration_id": "string",
              "instance_configuration_version": 42,
              "size": {
                "value": 42,
                "resource": "memory"
              },
              "zone_count": 42,
              "enterprise_search": {
                "version": "string",
                "docker_image": "string",
                "system_settings": {
                  "elasticsearch_url": "string",
                  "elasticsearch_username": "string",
                  "elasticsearch_password": "string",
                  "secret_session_key": "string"
                },
                "user_settings_json": {},
                "user_settings_yaml": "string",
                "user_settings_override_json": {},
                "user_settings_override_yaml": "string"
              },
              "allocator_filter": {},
              "node_configuration": "string",
              "memory_per_node": {},
              "node_count_per_zone": {}
            }
          ],
          "enterprise_search": {
            "version": "string",
            "docker_image": "string",
            "system_settings": {
              "elasticsearch_url": "string",
              "elasticsearch_username": "string",
              "elasticsearch_password": "string",
              "secret_session_key": "string"
            },
            "user_settings_json": {},
            "user_settings_yaml": "string",
            "user_settings_override_json": {},
            "user_settings_override_yaml": "string"
          },
          "transient": {
            "strategy": {
              "rolling": {
                "group_by": "string",
                "allow_inline_resize": true,
                "skip_synced_flush": true,
                "shard_init_wait_time": 42
              },
              "grow_and_shrink": {},
              "rolling_grow_and_shrink": {},
              "autodetect": {}
            },
            "plan_configuration": {
              "timeout": 42,
              "calm_wait_time": 42,
              "move_instances": [
                {
                  "from": "string",
                  "to": [
                    "string"
                  ],
                  "instance_down": true
                }
              ],
              "move_allocators": [
                {
                  "from": "string",
                  "to": [
                    "string"
                  ],
                  "allocator_down": true
                }
              ],
              "reallocate_instances": true,
              "preferred_allocators": [
                "string"
              ],
              "preferred_allocator_tags": {
                "additionalProperty1": "string",
                "additionalProperty2": "string"
              },
              "extended_maintenance": true,
              "cluster_reboot": "forced",
              "override_failsafe": true
            }
          }
        },
        "plan_attempt_log": [
          {
            "step_id": "string",
            "started": "2024-05-04T09:42:00+00:00",
            "completed": "2024-05-04T09:42:00+00:00",
            "duration_in_millis": 42,
            "status": "success",
            "stage": "starting",
            "info_log": [
              {
                "timestamp": "2024-05-04T09:42:00+00:00",
                "delta_in_millis": 42,
                "stage": "starting",
                "message": "string",
                "details": {
                  "additionalProperty1": "string",
                  "additionalProperty2": "string"
                },
                "internal_details": {
                  "additionalProperty1": "string",
                  "additionalProperty2": "string"
                },
                "failure_type": "string"
              }
            ]
          }
        ],
        "source": {
          "facilitator": "string",
          "action": "string",
          "date": "2024-05-04T09:42:00+00:00",
          "user_id": "string",
          "admin_id": "string",
          "remote_addresses": [
            "string"
          ]
        },
        "warnings": [
          {
            "code": "string",
            "message": "string",
            "step_id": "string"
          }
        ],
        "error": {
          "timestamp": "2024-05-04T09:42:00+00:00",
          "message": "string",
          "details": {
            "additionalProperty1": "string",
            "additionalProperty2": "string"
          },
          "failure_type": "string"
        }
      },
      "history": [
        {
          "plan_attempt_id": "string",
          "plan_attempt_name": "string",
          "healthy": true,
          "attempt_start_time": "2024-05-04T09:42:00+00:00",
          "attempt_end_time": "2024-05-04T09:42:00+00:00",
          "plan_end_time": "2024-05-04T09:42:00+00:00",
          "plan": {
            "cluster_topology": [
              {
                "node_type": {
                  "appserver": true,
                  "worker": true,
                  "connector": true
                },
                "instance_configuration_id": "string",
                "instance_configuration_version": 42,
                "size": {
                  "value": 42,
                  "resource": "memory"
                },
                "zone_count": 42,
                "enterprise_search": {
                  "version": "string",
                  "docker_image": "string",
                  "system_settings": {
                    "elasticsearch_url": "string",
                    "elasticsearch_username": "string",
                    "elasticsearch_password": "string",
                    "secret_session_key": "string"
                  },
                  "user_settings_json": {},
                  "user_settings_yaml": "string",
                  "user_settings_override_json": {},
                  "user_settings_override_yaml": "string"
                },
                "allocator_filter": {},
                "node_configuration": "string",
                "memory_per_node": {},
                "node_count_per_zone": {}
              }
            ],
            "enterprise_search": {
              "version": "string",
              "docker_image": "string",
              "system_settings": {
                "elasticsearch_url": "string",
                "elasticsearch_username": "string",
                "elasticsearch_password": "string",
                "secret_session_key": "string"
              },
              "user_settings_json": {},
              "user_settings_yaml": "string",
              "user_settings_override_json": {},
              "user_settings_override_yaml": "string"
            },
            "transient": {
              "strategy": {
                "rolling": {
                  "group_by": "string",
                  "allow_inline_resize": true,
                  "skip_synced_flush": true,
                  "shard_init_wait_time": 42
                },
                "grow_and_shrink": {},
                "rolling_grow_and_shrink": {},
                "autodetect": {}
              },
              "plan_configuration": {
                "timeout": 42,
                "calm_wait_time": 42,
                "move_instances": [
                  {
                    "from": "string",
                    "to": [
                      "string"
                    ],
                    "instance_down": true
                  }
                ],
                "move_allocators": [
                  {
                    "from": "string",
                    "to": [
                      "string"
                    ],
                    "allocator_down": true
                  }
                ],
                "reallocate_instances": true,
                "preferred_allocators": [
                  "string"
                ],
                "preferred_allocator_tags": {
                  "additionalProperty1": "string",
                  "additionalProperty2": "string"
                },
                "extended_maintenance": true,
                "cluster_reboot": "forced",
                "override_failsafe": true
              }
            }
          },
          "plan_attempt_log": [
            {
              "step_id": "string",
              "started": "2024-05-04T09:42:00+00:00",
              "completed": "2024-05-04T09:42:00+00:00",
              "duration_in_millis": 42,
              "status": "success",
              "stage": "starting",
              "info_log": [
                {
                  "timestamp": "2024-05-04T09:42:00+00:00",
                  "delta_in_millis": 42,
                  "stage": "starting",
                  "message": "string",
                  "details": {
                    "additionalProperty1": "string",
                    "additionalProperty2": "string"
                  },
                  "internal_details": {
                    "additionalProperty1": "string",
                    "additionalProperty2": "string"
                  },
                  "failure_type": "string"
                }
              ]
            }
          ],
          "source": {
            "facilitator": "string",
            "action": "string",
            "date": "2024-05-04T09:42:00+00:00",
            "user_id": "string",
            "admin_id": "string",
            "remote_addresses": [
              "string"
            ]
          },
          "warnings": [
            {
              "code": "string",
              "message": "string",
              "step_id": "string"
            }
          ],
          "error": {
            "timestamp": "2024-05-04T09:42:00+00:00",
            "message": "string",
            "details": {
              "additionalProperty1": "string",
              "additionalProperty2": "string"
            },
            "failure_type": "string"
          }
        }
      ]
    },
    "metadata": {
      "version": 42,
      "last_modified": "2024-05-04T09:42:00+00:00",
      "endpoint": "string",
      "service_url": "string",
      "aliased_endpoint": "string",
      "aliased_url": "string",
      "cloud_id": "string",
      "raw": {},
      "ports": {
        "http": 42,
        "https": 42,
        "transport_passthrough": 42
      },
      "services_urls": [
        {
          "service": "string",
          "url": "string"
        }
      ]
    },
    "topology": {
      "healthy": true,
      "instances": [
        {
          "instance_name": "string",
          "instance_configuration": {
            "id": "string",
            "name": "string",
            "config_version": 42,
            "resource": "memory"
          },
          "service_version": "string",
          "healthy": true,
          "container_started": true,
          "service_running": true,
          "maintenance_mode": true,
          "zone": "string",
          "allocator_id": "string",
          "memory": {
            "instance_capacity": 42,
            "instance_capacity_planned": 42,
            "memory_pressure": 42,
            "native_memory_pressure": 42
          },
          "disk": {
            "disk_space_available": 42,
            "disk_space_used": 42,
            "storage_multiplier": 42.0
          },
          "service_roles": [
            "string"
          ],
          "node_roles": [
            "master"
          ],
          "instance_overrides": {
            "capacity": 42,
            "storage_multiplier": 42.0
          }
        }
      ]
    },
    "external_links": [
      {
        "id": "string",
        "label": "string",
        "uri": "string"
      }
    ],
    "links": {
      "additionalProperty1": {
        "need_elevated_permissions": true
      },
      "additionalProperty2": {
        "need_elevated_permissions": true
      }
    },
    "settings": {
      "metadata": {
        "name": "string",
        "owner_id": "string",
        "organization_id": "string",
        "subscription_level": "string",
        "system_owned": true,
        "contact_email": "string",
        "hidden": true,
        "resources": {
          "cpu": {
            "boost": true,
            "hard_limit": true
          }
        }
      }
    },
    "region": "string"
  }
}

Response examples (404)

# Headers
x-cloud-error-codes: deployments.deployment_not_found

# Payload
{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}

Response examples (500)

# Headers
x-cloud-error-codes: deployments.deployment_resource_no_longer_exists

# Payload
{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}