Get stack version

Get deployments costs for the organization. Currently unavailable in self-hosted ECE.

GET /billing/costs/{organization_id}/deployments

EXPERIMENTAL (it may change in future versions): Retrieves the costs associated with all deployments for the organization.

Headers

Accept string

Accept header containing the content preference.

Path parameters

organization_id string Required

Identifier for the organization

Query parameters

from string

A datetime for the beginning of the desired range for which to fetch activity. Defaults to start of current month.
to string

A datetime for the end of the desired range for which to fetch activity. Defaults to the current date.

Responses

200

The costs associated to a set of products
Hide response attributes Show response attributes object
- total_cost number(double) Required
  
  Total cost for all deployments
- deployments array[object] Required
  
  Costs of the list of deployments
  
  Detailed costs for a deployment for an organization. All of the costs are expressed in Elastic Consumption Unit (ECU).
  
  Hide deployments attributes Show deployments attributes object
  
  deployment_id string Required
  
  Elasticsearch deployment id
  
  deployment_name string Required
  
  Elasticsearch deployment name
  
  costs object Required
  
  Costs for the organization
  
  Additional properties are allowed.
  
  Hide costs attributes Show costs attributes object
  
  total number(double) Required
  
  Total costs
  
  dimensions array[object] Required
  
  A collection of billing details by dimension.
  
  Billing dimension
  
  Hide dimensions attributes Show dimensions attributes object
  
  type string Required
  
  The type of the billing dimension
  
  Values are capacity, data_in, data_internode, data_out, storage_api, or storage_bytes.
  
  cost number(double) Required
  
  The cost of the billing dimension
  
  hourly_rate number(double) Required
  
  Price per hour
  
  period object
  
  Period
  
  Additional properties are allowed.
  
  Hide period attributes Show period attributes object
  
  start string(date-time) Required
  
  Start
  
  end string(date-time) Required
  
  End
400

Invalid date range specified. (code: costs.invalid_date_range)
Hide headers attribute Show headers attribute
- x-cloud-error-codes string
  
  The error codes associated with the response
  
  Value is costs.invalid_date_range.
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
403

The current user does not have access to the requested organization. (code: organization.invalid_access)
Hide headers attribute Show headers attribute
- x-cloud-error-codes string
  
  The error codes associated with the response
  
  Value is organization.invalid_access.
Hide response attribute Show response attribute object
- errors array[object] Required
  
  A list of errors that occurred in the failing request
  
  Hide errors attributes Show errors attributes object
  
  code string Required
  
  A structured code representing the error type that occurred
  
  message string Required
  
  A human readable message describing the error that occurred
  
  fields array[string]
  
  If the error can be tied to a specific field or fields in the user request, this lists those fields
404

Organization not found. (code: organization.not_found)
Hide headers attribute Show headers attribute
- x-cloud-error-codes string
  
  The error codes associated with the response
  
  Value is organization.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

An error occurred when fetching the costs associated with all deployments for the organization. (code: billing_service.failed_request)
Hide headers attribute Show headers attribute
- x-cloud-error-codes string
  
  The error codes associated with the response
  
  Value is billing_service.failed_request.
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 /billing/costs/{organization_id}/deployments

curl \
 --request GET https://{{hostname}}/api/v1/billing/costs/{organization_id}/deployments \
 --header "Accept: string"

Response examples (200)

{
  "total_cost": 42.0,
  "deployments": [
    {
      "deployment_id": "string",
      "deployment_name": "string",
      "costs": {
        "total": 42.0,
        "dimensions": [
          {
            "type": "capacity",
            "cost": 42.0
          }
        ]
      },
      "hourly_rate": 42.0,
      "period": {
        "start": "2025-05-04T09:42:00Z",
        "end": "2025-05-04T09:42:00Z"
      }
    }
  ]
}

Response examples (400)

# Headers
x-cloud-error-codes: costs.invalid_date_range

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

Response examples (403)

# Headers
x-cloud-error-codes: organization.invalid_access

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

Response examples (404)

# Headers
x-cloud-error-codes: organization.not_found

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

Response examples (500)

# Headers
x-cloud-error-codes: billing_service.failed_request

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

Delete Deployment

DELETE /deployments/{deployment_id}

Deletes a Deployment and all its resources.

Path parameters

deployment_id string Required

Identifier for the Deployment

Responses

200

The request was valid and the deployment was deleted.
Hide response attributes Show response attributes object
- id string Required
  
  The id of the deployment
- name string Required
  
  The name of the deployment
- orphaned object
  
  List of resources that have been shut down
  
  Additional properties are allowed.
  
  Hide orphaned attributes Show orphaned attributes object
  
  elasticsearch array[object] Required
  
  List of orphaned Elasticsearch resources
  
  Details about an orphaned Elasticsearch resources.
  
  Hide elasticsearch attributes Show elasticsearch attributes object
  
  id string Required
  
  The id of the orphaned resource
  
  dependents array[object] Required
  
  List of orphaned dependent resources
  
  Details about an orphaned Elasticsearch-dependent resources.
  
  Hide dependents attributes Show dependents attributes object
  
  id string Required
  
  The id of the orphaned resource
  
  kind string Required
  
  The kind of resource
  
  kibana array[string] Required
  
  List of orphaned Kibana resource ids
  
  apm array[string] Required
  
  List of orphaned APM resource ids
  
  appsearch array[string] Required
  
  List of orphaned AppSearch resource ids
  
  enterprise_search array[string] Required
  
  List of orphaned Enterprise Search resource ids
  
  integrations_server array[string] Required
  
  List of orphaned Integrations Server resource ids
400

The Deployment resources have not been shutdown yet.
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
401

You are not authorized to perform this action.
Hide response attribute Show response attribute object
- errors array[object] Required
  
  A list of errors that occurred in the failing request
  
  Hide errors attributes Show errors attributes object
  
  code string Required
  
  A structured code representing the error type that occurred
  
  message string Required
  
  A human readable message describing the error that occurred
  
  fields array[string]
  
  If the error can be tied to a specific field or fields in the user request, this lists those fields
404

The Deployment specified by {deployment_id} cannot be found. (code: deployments.deployment_not_found)
Hide headers attribute Show headers attribute
- x-cloud-error-codes string
  
  The error codes associated with the response
  
  Value is deployments.deployment_not_found.
Hide response attribute Show response attribute object
- errors array[object] Required
  
  A list of errors that occurred in the failing request
  
  Hide errors attributes Show errors attributes object
  
  code string Required
  
  A structured code representing the error type that occurred
  
  message string Required
  
  A human readable message describing the error that occurred
  
  fields array[string]
  
  If the error can be tied to a specific field or fields in the user request, this lists those fields

DELETE /deployments/{deployment_id}

curl \
 --request DELETE https://{{hostname}}/api/v1/deployments/{deployment_id}

Response examples (200)

{
  "id": "string",
  "name": "string",
  "orphaned": {
    "elasticsearch": [
      {
        "id": "string",
        "dependents": [
          {
            "id": "string",
            "kind": "string"
          }
        ]
      }
    ],
    "kibana": [
      "string"
    ],
    "apm": [
      "string"
    ],
    "appsearch": [
      "string"
    ],
    "enterprise_search": [
      "string"
    ],
    "integrations_server": [
      "string"
    ]
  }
}

Response examples (400)

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

Response examples (401)

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

Response examples (404)

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

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

Get Deployment APM Resource Info

GET /deployments/{deployment_id}/apm/{ref_id}

Get info about an APM 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 APM
  
  name string Required
  
  The name of the APM
  
  elasticsearch_cluster object Required
  
  Information about the specified Elasticsearch cluster.
  
  Additional properties are allowed.
  
  Hide elasticsearch_cluster attributes Show elasticsearch_cluster attributes object
  
  elasticsearch_id string Required
  
  The Elasticsearch cluster Id
  
  links object
  
  A map of application-specific operations (which map to 'operationId's in the Swagger API) to metadata about that operation
  
  Hide links attribute Show links attribute object
  
  * object Additional properties
  
  Additional properties are allowed.
  
  Hide * attribute Show * attribute object
  
  need_elevated_permissions boolean
  
  Whether the operation requires elevated permissions (when the field is present, elevated permissions are required).
  
  deployment_id string
  
  The id of the deployment that this APM Server belongs to.
  
  healthy boolean Required
  
  Whether the APM is healthy or not (one or more of the info subsections will have healthy: false)
  
  status string Required
  
  APM status
  
  Values are initializing, stopping, stopped, rebooting, restarting, reconfiguring, or started.
  
  plan_info object Required
  
  Information about current, pending, and past APM Server plans.
  
  Additional properties are allowed.
  
  Hide plan_info attributes Show plan_info attributes object
  
  healthy boolean Required
  
  Whether the plan situation is healthy (if unhealthy, means the last plan attempt failed)
  
  current object
  
  Information about the APM Server plan.
  
  Additional properties are allowed.
  
  Hide current attributes Show current attributes object
  
  plan_attempt_id string
  
  A UUID for each plan attempt
  
  plan_attempt_name string
  
  A human readable name for each plan attempt, only populated when retrieving plan histories
  
  healthy boolean Required
  
  Either the plan ended successfully, or is not yet completed (and no errors have occurred)
  
  attempt_start_time string(date-time)
  
  When this plan attempt (ie to apply the plan to the APM) started (ISO format in UTC)
  
  attempt_end_time string(date-time)
  
  If this plan completed or failed (ie is not pending), when the attempt ended (ISO format in UTC)
  
  plan_end_time string(date-time)
  
  If this plan is not current or pending, when the plan was no longer active (ISO format in UTC)
  
  plan object
  
  The plan for the APM Server.
  
  Additional properties are allowed.
  
  Hide plan attributes Show plan attributes object
  
  cluster_topology array[object]
  
  Defines the topology of the APM Server nodes. For example, the number or capacity of the nodes, and where you can allocate the nodes.
  
  Hide cluster_topology attributes Show cluster_topology attributes object
  
  instance_configuration_id string
  
  Controls the allocation of this topology element as well as allowed sizes and node_types. It needs to match the id of an existing instance configuration.
  
  instance_configuration_version integer(int32)
  
  The version of the Instance Configuration Id. If it is unset, the meaning depends on read vs writes. For deployment reads, it is equivalent to version 0 (or the IC is unversioned); for deployment creates and deployment template use, it is equivalent to 'the latest version'; and for deployment updates, it is equivalent to 'retain the current version'.
  
  size object
  
  Measured by the amount of a resource. The final cluster size is calculated using multipliers from the topology instance configuration.
  
  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
  
  apm object
  
  The configuration options for the APM Server.
  
  Additional properties are allowed.
  
  Hide apm attributes Show apm attributes object
  
  version string
  
  The version of the Apm cluster (must be one of the ECE supported versions, and won't work unless it matches the APM version. Leave blank to auto-detect version.)
  
  docker_image string
  
  A docker URI that allows overriding of the default docker image specified for this version
  
  system_settings object
  
  A structure that defines a curated subset of the APM Server settings. TIP: To define the complete set of APM Server setting, use ApmSystemSettings with user_settings_override_ and user_settings_.
  
  Additional properties are allowed.
  
  Hide system_settings attributes Show system_settings attributes object
  
  elasticsearch_url string
  
  DEPRECATED: Scheduled for removal in a future version of the API.
  
  Optionally override the URL to which to send data (for advanced users only, if unspecified the system selects an internal URL)
  
  kibana_url string
  
  DEPRECATED: Scheduled for removal in a future version of the API.
  
  Optionally override the URL to which to send data (for advanced users only, if unspecified the system selects an internal URL)
  
  elasticsearch_username string
  
  Optionally override the account within APM - defaults to a system account that always exists (if specified, the password must also be specified). Note that this field is never returned from the API, it is write only.
  
  elasticsearch_password string
  
  Optionally override the account within APM - defaults to a system account that always exists (if specified, the username must also be specified). Note that this field is never returned from the API, it is write only.
  
  secret_token string
  
  Optionally override the secret token within APM - defaults to the previously existing secretToken
  
  debug_enabled boolean
  
  Optionally enable debug mode for APM servers - defaults false
  
  user_settings_json object
  
  An arbitrary JSON object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters are on the allowlist and not on the denylist. (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Apm settings)
  
  Additional properties are allowed.
  
  user_settings_yaml string
  
  An arbitrary YAML object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_json' is allowed), provided the parameters are on the allowlist and not on the denylist. (These field together with 'user_settings_override*' and 'system_settings' defines the total set of Apm settings)
  
  user_settings_override_json object
  
  An arbitrary JSON object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Apm settings)
  
  Additional properties are allowed.
  
  user_settings_override_yaml string
  
  An arbitrary YAML object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_json' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Apm settings)
  
  apm object Required
  
  The configuration options for the APM Server.
  
  Additional properties are allowed.
  
  Hide apm attributes Show apm attributes object
  
  version string
  
  The version of the Apm cluster (must be one of the ECE supported versions, and won't work unless it matches the APM version. Leave blank to auto-detect version.)
  
  docker_image string
  
  A docker URI that allows overriding of the default docker image specified for this version
  
  system_settings object
  
  A structure that defines a curated subset of the APM Server settings. TIP: To define the complete set of APM Server setting, use ApmSystemSettings with user_settings_override_ and user_settings_.
  
  Additional properties are allowed.
  
  Hide system_settings attributes Show system_settings attributes object
  
  elasticsearch_url string
  
  DEPRECATED: Scheduled for removal in a future version of the API.
  
  Optionally override the URL to which to send data (for advanced users only, if unspecified the system selects an internal URL)
  
  kibana_url string
  
  DEPRECATED: Scheduled for removal in a future version of the API.
  
  Optionally override the URL to which to send data (for advanced users only, if unspecified the system selects an internal URL)
  
  elasticsearch_username string
  
  Optionally override the account within APM - defaults to a system account that always exists (if specified, the password must also be specified). Note that this field is never returned from the API, it is write only.
  
  elasticsearch_password string
  
  Optionally override the account within APM - defaults to a system account that always exists (if specified, the username must also be specified). Note that this field is never returned from the API, it is write only.
  
  secret_token string
  
  Optionally override the secret token within APM - defaults to the previously existing secretToken
  
  debug_enabled boolean
  
  Optionally enable debug mode for APM servers - defaults false
  
  user_settings_json object
  
  An arbitrary JSON object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters are on the allowlist and not on the denylist. (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Apm settings)
  
  Additional properties are allowed.
  
  user_settings_yaml string
  
  An arbitrary YAML object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_json' is allowed), provided the parameters are on the allowlist and not on the denylist. (These field together with 'user_settings_override*' and 'system_settings' defines the total set of Apm settings)
  
  user_settings_override_json object
  
  An arbitrary JSON object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Apm settings)
  
  Additional properties are allowed.
  
  user_settings_override_yaml string
  
  An arbitrary YAML object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_json' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Apm settings)
  
  transient object
  
  Defines the configuration parameters that control how the plan is applied. For example, the Elasticsearch cluster topology and APM Server settings.
  
  Additional properties are allowed.
  
  Hide transient attributes Show transient attributes object
  
  strategy object
  
  The options for performing a plan change. Specify only one property each time. The default is grow_and_shrink.
  
  Additional properties are allowed.
  
  Hide strategy attributes Show strategy attributes object
  
  rolling object
  
  Performs inline, rolling configuration changes that mutate existing containers. TIP: This is the fastest way to update a plan, but can fail for complex plan changes, such as topology changes. Also, this is less safe for configuration changes that leave a cluster in a non running state. NOTE: When you perform a major version upgrade, and 'group_by' is set to 'pass:macros[all]';, rolling is required.
  
  Additional properties are allowed.
  
  Hide rolling attributes Show rolling attributes object
  
  group_by string
  
  Specifies the grouping attribute to use when rolling several instances. Instances that share the same value for the provided attribute key are rolled together as a unit. Examples that make sense to use are '__all__' (roll all instances as a single unit), 'logical_zone_name' (roll instances by zone), '__name__' (roll one instance at a time, the default if not specified). Note that '__all__' is required when performing a major version upgrade
  
  allow_inline_resize boolean
  
  Whether we allow changing the capacity of instances (default false). This is currently implemented by stopping, re-creating then starting the affected instance on its associated allocator when performing the changes. NOTES: This requires a round-trip through the allocation infrastructure of the active constructor, as it has to reserve the target capacity without over-committing
  
  skip_synced_flush boolean
  
  Whether to skip attempting to do a synced flush on the filesystem of the container (default: false), which is less safe but may be required if the container is unhealthy
  
  shard_init_wait_time integer(int64)
  
  The time, in seconds, to wait for shards that show no progress of initializing before rolling the next group (default: 10 minutes)
  
  grow_and_shrink object
  
  A strategy that creates instances with the new plan, migrates data from the old instances, then shuts down the old instances. GrowShrinkStrategyConfig is safer than 'rolling' and ensures single node availability during a plan change, but can be a lot slower on larger clusters.
  
  Additional properties are allowed.
  
  rolling_grow_and_shrink object
  
  A strategy that creates new Elasticsearch instances, Kibana instances, and APM Servers with the new plan, then migrates the node data to minimize the amount of spare capacity.
  
  Additional properties are allowed.
  
  autodetect object
  
  A strategy that lets constructor choose the most optimal way to execute the plan.
  
  Additional properties are allowed.
  
  plan_configuration object
  
  The plan control configuration options for the APM Server.
  
  Additional properties are allowed.
  
  Hide plan_configuration attributes Show plan_configuration attributes object
  
  timeout integer(int64)
  
  The total timeout in seconds after which the plan is cancelled even if it is not complete. Defaults to 4x the max memory capacity per node (in MB)
  
  calm_wait_time integer(int64)
  
  This timeout determines how long to give a cluster after it responds to API calls before performing actual operations on it. It defaults to 5s
  
  move_instances array[object]
  
  The request that specifies the Elasticsearch or stateless (eg Kibana) instances to move to allocators as part of the upgrade plan. When used in conjunction with '__all__' (roll all instances as a single unit) strategy, these instances are not restarted, which can sometimes enable recovery plans when these instances are boot-looping.
  
  Hide move_instances attributes Show move_instances attributes object
  
  from string Required
  
  The instance id that is going to be moved
  
  to array[string]
  
  An optional list of allocator ids to which the instance should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)
  
  instance_down boolean
  
  Tells the infrastructure that the instance should be considered as permanently down when deciding how to migrate data to new nodes. If left blank then the system will automatically decide (currently: will treat the instances as up)
  
  move_allocators array[object]
  
  As part of the upgrade plan, identifies the move requests for the Kibana instances or APM Servers on the allocators.
  
  Hide move_allocators attributes Show move_allocators attributes object
  
  from string Required
  
  The allocator id off which all instances in the cluster should be moved
  
  to array[string]
  
  An optional list of allocator ids to which the instance(s) should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)
  
  allocator_down boolean
  
  Tells the infrastructure that all instances on the allocator should be considered as permanently down when deciding how to migrate data to new nodes. If left blank then the system will auto-decide (currently: will treat the allocator as up)
  
  reallocate_instances boolean
  
  If true (default: false) does not allow re-using any existing instances currently in the cluster, ie even unchanged instances will be re-created
  
  preferred_allocators array[string]
  
  List of allocators on which instances are placed if possible (if not possible/not specified then any available allocator with space is used)
  
  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
  
  Information about a step in a plan.
  
  Hide plan_attempt_log attributes Show plan_attempt_log attributes object
  
  step_id string Required
  
  ID of current step
  
  started string(date-time) Required
  
  When the step started (ISO format in UTC)
  
  completed string(date-time)
  
  When the step completed (ISO format in UTC)
  
  duration_in_millis integer(int64)
  
  The duration of the step in MS
  
  status string Required
  
  The status of the step (success, warning, error - warning means something didn't go as expected but it was not serious enough to abort the plan)
  
  Values are success, warning, error, or pending.
  
  stage string Required
  
  Current stage that the step is in
  
  Values are starting, completed, or in_progress.
  
  info_log array[object] Required
  
  Human readable summaries of the step, including messages for each stage of the step
  
  The log message from a specified stage of an executed step in a plan.
  
  Hide info_log attributes Show info_log attributes object
  
  timestamp string(date-time) Required
  
  Timestamp marking on info log of step
  
  delta_in_millis integer(int64)
  
  Time in milliseconds since previous log message
  
  stage string Required
  
  Stage that info log message takes place in
  
  Values are starting, completed, or in_progress.
  
  message string Required
  
  Human readable log message
  
  details object Required
  
  A map with details for the log about what happened during the step execution. Keys and values for are always both strings, representing the name of the detail and its value, respectively.
  
  Hide details attribute Show details attribute object
  
  * string Additional properties
  
  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
  
  Information about a warning from a plan.
  
  Hide warnings attributes Show warnings attributes object
  
  code string Required
  
  A unique warning code
  
  message string Required
  
  A description of the warning
  
  step_id string
  
  The ID of the step which produced a warning, if any
  
  error object
  
  Information about an error during a plan attempt.
  
  Additional properties are allowed.
  
  Hide error attributes Show error attributes object
  
  timestamp string(date-time) Required
  
  Timestamp marking on info log of step
  
  message string Required
  
  Human readable error message
  
  details object Required
  
  A map with details regarding the error. Both the keys and values are always strings, representing the name of the detail and its value, respectively.
  
  Hide details attribute Show details attribute object
  
  * string Additional properties
  
  failure_type string
  
  The failure type
  
  pending object
  
  Information about the APM Server plan.
  
  Additional properties are allowed.
  
  Hide pending attributes Show pending attributes object
  
  plan_attempt_id string
  
  A UUID for each plan attempt
  
  plan_attempt_name string
  
  A human readable name for each plan attempt, only populated when retrieving plan histories
  
  healthy boolean Required
  
  Either the plan ended successfully, or is not yet completed (and no errors have occurred)
  
  attempt_start_time string(date-time)
  
  When this plan attempt (ie to apply the plan to the APM) started (ISO format in UTC)
  
  attempt_end_time string(date-time)
  
  If this plan completed or failed (ie is not pending), when the attempt ended (ISO format in UTC)
  
  plan_end_time string(date-time)
  
  If this plan is not current or pending, when the plan was no longer active (ISO format in UTC)
  
  plan object
  
  The plan for the APM Server.
  
  Additional properties are allowed.
  
  Hide plan attributes Show plan attributes object
  
  cluster_topology array[object]
  
  Defines the topology of the APM Server nodes. For example, the number or capacity of the nodes, and where you can allocate the nodes.
  
  Hide cluster_topology attributes Show cluster_topology attributes object
  
  instance_configuration_id string
  
  Controls the allocation of this topology element as well as allowed sizes and node_types. It needs to match the id of an existing instance configuration.
  
  instance_configuration_version integer(int32)
  
  The version of the Instance Configuration Id. If it is unset, the meaning depends on read vs writes. For deployment reads, it is equivalent to version 0 (or the IC is unversioned); for deployment creates and deployment template use, it is equivalent to 'the latest version'; and for deployment updates, it is equivalent to 'retain the current version'.
  
  size object
  
  Measured by the amount of a resource. The final cluster size is calculated using multipliers from the topology instance configuration.
  
  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
  
  apm object
  
  The configuration options for the APM Server.
  
  Additional properties are allowed.
  
  Hide apm attributes Show apm attributes object
  
  version string
  
  The version of the Apm cluster (must be one of the ECE supported versions, and won't work unless it matches the APM version. Leave blank to auto-detect version.)
  
  docker_image string
  
  A docker URI that allows overriding of the default docker image specified for this version
  
  system_settings object
  
  A structure that defines a curated subset of the APM Server settings. TIP: To define the complete set of APM Server setting, use ApmSystemSettings with user_settings_override_ and user_settings_.
  
  Additional properties are allowed.
  
  Hide system_settings attributes Show system_settings attributes object
  
  elasticsearch_url string
  
  DEPRECATED: Scheduled for removal in a future version of the API.
  
  Optionally override the URL to which to send data (for advanced users only, if unspecified the system selects an internal URL)
  
  kibana_url string
  
  DEPRECATED: Scheduled for removal in a future version of the API.
  
  Optionally override the URL to which to send data (for advanced users only, if unspecified the system selects an internal URL)
  
  elasticsearch_username string
  
  Optionally override the account within APM - defaults to a system account that always exists (if specified, the password must also be specified). Note that this field is never returned from the API, it is write only.
  
  elasticsearch_password string
  
  Optionally override the account within APM - defaults to a system account that always exists (if specified, the username must also be specified). Note that this field is never returned from the API, it is write only.
  
  secret_token string
  
  Optionally override the secret token within APM - defaults to the previously existing secretToken
  
  debug_enabled boolean
  
  Optionally enable debug mode for APM servers - defaults false
  
  user_settings_json object
  
  An arbitrary JSON object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters are on the allowlist and not on the denylist. (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Apm settings)
  
  Additional properties are allowed.
  
  user_settings_yaml string
  
  An arbitrary YAML object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_json' is allowed), provided the parameters are on the allowlist and not on the denylist. (These field together with 'user_settings_override*' and 'system_settings' defines the total set of Apm settings)
  
  user_settings_override_json object
  
  An arbitrary JSON object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Apm settings)
  
  Additional properties are allowed.
  
  user_settings_override_yaml string
  
  An arbitrary YAML object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_json' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Apm settings)
  
  apm object Required
  
  The configuration options for the APM Server.
  
  Additional properties are allowed.
  
  Hide apm attributes Show apm attributes object
  
  version string
  
  The version of the Apm cluster (must be one of the ECE supported versions, and won't work unless it matches the APM version. Leave blank to auto-detect version.)
  
  docker_image string
  
  A docker URI that allows overriding of the default docker image specified for this version
  
  system_settings object
  
  A structure that defines a curated subset of the APM Server settings. TIP: To define the complete set of APM Server setting, use ApmSystemSettings with user_settings_override_ and user_settings_.
  
  Additional properties are allowed.
  
  Hide system_settings attributes Show system_settings attributes object
  
  elasticsearch_url string
  
  DEPRECATED: Scheduled for removal in a future version of the API.
  
  Optionally override the URL to which to send data (for advanced users only, if unspecified the system selects an internal URL)
  
  kibana_url string
  
  DEPRECATED: Scheduled for removal in a future version of the API.
  
  Optionally override the URL to which to send data (for advanced users only, if unspecified the system selects an internal URL)
  
  elasticsearch_username string
  
  Optionally override the account within APM - defaults to a system account that always exists (if specified, the password must also be specified). Note that this field is never returned from the API, it is write only.
  
  elasticsearch_password string
  
  Optionally override the account within APM - defaults to a system account that always exists (if specified, the username must also be specified). Note that this field is never returned from the API, it is write only.
  
  secret_token string
  
  Optionally override the secret token within APM - defaults to the previously existing secretToken
  
  debug_enabled boolean
  
  Optionally enable debug mode for APM servers - defaults false
  
  user_settings_json object
  
  An arbitrary JSON object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters are on the allowlist and not on the denylist. (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Apm settings)
  
  Additional properties are allowed.
  
  user_settings_yaml string
  
  An arbitrary YAML object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_json' is allowed), provided the parameters are on the allowlist and not on the denylist. (These field together with 'user_settings_override*' and 'system_settings' defines the total set of Apm settings)
  
  user_settings_override_json object
  
  An arbitrary JSON object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Apm settings)
  
  Additional properties are allowed.
  
  user_settings_override_yaml string
  
  An arbitrary YAML object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_json' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Apm settings)
  
  transient object
  
  Defines the configuration parameters that control how the plan is applied. For example, the Elasticsearch cluster topology and APM Server settings.
  
  Additional properties are allowed.
  
  Hide transient attributes Show transient attributes object
  
  strategy object
  
  The options for performing a plan change. Specify only one property each time. The default is grow_and_shrink.
  
  Additional properties are allowed.
  
  Hide strategy attributes Show strategy attributes object
  
  rolling object
  
  Performs inline, rolling configuration changes that mutate existing containers. TIP: This is the fastest way to update a plan, but can fail for complex plan changes, such as topology changes. Also, this is less safe for configuration changes that leave a cluster in a non running state. NOTE: When you perform a major version upgrade, and 'group_by' is set to 'pass:macros[all]';, rolling is required.
  
  Additional properties are allowed.
  
  Hide rolling attributes Show rolling attributes object
  
  group_by string
  
  Specifies the grouping attribute to use when rolling several instances. Instances that share the same value for the provided attribute key are rolled together as a unit. Examples that make sense to use are '__all__' (roll all instances as a single unit), 'logical_zone_name' (roll instances by zone), '__name__' (roll one instance at a time, the default if not specified). Note that '__all__' is required when performing a major version upgrade
  
  allow_inline_resize boolean
  
  Whether we allow changing the capacity of instances (default false). This is currently implemented by stopping, re-creating then starting the affected instance on its associated allocator when performing the changes. NOTES: This requires a round-trip through the allocation infrastructure of the active constructor, as it has to reserve the target capacity without over-committing
  
  skip_synced_flush boolean
  
  Whether to skip attempting to do a synced flush on the filesystem of the container (default: false), which is less safe but may be required if the container is unhealthy
  
  shard_init_wait_time integer(int64)
  
  The time, in seconds, to wait for shards that show no progress of initializing before rolling the next group (default: 10 minutes)
  
  grow_and_shrink object
  
  A strategy that creates instances with the new plan, migrates data from the old instances, then shuts down the old instances. GrowShrinkStrategyConfig is safer than 'rolling' and ensures single node availability during a plan change, but can be a lot slower on larger clusters.
  
  Additional properties are allowed.
  
  rolling_grow_and_shrink object
  
  A strategy that creates new Elasticsearch instances, Kibana instances, and APM Servers with the new plan, then migrates the node data to minimize the amount of spare capacity.
  
  Additional properties are allowed.
  
  autodetect object
  
  A strategy that lets constructor choose the most optimal way to execute the plan.
  
  Additional properties are allowed.
  
  plan_configuration object
  
  The plan control configuration options for the APM Server.
  
  Additional properties are allowed.
  
  Hide plan_configuration attributes Show plan_configuration attributes object
  
  timeout integer(int64)
  
  The total timeout in seconds after which the plan is cancelled even if it is not complete. Defaults to 4x the max memory capacity per node (in MB)
  
  calm_wait_time integer(int64)
  
  This timeout determines how long to give a cluster after it responds to API calls before performing actual operations on it. It defaults to 5s
  
  move_instances array[object]
  
  The request that specifies the Elasticsearch or stateless (eg Kibana) instances to move to allocators as part of the upgrade plan. When used in conjunction with '__all__' (roll all instances as a single unit) strategy, these instances are not restarted, which can sometimes enable recovery plans when these instances are boot-looping.
  
  Hide move_instances attributes Show move_instances attributes object
  
  from string Required
  
  The instance id that is going to be moved
  
  to array[string]
  
  An optional list of allocator ids to which the instance should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)
  
  instance_down boolean
  
  Tells the infrastructure that the instance should be considered as permanently down when deciding how to migrate data to new nodes. If left blank then the system will automatically decide (currently: will treat the instances as up)
  
  move_allocators array[object]
  
  As part of the upgrade plan, identifies the move requests for the Kibana instances or APM Servers on the allocators.
  
  Hide move_allocators attributes Show move_allocators attributes object
  
  from string Required
  
  The allocator id off which all instances in the cluster should be moved
  
  to array[string]
  
  An optional list of allocator ids to which the instance(s) should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)
  
  allocator_down boolean
  
  Tells the infrastructure that all instances on the allocator should be considered as permanently down when deciding how to migrate data to new nodes. If left blank then the system will auto-decide (currently: will treat the allocator as up)
  
  reallocate_instances boolean
  
  If true (default: false) does not allow re-using any existing instances currently in the cluster, ie even unchanged instances will be re-created
  
  preferred_allocators array[string]
  
  List of allocators on which instances are placed if possible (if not possible/not specified then any available allocator with space is used)
  
  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
  
  Information about a step in a plan.
  
  Hide plan_attempt_log attributes Show plan_attempt_log attributes object
  
  step_id string Required
  
  ID of current step
  
  started string(date-time) Required
  
  When the step started (ISO format in UTC)
  
  completed string(date-time)
  
  When the step completed (ISO format in UTC)
  
  duration_in_millis integer(int64)
  
  The duration of the step in MS
  
  status string Required
  
  The status of the step (success, warning, error - warning means something didn't go as expected but it was not serious enough to abort the plan)
  
  Values are success, warning, error, or pending.
  
  stage string Required
  
  Current stage that the step is in
  
  Values are starting, completed, or in_progress.
  
  info_log array[object] Required
  
  Human readable summaries of the step, including messages for each stage of the step
  
  The log message from a specified stage of an executed step in a plan.
  
  Hide info_log attributes Show info_log attributes object
  
  timestamp string(date-time) Required
  
  Timestamp marking on info log of step
  
  delta_in_millis integer(int64)
  
  Time in milliseconds since previous log message
  
  stage string Required
  
  Stage that info log message takes place in
  
  Values are starting, completed, or in_progress.
  
  message string Required
  
  Human readable log message
  
  details object Required
  
  A map with details for the log about what happened during the step execution. Keys and values for are always both strings, representing the name of the detail and its value, respectively.
  
  Hide details attribute Show details attribute object
  
  * string Additional properties
  
  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
  
  Information about a warning from a plan.
  
  Hide warnings attributes Show warnings attributes object
  
  code string Required
  
  A unique warning code
  
  message string Required
  
  A description of the warning
  
  step_id string
  
  The ID of the step which produced a warning, if any
  
  error object
  
  Information about an error during a plan attempt.
  
  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
  
  Information about the APM Server plan.
  
  Hide history attributes Show history attributes object
  
  plan_attempt_id string
  
  A UUID for each plan attempt
  
  plan_attempt_name string
  
  A human readable name for each plan attempt, only populated when retrieving plan histories
  
  healthy boolean Required
  
  Either the plan ended successfully, or is not yet completed (and no errors have occurred)
  
  attempt_start_time string(date-time)
  
  When this plan attempt (ie to apply the plan to the APM) started (ISO format in UTC)
  
  attempt_end_time string(date-time)
  
  If this plan completed or failed (ie is not pending), when the attempt ended (ISO format in UTC)
  
  plan_end_time string(date-time)
  
  If this plan is not current or pending, when the plan was no longer active (ISO format in UTC)
  
  plan object
  
  The plan for the APM Server.
  
  Additional properties are allowed.
  
  Hide plan attributes Show plan attributes object
  
  cluster_topology array[object]
  
  Defines the topology of the APM Server nodes. For example, the number or capacity of the nodes, and where you can allocate the nodes.
  
  Hide cluster_topology attributes Show cluster_topology attributes object
  
  instance_configuration_id string
  
  Controls the allocation of this topology element as well as allowed sizes and node_types. It needs to match the id of an existing instance configuration.
  
  instance_configuration_version integer(int32)
  
  The version of the Instance Configuration Id. If it is unset, the meaning depends on read vs writes. For deployment reads, it is equivalent to version 0 (or the IC is unversioned); for deployment creates and deployment template use, it is equivalent to 'the latest version'; and for deployment updates, it is equivalent to 'retain the current version'.
  
  size object
  
  Measured by the amount of a resource. The final cluster size is calculated using multipliers from the topology instance configuration.
  
  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
  
  apm object
  
  The configuration options for the APM Server.
  
  Additional properties are allowed.
  
  Hide apm attributes Show apm attributes object
  
  version string
  
  The version of the Apm cluster (must be one of the ECE supported versions, and won't work unless it matches the APM version. Leave blank to auto-detect version.)
  
  docker_image string
  
  A docker URI that allows overriding of the default docker image specified for this version
  
  system_settings object
  
  A structure that defines a curated subset of the APM Server settings. TIP: To define the complete set of APM Server setting, use ApmSystemSettings with user_settings_override_ and user_settings_.
  
  Additional properties are allowed.
  
  Hide system_settings attributes Show system_settings attributes object
  
  elasticsearch_url string
  
  DEPRECATED: Scheduled for removal in a future version of the API.
  
  Optionally override the URL to which to send data (for advanced users only, if unspecified the system selects an internal URL)
  
  kibana_url string
  
  DEPRECATED: Scheduled for removal in a future version of the API.
  
  Optionally override the URL to which to send data (for advanced users only, if unspecified the system selects an internal URL)
  
  elasticsearch_username string
  
  Optionally override the account within APM - defaults to a system account that always exists (if specified, the password must also be specified). Note that this field is never returned from the API, it is write only.
  
  elasticsearch_password string
  
  Optionally override the account within APM - defaults to a system account that always exists (if specified, the username must also be specified). Note that this field is never returned from the API, it is write only.
  
  secret_token string
  
  Optionally override the secret token within APM - defaults to the previously existing secretToken
  
  debug_enabled boolean
  
  Optionally enable debug mode for APM servers - defaults false
  
  user_settings_json object
  
  An arbitrary JSON object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters are on the allowlist and not on the denylist. (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Apm settings)
  
  Additional properties are allowed.
  
  user_settings_yaml string
  
  An arbitrary YAML object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_json' is allowed), provided the parameters are on the allowlist and not on the denylist. (These field together with 'user_settings_override*' and 'system_settings' defines the total set of Apm settings)
  
  user_settings_override_json object
  
  An arbitrary JSON object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Apm settings)
  
  Additional properties are allowed.
  
  user_settings_override_yaml string
  
  An arbitrary YAML object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_json' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Apm settings)
  
  apm object Required
  
  The configuration options for the APM Server.
  
  Additional properties are allowed.
  
  Hide apm attributes Show apm attributes object
  
  version string
  
  The version of the Apm cluster (must be one of the ECE supported versions, and won't work unless it matches the APM version. Leave blank to auto-detect version.)
  
  docker_image string
  
  A docker URI that allows overriding of the default docker image specified for this version
  
  system_settings object
  
  A structure that defines a curated subset of the APM Server settings. TIP: To define the complete set of APM Server setting, use ApmSystemSettings with user_settings_override_ and user_settings_.
  
  Additional properties are allowed.
  
  Hide system_settings attributes Show system_settings attributes object
  
  elasticsearch_url string
  
  DEPRECATED: Scheduled for removal in a future version of the API.
  
  Optionally override the URL to which to send data (for advanced users only, if unspecified the system selects an internal URL)
  
  kibana_url string
  
  DEPRECATED: Scheduled for removal in a future version of the API.
  
  Optionally override the URL to which to send data (for advanced users only, if unspecified the system selects an internal URL)
  
  elasticsearch_username string
  
  Optionally override the account within APM - defaults to a system account that always exists (if specified, the password must also be specified). Note that this field is never returned from the API, it is write only.
  
  elasticsearch_password string
  
  Optionally override the account within APM - defaults to a system account that always exists (if specified, the username must also be specified). Note that this field is never returned from the API, it is write only.
  
  secret_token string
  
  Optionally override the secret token within APM - defaults to the previously existing secretToken
  
  debug_enabled boolean
  
  Optionally enable debug mode for APM servers - defaults false
  
  user_settings_json object
  
  An arbitrary JSON object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters are on the allowlist and not on the denylist. (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Apm settings)
  
  Additional properties are allowed.
  
  user_settings_yaml string
  
  An arbitrary YAML object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_json' is allowed), provided the parameters are on the allowlist and not on the denylist. (These field together with 'user_settings_override*' and 'system_settings' defines the total set of Apm settings)
  
  user_settings_override_json object
  
  An arbitrary JSON object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Apm settings)
  
  Additional properties are allowed.
  
  user_settings_override_yaml string
  
  An arbitrary YAML object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_json' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Apm settings)
  
  transient object
  
  Defines the configuration parameters that control how the plan is applied. For example, the Elasticsearch cluster topology and APM Server settings.
  
  Additional properties are allowed.
  
  Hide transient attributes Show transient attributes object
  
  strategy object
  
  The options for performing a plan change. Specify only one property each time. The default is grow_and_shrink.
  
  Additional properties are allowed.
  
  Hide strategy attributes Show strategy attributes object
  
  rolling object
  
  Performs inline, rolling configuration changes that mutate existing containers. TIP: This is the fastest way to update a plan, but can fail for complex plan changes, such as topology changes. Also, this is less safe for configuration changes that leave a cluster in a non running state. NOTE: When you perform a major version upgrade, and 'group_by' is set to 'pass:macros[all]';, rolling is required.
  
  Additional properties are allowed.
  
  Hide rolling attributes Show rolling attributes object
  
  group_by string
  
  Specifies the grouping attribute to use when rolling several instances. Instances that share the same value for the provided attribute key are rolled together as a unit. Examples that make sense to use are '__all__' (roll all instances as a single unit), 'logical_zone_name' (roll instances by zone), '__name__' (roll one instance at a time, the default if not specified). Note that '__all__' is required when performing a major version upgrade
  
  allow_inline_resize boolean
  
  Whether we allow changing the capacity of instances (default false). This is currently implemented by stopping, re-creating then starting the affected instance on its associated allocator when performing the changes. NOTES: This requires a round-trip through the allocation infrastructure of the active constructor, as it has to reserve the target capacity without over-committing
  
  skip_synced_flush boolean
  
  Whether to skip attempting to do a synced flush on the filesystem of the container (default: false), which is less safe but may be required if the container is unhealthy
  
  shard_init_wait_time integer(int64)
  
  The time, in seconds, to wait for shards that show no progress of initializing before rolling the next group (default: 10 minutes)
  
  grow_and_shrink object
  
  A strategy that creates instances with the new plan, migrates data from the old instances, then shuts down the old instances. GrowShrinkStrategyConfig is safer than 'rolling' and ensures single node availability during a plan change, but can be a lot slower on larger clusters.
  
  Additional properties are allowed.
  
  rolling_grow_and_shrink object
  
  A strategy that creates new Elasticsearch instances, Kibana instances, and APM Servers with the new plan, then migrates the node data to minimize the amount of spare capacity.
  
  Additional properties are allowed.
  
  autodetect object
  
  A strategy that lets constructor choose the most optimal way to execute the plan.
  
  Additional properties are allowed.
  
  plan_configuration object
  
  The plan control configuration options for the APM Server.
  
  Additional properties are allowed.
  
  Hide plan_configuration attributes Show plan_configuration attributes object
  
  timeout integer(int64)
  
  The total timeout in seconds after which the plan is cancelled even if it is not complete. Defaults to 4x the max memory capacity per node (in MB)
  
  calm_wait_time integer(int64)
  
  This timeout determines how long to give a cluster after it responds to API calls before performing actual operations on it. It defaults to 5s
  
  move_instances array[object]
  
  The request that specifies the Elasticsearch or stateless (eg Kibana) instances to move to allocators as part of the upgrade plan. When used in conjunction with '__all__' (roll all instances as a single unit) strategy, these instances are not restarted, which can sometimes enable recovery plans when these instances are boot-looping.
  
  Hide move_instances attributes Show move_instances attributes object
  
  from string Required
  
  The instance id that is going to be moved
  
  to array[string]
  
  An optional list of allocator ids to which the instance should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)
  
  instance_down boolean
  
  Tells the infrastructure that the instance should be considered as permanently down when deciding how to migrate data to new nodes. If left blank then the system will automatically decide (currently: will treat the instances as up)
  
  move_allocators array[object]
  
  As part of the upgrade plan, identifies the move requests for the Kibana instances or APM Servers on the allocators.
  
  Hide move_allocators attributes Show move_allocators attributes object
  
  from string Required
  
  The allocator id off which all instances in the cluster should be moved
  
  to array[string]
  
  An optional list of allocator ids to which the instance(s) should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)
  
  allocator_down boolean
  
  Tells the infrastructure that all instances on the allocator should be considered as permanently down when deciding how to migrate data to new nodes. If left blank then the system will auto-decide (currently: will treat the allocator as up)
  
  reallocate_instances boolean
  
  If true (default: false) does not allow re-using any existing instances currently in the cluster, ie even unchanged instances will be re-created
  
  preferred_allocators array[string]
  
  List of allocators on which instances are placed if possible (if not possible/not specified then any available allocator with space is used)
  
  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
  
  Information about a step in a plan.
  
  Hide plan_attempt_log attributes Show plan_attempt_log attributes object
  
  step_id string Required
  
  ID of current step
  
  started string(date-time) Required
  
  When the step started (ISO format in UTC)
  
  completed string(date-time)
  
  When the step completed (ISO format in UTC)
  
  duration_in_millis integer(int64)
  
  The duration of the step in MS
  
  status string Required
  
  The status of the step (success, warning, error - warning means something didn't go as expected but it was not serious enough to abort the plan)
  
  Values are success, warning, error, or pending.
  
  stage string Required
  
  Current stage that the step is in
  
  Values are starting, completed, or in_progress.
  
  info_log array[object] Required
  
  Human readable summaries of the step, including messages for each stage of the step
  
  The log message from a specified stage of an executed step in a plan.
  
  Hide info_log attributes Show info_log attributes object
  
  timestamp string(date-time) Required
  
  Timestamp marking on info log of step
  
  delta_in_millis integer(int64)
  
  Time in milliseconds since previous log message
  
  stage string Required
  
  Stage that info log message takes place in
  
  Values are starting, completed, or in_progress.
  
  message string Required
  
  Human readable log message
  
  details object Required
  
  A map with details for the log about what happened during the step execution. Keys and values for are always both strings, representing the name of the detail and its value, respectively.
  
  Hide details attribute Show details attribute object
  
  * string Additional properties
  
  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
  
  Information about a warning from a plan.
  
  Hide warnings attributes Show warnings attributes object
  
  code string Required
  
  A unique warning code
  
  message string Required
  
  A description of the warning
  
  step_id string
  
  The ID of the step which produced a warning, if any
  
  error object
  
  Information about an error during a plan attempt.
  
  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
  
  A URL to access the service of a resource
  
  Hide services_urls attributes Show services_urls attributes object
  
  service string Required
  
  Name of the service
  
  url string Required
  
  The full URL to access the service
  
  topology object Required
  
  The topology for Elasticsearch clusters, multiple Kibana instances, or multiple APM Servers. The ClusterTopologyInfo also includes the instances and containers, and where they are located.
  
  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
  
  Information about each Kibana instance and APM Server in the Elasticsearch cluster.
  
  Hide instances attributes Show instances attributes object
  
  instance_name string Required
  
  The name of the instance in Elastic Cloud
  
  instance_configuration object
  
  Information about a configuration that creates a Kibana instance or APM Server.
  
  Additional properties are allowed.
  
  Hide instance_configuration attributes Show instance_configuration attributes object
  
  id string Required
  
  The id of the configuration used to create the instance
  
  name string Required
  
  The name of the configuration used to create the instance
  
  config_version integer(int32)
  
  If the IC is configuration controlled, this field is the version either being read back (reads return the latest IC unless specified by the 'config_version' URL param), or the version to update. Cannot be used in creates. For unversioned IC reads it is left empty.
  
  resource string Required
  
  The resource type of the instance configuration
  
  Values are memory or storage.
  
  service_version string
  
  The version of the service that the instance is running (eg Elasticsearch or Kibana), if available
  
  healthy boolean Required
  
  Whether the instance is healthy (ie started and running)
  
  container_started boolean Required
  
  Whether the container has started (does not tell you anything about the service -ie Elasticsearch- running inside the container)
  
  service_running boolean Required
  
  Whether the service launched inside the container -ie Elasticsearch- is actually running
  
  maintenance_mode boolean Required
  
  Whether the service is is maintenance mode (meaning that the proxy is not routing external traffic to it)
  
  zone string
  
  The zone in which this instance is being allocated
  
  allocator_id string
  
  The id of the allocator on which this instance is running (if the container is started or starting)
  
  memory object
  
  Information about the specific instances memory capacity and its usage
  
  Additional properties are allowed.
  
  Hide memory attributes Show memory attributes object
  
  instance_capacity integer(int32) Required
  
  The memory capacity in MB of the instance
  
  instance_capacity_planned integer(int32)
  
  The planned memory capacity in MB of the instance (only shown when an override is present)
  
  memory_pressure integer(int32)
  
  The % memory pressure of Elasticsearch JVM heap space if available (60-75% consider increasing capacity, >75% can incur significant performance and stability issues)
  
  native_memory_pressure integer(int32)
  
  The % memory pressure of the instance Docker container (if available)
  
  disk object
  
  Information about the use and storage capacity of a Kibana instance or APM Server.
  
  Additional properties are allowed.
  
  Hide disk attributes Show disk attributes object
  
  disk_space_available integer(int64)
  
  If known, the amount of total disk space available to the container in MB
  
  disk_space_used integer(int64) Required
  
  The amount of disk space being used by the service in MB
  
  storage_multiplier number(double) Required
  
  The storage multiplier originally defined to calculate disk space.
  
  service_roles array[string]
  
  List of roles assigned to the service running in the instance. Currently only populated for Elasticsearch, with possible values: master,data,ingest,ml
  
  node_roles array[string]
  
  A list of the node roles assigned to the service running in the instance. Currently populated only for Elasticsearch.
  
  Values are master, ingest, ml, data_hot, data_content, data_warm, data_cold, data_frozen, remote_cluster_client, transform, or voting_only.
  
  instance_overrides object
  
  Instance overrides
  
  Additional properties are allowed.
  
  Hide instance_overrides attributes Show instance_overrides attributes object
  
  capacity integer(int32)
  
  Sets the memory capacity for the instances container. Requires a restart to take effect.
  
  storage_multiplier number(double)
  
  Overrides the disk quota multiplier for the instance
  
  external_links array[object] Required
  
  External resources related to the APM
  
  Hide external_links attributes Show external_links attributes object
  
  id string Required
  
  Identifier of the external link
  
  label string Required
  
  Human-readable description of the external link
  
  uri string
  
  hyperlink to an external resource
  
  links object
  
  A map of application-specific operations (which map to 'operationId's in the Swagger API) to metadata about that operation
  
  Hide links attribute Show links attribute object
  
  * object Additional properties
  
  Additional properties are allowed.
  
  Hide * attribute Show * attribute object
  
  need_elevated_permissions boolean
  
  Whether the operation requires elevated permissions (when the field is present, elevated permissions are required).
  
  settings object
  
  The settings for building this APM cluster
  
  Additional properties are allowed.
  
  Hide settings attribute Show settings attribute object
  
  metadata object
  
  The top-level configuration settings for the Elasticsearch cluster.
  
  Additional properties are allowed.
  
  Hide metadata 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 APM belongs to. Only populated in SaaS or federated ECE.
  
  apm_server_mode string
  
  The mode APM is operating in.
  
  Values are standalone or managed.
404

The Deployment specified by {deployment_id} cannot be found. (code: deployments.deployment_not_found)
Hide headers attribute Show headers attribute
- x-cloud-error-codes string
  
  The error codes associated with the response
  
  Value is deployments.deployment_not_found.
Hide response attribute Show response attribute object
- errors array[object] Required
  
  A list of errors that occurred in the failing request
  
  Hide errors attributes Show errors attributes object
  
  code string Required
  
  A structured code representing the error type that occurred
  
  message string Required
  
  A human readable message describing the error that occurred
  
  fields array[string]
  
  If the error can be tied to a specific field or fields in the user request, this lists those fields
500

We have failed you. (code: deployments.deployment_resource_no_longer_exists)
Hide headers attribute Show headers attribute
- x-cloud-error-codes string
  
  The error codes associated with the response
  
  Value is deployments.deployment_resource_no_longer_exists.
Hide response attribute Show response attribute object
- errors array[object] Required
  
  A list of errors that occurred in the failing request
  
  Hide errors attributes Show errors attributes object
  
  code string Required
  
  A structured code representing the error type that occurred
  
  message string Required
  
  A human readable message describing the error that occurred
  
  fields array[string]
  
  If the error can be tied to a specific field or fields in the user request, this lists those fields

GET /deployments/{deployment_id}/apm/{ref_id}

curl \
 --request GET https://{{hostname}}/api/v1/deployments/{deployment_id}/apm/{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": "2025-05-04T09:42:00Z",
        "attempt_end_time": "2025-05-04T09:42:00Z",
        "plan_end_time": "2025-05-04T09:42:00Z",
        "plan": {
          "cluster_topology": [
            {
              "instance_configuration_id": "string",
              "instance_configuration_version": 42,
              "size": {
                "value": 42,
                "resource": "memory"
              },
              "zone_count": 42,
              "apm": {
                "version": "string",
                "docker_image": "string",
                "system_settings": {
                  "elasticsearch_url": "string",
                  "kibana_url": "string",
                  "elasticsearch_username": "string",
                  "elasticsearch_password": "string",
                  "secret_token": "string",
                  "debug_enabled": true
                },
                "user_settings_json": {},
                "user_settings_yaml": "string",
                "user_settings_override_json": {},
                "user_settings_override_yaml": "string"
              }
            }
          ],
          "apm": {
            "version": "string",
            "docker_image": "string",
            "system_settings": {
              "elasticsearch_url": "string",
              "kibana_url": "string",
              "elasticsearch_username": "string",
              "elasticsearch_password": "string",
              "secret_token": "string",
              "debug_enabled": true
            },
            "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": "2025-05-04T09:42:00Z",
            "completed": "2025-05-04T09:42:00Z",
            "duration_in_millis": 42,
            "status": "success",
            "stage": "starting",
            "info_log": [
              {
                "timestamp": "2025-05-04T09:42:00Z",
                "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": "2025-05-04T09:42:00Z",
          "user_id": "string",
          "admin_id": "string",
          "remote_addresses": [
            "string"
          ]
        },
        "warnings": [
          {
            "code": "string",
            "message": "string",
            "step_id": "string"
          }
        ],
        "error": {
          "timestamp": "2025-05-04T09:42:00Z",
          "message": "string",
          "details": {
            "additionalProperty1": "string",
            "additionalProperty2": "string"
          },
          "failure_type": "string"
        }
      },
      "pending": {
        "plan_attempt_id": "string",
        "plan_attempt_name": "string",
        "healthy": true,
        "attempt_start_time": "2025-05-04T09:42:00Z",
        "attempt_end_time": "2025-05-04T09:42:00Z",
        "plan_end_time": "2025-05-04T09:42:00Z",
        "plan": {
          "cluster_topology": [
            {
              "instance_configuration_id": "string",
              "instance_configuration_version": 42,
              "size": {
                "value": 42,
                "resource": "memory"
              },
              "zone_count": 42,
              "apm": {
                "version": "string",
                "docker_image": "string",
                "system_settings": {
                  "elasticsearch_url": "string",
                  "kibana_url": "string",
                  "elasticsearch_username": "string",
                  "elasticsearch_password": "string",
                  "secret_token": "string",
                  "debug_enabled": true
                },
                "user_settings_json": {},
                "user_settings_yaml": "string",
                "user_settings_override_json": {},
                "user_settings_override_yaml": "string"
              }
            }
          ],
          "apm": {
            "version": "string",
            "docker_image": "string",
            "system_settings": {
              "elasticsearch_url": "string",
              "kibana_url": "string",
              "elasticsearch_username": "string",
              "elasticsearch_password": "string",
              "secret_token": "string",
              "debug_enabled": true
            },
            "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": "2025-05-04T09:42:00Z",
            "completed": "2025-05-04T09:42:00Z",
            "duration_in_millis": 42,
            "status": "success",
            "stage": "starting",
            "info_log": [
              {
                "timestamp": "2025-05-04T09:42:00Z",
                "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": "2025-05-04T09:42:00Z",
          "user_id": "string",
          "admin_id": "string",
          "remote_addresses": [
            "string"
          ]
        },
        "warnings": [
          {
            "code": "string",
            "message": "string",
            "step_id": "string"
          }
        ],
        "error": {
          "timestamp": "2025-05-04T09:42:00Z",
          "message": "string",
          "details": {
            "additionalProperty1": "string",
            "additionalProperty2": "string"
          },
          "failure_type": "string"
        }
      },
      "history": [
        {
          "plan_attempt_id": "string",
          "plan_attempt_name": "string",
          "healthy": true,
          "attempt_start_time": "2025-05-04T09:42:00Z",
          "attempt_end_time": "2025-05-04T09:42:00Z",
          "plan_end_time": "2025-05-04T09:42:00Z",
          "plan": {
            "cluster_topology": [
              {
                "instance_configuration_id": "string",
                "instance_configuration_version": 42,
                "size": {
                  "value": 42,
                  "resource": "memory"
                },
                "zone_count": 42,
                "apm": {
                  "version": "string",
                  "docker_image": "string",
                  "system_settings": {
                    "elasticsearch_url": "string",
                    "kibana_url": "string",
                    "elasticsearch_username": "string",
                    "elasticsearch_password": "string",
                    "secret_token": "string",
                    "debug_enabled": true
                  },
                  "user_settings_json": {},
                  "user_settings_yaml": "string",
                  "user_settings_override_json": {},
                  "user_settings_override_yaml": "string"
                }
              }
            ],
            "apm": {
              "version": "string",
              "docker_image": "string",
              "system_settings": {
                "elasticsearch_url": "string",
                "kibana_url": "string",
                "elasticsearch_username": "string",
                "elasticsearch_password": "string",
                "secret_token": "string",
                "debug_enabled": true
              },
              "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": "2025-05-04T09:42:00Z",
              "completed": "2025-05-04T09:42:00Z",
              "duration_in_millis": 42,
              "status": "success",
              "stage": "starting",
              "info_log": [
                {
                  "timestamp": "2025-05-04T09:42:00Z",
                  "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": "2025-05-04T09:42:00Z",
            "user_id": "string",
            "admin_id": "string",
            "remote_addresses": [
              "string"
            ]
          },
          "warnings": [
            {
              "code": "string",
              "message": "string",
              "step_id": "string"
            }
          ],
          "error": {
            "timestamp": "2025-05-04T09:42:00Z",
            "message": "string",
            "details": {
              "additionalProperty1": "string",
              "additionalProperty2": "string"
            },
            "failure_type": "string"
          }
        }
      ]
    },
    "metadata": {
      "version": 42,
      "last_modified": "2025-05-04T09:42:00Z",
      "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",
    "apm_server_mode": "standalone"
  }
}

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

Get Deployment App Search Resource Info

GET /deployments/{deployment_id}/appsearch/{ref_id}

Get info about an App 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 App Search
  
  name string Required
  
  The name of the App Search
  
  elasticsearch_cluster object Required
  
  Information about the specified Elasticsearch cluster.
  
  Additional properties are allowed.
  
  Hide elasticsearch_cluster attributes Show elasticsearch_cluster attributes object
  
  elasticsearch_id string Required
  
  The Elasticsearch cluster Id
  
  links object
  
  A map of application-specific operations (which map to 'operationId's in the Swagger API) to metadata about that operation
  
  Hide links attribute Show links attribute object
  
  * object Additional properties
  
  Additional properties are allowed.
  
  Hide * attribute Show * attribute object
  
  need_elevated_permissions boolean
  
  Whether the operation requires elevated permissions (when the field is present, elevated permissions are required).
  
  deployment_id string
  
  The id of the deployment that this App Search belongs to.
  
  healthy boolean Required
  
  Whether the App Search is healthy or not (one or more of the info subsections will have healthy: false)
  
  status string Required
  
  App Search status
  
  Values are initializing, stopping, stopped, rebooting, restarting, reconfiguring, or started.
  
  plan_info object Required
  
  Information about current, pending, and past App Search Server plans.
  
  Additional properties are allowed.
  
  Hide plan_info attributes Show plan_info attributes object
  
  healthy boolean Required
  
  Whether the plan situation is healthy (if unhealthy, means the last plan attempt failed)
  
  current object
  
  Information about the App Search Server plan.
  
  Additional properties are allowed.
  
  Hide current attributes Show current attributes object
  
  plan_attempt_id string
  
  A UUID for each plan attempt
  
  plan_attempt_name string
  
  A human readable name for each plan attempt, only populated when retrieving plan histories
  
  healthy boolean Required
  
  Either the plan ended successfully, or is not yet completed (and no errors have occurred)
  
  attempt_start_time string(date-time)
  
  When this plan attempt (ie to apply the plan to the App Search) started (ISO format in UTC)
  
  attempt_end_time string(date-time)
  
  If this plan completed or failed (ie is not pending), when the attempt ended (ISO format in UTC)
  
  plan_end_time string(date-time)
  
  If this plan is not current or pending, when the plan was no longer active (ISO format in UTC)
  
  plan object
  
  The plan for the App Search cluster.
  
  Additional properties are allowed.
  
  Hide plan attributes Show plan attributes object
  
  cluster_topology array[object]
  
  Defines the topology of the AppSearch nodes (eg number/capacity of nodes, and where they can be allocated)
  
  Hide cluster_topology attributes Show cluster_topology attributes object
  
  node_type object
  
  Defines the AppSearch node type
  
  Additional properties are allowed.
  
  Hide node_type attributes Show node_type attributes object
  
  appserver boolean Required
  
  Defines whether this instance should run as Application/API server
  
  worker boolean Required
  
  Defines whether this instance should run as background worker
  
  instance_configuration_id string
  
  Controls the allocation of this topology element as well as allowed sizes and node_types. It needs to match the id of an existing instance configuration.
  
  instance_configuration_version integer(int32)
  
  The version of the Instance Configuration Id. If it is unset, the meaning depends on read vs writes. For deployment reads, it is equivalent to version 0 (or the IC is unversioned); for deployment creates and deployment template use, it is equivalent to 'the latest version'; and for deployment updates, it is equivalent to 'retain the current version'.
  
  size object
  
  Measured by the amount of a resource. The final cluster size is calculated using multipliers from the topology instance configuration.
  
  Additional properties are allowed.
  
  Hide size attributes Show size attributes object
  
  value integer(int32) Required
  
  Amount of resource
  
  resource string Required
  
  Type of resource
  
  Values are memory or storage.
  
  zone_count integer(int32)
  
  number of zones in which nodes will be placed
  
  appsearch object
  
  Additional properties are allowed.
  
  Hide appsearch attributes Show appsearch attributes object
  
  version string
  
  The version of the AppSearch cluster (must be one of the ECE supported versions, and won't work unless it matches the Elasticsearch version. Leave blank to auto-detect version.)
  
  docker_image string
  
  A docker URI that allows overriding of the default docker image specified for this version
  
  system_settings object
  
  This structure defines a curated subset of the AppSearch settings. (This field together with 'user_settings_override*' and 'user_settings*' defines the total set of AppSearch settings)
  
  Additional properties are allowed.
  
  Hide system_settings attributes Show system_settings attributes object
  
  elasticsearch_url string
  
  Optionally override the URL to which to send data (for advanced users only, if unspecified the system selects an internal URL)
  
  elasticsearch_username string
  
  Optionally override the account within App Search - defaults to a system account that always exists (if specified, the password must also be specified). Note that this field is never returned from the API, it is write only.
  
  elasticsearch_password string
  
  Optionally override the account within App Search - defaults to a system account that always exists (if specified, the username must also be specified). Note that this field is never returned from the API, it is write only.
  
  secret_session_key string
  
  Optionally override the secret session key within App Search - defaults to the previously existing secretSession. Note that this field is never returned from the API, it is write only.
  
  user_settings_json object
  
  An arbitrary JSON object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters are on the allowlist and not on the denylist. (This field together with 'user_settings_override*' and 'system_settings' defines the total set of AppSearch settings)
  
  Additional properties are allowed.
  
  user_settings_yaml string
  
  An arbitrary YAML object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_json' is allowed), provided the parameters are on the allowlist and not on the denylist. (These field together with 'user_settings_override*' and 'system_settings' defines the total set of AppSearch settings)
  
  user_settings_override_json object
  
  An arbitrary JSON object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of AppSearch settings)
  
  Additional properties are allowed.
  
  user_settings_override_yaml string
  
  An arbitrary YAML object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_json' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of AppSearch settings)
  
  appsearch object Required
  
  Additional properties are allowed.
  
  Hide appsearch attributes Show appsearch attributes object
  
  version string
  
  The version of the AppSearch cluster (must be one of the ECE supported versions, and won't work unless it matches the Elasticsearch version. Leave blank to auto-detect version.)
  
  docker_image string
  
  A docker URI that allows overriding of the default docker image specified for this version
  
  system_settings object
  
  This structure defines a curated subset of the AppSearch settings. (This field together with 'user_settings_override*' and 'user_settings*' defines the total set of AppSearch settings)
  
  Additional properties are allowed.
  
  Hide system_settings attributes Show system_settings attributes object
  
  elasticsearch_url string
  
  Optionally override the URL to which to send data (for advanced users only, if unspecified the system selects an internal URL)
  
  elasticsearch_username string
  
  Optionally override the account within App Search - defaults to a system account that always exists (if specified, the password must also be specified). Note that this field is never returned from the API, it is write only.
  
  elasticsearch_password string
  
  Optionally override the account within App Search - defaults to a system account that always exists (if specified, the username must also be specified). Note that this field is never returned from the API, it is write only.
  
  secret_session_key string
  
  Optionally override the secret session key within App Search - defaults to the previously existing secretSession. Note that this field is never returned from the API, it is write only.
  
  user_settings_json object
  
  An arbitrary JSON object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters are on the allowlist and not on the denylist. (This field together with 'user_settings_override*' and 'system_settings' defines the total set of AppSearch settings)
  
  Additional properties are allowed.
  
  user_settings_yaml string
  
  An arbitrary YAML object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_json' is allowed), provided the parameters are on the allowlist and not on the denylist. (These field together with 'user_settings_override*' and 'system_settings' defines the total set of AppSearch settings)
  
  user_settings_override_json object
  
  An arbitrary JSON object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of AppSearch settings)
  
  Additional properties are allowed.
  
  user_settings_override_yaml string
  
  An arbitrary YAML object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_json' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of AppSearch settings)
  
  transient object
  
  Defines configuration parameters that control how the plan (ie consisting of the cluster topology and AppSearch settings) is applied
  
  Additional properties are allowed.
  
  Hide transient attributes Show transient attributes object
  
  strategy object
  
  The options for performing a plan change. Specify only one property each time. The default is grow_and_shrink.
  
  Additional properties are allowed.
  
  Hide strategy attributes Show strategy attributes object
  
  rolling object
  
  Performs inline, rolling configuration changes that mutate existing containers. TIP: This is the fastest way to update a plan, but can fail for complex plan changes, such as topology changes. Also, this is less safe for configuration changes that leave a cluster in a non running state. NOTE: When you perform a major version upgrade, and 'group_by' is set to 'pass:macros[all]';, rolling is required.
  
  Additional properties are allowed.
  
  Hide rolling attributes Show rolling attributes object
  
  group_by string
  
  Specifies the grouping attribute to use when rolling several instances. Instances that share the same value for the provided attribute key are rolled together as a unit. Examples that make sense to use are '__all__' (roll all instances as a single unit), 'logical_zone_name' (roll instances by zone), '__name__' (roll one instance at a time, the default if not specified). Note that '__all__' is required when performing a major version upgrade
  
  allow_inline_resize boolean
  
  Whether we allow changing the capacity of instances (default false). This is currently implemented by stopping, re-creating then starting the affected instance on its associated allocator when performing the changes. NOTES: This requires a round-trip through the allocation infrastructure of the active constructor, as it has to reserve the target capacity without over-committing
  
  skip_synced_flush boolean
  
  Whether to skip attempting to do a synced flush on the filesystem of the container (default: false), which is less safe but may be required if the container is unhealthy
  
  shard_init_wait_time integer(int64)
  
  The time, in seconds, to wait for shards that show no progress of initializing before rolling the next group (default: 10 minutes)
  
  grow_and_shrink object
  
  A strategy that creates instances with the new plan, migrates data from the old instances, then shuts down the old instances. GrowShrinkStrategyConfig is safer than 'rolling' and ensures single node availability during a plan change, but can be a lot slower on larger clusters.
  
  Additional properties are allowed.
  
  rolling_grow_and_shrink object
  
  A strategy that creates new Elasticsearch instances, Kibana instances, and APM Servers with the new plan, then migrates the node data to minimize the amount of spare capacity.
  
  Additional properties are allowed.
  
  autodetect object
  
  A strategy that lets constructor choose the most optimal way to execute the plan.
  
  Additional properties are allowed.
  
  plan_configuration object
  
  Additional properties are allowed.
  
  Hide plan_configuration attributes Show plan_configuration attributes object
  
  timeout integer(int64)
  
  The total timeout in seconds after which the plan is cancelled even if it is not complete. Defaults to 4x the max memory capacity per node (in MB)
  
  calm_wait_time integer(int64)
  
  This timeout determines how long to give a cluster after it responds to API calls before performing actual operations on it. It defaults to 5s
  
  move_instances array[object]
  
  The request that specifies the Elasticsearch or stateless (eg Kibana) instances to move to allocators as part of the upgrade plan. When used in conjunction with '__all__' (roll all instances as a single unit) strategy, these instances are not restarted, which can sometimes enable recovery plans when these instances are boot-looping.
  
  Hide move_instances attributes Show move_instances attributes object
  
  from string Required
  
  The instance id that is going to be moved
  
  to array[string]
  
  An optional list of allocator ids to which the instance should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)
  
  instance_down boolean
  
  Tells the infrastructure that the instance should be considered as permanently down when deciding how to migrate data to new nodes. If left blank then the system will automatically decide (currently: will treat the instances as up)
  
  move_allocators array[object]
  
  As part of the upgrade plan, identifies the move requests for the Kibana instances or APM Servers on the allocators.
  
  Hide move_allocators attributes Show move_allocators attributes object
  
  from string Required
  
  The allocator id off which all instances in the cluster should be moved
  
  to array[string]
  
  An optional list of allocator ids to which the instance(s) should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)
  
  allocator_down boolean
  
  Tells the infrastructure that all instances on the allocator should be considered as permanently down when deciding how to migrate data to new nodes. If left blank then the system will auto-decide (currently: will treat the allocator as up)
  
  reallocate_instances boolean
  
  If true (default: false) does not allow re-using any existing instances currently in the cluster, ie even unchanged instances will be re-created
  
  preferred_allocators array[string]
  
  List of allocators on which instances are placed if possible (if not possible/not specified then any available allocator with space is used)
  
  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
  
  Information about a step in a plan.
  
  Hide plan_attempt_log attributes Show plan_attempt_log attributes object
  
  step_id string Required
  
  ID of current step
  
  started string(date-time) Required
  
  When the step started (ISO format in UTC)
  
  completed string(date-time)
  
  When the step completed (ISO format in UTC)
  
  duration_in_millis integer(int64)
  
  The duration of the step in MS
  
  status string Required
  
  The status of the step (success, warning, error - warning means something didn't go as expected but it was not serious enough to abort the plan)
  
  Values are success, warning, error, or pending.
  
  stage string Required
  
  Current stage that the step is in
  
  Values are starting, completed, or in_progress.
  
  info_log array[object] Required
  
  Human readable summaries of the step, including messages for each stage of the step
  
  The log message from a specified stage of an executed step in a plan.
  
  Hide info_log attributes Show info_log attributes object
  
  timestamp string(date-time) Required
  
  Timestamp marking on info log of step
  
  delta_in_millis integer(int64)
  
  Time in milliseconds since previous log message
  
  stage string Required
  
  Stage that info log message takes place in
  
  Values are starting, completed, or in_progress.
  
  message string Required
  
  Human readable log message
  
  details object Required
  
  A map with details for the log about what happened during the step execution. Keys and values for are always both strings, representing the name of the detail and its value, respectively.
  
  Hide details attribute Show details attribute object
  
  * string Additional properties
  
  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
  
  Information about a warning from a plan.
  
  Hide warnings attributes Show warnings attributes object
  
  code string Required
  
  A unique warning code
  
  message string Required
  
  A description of the warning
  
  step_id string
  
  The ID of the step which produced a warning, if any
  
  error object
  
  Information about an error during a plan attempt.
  
  Additional properties are allowed.
  
  Hide error attributes Show error attributes object
  
  timestamp string(date-time) Required
  
  Timestamp marking on info log of step
  
  message string Required
  
  Human readable error message
  
  details object Required
  
  A map with details regarding the error. Both the keys and values are always strings, representing the name of the detail and its value, respectively.
  
  Hide details attribute Show details attribute object
  
  * string Additional properties
  
  failure_type string
  
  The failure type
  
  pending object
  
  Information about the App Search Server plan.
  
  Additional properties are allowed.
  
  Hide pending attributes Show pending attributes object
  
  plan_attempt_id string
  
  A UUID for each plan attempt
  
  plan_attempt_name string
  
  A human readable name for each plan attempt, only populated when retrieving plan histories
  
  healthy boolean Required
  
  Either the plan ended successfully, or is not yet completed (and no errors have occurred)
  
  attempt_start_time string(date-time)
  
  When this plan attempt (ie to apply the plan to the App Search) started (ISO format in UTC)
  
  attempt_end_time string(date-time)
  
  If this plan completed or failed (ie is not pending), when the attempt ended (ISO format in UTC)
  
  plan_end_time string(date-time)
  
  If this plan is not current or pending, when the plan was no longer active (ISO format in UTC)
  
  plan object
  
  The plan for the App Search cluster.
  
  Additional properties are allowed.
  
  Hide plan attributes Show plan attributes object
  
  cluster_topology array[object]
  
  Defines the topology of the AppSearch nodes (eg number/capacity of nodes, and where they can be allocated)
  
  Hide cluster_topology attributes Show cluster_topology attributes object
  
  node_type object
  
  Defines the AppSearch node type
  
  Additional properties are allowed.
  
  Hide node_type attributes Show node_type attributes object
  
  appserver boolean Required
  
  Defines whether this instance should run as Application/API server
  
  worker boolean Required
  
  Defines whether this instance should run as background worker
  
  instance_configuration_id string
  
  Controls the allocation of this topology element as well as allowed sizes and node_types. It needs to match the id of an existing instance configuration.
  
  instance_configuration_version integer(int32)
  
  The version of the Instance Configuration Id. If it is unset, the meaning depends on read vs writes. For deployment reads, it is equivalent to version 0 (or the IC is unversioned); for deployment creates and deployment template use, it is equivalent to 'the latest version'; and for deployment updates, it is equivalent to 'retain the current version'.
  
  size object
  
  Measured by the amount of a resource. The final cluster size is calculated using multipliers from the topology instance configuration.
  
  Additional properties are allowed.
  
  Hide size attributes Show size attributes object
  
  value integer(int32) Required
  
  Amount of resource
  
  resource string Required
  
  Type of resource
  
  Values are memory or storage.
  
  zone_count integer(int32)
  
  number of zones in which nodes will be placed
  
  appsearch object
  
  Additional properties are allowed.
  
  Hide appsearch attributes Show appsearch attributes object
  
  version string
  
  The version of the AppSearch cluster (must be one of the ECE supported versions, and won't work unless it matches the Elasticsearch version. Leave blank to auto-detect version.)
  
  docker_image string
  
  A docker URI that allows overriding of the default docker image specified for this version
  
  system_settings object
  
  This structure defines a curated subset of the AppSearch settings. (This field together with 'user_settings_override*' and 'user_settings*' defines the total set of AppSearch settings)
  
  Additional properties are allowed.
  
  Hide system_settings attributes Show system_settings attributes object
  
  elasticsearch_url string
  
  Optionally override the URL to which to send data (for advanced users only, if unspecified the system selects an internal URL)
  
  elasticsearch_username string
  
  Optionally override the account within App Search - defaults to a system account that always exists (if specified, the password must also be specified). Note that this field is never returned from the API, it is write only.
  
  elasticsearch_password string
  
  Optionally override the account within App Search - defaults to a system account that always exists (if specified, the username must also be specified). Note that this field is never returned from the API, it is write only.
  
  secret_session_key string
  
  Optionally override the secret session key within App Search - defaults to the previously existing secretSession. Note that this field is never returned from the API, it is write only.
  
  user_settings_json object
  
  An arbitrary JSON object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters are on the allowlist and not on the denylist. (This field together with 'user_settings_override*' and 'system_settings' defines the total set of AppSearch settings)
  
  Additional properties are allowed.
  
  user_settings_yaml string
  
  An arbitrary YAML object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_json' is allowed), provided the parameters are on the allowlist and not on the denylist. (These field together with 'user_settings_override*' and 'system_settings' defines the total set of AppSearch settings)
  
  user_settings_override_json object
  
  An arbitrary JSON object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of AppSearch settings)
  
  Additional properties are allowed.
  
  user_settings_override_yaml string
  
  An arbitrary YAML object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_json' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of AppSearch settings)
  
  appsearch object Required
  
  Additional properties are allowed.
  
  Hide appsearch attributes Show appsearch attributes object
  
  version string
  
  The version of the AppSearch cluster (must be one of the ECE supported versions, and won't work unless it matches the Elasticsearch version. Leave blank to auto-detect version.)
  
  docker_image string
  
  A docker URI that allows overriding of the default docker image specified for this version
  
  system_settings object
  
  This structure defines a curated subset of the AppSearch settings. (This field together with 'user_settings_override*' and 'user_settings*' defines the total set of AppSearch settings)
  
  Additional properties are allowed.
  
  Hide system_settings attributes Show system_settings attributes object
  
  elasticsearch_url string
  
  Optionally override the URL to which to send data (for advanced users only, if unspecified the system selects an internal URL)
  
  elasticsearch_username string
  
  Optionally override the account within App Search - defaults to a system account that always exists (if specified, the password must also be specified). Note that this field is never returned from the API, it is write only.
  
  elasticsearch_password string
  
  Optionally override the account within App Search - defaults to a system account that always exists (if specified, the username must also be specified). Note that this field is never returned from the API, it is write only.
  
  secret_session_key string
  
  Optionally override the secret session key within App Search - defaults to the previously existing secretSession. Note that this field is never returned from the API, it is write only.
  
  user_settings_json object
  
  An arbitrary JSON object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters are on the allowlist and not on the denylist. (This field together with 'user_settings_override*' and 'system_settings' defines the total set of AppSearch settings)
  
  Additional properties are allowed.
  
  user_settings_yaml string
  
  An arbitrary YAML object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_json' is allowed), provided the parameters are on the allowlist and not on the denylist. (These field together with 'user_settings_override*' and 'system_settings' defines the total set of AppSearch settings)
  
  user_settings_override_json object
  
  An arbitrary JSON object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of AppSearch settings)
  
  Additional properties are allowed.
  
  user_settings_override_yaml string
  
  An arbitrary YAML object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_json' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of AppSearch settings)
  
  transient object
  
  Defines configuration parameters that control how the plan (ie consisting of the cluster topology and AppSearch settings) is applied
  
  Additional properties are allowed.
  
  Hide transient attributes Show transient attributes object
  
  strategy object
  
  The options for performing a plan change. Specify only one property each time. The default is grow_and_shrink.
  
  Additional properties are allowed.
  
  Hide strategy attributes Show strategy attributes object
  
  rolling object
  
  Performs inline, rolling configuration changes that mutate existing containers. TIP: This is the fastest way to update a plan, but can fail for complex plan changes, such as topology changes. Also, this is less safe for configuration changes that leave a cluster in a non running state. NOTE: When you perform a major version upgrade, and 'group_by' is set to 'pass:macros[all]';, rolling is required.
  
  Additional properties are allowed.
  
  Hide rolling attributes Show rolling attributes object
  
  group_by string
  
  Specifies the grouping attribute to use when rolling several instances. Instances that share the same value for the provided attribute key are rolled together as a unit. Examples that make sense to use are '__all__' (roll all instances as a single unit), 'logical_zone_name' (roll instances by zone), '__name__' (roll one instance at a time, the default if not specified). Note that '__all__' is required when performing a major version upgrade
  
  allow_inline_resize boolean
  
  Whether we allow changing the capacity of instances (default false). This is currently implemented by stopping, re-creating then starting the affected instance on its associated allocator when performing the changes. NOTES: This requires a round-trip through the allocation infrastructure of the active constructor, as it has to reserve the target capacity without over-committing
  
  skip_synced_flush boolean
  
  Whether to skip attempting to do a synced flush on the filesystem of the container (default: false), which is less safe but may be required if the container is unhealthy
  
  shard_init_wait_time integer(int64)
  
  The time, in seconds, to wait for shards that show no progress of initializing before rolling the next group (default: 10 minutes)
  
  grow_and_shrink object
  
  A strategy that creates instances with the new plan, migrates data from the old instances, then shuts down the old instances. GrowShrinkStrategyConfig is safer than 'rolling' and ensures single node availability during a plan change, but can be a lot slower on larger clusters.
  
  Additional properties are allowed.
  
  rolling_grow_and_shrink object
  
  A strategy that creates new Elasticsearch instances, Kibana instances, and APM Servers with the new plan, then migrates the node data to minimize the amount of spare capacity.
  
  Additional properties are allowed.
  
  autodetect object
  
  A strategy that lets constructor choose the most optimal way to execute the plan.
  
  Additional properties are allowed.
  
  plan_configuration object
  
  Additional properties are allowed.
  
  Hide plan_configuration attributes Show plan_configuration attributes object
  
  timeout integer(int64)
  
  The total timeout in seconds after which the plan is cancelled even if it is not complete. Defaults to 4x the max memory capacity per node (in MB)
  
  calm_wait_time integer(int64)
  
  This timeout determines how long to give a cluster after it responds to API calls before performing actual operations on it. It defaults to 5s
  
  move_instances array[object]
  
  The request that specifies the Elasticsearch or stateless (eg Kibana) instances to move to allocators as part of the upgrade plan. When used in conjunction with '__all__' (roll all instances as a single unit) strategy, these instances are not restarted, which can sometimes enable recovery plans when these instances are boot-looping.
  
  Hide move_instances attributes Show move_instances attributes object
  
  from string Required
  
  The instance id that is going to be moved
  
  to array[string]
  
  An optional list of allocator ids to which the instance should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)
  
  instance_down boolean
  
  Tells the infrastructure that the instance should be considered as permanently down when deciding how to migrate data to new nodes. If left blank then the system will automatically decide (currently: will treat the instances as up)
  
  move_allocators array[object]
  
  As part of the upgrade plan, identifies the move requests for the Kibana instances or APM Servers on the allocators.
  
  Hide move_allocators attributes Show move_allocators attributes object
  
  from string Required
  
  The allocator id off which all instances in the cluster should be moved
  
  to array[string]
  
  An optional list of allocator ids to which the instance(s) should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)
  
  allocator_down boolean
  
  Tells the infrastructure that all instances on the allocator should be considered as permanently down when deciding how to migrate data to new nodes. If left blank then the system will auto-decide (currently: will treat the allocator as up)
  
  reallocate_instances boolean
  
  If true (default: false) does not allow re-using any existing instances currently in the cluster, ie even unchanged instances will be re-created
  
  preferred_allocators array[string]
  
  List of allocators on which instances are placed if possible (if not possible/not specified then any available allocator with space is used)
  
  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
  
  Information about a step in a plan.
  
  Hide plan_attempt_log attributes Show plan_attempt_log attributes object
  
  step_id string Required
  
  ID of current step
  
  started string(date-time) Required
  
  When the step started (ISO format in UTC)
  
  completed string(date-time)
  
  When the step completed (ISO format in UTC)
  
  duration_in_millis integer(int64)
  
  The duration of the step in MS
  
  status string Required
  
  The status of the step (success, warning, error - warning means something didn't go as expected but it was not serious enough to abort the plan)
  
  Values are success, warning, error, or pending.
  
  stage string Required
  
  Current stage that the step is in
  
  Values are starting, completed, or in_progress.
  
  info_log array[object] Required
  
  Human readable summaries of the step, including messages for each stage of the step
  
  The log message from a specified stage of an executed step in a plan.
  
  Hide info_log attributes Show info_log attributes object
  
  timestamp string(date-time) Required
  
  Timestamp marking on info log of step
  
  delta_in_millis integer(int64)
  
  Time in milliseconds since previous log message
  
  stage string Required
  
  Stage that info log message takes place in
  
  Values are starting, completed, or in_progress.
  
  message string Required
  
  Human readable log message
  
  details object Required
  
  A map with details for the log about what happened during the step execution. Keys and values for are always both strings, representing the name of the detail and its value, respectively.
  
  Hide details attribute Show details attribute object
  
  * string Additional properties
  
  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
  
  Information about a warning from a plan.
  
  Hide warnings attributes Show warnings attributes object
  
  code string Required
  
  A unique warning code
  
  message string Required
  
  A description of the warning
  
  step_id string
  
  The ID of the step which produced a warning, if any
  
  error object
  
  Information about an error during a plan attempt.
  
  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
  
  Information about the App Search Server plan.
  
  Hide history attributes Show history attributes object
  
  plan_attempt_id string
  
  A UUID for each plan attempt
  
  plan_attempt_name string
  
  A human readable name for each plan attempt, only populated when retrieving plan histories
  
  healthy boolean Required
  
  Either the plan ended successfully, or is not yet completed (and no errors have occurred)
  
  attempt_start_time string(date-time)
  
  When this plan attempt (ie to apply the plan to the App Search) started (ISO format in UTC)
  
  attempt_end_time string(date-time)
  
  If this plan completed or failed (ie is not pending), when the attempt ended (ISO format in UTC)
  
  plan_end_time string(date-time)
  
  If this plan is not current or pending, when the plan was no longer active (ISO format in UTC)
  
  plan object
  
  The plan for the App Search cluster.
  
  Additional properties are allowed.
  
  Hide plan attributes Show plan attributes object
  
  cluster_topology array[object]
  
  Defines the topology of the AppSearch nodes (eg number/capacity of nodes, and where they can be allocated)
  
  Hide cluster_topology attributes Show cluster_topology attributes object
  
  node_type object
  
  Defines the AppSearch node type
  
  Additional properties are allowed.
  
  Hide node_type attributes Show node_type attributes object
  
  appserver boolean Required
  
  Defines whether this instance should run as Application/API server
  
  worker boolean Required
  
  Defines whether this instance should run as background worker
  
  instance_configuration_id string
  
  Controls the allocation of this topology element as well as allowed sizes and node_types. It needs to match the id of an existing instance configuration.
  
  instance_configuration_version integer(int32)
  
  The version of the Instance Configuration Id. If it is unset, the meaning depends on read vs writes. For deployment reads, it is equivalent to version 0 (or the IC is unversioned); for deployment creates and deployment template use, it is equivalent to 'the latest version'; and for deployment updates, it is equivalent to 'retain the current version'.
  
  size object
  
  Measured by the amount of a resource. The final cluster size is calculated using multipliers from the topology instance configuration.
  
  Additional properties are allowed.
  
  Hide size attributes Show size attributes object
  
  value integer(int32) Required
  
  Amount of resource
  
  resource string Required
  
  Type of resource
  
  Values are memory or storage.
  
  zone_count integer(int32)
  
  number of zones in which nodes will be placed
  
  appsearch object
  
  Additional properties are allowed.
  
  Hide appsearch attributes Show appsearch attributes object
  
  version string
  
  The version of the AppSearch cluster (must be one of the ECE supported versions, and won't work unless it matches the Elasticsearch version. Leave blank to auto-detect version.)
  
  docker_image string
  
  A docker URI that allows overriding of the default docker image specified for this version
  
  system_settings object
  
  This structure defines a curated subset of the AppSearch settings. (This field together with 'user_settings_override*' and 'user_settings*' defines the total set of AppSearch settings)
  
  Additional properties are allowed.
  
  Hide system_settings attributes Show system_settings attributes object
  
  elasticsearch_url string
  
  Optionally override the URL to which to send data (for advanced users only, if unspecified the system selects an internal URL)
  
  elasticsearch_username string
  
  Optionally override the account within App Search - defaults to a system account that always exists (if specified, the password must also be specified). Note that this field is never returned from the API, it is write only.
  
  elasticsearch_password string
  
  Optionally override the account within App Search - defaults to a system account that always exists (if specified, the username must also be specified). Note that this field is never returned from the API, it is write only.
  
  secret_session_key string
  
  Optionally override the secret session key within App Search - defaults to the previously existing secretSession. Note that this field is never returned from the API, it is write only.
  
  user_settings_json object
  
  An arbitrary JSON object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters are on the allowlist and not on the denylist. (This field together with 'user_settings_override*' and 'system_settings' defines the total set of AppSearch settings)
  
  Additional properties are allowed.
  
  user_settings_yaml string
  
  An arbitrary YAML object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_json' is allowed), provided the parameters are on the allowlist and not on the denylist. (These field together with 'user_settings_override*' and 'system_settings' defines the total set of AppSearch settings)
  
  user_settings_override_json object
  
  An arbitrary JSON object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of AppSearch settings)
  
  Additional properties are allowed.
  
  user_settings_override_yaml string
  
  An arbitrary YAML object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_json' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of AppSearch settings)
  
  appsearch object Required
  
  Additional properties are allowed.
  
  Hide appsearch attributes Show appsearch attributes object
  
  version string
  
  The version of the AppSearch cluster (must be one of the ECE supported versions, and won't work unless it matches the Elasticsearch version. Leave blank to auto-detect version.)
  
  docker_image string
  
  A docker URI that allows overriding of the default docker image specified for this version
  
  system_settings object
  
  This structure defines a curated subset of the AppSearch settings. (This field together with 'user_settings_override*' and 'user_settings*' defines the total set of AppSearch settings)
  
  Additional properties are allowed.
  
  Hide system_settings attributes Show system_settings attributes object
  
  elasticsearch_url string
  
  Optionally override the URL to which to send data (for advanced users only, if unspecified the system selects an internal URL)
  
  elasticsearch_username string
  
  Optionally override the account within App Search - defaults to a system account that always exists (if specified, the password must also be specified). Note that this field is never returned from the API, it is write only.
  
  elasticsearch_password string
  
  Optionally override the account within App Search - defaults to a system account that always exists (if specified, the username must also be specified). Note that this field is never returned from the API, it is write only.
  
  secret_session_key string
  
  Optionally override the secret session key within App Search - defaults to the previously existing secretSession. Note that this field is never returned from the API, it is write only.
  
  user_settings_json object
  
  An arbitrary JSON object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters are on the allowlist and not on the denylist. (This field together with 'user_settings_override*' and 'system_settings' defines the total set of AppSearch settings)
  
  Additional properties are allowed.
  
  user_settings_yaml string
  
  An arbitrary YAML object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_json' is allowed), provided the parameters are on the allowlist and not on the denylist. (These field together with 'user_settings_override*' and 'system_settings' defines the total set of AppSearch settings)
  
  user_settings_override_json object
  
  An arbitrary JSON object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of AppSearch settings)
  
  Additional properties are allowed.
  
  user_settings_override_yaml string
  
  An arbitrary YAML object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_json' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of AppSearch settings)
  
  transient object
  
  Defines configuration parameters that control how the plan (ie consisting of the cluster topology and AppSearch settings) is applied
  
  Additional properties are allowed.
  
  Hide transient attributes Show transient attributes object
  
  strategy object
  
  The options for performing a plan change. Specify only one property each time. The default is grow_and_shrink.
  
  Additional properties are allowed.
  
  Hide strategy attributes Show strategy attributes object
  
  rolling object
  
  Performs inline, rolling configuration changes that mutate existing containers. TIP: This is the fastest way to update a plan, but can fail for complex plan changes, such as topology changes. Also, this is less safe for configuration changes that leave a cluster in a non running state. NOTE: When you perform a major version upgrade, and 'group_by' is set to 'pass:macros[all]';, rolling is required.
  
  Additional properties are allowed.
  
  Hide rolling attributes Show rolling attributes object
  
  group_by string
  
  Specifies the grouping attribute to use when rolling several instances. Instances that share the same value for the provided attribute key are rolled together as a unit. Examples that make sense to use are '__all__' (roll all instances as a single unit), 'logical_zone_name' (roll instances by zone), '__name__' (roll one instance at a time, the default if not specified). Note that '__all__' is required when performing a major version upgrade
  
  allow_inline_resize boolean
  
  Whether we allow changing the capacity of instances (default false). This is currently implemented by stopping, re-creating then starting the affected instance on its associated allocator when performing the changes. NOTES: This requires a round-trip through the allocation infrastructure of the active constructor, as it has to reserve the target capacity without over-committing
  
  skip_synced_flush boolean
  
  Whether to skip attempting to do a synced flush on the filesystem of the container (default: false), which is less safe but may be required if the container is unhealthy
  
  shard_init_wait_time integer(int64)
  
  The time, in seconds, to wait for shards that show no progress of initializing before rolling the next group (default: 10 minutes)
  
  grow_and_shrink object
  
  A strategy that creates instances with the new plan, migrates data from the old instances, then shuts down the old instances. GrowShrinkStrategyConfig is safer than 'rolling' and ensures single node availability during a plan change, but can be a lot slower on larger clusters.
  
  Additional properties are allowed.
  
  rolling_grow_and_shrink object
  
  A strategy that creates new Elasticsearch instances, Kibana instances, and APM Servers with the new plan, then migrates the node data to minimize the amount of spare capacity.
  
  Additional properties are allowed.
  
  autodetect object
  
  A strategy that lets constructor choose the most optimal way to execute the plan.
  
  Additional properties are allowed.
  
  plan_configuration object
  
  Additional properties are allowed.
  
  Hide plan_configuration attributes Show plan_configuration attributes object
  
  timeout integer(int64)
  
  The total timeout in seconds after which the plan is cancelled even if it is not complete. Defaults to 4x the max memory capacity per node (in MB)
  
  calm_wait_time integer(int64)
  
  This timeout determines how long to give a cluster after it responds to API calls before performing actual operations on it. It defaults to 5s
  
  move_instances array[object]
  
  The request that specifies the Elasticsearch or stateless (eg Kibana) instances to move to allocators as part of the upgrade plan. When used in conjunction with '__all__' (roll all instances as a single unit) strategy, these instances are not restarted, which can sometimes enable recovery plans when these instances are boot-looping.
  
  Hide move_instances attributes Show move_instances attributes object
  
  from string Required
  
  The instance id that is going to be moved
  
  to array[string]
  
  An optional list of allocator ids to which the instance should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)
  
  instance_down boolean
  
  Tells the infrastructure that the instance should be considered as permanently down when deciding how to migrate data to new nodes. If left blank then the system will automatically decide (currently: will treat the instances as up)
  
  move_allocators array[object]
  
  As part of the upgrade plan, identifies the move requests for the Kibana instances or APM Servers on the allocators.
  
  Hide move_allocators attributes Show move_allocators attributes object
  
  from string Required
  
  The allocator id off which all instances in the cluster should be moved
  
  to array[string]
  
  An optional list of allocator ids to which the instance(s) should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)
  
  allocator_down boolean
  
  Tells the infrastructure that all instances on the allocator should be considered as permanently down when deciding how to migrate data to new nodes. If left blank then the system will auto-decide (currently: will treat the allocator as up)
  
  reallocate_instances boolean
  
  If true (default: false) does not allow re-using any existing instances currently in the cluster, ie even unchanged instances will be re-created
  
  preferred_allocators array[string]
  
  List of allocators on which instances are placed if possible (if not possible/not specified then any available allocator with space is used)
  
  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
  
  Information about a step in a plan.
  
  Hide plan_attempt_log attributes Show plan_attempt_log attributes object
  
  step_id string Required
  
  ID of current step
  
  started string(date-time) Required
  
  When the step started (ISO format in UTC)
  
  completed string(date-time)
  
  When the step completed (ISO format in UTC)
  
  duration_in_millis integer(int64)
  
  The duration of the step in MS
  
  status string Required
  
  The status of the step (success, warning, error - warning means something didn't go as expected but it was not serious enough to abort the plan)
  
  Values are success, warning, error, or pending.
  
  stage string Required
  
  Current stage that the step is in
  
  Values are starting, completed, or in_progress.
  
  info_log array[object] Required
  
  Human readable summaries of the step, including messages for each stage of the step
  
  The log message from a specified stage of an executed step in a plan.
  
  Hide info_log attributes Show info_log attributes object
  
  timestamp string(date-time) Required
  
  Timestamp marking on info log of step
  
  delta_in_millis integer(int64)
  
  Time in milliseconds since previous log message
  
  stage string Required
  
  Stage that info log message takes place in
  
  Values are starting, completed, or in_progress.
  
  message string Required
  
  Human readable log message
  
  details object Required
  
  A map with details for the log about what happened during the step execution. Keys and values for are always both strings, representing the name of the detail and its value, respectively.
  
  Hide details attribute Show details attribute object
  
  * string Additional properties
  
  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
  
  Information about a warning from a plan.
  
  Hide warnings attributes Show warnings attributes object
  
  code string Required
  
  A unique warning code
  
  message string Required
  
  A description of the warning
  
  step_id string
  
  The ID of the step which produced a warning, if any
  
  error object
  
  Information about an error during a plan attempt.
  
  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
  
  A URL to access the service of a resource
  
  Hide services_urls attributes Show services_urls attributes object
  
  service string Required
  
  Name of the service
  
  url string Required
  
  The full URL to access the service
  
  topology object Required
  
  The topology for Elasticsearch clusters, multiple Kibana instances, or multiple APM Servers. The ClusterTopologyInfo also includes the instances and containers, and where they are located.
  
  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
  
  Information about each Kibana instance and APM Server in the Elasticsearch cluster.
  
  Hide instances attributes Show instances attributes object
  
  instance_name string Required
  
  The name of the instance in Elastic Cloud
  
  instance_configuration object
  
  Information about a configuration that creates a Kibana instance or APM Server.
  
  Additional properties are allowed.
  
  Hide instance_configuration attributes Show instance_configuration attributes object
  
  id string Required
  
  The id of the configuration used to create the instance
  
  name string Required
  
  The name of the configuration used to create the instance
  
  config_version integer(int32)
  
  If the IC is configuration controlled, this field is the version either being read back (reads return the latest IC unless specified by the 'config_version' URL param), or the version to update. Cannot be used in creates. For unversioned IC reads it is left empty.
  
  resource string Required
  
  The resource type of the instance configuration
  
  Values are memory or storage.
  
  service_version string
  
  The version of the service that the instance is running (eg Elasticsearch or Kibana), if available
  
  healthy boolean Required
  
  Whether the instance is healthy (ie started and running)
  
  container_started boolean Required
  
  Whether the container has started (does not tell you anything about the service -ie Elasticsearch- running inside the container)
  
  service_running boolean Required
  
  Whether the service launched inside the container -ie Elasticsearch- is actually running
  
  maintenance_mode boolean Required
  
  Whether the service is is maintenance mode (meaning that the proxy is not routing external traffic to it)
  
  zone string
  
  The zone in which this instance is being allocated
  
  allocator_id string
  
  The id of the allocator on which this instance is running (if the container is started or starting)
  
  memory object
  
  Information about the specific instances memory capacity and its usage
  
  Additional properties are allowed.
  
  Hide memory attributes Show memory attributes object
  
  instance_capacity integer(int32) Required
  
  The memory capacity in MB of the instance
  
  instance_capacity_planned integer(int32)
  
  The planned memory capacity in MB of the instance (only shown when an override is present)
  
  memory_pressure integer(int32)
  
  The % memory pressure of Elasticsearch JVM heap space if available (60-75% consider increasing capacity, >75% can incur significant performance and stability issues)
  
  native_memory_pressure integer(int32)
  
  The % memory pressure of the instance Docker container (if available)
  
  disk object
  
  Information about the use and storage capacity of a Kibana instance or APM Server.
  
  Additional properties are allowed.
  
  Hide disk attributes Show disk attributes object
  
  disk_space_available integer(int64)
  
  If known, the amount of total disk space available to the container in MB
  
  disk_space_used integer(int64) Required
  
  The amount of disk space being used by the service in MB
  
  storage_multiplier number(double) Required
  
  The storage multiplier originally defined to calculate disk space.
  
  service_roles array[string]
  
  List of roles assigned to the service running in the instance. Currently only populated for Elasticsearch, with possible values: master,data,ingest,ml
  
  node_roles array[string]
  
  A list of the node roles assigned to the service running in the instance. Currently populated only for Elasticsearch.
  
  Values are master, ingest, ml, data_hot, data_content, data_warm, data_cold, data_frozen, remote_cluster_client, transform, or voting_only.
  
  instance_overrides object
  
  Instance overrides
  
  Additional properties are allowed.
  
  Hide instance_overrides attributes Show instance_overrides attributes object
  
  capacity integer(int32)
  
  Sets the memory capacity for the instances container. Requires a restart to take effect.
  
  storage_multiplier number(double)
  
  Overrides the disk quota multiplier for the instance
  
  external_links array[object] Required
  
  External resources related to the App Search
  
  Hide external_links attributes Show external_links attributes object
  
  id string Required
  
  Identifier of the external link
  
  label string Required
  
  Human-readable description of the external link
  
  uri string
  
  hyperlink to an external resource
  
  links object
  
  A map of application-specific operations (which map to 'operationId's in the Swagger API) to metadata about that operation
  
  Hide links attribute Show links attribute object
  
  * object Additional properties
  
  Additional properties are allowed.
  
  Hide * attribute Show * attribute object
  
  need_elevated_permissions boolean
  
  Whether the operation requires elevated permissions (when the field is present, elevated permissions are required).
  
  settings object
  
  The settings for building this AppSearch cluster
  
  Additional properties are allowed.
  
  Hide settings attribute Show settings attribute object
  
  metadata object
  
  The top-level configuration settings for the Elasticsearch cluster.
  
  Additional properties are allowed.
  
  Hide metadata 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 App 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}/appsearch/{ref_id}

curl \
 --request GET https://{{hostname}}/api/v1/deployments/{deployment_id}/appsearch/{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": "2025-05-04T09:42:00Z",
        "attempt_end_time": "2025-05-04T09:42:00Z",
        "plan_end_time": "2025-05-04T09:42:00Z",
        "plan": {
          "cluster_topology": [
            {
              "node_type": {
                "appserver": true,
                "worker": true
              },
              "instance_configuration_id": "string",
              "instance_configuration_version": 42,
              "size": {
                "value": 42,
                "resource": "memory"
              },
              "zone_count": 42,
              "appsearch": {
                "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"
              }
            }
          ],
          "appsearch": {
            "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": "2025-05-04T09:42:00Z",
            "completed": "2025-05-04T09:42:00Z",
            "duration_in_millis": 42,
            "status": "success",
            "stage": "starting",
            "info_log": [
              {
                "timestamp": "2025-05-04T09:42:00Z",
                "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": "2025-05-04T09:42:00Z",
          "user_id": "string",
          "admin_id": "string",
          "remote_addresses": [
            "string"
          ]
        },
        "warnings": [
          {
            "code": "string",
            "message": "string",
            "step_id": "string"
          }
        ],
        "error": {
          "timestamp": "2025-05-04T09:42:00Z",
          "message": "string",
          "details": {
            "additionalProperty1": "string",
            "additionalProperty2": "string"
          },
          "failure_type": "string"
        }
      },
      "pending": {
        "plan_attempt_id": "string",
        "plan_attempt_name": "string",
        "healthy": true,
        "attempt_start_time": "2025-05-04T09:42:00Z",
        "attempt_end_time": "2025-05-04T09:42:00Z",
        "plan_end_time": "2025-05-04T09:42:00Z",
        "plan": {
          "cluster_topology": [
            {
              "node_type": {
                "appserver": true,
                "worker": true
              },
              "instance_configuration_id": "string",
              "instance_configuration_version": 42,
              "size": {
                "value": 42,
                "resource": "memory"
              },
              "zone_count": 42,
              "appsearch": {
                "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"
              }
            }
          ],
          "appsearch": {
            "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": "2025-05-04T09:42:00Z",
            "completed": "2025-05-04T09:42:00Z",
            "duration_in_millis": 42,
            "status": "success",
            "stage": "starting",
            "info_log": [
              {
                "timestamp": "2025-05-04T09:42:00Z",
                "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": "2025-05-04T09:42:00Z",
          "user_id": "string",
          "admin_id": "string",
          "remote_addresses": [
            "string"
          ]
        },
        "warnings": [
          {
            "code": "string",
            "message": "string",
            "step_id": "string"
          }
        ],
        "error": {
          "timestamp": "2025-05-04T09:42:00Z",
          "message": "string",
          "details": {
            "additionalProperty1": "string",
            "additionalProperty2": "string"
          },
          "failure_type": "string"
        }
      },
      "history": [
        {
          "plan_attempt_id": "string",
          "plan_attempt_name": "string",
          "healthy": true,
          "attempt_start_time": "2025-05-04T09:42:00Z",
          "attempt_end_time": "2025-05-04T09:42:00Z",
          "plan_end_time": "2025-05-04T09:42:00Z",
          "plan": {
            "cluster_topology": [
              {
                "node_type": {
                  "appserver": true,
                  "worker": true
                },
                "instance_configuration_id": "string",
                "instance_configuration_version": 42,
                "size": {
                  "value": 42,
                  "resource": "memory"
                },
                "zone_count": 42,
                "appsearch": {
                  "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"
                }
              }
            ],
            "appsearch": {
              "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": "2025-05-04T09:42:00Z",
              "completed": "2025-05-04T09:42:00Z",
              "duration_in_millis": 42,
              "status": "success",
              "stage": "starting",
              "info_log": [
                {
                  "timestamp": "2025-05-04T09:42:00Z",
                  "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": "2025-05-04T09:42:00Z",
            "user_id": "string",
            "admin_id": "string",
            "remote_addresses": [
              "string"
            ]
          },
          "warnings": [
            {
              "code": "string",
              "message": "string",
              "step_id": "string"
            }
          ],
          "error": {
            "timestamp": "2025-05-04T09:42:00Z",
            "message": "string",
            "details": {
              "additionalProperty1": "string",
              "additionalProperty2": "string"
            },
            "failure_type": "string"
          }
        }
      ]
    },
    "metadata": {
      "version": 42,
      "last_modified": "2025-05-04T09:42:00Z",
      "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"
      ]
    }
  ]
}

Start instances

POST /deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/{instance_ids}/_start

Starts instances belonging to a Deployment Resource.

Path parameters

deployment_id string Required

Identifier for the Deployment.
resource_kind string Required

The kind of resource (one of elasticsearch, kibana, apm, or integrations_server).
ref_id string Required

User-specified RefId for the Resource (or '_main' if there is only one).
instance_ids array[string] Required

A comma-separated list of instance identifiers.

Query parameters

ignore_missing boolean

If true and the instance does not exist then quietly proceed to the next instance, otherwise treated as an error

Default value is false.

Responses

202

The start command was issued successfully.
Hide response attribute Show response attribute object
- warnings array[object]
  
  List of warnings generated from validating command
  
  Hide warnings attributes Show warnings attributes object
  
  code string Required
  
  A structured code representing the error type that occurred
  
  message string
  
  A human readable message describing the warning that occurred
403

The start maintenance mode command was prohibited for the given Resource. (code: deployments.instance_update_prohibited_error)
Hide headers attribute Show headers attribute
- x-cloud-error-codes string
  
  The error codes associated with the response
  
  Value is deployments.instance_update_prohibited_error.
Hide response attribute Show response attribute object
- errors array[object] Required
  
  A list of errors that occurred in the failing request
  
  Hide errors attributes Show errors attributes object
  
  code string Required
  
  A structured code representing the error type that occurred
  
  message string Required
  
  A human readable message describing the error that occurred
  
  fields array[string]
  
  If the error can be tied to a specific field or fields in the user request, this lists those fields
404
- The Deployment specified by {deployment_id} cannot be found. (code: deployments.deployment_not_found)
- The Resource specified by {ref_id} cannot be found. (code: deployments.deployment_resource_not_found)
- One or more instances of the given resource type are missing. (code: deployments.instances_missing_on_update_error)
Hide headers attribute Show headers attribute
- x-cloud-error-codes string
  
  The error codes associated with the response
  
  Values are deployments.deployment_not_found, deployments.deployment_resource_not_found, or deployments.instances_missing_on_update_error.
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

A Resource that was previously stored no longer exists. (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

POST /deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/{instance_ids}/_start

curl \
 --request POST https://{{hostname}}/api/v1/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/{instance_ids}/_start

Response examples (202)

{
  "warnings": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Response examples (403)

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

# Payload
{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "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"
      ]
    }
  ]
}

Proxy HTTP PUT request

PUT /deployments/{deployment_id}/{resource_kind}/{ref_id}/proxy/{proxy_path}

Proxies the HTTP PUT request to the deployment resource. You must specify the X-Management-Request HTTP header. NOTE: Use this endpoint for management purposes. It does not provide high performance.

Headers

X-Management-Request string Required

You must specify the X-Management-Request HTTP header with value true. NOTE: Use this endpoint for management purposes. It does not provide high performance.

Path parameters

deployment_id string Required

Identifier for the Deployment
resource_kind string Required

The kind of resource

Values are elasticsearch, kibana, or enterprise_search.
ref_id string Required

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

The URL part to proxy to the deployment resource. Example: _cat/indices, /api/spaces/space or /api/ent/v1/internal/health

Body

The JSON payload to proxy to the deployment resource.

string

Responses

200

The request has been processed successfully through the proxy.
Hide response attribute Show response attribute object
- value string Required
404
- The Deployment specified by {deployment_id} cannot be found. (code: deployments.deployment_not_found)
- The Resource specified by {ref_id} cannot be found. (code: deployments.deployment_resource_not_found)
- The Resource specified by {ref_id} cannot be found. (code: clusters.cluster_not_found)
Hide headers attribute Show headers attribute
- x-cloud-error-codes string
  
  The error codes associated with the response
  
  Values are deployments.deployment_not_found, deployments.deployment_resource_not_found, or clusters.cluster_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

PUT /deployments/{deployment_id}/{resource_kind}/{ref_id}/proxy/{proxy_path}

curl \
 --request PUT https://{{hostname}}/api/v1/deployments/{deployment_id}/{resource_kind}/{ref_id}/proxy/{proxy_path} \
 --header "X-Management-Request: string" \
 --data '"string"'

Request examples

# Headers
X-Management-Request: string

# Payload
string

Response examples (200)

{
  "value": "string"
}

Response examples (404)

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

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

Delete Stateless Resource from Deployment

DELETE /deployments/{deployment_id}/{stateless_resource_kind}/{ref_id}

Delete Stateless Resource belonging to a given Deployment. Deployment must be shutdown already.

Path parameters

deployment_id string Required

Identifier for the Deployment
stateless_resource_kind string Required

The kind of stateless resource

Values are kibana, apm, appsearch, enterprise_search, or integrations_server.
ref_id string Required

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

Responses

200

Standard Deployment Resource Crud Response
Hide response attributes Show response attributes object
- id string Required
  
  The id of the deployment
- kind string Required
  
  The kind of the stateless resource
- ref_id string Required
  
  The reference id of the resource
400

Resource has still instances. (code: deployments.resource_has_instances)
Hide headers attribute Show headers attribute
- x-cloud-error-codes string
  
  The error codes associated with the response
  
  Value is deployments.resource_has_instances.
Hide response attribute Show response attribute object
- errors array[object] Required
  
  A list of errors that occurred in the failing request
  
  Hide errors attributes Show errors attributes object
  
  code string Required
  
  A structured code representing the error type that occurred
  
  message string Required
  
  A human readable message describing the error that occurred
  
  fields array[string]
  
  If the error can be tied to a specific field or fields in the user request, this lists those fields
404
- The Deployment specified by {deployment_id} cannot be found. (code: deployments.deployment_not_found)
- The Resource specified by {ref_id} cannot be found. (code: deployments.deployment_resource_not_found)
Hide headers attribute Show headers attribute
- x-cloud-error-codes string
  
  The error codes associated with the response
  
  Values are deployments.deployment_not_found or deployments.deployment_resource_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

DELETE /deployments/{deployment_id}/{stateless_resource_kind}/{ref_id}

curl \
 --request DELETE https://{{hostname}}/api/v1/deployments/{deployment_id}/{stateless_resource_kind}/{ref_id}

Response examples (200)

{
  "id": "string",
  "kind": "string",
  "ref_id": "string"
}

Response examples (400)

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

# Payload
{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "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"
      ]
    }
  ]
}

Shutdown Deployment Stateless Resource

POST /deployments/{deployment_id}/{stateless_resource_kind}/{ref_id}/_shutdown

Shut down Stateless Resource belonging to a given Deployment. Kibana cannot be shut down on Elasticsearch Service as it is required for Elasticsearch administrative functions, such as Snapshot Lifecycle Management and version upgrades.

Path parameters

deployment_id string Required

Identifier for the Deployment.
stateless_resource_kind string Required

The kind of stateless resource

Values are kibana, apm, appsearch, enterprise_search, or integrations_server.
ref_id string Required

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

Query parameters

hide boolean

Hide cluster on shutdown. Hidden clusters are not listed by default. Only applicable for Platform administrators.
skip_snapshot boolean

If true, will skip taking a snapshot of the cluster before shutting the cluster down (if even possible)

Default value is false.

Responses

200

Standard response
Hide response attribute Show response attribute object
- warnings array[object]
  
  List of warnings generated from validating command
  
  Hide warnings attributes Show warnings attributes object
  
  code string Required
  
  A structured code representing the error type that occurred
  
  message string
  
  A human readable message describing the warning that occurred
400

Parameter is restricted and can only be set by a Platform administrator. (code: deployments.restricted_parameter)
Hide headers attribute Show headers attribute
- x-cloud-error-codes string
  
  The error codes associated with the response
  
  Value is deployments.restricted_parameter.
Hide response attribute Show response attribute object
- errors array[object] Required
  
  A list of errors that occurred in the failing request
  
  Hide errors attributes Show errors attributes object
  
  code string Required
  
  A structured code representing the error type that occurred
  
  message string Required
  
  A human readable message describing the error that occurred
  
  fields array[string]
  
  If the error can be tied to a specific field or fields in the user request, this lists those fields
404
- The Deployment specified by {deployment_id} cannot be found. (code: deployments.deployment_not_found)
- The Resource specified by {ref_id} cannot be found. (code: deployments.deployment_resource_not_found)
Hide headers attribute Show headers attribute
- x-cloud-error-codes string
  
  The error codes associated with the response
  
  Values are deployments.deployment_not_found or deployments.deployment_resource_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

POST /deployments/{deployment_id}/{stateless_resource_kind}/{ref_id}/_shutdown

curl \
 --request POST https://{{hostname}}/api/v1/deployments/{deployment_id}/{stateless_resource_kind}/{ref_id}/_shutdown

Response examples (200)

{
  "warnings": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Response examples (400)

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

# Payload
{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "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"
      ]
    }
  ]
}

Create a ruleset

POST /deployments/traffic-filter/rulesets

Creates a ruleset that consists of a set of rules.

Body Required

The specification for traffic filter ruleset.

name string Required

Name of the ruleset
description string

Description of the ruleset
type string Required

Type of the ruleset
include_by_default boolean Required

Should the ruleset be automatically included in the new deployments
region string Required

The ruleset can be attached only to deployments in the specific region
rules array[object] Required

List of rules

The container for a traffic filter rule.
Hide rules attributes Show rules attributes object
- id string
  
  The rule ID
- remote_cluster_org_id string
  
  The remote cluster organization ID
- remote_cluster_id string
  
  The remote cluster ID
- description string
  
  Description of the rule
- source string
  
  Allowed traffic filter source: IP address, CIDR mask, or VPC endpoint ID
- azure_endpoint_name string
  
  Name of the Azure Private Endpoint to allow connections from
- azure_endpoint_guid string
  
  Resource GUID of the Azure Private Endpoint to allow connections from
- egress_rule object
  
  An egress traffic filter rule
  
  Additional properties are allowed.
  Hide egress_rule attributes Show egress_rule attributes object
  
  target string Required
  
  Allowed traffic filter egress target: IP address or CIDR mask
  
  ports array[integer(int32)]
  
  A list of target ports for an egress rule
  
  protocol string Required
  
  The target protocol for an egress rule
  
  Values are all, tcp, or udp.

Responses

201

The ruleset definition is valid and the creation has started.
Hide response attribute Show response attribute object
- id string Required
  
  The new ruleset ID
500

Error creating the traffic filter ruleset. (code: traffic_filter.request_execution_failed)
Hide headers attribute Show headers attribute
- x-cloud-error-codes string
  
  The error codes associated with the response
  
  Value is traffic_filter.request_execution_failed.
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

POST /deployments/traffic-filter/rulesets

curl \
 --request POST https://{{hostname}}/api/v1/deployments/traffic-filter/rulesets \
 --data '{"name":"string","description":"string","type":"string","include_by_default":true,"region":"string","rules":[{"id":"string","remote_cluster_org_id":"string","remote_cluster_id":"string","description":"string","source":"string","azure_endpoint_name":"string","azure_endpoint_guid":"string","egress_rule":{"target":"string","ports":[42],"protocol":"all"}}]}'

Request examples

{
  "name": "string",
  "description": "string",
  "type": "string",
  "include_by_default": true,
  "region": "string",
  "rules": [
    {
      "id": "string",
      "remote_cluster_org_id": "string",
      "remote_cluster_id": "string",
      "description": "string",
      "source": "string",
      "azure_endpoint_name": "string",
      "azure_endpoint_guid": "string",
      "egress_rule": {
        "target": "string",
        "ports": [
          42
        ],
        "protocol": "all"
      }
    }
  ]
}

Response examples (201)

{
  "id": "string"
}

Response examples (500)

# Headers
x-cloud-error-codes: traffic_filter.request_execution_failed

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

Delete ruleset association

DELETE /deployments/traffic-filter/rulesets/{ruleset_id}/associations/{association_type}/{associated_entity_id}

Deletes the traffic rules in the ruleset from the deployment.

Path parameters

ruleset_id string Required

The mandatory ruleset ID.
association_type string Required

Association type
associated_entity_id string Required

Associated entity ID

Responses

200

Delete association request was valid and the association has been deleted

Additional properties are allowed.
404

The traffic filter ruleset association cannot be found. (code: traffic_filter.not_found)
Hide headers attribute Show headers attribute
- x-cloud-error-codes string
  
  The error codes associated with the response
  
  Value is traffic_filter.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

Deletion failed. (code: traffic_filter.request_execution_failed)
Hide headers attribute Show headers attribute
- x-cloud-error-codes string
  
  The error codes associated with the response
  
  Value is traffic_filter.request_execution_failed.
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

DELETE /deployments/traffic-filter/rulesets/{ruleset_id}/associations/{association_type}/{associated_entity_id}

curl \
 --request DELETE https://{{hostname}}/api/v1/deployments/traffic-filter/rulesets/{ruleset_id}/associations/{association_type}/{associated_entity_id}

Response examples (200)

{}

Response examples (404)

# Headers
x-cloud-error-codes: traffic_filter.not_found

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

Response examples (500)

# Headers
x-cloud-error-codes: traffic_filter.request_execution_failed

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

List extra certificates

GET /platform/configuration/security/extra_certs

List all of the extra certificates.

Responses

200

The collection of all available extra certificates public chains
Hide response attribute Show response attribute object
- certs object Required
  
  The map of extra certificate ids to their public certificate chains
  
  Hide certs attribute Show certs attribute object
  
  * object Additional properties
  
  The public portion of the certificate chain that contains the PEM encoded server certificate, intermediate certificates, and the CA certificate. NOTE: The private key, normally included in certificate chains, is omitted.
  
  Additional properties are allowed.
  
  Hide * attribute Show * attribute object
  
  chain array[string] Required
  
  The list of PEM encoded X509 certificates that make up the certificate chain

GET /platform/configuration/security/extra_certs

curl \
 --request GET https://{{hostname}}/api/v1/platform/configuration/security/extra_certs

Response examples (200)

{
  "certs": {
    "additionalProperty1": {
      "chain": [
        "string"
      ]
    },
    "additionalProperty2": {
      "chain": [
        "string"
      ]
    }
  }
}

Read extra certificate

GET /platform/configuration/security/extra_certs/{cert_id}

Read an extra certificate.

Path parameters

cert_id string Required

The extra certificate Id. For example, star_my_domain_com.

Responses

200

Extra certificate public chain if exists
Hide response attribute Show response attribute object
- chain array[string] Required
  
  The list of PEM encoded X509 certificates that make up the certificate chain
404

The extra certificate cannot be found. (code: cert.not_found)
Hide headers attribute Show headers attribute
- x-cloud-error-codes string
  
  The error codes associated with the response
  
  Value is cert.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

GET /platform/configuration/security/extra_certs/{cert_id}

curl \
 --request GET https://{{hostname}}/api/v1/platform/configuration/security/extra_certs/{cert_id}

Response examples (200)

{
  "chain": [
    "string"
  ]
}

Response examples (404)

# Headers
x-cloud-error-codes: cert.not_found

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

Get instance configurations

GET /platform/configuration/instances

Get instance configurations.

Query parameters

show_deleted boolean

If true, instance configurations marked for deletions are also returned. Otherwise, only instance configurations not marked for deletion are returned
show_max_zones boolean

If true, will populate the max_zones field of the instance configurations.

Default value is false.
include_versions boolean

If true, will return all existing versions of each instance configuration.

Default value is false.

Responses

200

A InstanceConfiguration
Hide response attributes Show response attributes object
- id string
  
  Unique identifier for the instance configuration
- name string Required
  
  Display name for the instance configuration.
- config_version integer(int32)
  
  If the IC is configuration controlled, this field is the version either being read back (reads return the latest IC unless specified by the 'config_version' URL param), or the version to update. Cannot be used in creates. For unversioned IC reads it is left empty.
- description string
  
  Optional description for the instance configuration
- instance_type string
  
  The type of instance. For instance configurations where the type is specified in the 'id', the default value of 'instance_type' will be automatically inferred.
  
  Values are elasticsearch, kibana, apm, integrations_server, appsearch, or enterprise_search.
- node_types array[string]
  
  Node types (master, data) for the instance. For instance configurations where the type (and tier) is specified in the 'id', the default value of 'node_types' will be automatically inferred.
- discrete_sizes object Required
  
  Numerics representing possible instance sizes that the instance configuration supports.
  
  Additional properties are allowed.
  
  Hide discrete_sizes attributes Show discrete_sizes attributes object
  
  sizes array[integer(int32)] Required
  
  List of supported sizes
  
  default_size integer(int32)
  
  The default size
  
  resource string
  
  The unit that each size represents. If not specified, it will default to 'memory'.
  
  Values are memory or storage.
- allocator_filter object
  
  The container for all of the allowed Elasticsearch queries. Specify only one property each time.
  
  Additional properties are allowed.
  
  Hide allocator_filter attributes Show allocator_filter attributes object
  
  match object
  
  Hide match attribute Show match attribute object
  
  * object Additional properties
  
  Consumes and analyzes text, numbers, and dates, then constructs a query.
  
  Additional properties are allowed.
  
  Hide * attributes Show * attributes object
  
  query string Required
  
  The text/numeric/date to query for.
  
  operator string
  
  The operator flag can be set to or or and to control the boolean clauses (defaults to or).
  
  minimum_should_match integer(int32)
  
  The minimum number of optional should clauses to match.
  
  analyzer string
  
  The analyzer that will be used to perform the analysis process on the text. Defaults to the analyzer that was used to index the field.
  
  match_all object
  
  A query that matches all documents.
  
  Additional properties are allowed.
  
  match_none object
  
  A query that doesn't match any documents.
  
  Additional properties are allowed.
  
  term object
  
  Hide term attribute Show term attribute object
  
  * object Additional properties
  
  A query for documents that contain the specified term in the inverted index.
  
  Additional properties are allowed.
  
  Hide * attribute Show * attribute object
  
  value string Required
  
  The exact value to query for.
  
  bool object
  
  A query for documents that match boolean combinations of other queries.
  
  Additional properties are allowed.
  
  Hide bool attributes Show bool attributes object
  
  must array[object]
  
  The container for all of the allowed Elasticsearch queries. Specify only one property each time.
  
  The container for all of the allowed Elasticsearch queries. Specify only one property each time.
  
  Additional properties are allowed.
  
  should array[object]
  
  The container for all of the allowed Elasticsearch queries. Specify only one property each time.
  
  The container for all of the allowed Elasticsearch queries. Specify only one property each time.
  
  Additional properties are allowed.
  
  must_not array[object]
  
  The container for all of the allowed Elasticsearch queries. Specify only one property each time.
  
  The container for all of the allowed Elasticsearch queries. Specify only one property each time.
  
  Additional properties are allowed.
  
  filter array[object]
  
  The container for all of the allowed Elasticsearch queries. Specify only one property each time.
  
  The container for all of the allowed Elasticsearch queries. Specify only one property each time.
  
  Additional properties are allowed.
  
  minimum_should_match integer(int32)
  
  The minimum number of optional should clauses to match.
  
  query_string object
  
  A query that uses the strict query string syntax for parsing. Will return an error for invalid syntax.
  
  Additional properties are allowed.
  
  Hide query_string attributes Show query_string attributes object
  
  query string Required
  
  The actual query to be parsed.
  
  default_field string
  
  The default field for query terms if no prefix field is specified.
  
  analyzer string
  
  The analyzer used to analyze each term of the query when creating composite queries.
  
  default_operator string
  
  The default operator used if no explicit operator is specified.
  
  allow_leading_wildcard boolean
  
  When set, * or ? are allowed as the first character. Defaults to false.
  
  nested object
  
  A query that matches nested objects.
  
  Additional properties are allowed.
  
  Hide nested attributes Show nested attributes object
  
  query object Required
  
  The container for all of the allowed Elasticsearch queries. Specify only one property each time.
  
  Additional properties are allowed.
  
  path string Required
  
  The path to the nested object.
  
  score_mode string
  
  Allows to specify how inner children matching affects score of the parent. Refer to the Elasticsearch documentation for details.
  
  Values are avg, sum, min, max, or none.
  
  prefix object
  
  Hide prefix attribute Show prefix attribute object
  
  * object Additional properties
  
  The query that matches documents with fields that contain terms with a specified, not analyzed, prefix.
  
  Additional properties are allowed.
  
  Hide * attributes Show * attributes object
  
  value string Required
  
  The prefix to search for.
  
  boost number(float)
  
  An optional boost value to apply to the query.
  
  exists object
  
  Matches documents that have at least one non-null value in the original field.
  
  Additional properties are allowed.
  
  Hide exists attribute Show exists attribute object
  
  field string Required
  
  The field to check for non-null values in.
  
  range object
  
  Hide range attribute Show range attribute object
  
  * object Additional properties
  
  The query that matches documents with fields that contain terms within a specified range.
  
  Additional properties are allowed.
  
  Hide * attributes Show * attributes object
  
  gt object
  
  Greater-than
  
  Additional properties are allowed.
  
  gte object
  
  Greater-than or equal to
  
  Additional properties are allowed.
  
  lt object
  
  Less-than
  
  Additional properties are allowed.
  
  lte object
  
  Less-than or equal to.
  
  Additional properties are allowed.
  
  boost number(float)
  
  An optional boost value to apply to the query.
  
  format string
  
  Formatted dates will be parsed using the format specified on the date field by default, but it can be overridden by passing the format parameter.
  
  time_zone string
  
  Dates can be converted from another timezone to UTC either by specifying the time zone in the date value itself (if the format accepts it), or it can be specified as the time_zone parameter.
  
  simple_query_string object
  
  A query that uses simple query string syntax. Will ignore invalid syntax.
  
  Additional properties are allowed.
  
  Hide simple_query_string attributes Show simple_query_string attributes object
  
  query string Required
  
  The query expressed in simple query string syntax.
  
  fields array[string]
  
  Array of fields to search
  
  default_operator string
  
  The boolean operator used to combine the terms of the query. Valid values are OR (default) and AND.
  
  analyze_wildcard boolean
  
  If true, the query attempts to analyze wildcard terms. Defaults to false.
  
  analyzer string
  
  The name of the analyzer to use to convert the query text into tokens.
  
  auto_generate_synonyms_phrase_query boolean
  
  If true, the parse creates a match_phrase uery for each multi-position token. Defaults to true.
  
  flags string
  
  List of enabled operators for the simple query string syntax. Defaults to ALL.
  
  fuzzy_max_expansions integer(int32)
  
  Maximum number of terms to which the query expands for fuzzy matching. Defaults to 50.
  
  fuzzy_prefix_length integer(int32)
  
  Number of beginning characters left unchanged for fuzzy matching. Defaults to 0.
  
  fuzzy_transpositions boolean
  
  If true, edits for fuzzy matching include transpositions of two adjacent characters. Defaults to false.
  
  lenient boolean
  
  If true, format-based errors, such as providing a text value for a numeric field are ignored. Defaults to false.
  
  minimum_should_match string
  
  Minimum number of clauses that must match for a document to be returned.
  
  quote_field_suffix string
  
  Suffix appended to quoted text in the query string.
- storage_multiplier number(double)
  
  Settings for the instance storage multiplier
- deleted_on string(date-time)
  
  Date/time that this instance configuration was marked for deletion
- system_owned boolean
  
  Indicates if a instance configuration is system owned (restricts the set of operations that can be performed on it)
- metadata object
  
  Optional arbitrary metadata to associate with this template.
  
  Additional properties are allowed.
- cpu_multiplier number(double)
  
  Settings for the instance CPU multiplier
- allowed_zones array[string]
  
  The zones this instance configuration may exist in. Leaving out this parameter or specifying an empty list implies all zones are allowed. Normally not needed, but can be useful for exceptional infrastructure constraints.
- max_zones integer(int32)
  
  The maximum number of availability zones in which this instance configuration has allocators. This field will be missing unless explicitly requested with the show_max_zones parameter.

GET /platform/configuration/instances

curl \
 --request GET https://{{hostname}}/api/v1/platform/configuration/instances

Response examples (200)

[
  {
    "id": "string",
    "name": "string",
    "config_version": 42,
    "description": "string",
    "instance_type": "elasticsearch",
    "node_types": [
      "string"
    ],
    "discrete_sizes": {
      "sizes": [
        42
      ],
      "default_size": 42,
      "resource": "memory"
    },
    "allocator_filter": {
      "match": {
        "additionalProperty1": {
          "query": "string",
          "operator": "string",
          "minimum_should_match": 42,
          "analyzer": "string"
        },
        "additionalProperty2": {
          "query": "string",
          "operator": "string",
          "minimum_should_match": 42,
          "analyzer": "string"
        }
      },
      "match_all": {},
      "match_none": {},
      "term": {
        "additionalProperty1": {
          "value": "string"
        },
        "additionalProperty2": {
          "value": "string"
        }
      },
      "bool": {
        "must": [
          {}
        ],
        "should": [
          {}
        ],
        "must_not": [
          {}
        ],
        "filter": [
          {}
        ],
        "minimum_should_match": 42
      },
      "query_string": {
        "query": "string",
        "default_field": "string",
        "analyzer": "string",
        "default_operator": "string",
        "allow_leading_wildcard": true
      },
      "nested": {
        "query": {},
        "path": "string",
        "score_mode": "avg"
      },
      "prefix": {
        "additionalProperty1": {
          "value": "string",
          "boost": 42.0
        },
        "additionalProperty2": {
          "value": "string",
          "boost": 42.0
        }
      },
      "exists": {
        "field": "string"
      },
      "range": {
        "additionalProperty1": {
          "gt": {},
          "gte": {},
          "lt": {},
          "lte": {},
          "boost": 42.0,
          "format": "string",
          "time_zone": "string"
        },
        "additionalProperty2": {
          "gt": {},
          "gte": {},
          "lt": {},
          "lte": {},
          "boost": 42.0,
          "format": "string",
          "time_zone": "string"
        }
      },
      "simple_query_string": {
        "query": "string",
        "fields": [
          "string"
        ],
        "default_operator": "string",
        "analyze_wildcard": true,
        "analyzer": "string",
        "auto_generate_synonyms_phrase_query": true,
        "flags": "string",
        "fuzzy_max_expansions": 42,
        "fuzzy_prefix_length": 42,
        "fuzzy_transpositions": true,
        "lenient": true,
        "minimum_should_match": "string",
        "quote_field_suffix": "string"
      }
    },
    "storage_multiplier": 42.0,
    "deleted_on": "2025-05-04T09:42:00Z",
    "system_owned": true,
    "metadata": {},
    "cpu_multiplier": 42.0,
    "allowed_zones": [
      "string"
    ],
    "max_zones": 42
  }
]

Get trust relationship

GET /platform/configuration/trust-relationships/{trust_relationship_id}

Retrieves information about a trust relationship.

Path parameters

trust_relationship_id string Required

Identifier for the trust relationship

Query parameters

include_certificate boolean

Whether to include the public CA certificates in the response.

Default value is false.

Responses

200

The trust relationship info response
Hide headers attributes Show headers attributes
- x-cloud-resource-version string
  
  The resource version, which is used to avoid update conflicts with concurrent operations
- x-cloud-resource-created string
  
  The date-time when the resource was created (ISO format relative to UTC)
- x-cloud-resource-last-modified string
  
  The date-time when the resource was last modified (ISO format relative to UTC)
Hide response attributes Show response attributes object
- id string Required
  
  The id of the trust relationship
- name string Required
  
  The name of the trust relationship
- trust_by_default boolean Required
  
  If this relationship is trusted by default by all deployments in the current environment.
- account_ids array[string]
  
  The ID of the accounts trusted by this relationship.
- public_ca_cert string
  
  The public CA certificate of the environment to trust
- local boolean Required
  
  If this is the trust relationship for the local environment
- installation_id string
  
  The installation ID of the environment to trust
- last_modified string(date-time) Required
  
  The most recent time the trust relationship was changed (ISO format in UTC)
401

You are not authorized to perform this action.
Hide response attribute Show response attribute object
- errors array[object] Required
  
  A list of errors that occurred in the failing request
  
  Hide errors attributes Show errors attributes object
  
  code string Required
  
  A structured code representing the error type that occurred
  
  message string Required
  
  A human readable message describing the error that occurred
  
  fields array[string]
  
  If the error can be tied to a specific field or fields in the user request, this lists those fields
404

The trust relationship specified by {trust_relationship_id} cannot be found. (code: trust_relationships.not_found)
Hide headers attribute Show headers attribute
- x-cloud-error-codes string
  
  The error codes associated with the response
  
  Value is trust_relationships.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

GET /platform/configuration/trust-relationships/{trust_relationship_id}

curl \
 --request GET https://{{hostname}}/api/v1/platform/configuration/trust-relationships/{trust_relationship_id}

Response examples (200)

# Headers
x-cloud-resource-version: string
x-cloud-resource-created: string
x-cloud-resource-last-modified: string

# Payload
{
  "id": "string",
  "name": "string",
  "trust_by_default": true,
  "account_ids": [
    "string"
  ],
  "public_ca_cert": "string",
  "local": true,
  "installation_id": "string",
  "last_modified": "2025-05-04T09:42:00Z"
}

Response examples (401)

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

Response examples (404)

# Headers
x-cloud-error-codes: trust_relationships.not_found

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

Get API base Url

GET /platform/configuration/api_base_url

Gets the API base Url configuration value.

Responses

200

The API base Url was successfully retrieved
Hide headers attributes Show headers attributes
- x-cloud-resource-version string
  
  The resource version, which is used to avoid update conflicts with concurrent operations
- x-cloud-resource-created string
  
  The date-time when the resource was created (ISO format relative to UTC)
- x-cloud-resource-last-modified string
  
  The date-time when the resource was last modified (ISO format relative to UTC)
Hide response attribute Show response attribute object
- value string Required
  
  The configured base Url
404

There is no configured API base value but optimistic locking was sent. (code: adminconsole.base_url.not_found)
Hide headers attribute Show headers attribute
- x-cloud-error-codes string
  
  The error codes associated with the response
  
  Value is adminconsole.base_url.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

The persisted Url is malformed. (code: adminconsole.base_url.invalid_persisted_data)
Hide headers attribute Show headers attribute
- x-cloud-error-codes string
  
  The error codes associated with the response
  
  Value is adminconsole.base_url.invalid_persisted_data.
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 /platform/configuration/api_base_url

curl \
 --request GET https://{{hostname}}/api/v1/platform/configuration/api_base_url

Response examples (200)

# Headers
x-cloud-resource-version: string
x-cloud-resource-created: string
x-cloud-resource-last-modified: string

# Payload
{
  "value": "string"
}

Response examples (404)

# Headers
x-cloud-error-codes: adminconsole.base_url.not_found

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

Response examples (500)

# Headers
x-cloud-error-codes: adminconsole.base_url.invalid_persisted_data

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

Get allocator

GET /platform/infrastructure/allocators/{allocator_id}

Retrieves the allocator by the ID.

Path parameters

allocator_id string Required

The allocator identifier.

Responses

200

The information for the allocator specified by {allocator_id}
Hide response attributes Show response attributes object
- status object Required
  
  The health status of the allocator.
  
  Additional properties are allowed.
  
  Hide status attributes Show status attributes object
  
  connected boolean Required
  
  Whether the allocator is connected
  
  healthy boolean Required
  
  Whether the allocator is healthy, meaning it is either connected or has no instances
  
  health_checks object
  
  Checks used to determine if an allocator is healthy or not
  
  Additional properties are allowed.
  
  Hide health_checks attributes Show health_checks attributes object
  
  is_docker_healthy boolean Required
  
  Check performed by the allocator to figure out if docker is healthy
  
  is_connected_to_zk boolean Required
  
  Whether the allocator is connected to zk or not
  
  has_instances boolean Required
  
  Whether the allocator has allocated instances
  
  maintenance_mode boolean Required
  
  Whether the allocator is in maintenance mode (meaning that new workload won't be assigned to it)
  
  maintenance_mode_timestamp string(date-time)
  
  Timestamp when allocator last entered or exited maintenance mode
- allocator_id string Required
  
  Identifier for this allocator
- zone_id string Required
  
  Identifier of the zone
- host_ip string Required
  
  Host IP of this allocator
- public_hostname string Required
  
  Public hostname of this allocator
- capacity object Required
  
  The total and used capacity of the allocator.
  
  Additional properties are allowed.
  
  Hide capacity attributes Show capacity attributes object
  
  memory object Required
  
  The available and used memory of the allocator.
  
  Additional properties are allowed.
  
  Hide memory attributes Show memory attributes object
  
  total integer(int32) Required
  
  Total memory in MB capacity installed on this allocator
  
  used integer(int32) Required
  
  Used memory in MB used by instances assigned to this allocator
  
  storage object Required
  
  The storage capacity of the allocator.
  
  Additional properties are allowed.
  
  Hide storage attribute Show storage attribute object
  
  total integer(int64) Required
  
  Total storage in MiB capacity installed on this allocator
  
  available_cpus integer(int32)
  
  Total number of CPUs available on this allocator
  
  additional_master_bonus number(float)
  
  Additional bonus CPU shares available to Elasticsearch master instances
- settings object Required
  
  The settings for the allocator.
  
  Additional properties are allowed.
  
  Hide settings attribute Show settings attribute object
  
  capacity integer(int32)
  
  A memory capacity (in MB) that overrides the capacity defined during installation - requires separate restart of Allocator services on each host to take full effect.
- instances array[object] Required
  
  The status of the allocated Kibana instance or APM Server.
  
  Hide instances attributes Show instances attributes object
  
  cluster_type string Required
  
  Type of instance that is running
  
  Values are elasticsearch, kibana, apm, integrations_server, appsearch, or enterprise_search.
  
  cluster_id string Required
  
  Identifier for the cluster this instance belongs
  
  cluster_name string
  
  Name of cluster this instance belongs, if available
  
  instance_name string Required
  
  Instance ID of the instance
  
  node_memory integer(int32) Required
  
  Memory assigned to this instance
  
  healthy boolean
  
  Indicates whether the instance is healthy
  
  cluster_healthy boolean
  
  Indicates whether the cluster the instance belongs to is healthy
  
  instance_configuration_id string
  
  The instance configuration id of this instance
  
  moving boolean
  
  Indicates whether the instance is vacating away from this allocator. Note that this is currently not populated when returned from the search endpoint.
  
  plans_info object
  
  The plans associated with the current instance. Note that this is currently not populated when returned from the search endpoint.
  
  Additional properties are allowed.
  
  Hide plans_info attributes Show plans_info attributes object
  
  pending boolean Required
  
  Whether or not there is a pending plan.
  
  version string
  
  The version of the current plan, falling back to that of the pending plan if it exists.
  
  zone_count integer(int32)
  
  The number of zones in the current plan, falling back to that of the pending plan if it exists.
  
  deployment_id string
  
  The id of the deployment this cluster belongs to.
- metadata array[object] Required
  
  Arbitrary metadata associated with this allocator
  
  The key-value pair.
  
  Hide metadata attributes Show metadata attributes object
  
  key string Required
  
  The metadata field name
  
  value string Required
  
  The metadata value
- build_info object
  
  Build Info of the artifact
  
  Additional properties are allowed.
  
  Hide build_info attributes Show build_info attributes object
  
  commit_hash string
  
  Git commit hash
  
  version string
  
  Version of the artifact
- features array[string] Required
  
  List of features associated with this allocator. Note this is only present for backwards compatibility purposes and is scheduled for removal in the next major version release.
- external_links array[object] Required
  
  External resources related to this allocator.
  
  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
- region string
  
  The region that this allocator belongs to. Only populated in SaaS or federated ECE.
404

The allocator specified by {allocator_id} cannot be found. (code: allocators.allocator_not_found)
Hide headers attribute Show headers attribute
- x-cloud-error-codes string
  
  The error codes associated with the response
  
  Value is allocators.allocator_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

GET /platform/infrastructure/allocators/{allocator_id}

curl \
 --request GET https://{{hostname}}/api/v1/platform/infrastructure/allocators/{allocator_id}

Response examples (200)

{
  "status": {
    "connected": true,
    "healthy": true,
    "health_checks": {
      "is_docker_healthy": true,
      "is_connected_to_zk": true,
      "has_instances": true
    },
    "maintenance_mode": true,
    "maintenance_mode_timestamp": "2025-05-04T09:42:00Z"
  },
  "allocator_id": "string",
  "zone_id": "string",
  "host_ip": "string",
  "public_hostname": "string",
  "capacity": {
    "memory": {
      "total": 42,
      "used": 42
    },
    "storage": {
      "total": 42
    },
    "available_cpus": 42,
    "additional_master_bonus": 42.0
  },
  "settings": {
    "capacity": 42
  },
  "instances": [
    {
      "cluster_type": "elasticsearch",
      "cluster_id": "string",
      "cluster_name": "string",
      "instance_name": "string",
      "node_memory": 42,
      "healthy": true,
      "cluster_healthy": true,
      "instance_configuration_id": "string",
      "moving": true,
      "plans_info": {
        "pending": true,
        "version": "string",
        "zone_count": 42
      },
      "deployment_id": "string"
    }
  ],
  "metadata": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "build_info": {
    "commit_hash": "string",
    "version": "string"
  },
  "features": [
    "string"
  ],
  "external_links": [
    {
      "id": "string",
      "label": "string",
      "uri": "string"
    }
  ],
  "region": "string"
}

Response examples (404)

# Headers
x-cloud-error-codes: allocators.allocator_not_found

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

Start maintenance mode

POST /platform/infrastructure/constructors/{constructor_id}/maintenance-mode/_start

Start maintenance mode of a constructor. It will stop constructing new plans while continuing with on-going ones.

Path parameters

constructor_id string Required

Identifier for the constructor

Responses

202

The start maintenance mode command was issued successfully

Additional properties are allowed.
403

The start maintenance mode command was prohibited for the given constructor. (code: constructors.command_prohibited)
Hide headers attribute Show headers attribute
- x-cloud-error-codes string
  
  The error codes associated with the response
  
  Value is constructors.command_prohibited.
Hide response attribute Show response attribute object
- errors array[object] Required
  
  A list of errors that occurred in the failing request
  
  Hide errors attributes Show errors attributes object
  
  code string Required
  
  A structured code representing the error type that occurred
  
  message string Required
  
  A human readable message describing the error that occurred
  
  fields array[string]
  
  If the error can be tied to a specific field or fields in the user request, this lists those fields
404

The constructor specified by {constructor_id} cannot be found. (code: constructors.constructor_not_found)
Hide headers attribute Show headers attribute
- x-cloud-error-codes string
  
  The error codes associated with the response
  
  Value is constructors.constructor_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

POST /platform/infrastructure/constructors/{constructor_id}/maintenance-mode/_start

curl \
 --request POST https://{{hostname}}/api/v1/platform/infrastructure/constructors/{constructor_id}/maintenance-mode/_start

Response examples (202)

{}

Response examples (403)

# Headers
x-cloud-error-codes: constructors.command_prohibited

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

Response examples (404)

# Headers
x-cloud-error-codes: constructors.constructor_not_found

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

Get filtered group of proxies

GET /platform/infrastructure/proxies/filtered-groups/{proxies_filtered_group_id}

Get data for a filtered group of proxies.

Path parameters

proxies_filtered_group_id string Required

"The identifier for the filtered group of proxies

Responses

200

Data for the filtered group of proxies identified by {proxies_filtered_group_id}
Hide headers attributes Show headers attributes
- x-cloud-resource-version string
  
  The resource version, which is used to avoid update conflicts with concurrent operations
- x-cloud-resource-created string
  
  The date-time when the resource was created (ISO format relative to UTC)
- x-cloud-resource-last-modified string
  
  The date-time when the resource was last modified (ISO format relative to UTC)
Hide response attributes Show response attributes object
- id string
  
  Identifier of the filtered group of proxies
- filters array[object] Required
  
  Filters to be matched
  
  Selects proxies by matching a proxy metadata item.
  
  Hide filters attributes Show filters attributes object
  
  key string Required
  
  Key of the proxy metadata item to be matched
  
  value string Required
  
  Value of the proxy metadata item to be matched
- expected_proxies_count integer(int32) Required
  
  Expected minimum number of proxies matching all filters in this group
404

Unable to find the {proxies_filtered_group_id} specified filtered group of proxies. Edit your request, then try again. (code: proxies.proxies_filtered_group_not_found)
Hide headers attribute Show headers attribute
- x-cloud-error-codes string
  
  The error codes associated with the response
  
  Value is proxies.proxies_filtered_group_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

GET /platform/infrastructure/proxies/filtered-groups/{proxies_filtered_group_id}

curl \
 --request GET https://{{hostname}}/api/v1/platform/infrastructure/proxies/filtered-groups/{proxies_filtered_group_id}

Response examples (200)

# Headers
x-cloud-resource-version: string
x-cloud-resource-created: string
x-cloud-resource-last-modified: string

# Payload
{
  "id": "string",
  "filters": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "expected_proxies_count": 42
}

Response examples (404)

# Headers
x-cloud-error-codes: proxies.proxies_filtered_group_not_found

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

GET /stack/versions/{version}

Retrieves the Elastic Stack version and template.

Path parameters

version string Required

The Elastic Stack version. For example, 5.3.1 or 5.0.0-RC4.

Responses

200

The Elastic Stack version is found.
Hide response attributes Show response attributes object
- version string
  
  Stack version
- template object Required
  
  The template information for an Elastic Stack version.
  
  Additional properties are allowed.
  
  Hide template attributes Show template attributes object
  
  template_version string
  
  Template version
  
  hashes array[object]
  
  Relative paths of files with SHA-256 hashes that contains the template
  
  The template file hash for an Elastic Stack version.
  
  Hide hashes attributes Show hashes attributes object
  
  path string Required
  
  File path relative to template's root
  
  hash string Required
  
  SHA-256 hash of a file
- elasticsearch object Required
  
  The Elasticsearch configuration for an Elastic Stack version.
  
  Additional properties are allowed.
  
  Hide elasticsearch attributes Show elasticsearch attributes object
  
  docker_image string Required
  
  Docker image for the Elasticsearch
  
  plugins array[string] Required
  
  List of available plugins
  
  default_plugins array[string] Required
  
  List of default plugins
  
  blacklist array[string] Required
  
  List of configuration options that cannot be overridden by user settings
  
  node_types array[object]
  
  Node types that are supported by this stack version
  
  The configuration for an Elastic Stack node type.
  
  Hide node_types attributes Show node_types attributes object
  
  node_type string Required
  
  Type of the node (master, data, ...)
  
  name string Required
  
  Name of the node type
  
  description string Required
  
  Description of the node type
  
  settings object
  
  Settings that are applied to all nodes of this type
  
  Additional properties are allowed.
  
  capacity_constraints object
  
  WARNING This endpoint is deprecated and scheduled to be removed in the next major version. This field will soon be removed in favor of having a global capacity constraint for all node types.
  
  Capacity constraints for the node type
  
  Additional properties are allowed.
  
  Hide capacity_constraints attributes Show capacity_constraints attributes object
  
  min integer(int32) Required
  
  Min capacity of the instances
  
  max integer(int32) Required
  
  Max capacity of the instances
  
  compatible_node_types array[string]
  
  Node types that are compatible with this one
  
  mandatory boolean
  
  Flag to specify a node type is mandatory in a cluster's plan
  
  settings object
  
  Settings that are applied to all nodes of this type
  
  Additional properties are allowed.
  
  capacity_constraints object
  
  WARNING This endpoint is deprecated and scheduled to be removed in the next major version. This field will soon be removed in favor of having a global capacity constraint for all node types.
  
  Capacity constraints for the node type
  
  Additional properties are allowed.
  
  Hide capacity_constraints attributes Show capacity_constraints attributes object
  
  min integer(int32) Required
  
  Min capacity of the instances
  
  max integer(int32) Required
  
  Max capacity of the instances
  
  compatible_node_types array[string]
  
  Node types that are compatible with this one
- kibana object Required
  
  The Kibana configuration for an Elastic Stack version.
  
  Additional properties are allowed.
  
  Hide kibana attributes Show kibana attributes object
  
  version string
  
  Version of Kibana
  
  docker_image string Required
  
  Docker image for the kibana
  
  blacklist array[string] Required
  
  List of configuration options that cannot be overridden by user settings
  
  settings object
  
  Settings that are applied to all nodes of this type
  
  Additional properties are allowed.
  
  capacity_constraints object
  
  WARNING This endpoint is deprecated and scheduled to be removed in the next major version. This field will soon be removed in favor of having a global capacity constraint for all node types.
  
  Capacity constraints for the node type
  
  Additional properties are allowed.
  
  Hide capacity_constraints attributes Show capacity_constraints attributes object
  
  min integer(int32) Required
  
  Min capacity of the instances
  
  max integer(int32) Required
  
  Max capacity of the instances
  
  compatible_node_types array[string]
  
  Node types that are compatible with this one
- apm object
  
  The APM Server configuration for an Elastic Stack version.
  
  Additional properties are allowed.
  
  Hide apm attributes Show apm attributes object
  
  version string
  
  Version of APM
  
  docker_image string Required
  
  Docker image for the APM
  
  blacklist array[string] Required
  
  List of configuration options that cannot be overridden by user settings
  
  settings object
  
  Settings that are applied to all nodes of this type
  
  Additional properties are allowed.
  
  capacity_constraints object
  
  WARNING This endpoint is deprecated and scheduled to be removed in the next major version. This field will soon be removed in favor of having a global capacity constraint for all node types.
  
  Capacity constraints for the node type
  
  Additional properties are allowed.
  
  Hide capacity_constraints attributes Show capacity_constraints attributes object
  
  min integer(int32) Required
  
  Min capacity of the instances
  
  max integer(int32) Required
  
  Max capacity of the instances
  
  compatible_node_types array[string]
  
  Node types that are compatible with this one
- appsearch object
  
  AppSearch related configuration of an Elastic Stack version
  
  Additional properties are allowed.
  
  Hide appsearch attributes Show appsearch attributes object
  
  version string
  
  Version of AppSearch
  
  docker_image string Required
  
  Docker image for the AppSearch
  
  blacklist array[string] Required
  
  List of configuration options that cannot be overridden by user settings
  
  settings object
  
  Settings that are applied to all nodes of this type
  
  Additional properties are allowed.
  
  capacity_constraints object
  
  WARNING This endpoint is deprecated and scheduled to be removed in the next major version. This field will soon be removed in favor of having a global capacity constraint for all node types.
  
  Capacity constraints for the node type
  
  Additional properties are allowed.
  
  Hide capacity_constraints attributes Show capacity_constraints attributes object
  
  min integer(int32) Required
  
  Min capacity of the instances
  
  max integer(int32) Required
  
  Max capacity of the instances
  
  compatible_node_types array[string]
  
  Node types that are compatible with this one
  
  node_types array[object]
  
  Node types that are supported by this stack version
  
  The configuration for an Elastic Stack node type.
  
  Hide node_types attributes Show node_types attributes object
  
  node_type string Required
  
  Type of the node (master, data, ...)
  
  name string Required
  
  Name of the node type
  
  description string Required
  
  Description of the node type
  
  settings object
  
  Settings that are applied to all nodes of this type
  
  Additional properties are allowed.
  
  capacity_constraints object
  
  WARNING This endpoint is deprecated and scheduled to be removed in the next major version. This field will soon be removed in favor of having a global capacity constraint for all node types.
  
  Capacity constraints for the node type
  
  Additional properties are allowed.
  
  Hide capacity_constraints attributes Show capacity_constraints attributes object
  
  min integer(int32) Required
  
  Min capacity of the instances
  
  max integer(int32) Required
  
  Max capacity of the instances
  
  compatible_node_types array[string]
  
  Node types that are compatible with this one
  
  mandatory boolean
  
  Flag to specify a node type is mandatory in a cluster's plan
- enterprise_search object
  
  EnterpriseSearch related configuration of an Elastic Stack version
  
  Additional properties are allowed.
  
  Hide enterprise_search attributes Show enterprise_search attributes object
  
  version string
  
  Version of EnterpriseSearch
  
  docker_image string Required
  
  Docker image for the EnterpriseSearch
  
  blacklist array[string] Required
  
  List of configuration options that cannot be overridden by user settings
  
  settings object
  
  Settings that are applied to all nodes of this type
  
  Additional properties are allowed.
  
  capacity_constraints object
  
  WARNING This endpoint is deprecated and scheduled to be removed in the next major version. This field will soon be removed in favor of having a global capacity constraint for all node types.
  
  Capacity constraints for the node type
  
  Additional properties are allowed.
  
  Hide capacity_constraints attributes Show capacity_constraints attributes object
  
  min integer(int32) Required
  
  Min capacity of the instances
  
  max integer(int32) Required
  
  Max capacity of the instances
  
  compatible_node_types array[string]
  
  Node types that are compatible with this one
  
  node_types array[object]
  
  Node types that are supported by this stack version
  
  The configuration for an Elastic Stack node type.
  
  Hide node_types attributes Show node_types attributes object
  
  node_type string Required
  
  Type of the node (master, data, ...)
  
  name string Required
  
  Name of the node type
  
  description string Required
  
  Description of the node type
  
  settings object
  
  Settings that are applied to all nodes of this type
  
  Additional properties are allowed.
  
  capacity_constraints object
  
  WARNING This endpoint is deprecated and scheduled to be removed in the next major version. This field will soon be removed in favor of having a global capacity constraint for all node types.
  
  Capacity constraints for the node type
  
  Additional properties are allowed.
  
  Hide capacity_constraints attributes Show capacity_constraints attributes object
  
  min integer(int32) Required
  
  Min capacity of the instances
  
  max integer(int32) Required
  
  Max capacity of the instances
  
  compatible_node_types array[string]
  
  Node types that are compatible with this one
  
  mandatory boolean
  
  Flag to specify a node type is mandatory in a cluster's plan
- metadata object
  
  The metadata for the Elastic Stack.
  
  Additional properties are allowed.
  
  Hide metadata attributes Show metadata attributes object
  
  notes string
  
  Notes for administrator
  
  pre_release boolean
  
  Indicates that the stack pack version is not GA and is not supposed to be used in production
  
  min_platform_version string
  
  The minimum version of the platform that the stack pack version is compatible with
  
  min_wire_compatibility_version string
  
  The minimum version required for performing a rolling upgrade to this stack version.
  
  min_index_compatibility_version string
  
  The minimum version required for performing a full cluster restart upgrade to this stack version.
  
  schema_version integer(int32)
  
  The schema version of the stack pack version
- deleted boolean
  
  Identifies that the Elastic Stack version is marked for deletion
- upgradable_to array[string] Required
  
  Stack Versions that this version can upgrade to
- min_upgradable_from string
  
  The minimum version recommended to upgrade this version.
- whitelisted boolean
  
  Whether or not this version is whitelisted. This is only relevant in EC (SaaS) and is not sent in ECE.
- accessible boolean
  
  Whether or not this version is accessible by the calling user. This is only relevant in EC (SaaS) and is not sent in ECE.
404

The Elastic Stack version can't be found. (code: stackpack.version_not_found)
Hide headers attribute Show headers attribute
- x-cloud-error-codes string
  
  The error codes associated with the response
  
  Value is stackpack.version_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

GET /stack/versions/{version}

curl \
 --request GET https://{{hostname}}/api/v1/stack/versions/{version}

Response examples (200)

{
  "version": "string",
  "template": {
    "template_version": "string",
    "hashes": [
      {
        "path": "string",
        "hash": "string"
      }
    ]
  },
  "elasticsearch": {
    "docker_image": "string",
    "plugins": [
      "string"
    ],
    "default_plugins": [
      "string"
    ],
    "blacklist": [
      "string"
    ],
    "node_types": [
      {
        "node_type": "string",
        "name": "string",
        "description": "string",
        "settings": {},
        "capacity_constraints": {
          "min": 42,
          "max": 42
        },
        "compatible_node_types": [
          "string"
        ],
        "mandatory": true
      }
    ],
    "settings": {},
    "capacity_constraints": {
      "min": 42,
      "max": 42
    },
    "compatible_node_types": [
      "string"
    ]
  },
  "kibana": {
    "version": "string",
    "docker_image": "string",
    "blacklist": [
      "string"
    ],
    "settings": {},
    "capacity_constraints": {
      "min": 42,
      "max": 42
    },
    "compatible_node_types": [
      "string"
    ]
  },
  "apm": {
    "version": "string",
    "docker_image": "string",
    "blacklist": [
      "string"
    ],
    "settings": {},
    "capacity_constraints": {
      "min": 42,
      "max": 42
    },
    "compatible_node_types": [
      "string"
    ]
  },
  "appsearch": {
    "version": "string",
    "docker_image": "string",
    "blacklist": [
      "string"
    ],
    "settings": {},
    "capacity_constraints": {
      "min": 42,
      "max": 42
    },
    "compatible_node_types": [
      "string"
    ],
    "node_types": [
      {
        "node_type": "string",
        "name": "string",
        "description": "string",
        "settings": {},
        "capacity_constraints": {
          "min": 42,
          "max": 42
        },
        "compatible_node_types": [
          "string"
        ],
        "mandatory": true
      }
    ]
  },
  "enterprise_search": {
    "version": "string",
    "docker_image": "string",
    "blacklist": [
      "string"
    ],
    "settings": {},
    "capacity_constraints": {
      "min": 42,
      "max": 42
    },
    "compatible_node_types": [
      "string"
    ],
    "node_types": [
      {
        "node_type": "string",
        "name": "string",
        "description": "string",
        "settings": {},
        "capacity_constraints": {
          "min": 42,
          "max": 42
        },
        "compatible_node_types": [
          "string"
        ],
        "mandatory": true
      }
    ]
  },
  "metadata": {
    "notes": "string",
    "pre_release": true,
    "min_platform_version": "string",
    "min_wire_compatibility_version": "string",
    "min_index_compatibility_version": "string",
    "schema_version": 42
  },
  "deleted": true,
  "upgradable_to": [
    "string"
  ],
  "min_upgradable_from": "6.7.0",
  "whitelisted": true,
  "accessible": true
}

Response examples (404)

# Headers
x-cloud-error-codes: stackpack.version_not_found

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