Elastic Cloud API documentation

Fetch current account information

GET /account

Fetch current account information.

Responses

200 application/json

Account fetched successfully
Hide response attributes Show response attributes object
- id string Required
  
  The account's identifier
- trust object
  
  Settings related to the level of trust of the clusters in this account
  
  Hide trust attribute Show trust attribute object
  
  trust_all boolean Required
  
  If true, all clusters in this account will by default trust all other clusters in the same account
404 application/json

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

curl \
 --request GET 'https://api.elastic-cloud.com/api/v1/account'

Create API key

POST /users/auth/keys

Creates a new API key.

application/json

Body Required

The request to create the API key

description string Required

API key description. Useful if there are multiple keys
expiration string

The optional expiration for the API key, provided as a duration (ex: '1d', '3h')
role_assignments object

Roles assigned to users, API keys or organization invitations. Currently unavailable in self-hosted ECE.
Hide role_assignments attributes Show role_assignments attributes object
- platform array[object]
  
  Assignments for roles with platform scope.
  
  Assignment for a role with platform scope.
  Hide platform attribute Show platform attribute object
  
  role_id string Required
  
  The ID of the role that is assigned.
- organization array[object]
  
  Assignments for roles with organization scope.
  
  Assignment for a role with organization scope.
  Hide organization attributes Show organization attributes object
  
  role_id string Required
  
  The ID of the role that is assigned.
  
  organization_id string Required
  
  The ID of the organization the role is scoped to.
- deployment array[object]
  
  Assignments for roles with deployment scope.
  
  Assignment for a role with deployment scope.
  Hide deployment attributes Show deployment attributes object
  
  role_id string Required
  
  The ID of the role that is assigned.
  
  organization_id string Required
  
  The ID of the organization the role is scoped to.
  
  all boolean
  
  When true, the role applies to all deployments in the organization, otherwise the role is scoped to the deployments specified in deployment_ids.
  
  deployment_ids array[string]
  
  The IDs of the deployments the role is scoped to. Must be absent if all is true, and present if all is false.
  
  application_roles array[string]
  
  If provided, the user assigned this role assignment will be granted this application role when signing in to the deployment(s) specified in the role assignment.
- project object
  
  Assignments for roles with project scope.
  Hide project attributes Show project attributes object
  
  elasticsearch array[object]
  
  The Elasticsearch project-scoped role assignments to set
  
  Assignment for a role with project scope.
  
  Hide elasticsearch attributes Show elasticsearch attributes object
  
  role_id string Required
  
  The ID of the role that is assigned.
  
  organization_id string Required
  
  The ID of the organization the role is scoped to.
  
  all boolean
  
  When true, the role applies to all projects in the organization, otherwise the role is scoped to the projects specified in project_ids.
  
  project_ids array[string]
  
  The IDs of the projects the role is scoped to. Must be absent if all is true, and present if all is false.
  
  application_roles array[string]
  
  If provided, the user assigned this role assignment will be granted this application role when signing in to the project(s) specified in the role assignment.
  
  observability array[object]
  
  The Observability project-scoped role assignments to set
  
  Assignment for a role with project scope.
  
  Hide observability attributes Show observability attributes object
  
  role_id string Required
  
  The ID of the role that is assigned.
  
  organization_id string Required
  
  The ID of the organization the role is scoped to.
  
  all boolean
  
  When true, the role applies to all projects in the organization, otherwise the role is scoped to the projects specified in project_ids.
  
  project_ids array[string]
  
  The IDs of the projects the role is scoped to. Must be absent if all is true, and present if all is false.
  
  application_roles array[string]
  
  If provided, the user assigned this role assignment will be granted this application role when signing in to the project(s) specified in the role assignment.
  
  security array[object]
  
  The Security project-scoped role assignments to set
  
  Assignment for a role with project scope.
  
  Hide security attributes Show security attributes object
  
  role_id string Required
  
  The ID of the role that is assigned.
  
  organization_id string Required
  
  The ID of the organization the role is scoped to.
  
  all boolean
  
  When true, the role applies to all projects in the organization, otherwise the role is scoped to the projects specified in project_ids.
  
  project_ids array[string]
  
  The IDs of the projects the role is scoped to. Must be absent if all is true, and present if all is false.
  
  application_roles array[string]
  
  If provided, the user assigned this role assignment will be granted this application role when signing in to the project(s) specified in the role assignment.

Responses

201 application/json

The API key is created and returned in the body of the response.
Hide response attributes Show response attributes object
- id string Required
  
  The API key ID.
- user_id string
  
  The user ID.
- organization_id string
  
  The organization ID linked to the API key
- description string Required
  
  The API key description. TIP: Useful when you have multiple API keys.
- key string
  
  The API key. TIP: Since the API key is returned only once, save it in a safe place.
- creation_date string(date-time) Required
  
  The date/time for when the API key is created.
- expiration_date string(date-time)
  
  The date/time when the API key expires.
- role_assignments object
  
  Roles assigned to users, API keys or organization invitations. Currently unavailable in self-hosted ECE.
  
  Hide role_assignments attributes Show role_assignments attributes object
  
  platform array[object]
  
  Assignments for roles with platform scope.
  
  Assignment for a role with platform scope.
  
  Hide platform attribute Show platform attribute object
  
  role_id string Required
  
  The ID of the role that is assigned.
  
  organization array[object]
  
  Assignments for roles with organization scope.
  
  Assignment for a role with organization scope.
  
  Hide organization attributes Show organization attributes object
  
  role_id string Required
  
  The ID of the role that is assigned.
  
  organization_id string Required
  
  The ID of the organization the role is scoped to.
  
  deployment array[object]
  
  Assignments for roles with deployment scope.
  
  Assignment for a role with deployment scope.
  
  Hide deployment attributes Show deployment attributes object
  
  role_id string Required
  
  The ID of the role that is assigned.
  
  organization_id string Required
  
  The ID of the organization the role is scoped to.
  
  all boolean
  
  When true, the role applies to all deployments in the organization, otherwise the role is scoped to the deployments specified in deployment_ids.
  
  deployment_ids array[string]
  
  The IDs of the deployments the role is scoped to. Must be absent if all is true, and present if all is false.
  
  application_roles array[string]
  
  If provided, the user assigned this role assignment will be granted this application role when signing in to the deployment(s) specified in the role assignment.
  
  project object
  
  Assignments for roles with project scope.
  
  Hide project attributes Show project attributes object
  
  elasticsearch array[object]
  
  The Elasticsearch project-scoped role assignments to set
  
  Assignment for a role with project scope.
  
  Hide elasticsearch attributes Show elasticsearch attributes object
  
  role_id string Required
  
  The ID of the role that is assigned.
  
  organization_id string Required
  
  The ID of the organization the role is scoped to.
  
  all boolean
  
  When true, the role applies to all projects in the organization, otherwise the role is scoped to the projects specified in project_ids.
  
  project_ids array[string]
  
  The IDs of the projects the role is scoped to. Must be absent if all is true, and present if all is false.
  
  application_roles array[string]
  
  If provided, the user assigned this role assignment will be granted this application role when signing in to the project(s) specified in the role assignment.
  
  observability array[object]
  
  The Observability project-scoped role assignments to set
  
  Assignment for a role with project scope.
  
  Hide observability attributes Show observability attributes object
  
  role_id string Required
  
  The ID of the role that is assigned.
  
  organization_id string Required
  
  The ID of the organization the role is scoped to.
  
  all boolean
  
  When true, the role applies to all projects in the organization, otherwise the role is scoped to the projects specified in project_ids.
  
  project_ids array[string]
  
  The IDs of the projects the role is scoped to. Must be absent if all is true, and present if all is false.
  
  application_roles array[string]
  
  If provided, the user assigned this role assignment will be granted this application role when signing in to the project(s) specified in the role assignment.
  
  security array[object]
  
  The Security project-scoped role assignments to set
  
  Assignment for a role with project scope.
  
  Hide security attributes Show security attributes object
  
  role_id string Required
  
  The ID of the role that is assigned.
  
  organization_id string Required
  
  The ID of the organization the role is scoped to.
  
  all boolean
  
  When true, the role applies to all projects in the organization, otherwise the role is scoped to the projects specified in project_ids.
  
  project_ids array[string]
  
  The IDs of the projects the role is scoped to. Must be absent if all is true, and present if all is false.
  
  application_roles array[string]
  
  If provided, the user assigned this role assignment will be granted this application role when signing in to the project(s) specified in the role assignment.
400 application/json

The request is invalid. Specify a different request, then try again. (code: api_keys.invalid_input)
Hide headers attribute Show headers attribute
- x-cloud-error-codes string
  
  The error codes associated with the response
  
  Value is api_keys.invalid_input.
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 /users/auth/keys

curl \
 --request POST 'https://api.elastic-cloud.com/api/v1/users/auth/keys' \
 --header "Content-Type: application/json" \
 --data '{"description":"string","expiration":"string","role_assignments":{"platform":[{"role_id":"string"}],"organization":[{"role_id":"string","organization_id":"string"}],"deployment":[{"role_id":"string","organization_id":"string","all":true,"deployment_ids":["string"],"application_roles":["string"]}],"project":{"elasticsearch":[{"role_id":"string","organization_id":"string","all":true,"project_ids":["string"],"application_roles":["string"]}],"observability":[{"role_id":"string","organization_id":"string","all":true,"project_ids":["string"],"application_roles":["string"]}],"security":[{"role_id":"string","organization_id":"string","all":true,"project_ids":["string"],"application_roles":["string"]}]}}}'

Delete API key

DELETE /users/auth/keys/{api_key_id}

Delete or invalidate the API key.

Path parameters

api_key_id string Required

The API Key ID.

Responses

200 application/json

The API key is deleted.
404 application/json

The {api_key_id} can't be found. (code: api_keys.key_not_found)
Hide headers attribute Show headers attribute
- x-cloud-error-codes string
  
  The error codes associated with the response
  
  Value is api_keys.key_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 /users/auth/keys/{api_key_id}

curl \
 --request DELETE 'https://api.elastic-cloud.com/api/v1/users/auth/keys/{api_key_id}'

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

GET /billing/costs/{organization_id}

EXPERIMENTAL (it may change in future versions): Retrieves an overview of the costs by organization ID.

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 costs. Defaults to start of current month.
to string

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

Responses

200 application/json

Top-level cost overview for the organization
Hide response attributes Show response attributes object
- costs object Required
  
  Costs overview for an organization. All of the costs, credits, trials are expressed in Elastic Consumption Unit (ECU).
  
  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
- trials number(double) Required
  
  Trial costs for the organization
- hourly_rate number(double) Required
  
  Hourly rate applied.
- balance object
  
  The available balance for an organization
  
  Hide balance attributes Show balance attributes object
  
  available number(double) Required
  
  Available balance
  
  remaining number(double) Required
  
  Remaining balance
  
  line_items array[object] Required
  
  A collection of order line items for for an organization
  
  Line Item
  
  Hide line_items attributes Show line_items attributes object
  
  id string Required
  
  Line Item ID
  
  ecu_quantity number(double) Required
  
  Original Elastic Consumption Unit (ECU) quantity
  
  ecu_balance number(double) Required
  
  Elastic Consumption Unit (ECU) Balance
  
  start string(date-time) Required
  
  Start of the line item's validity
  
  end string(date-time) Required
  
  Expiration of the line item
400 application/json

The specified date range is invalid. (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 application/json

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 application/json

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 application/json

An error occurred when fetching an overview of the costs 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}

curl \
 --request GET 'https://api.elastic-cloud.com/api/v1/billing/costs/{organization_id}'

Get charts by deployment. Currently unavailable in self-hosted ECE. Deprecated

GET /billing/costs/{organization_id}/deployments/{deployment_id}/charts

EXPERIMENTAL (it may change in future versions): Retrieves the usage charts for the given deployment.

Path parameters

organization_id string Required

Identifier for the organization
deployment_id string Required

Id of a Deployment

Query parameters

from string

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

A datetime for the end of the desired range for which to fetch costs. Defaults to the current date.
bucketing_strategy string

The desired bucketing strategy for the charts. Defaults to daily.

Values are daily or monthly. Default value is daily.

Responses

200 application/json

The usage charts of a deployment.
Hide response attribute Show response attribute object
- data array[object] Required
  
  The list of chart item
  
  Chart Item
  
  Hide data attributes Show data attributes object
  
  timestamp integer(int64) Required
  
  Axis X position
  
  values array[object] Required
  
  the collection of values to plot the chart item
  
  A ChartItem value
  
  Hide values attributes Show values attributes object
  
  id string Required
  
  The id of chart item value
  
  name string Required
  
  The name of the chart item value
  
  value number(double) Required
  
  The actual value of the chart item value
400 application/json

The specified date range is invalid. (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 application/json

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 application/json

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
429 application/json

Too many requests. (code: billing_service.rate_limited)
Hide headers attribute Show headers attribute
- x-cloud-error-codes string
  
  The error codes associated with the response
  
  Value is billing_service.rate_limited.
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 application/json

Error fetching the itemized costs 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/{deployment_id}/charts

curl \
 --request GET 'https://api.elastic-cloud.com/api/v1/billing/costs/{organization_id}/deployments/{deployment_id}/charts'

List Deployments

GET /deployments

List Deployments.

Responses

200 application/json

The list of deployments that belong to the authenticated user.
Hide response attribute Show response attribute object
- deployments array[object] Required
  
  The deployments
  
  Hide deployments attributes Show deployments attributes object
  
  id string Required
  
  The id of this deployment
  
  name string Required
  
  The name of this deployment
  
  resources array[object] Required
  
  List of resources in this deployment
  
  Data for a deployment resource
  
  Hide resources attributes Show resources attributes object
  
  ref_id string Required
  
  A locally-unique friendly alias for this Elasticsearch cluster
  
  elasticsearch_cluster_ref_id string
  
  The Elasticsearch cluster that this resource depends on.
  
  id string Required
  
  A system-unique id for the created resource
  
  kind string Required
  
  The kind of resource
  
  region string Required
  
  Identifier of the region in which this resource runs.
  
  cloud_id string
  
  An encoded string that provides other Elastic services with the necessary information to connect to this Elasticsearch and Kibana
  
  credentials object
  
  The username and password for the new Elasticsearch cluster, which is returned from the Elasticsearch cluster create command.
  
  Hide credentials attributes Show credentials attributes object
  
  username string Required
  
  The username of the newly created cluster
  
  password string Required
  
  The password of the newly created cluster
  
  secret_token string
  
  Secret token for using a created resource. Only provided on initial create and absent otherwise.
  
  warnings array[object]
  
  List of warnings generated from validating resource updates
  
  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
401 application/json

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

GET /deployments

curl \
 --request GET 'https://api.elastic-cloud.com/api/v1/deployments'

Update Deployment

PUT /deployments/{deployment_id}

Updates a Deployment.

Path parameters

deployment_id string Required

Identifier for the Deployment

Query parameters

hide_pruned_orphans boolean

Whether or not to hide orphaned resources that were shut down (relevant if prune on the request is true)

Default value is false.
skip_snapshot boolean

Whether or not to skip snapshots before shutting down orphaned resources (relevant if prune on the request is true)

Default value is false.
validate_only boolean

If true, will just validate the Deployment definition but will not perform the update

Default value is false.
version string

If specified then checks for conflicts against the version stored in the persistent store (returned in 'x-cloud-resource-version' of the GET request)

application/json

Body Required

The deployment definition

name string

A new name for the deployment, otherwise stays the same.
prune_orphans boolean Required

Whether or not to prune orphan resources that are no longer mentioned in this request. Note that resourcesare tracked by ref_id, and if a resource's ref_id is changed, any previous running resources created with that previousref_id are considered to be orphaned as well.
resources object

Describes the Deployment resource updates
Hide resources attributes Show resources attributes object
- elasticsearch array[object]
  
  A list of payloads for Elasticsearch cluster updates
  
  An alias for an Elasticsearch Cluster paired with a request for creating one
  Hide elasticsearch attributes Show elasticsearch attributes object
  
  ref_id string Required
  
  A locally-unique user-specified id for this Elasticsearch cluster
  
  display_name string
  
  The human readable name for the cluster (defaults to the generated cluster id if not specified)
  
  region string Required
  
  The region where this resource exists
  
  plan object Required
  
  The plan for the Elasticsearch cluster.
  
  Hide plan attributes Show plan attributes object
  
  cluster_topology array[object] Required
  
  The topology of the Elasticsearch nodes, including the number, capacity, and type of nodes, and where they can be allocated.
  
  Hide cluster_topology attributes Show cluster_topology attributes object
  
  id string
  
  Unique identifier of this topology element
  
  node_type object
  
  Controls the combinations of Elasticsearch node types. TIP: By default, the Elasticsearch node is master eligible, can hold data, and run ingest pipelines. WARNING: Do not set for tiebreaker topologies.
  
  Hide node_type attributes Show node_type attributes object
  
  master boolean
  
  Defines whether this node can be elected master (default: false)
  
  data boolean
  
  Defines whether this node can hold data (default: false)
  
  ingest boolean
  
  Defines whether this node can run an ingest pipeline (default: false)
  
  ml boolean
  
  Defines whether this node can run ml jobs, valid only for versions 5.4.0 or greater (default: false)
  
  node_roles array[string]
  
  The list of node roles for this topology element (ES version >= 7.10). Allowable values are: master, ingest, ml, data_hot, data_content, data_warm, data_cold, data_frozen, remote_cluster_client, transform
  
  Values are master, ingest, ml, data_hot, data_content, data_warm, data_cold, data_frozen, remote_cluster_client, or transform.
  
  zone_count integer(int32)
  
  The default number of zones in which data nodes will be placed
  
  elasticsearch object
  
  The Elasticsearch cluster settings. When specified at the top level, provides a field-by-field default. When specified at the topology level, provides the override settings.
  
  Hide elasticsearch attributes Show elasticsearch attributes object
  
  version string
  
  The version of the Elasticsearch cluster (must be one of the ECE supported versions). Currently cannot be different across the topology (and is generally specified in the globals). Defaults to the latest version if not specified.
  
  docker_image string
  
  A docker URI that allows overriding of the default docker image specified for this version
  
  system_settings object
  
  A subset of Elasticsearch settings. TIP: To define the complete set of Elasticsearch settings, use ElasticsearchSystemSettings with user_settings_override* and user_settings*.
  
  Hide system_settings attributes Show system_settings attributes object
  
  scripting object
  
  Controls the languages supported by the Elasticsearch cluster, such as Painless, Mustache, and Expressions. Controls how the languages are used, such as file, index, and inline. TIP: For complex configurations, leave these blank and configure these settings in the user YAML or JSON.
  
  Hide scripting attributes Show scripting attributes object
  
  painless_enabled boolean
  
  (5.x+ only) If enabled (the default) then the painless scripting engine is allowed as a sandboxed language. Sandboxed languages are the only ones allowed if 'sandbox_mode' is set to true. NOTES: (Corresponds to the parameters 'script.engine.painless.[file|stored|inline]')
  
  mustache_enabled boolean
  
  (5.x+ only) If enabled (the default) then the mustache scripting engine is allowed as a sandboxed language. Sandboxed languages are the only ones allowed if 'sandbox_mode' is set to true. NOTES: (Corresponds to the parameters 'script.engine.mustache.[file|stored|inline]')
  
  expressions_enabled boolean
  
  (5.x+ only) If enabled (the default) then the expressions scripting engine is allowed as a sandboxed language. Sandboxed languages are the only ones allowed if 'sandbox_mode' is set to true. NOTES: (Corresponds to the parameters 'script.engine.expression.[file|stored|inline]')
  
  stored object
  
  Enables scripting for the specified type and controls other parameters. Store scripts in indexes (stored), upload in file bundles (file), or use in API requests (inline).
  
  Hide stored attributes Show stored attributes object
  
  enabled boolean
  
  If enabled (default: true) then scripts are enabled, either for sandboxing languages (by default), or for all installed languages if 'sandbox_mode' is disabled (or for 6.x). NOTES: (Corresponds to the parameter 'script.file|stored/indexed|inline')
  
  sandbox_mode boolean
  
  If enabled (default: true) and this script type is enabled, then only the sandbox languages are allowed. By default the sandbox languages are painless, expressions and mustache, but this can be restricted via the 'painless_enabled', 'mustache_enabled' 'expression_enabled' settings.NOTES: Not supported in 6.x. (Corresponds to the parameters 'script.engine.[painless|mustache|expressions].[file|stored|inline]')
  
  file object
  
  Enables scripting for the specified type and controls other parameters. Store scripts in indexes (stored), upload in file bundles (file), or use in API requests (inline).
  
  Hide file attributes Show file attributes object
  
  enabled boolean
  
  If enabled (default: true) then scripts are enabled, either for sandboxing languages (by default), or for all installed languages if 'sandbox_mode' is disabled (or for 6.x). NOTES: (Corresponds to the parameter 'script.file|stored/indexed|inline')
  
  sandbox_mode boolean
  
  If enabled (default: true) and this script type is enabled, then only the sandbox languages are allowed. By default the sandbox languages are painless, expressions and mustache, but this can be restricted via the 'painless_enabled', 'mustache_enabled' 'expression_enabled' settings.NOTES: Not supported in 6.x. (Corresponds to the parameters 'script.engine.[painless|mustache|expressions].[file|stored|inline]')
  
  inline object
  
  Enables scripting for the specified type and controls other parameters. Store scripts in indexes (stored), upload in file bundles (file), or use in API requests (inline).
  
  Hide inline attributes Show inline attributes object
  
  enabled boolean
  
  If enabled (default: true) then scripts are enabled, either for sandboxing languages (by default), or for all installed languages if 'sandbox_mode' is disabled (or for 6.x). NOTES: (Corresponds to the parameter 'script.file|stored/indexed|inline')
  
  sandbox_mode boolean
  
  If enabled (default: true) and this script type is enabled, then only the sandbox languages are allowed. By default the sandbox languages are painless, expressions and mustache, but this can be restricted via the 'painless_enabled', 'mustache_enabled' 'expression_enabled' settings.NOTES: Not supported in 6.x. (Corresponds to the parameters 'script.engine.[painless|mustache|expressions].[file|stored|inline]')
  
  reindex_whitelist array[string]
  
  Limits remote Elasticsearch clusters that can be used as the source for '_reindex' API commands
  
  auto_create_index boolean
  
  If true (the default), then any write operation on an index that does not currently exist will create it. NOTES: (Corresponds to the parameter 'action.auto_create_index')
  
  enable_close_index boolean
  
  Defaults to false on versions <= 7.2.0, true otherwise. If false, then the API commands to close indices are disabled. This is important because Elasticsearch does not snapshot or migrate close indices on versions under 7.2.0, therefore standard Elastic Cloud configuration operations will cause irretrievable loss of indices' data. NOTES: (Corresponds to the parameter 'cluster.indices.close.enable')
  
  destructive_requires_name boolean
  
  If true (default is false) then the index deletion API will not support wildcards or '_all'. NOTES: (Corresponds to the parameter 'action.destructive_requires_name')
  
  watcher_trigger_engine string
  
  The trigger engine for Watcher, defaults to 'scheduler' - see the xpack documentation for more information. NOTES: (Corresponds to the parameter '(xpack.)watcher.trigger.schedule.engine', depending on version. Ignored from 6.x onwards.)
  
  default_shards_per_index integer(int32)
  
  (2.x only - to get the same result in 5.x template mappings must be used) Sets the default number of shards per index, defaulting to 1 if not specified. (Corresponds to the parameter 'index.number_of_shards' in 2.x, not supported in 5.x)
  
  monitoring_collection_interval integer(int32)
  
  The default interval at which monitoring information from the cluster if collected, if monitoring is enabled. NOTES: (Corresponds to the parameter 'marvel.agent.interval' in 2.x and 'xpack.monitoring.collection.interval' in 5.x)
  
  monitoring_history_duration string
  
  The duration for which monitoring history is stored (format '(NUMBER)d' eg '3d' for 3 days). NOTES: ('Corresponds to the parameter xpack.monitoring.history.duration' in 5.x, defaults to '7d')
  
  user_settings_json object
  
  An arbitrary JSON object allowing cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters arey are on the allowlist and not on the denylist. NOTES: (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Elasticsearch settings)
  
  user_settings_yaml string
  
  An arbitrary YAML object allowing cluster owners to set their parameters (only one of this and 'user_settings_json' is allowed), provided the parameters arey are on the allowlist and not on the denylist. NOTES: (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Elasticsearch settings)
  
  user_settings_override_json object
  
  An arbitrary JSON object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), ie in addition to the documented 'system_settings'. NOTES: (This field together with 'system_settings' and 'user_settings*' defines the total set of Elasticsearch settings)
  
  user_settings_override_yaml string
  
  An arbitrary YAML object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_json' is allowed), ie in addition to the documented 'system_settings'. NOTES: (This field together with 'system_settings' and 'user_settings*' defines the total set of Elasticsearch settings)
  
  enabled_built_in_plugins array[string]
  
  A list of plugin names from the Elastic-supported subset that are bundled with the version images. NOTES: (Users should consult the Elastic stack objects to see what plugins are available, this is currently only available from the UI)
  
  user_plugins array[object]
  
  A list of admin-uploaded plugin objects that are available for this user.
  
  A list of admin-uploaded plugin objects.
  
  Hide user_plugins attributes Show user_plugins attributes object
  
  name string Required
  
  The name of the plugin
  
  url string Required
  
  The URL of the plugin (must be accessible from the ECE infrastructure)
  
  elasticsearch_version string Required
  
  The supported Elasticsearch version (must match the version in the plan)
  
  user_bundles array[object]
  
  A list of admin-uploaded bundle objects (eg scripts, synonym files) that are available for this user.
  
  A list of admin-uploaded bundle objects, such as scripts and synonym files.
  
  Hide user_bundles attributes Show user_bundles attributes object
  
  name string Required
  
  The name of the bundle
  
  url string Required
  
  The URL of the bundle, which must be accessible from the ECE infrastructure. This URL could be cached by platform, make sure to change it when updating the bundle
  
  elasticsearch_version string Required
  
  The supported Elasticsearch version (must match the version in the plan)
  
  curation object
  
  The structure that defines the routing settings for index curation.
  
  Hide curation attributes Show curation attributes object
  
  from_instance_configuration_id string Required
  
  The source instance configuration
  
  to_instance_configuration_id string Required
  
  The destination instance configuration
  
  node_attributes object
  
  Defines the Elasticsearch node attributes for the instances in the topology
  
  Hide node_attributes attribute Show node_attributes attribute object
  
  * string Additional properties
  
  instance_configuration_id string
  
  Controls the allocation of this topology element as well as allowed sizes and node_types. It needs to match the id of an existing instance configuration.
  
  instance_configuration_version integer(int32)
  
  The version of the Instance Configuration Id. If it is unset, the meaning depends on read vs writes. For deployment reads, it is equivalent to version 0 (or the IC is unversioned); for deployment creates and deployment template use, it is equivalent to 'the latest version'; and for deployment updates, it is equivalent to 'retain the current version'.
  
  size object
  
  Measured by the amount of a resource. The final cluster size is calculated using multipliers from the topology instance configuration.
  
  Hide size attributes Show size attributes object
  
  value integer(int32) Required
  
  Amount of resource
  
  resource string Required
  
  Type of resource. In ESS the resource used should always be memory.
  
  Values are memory or storage.
  
  autoscaling_min object
  
  Measured by the amount of a resource. The final cluster size is calculated using multipliers from the topology instance configuration.
  
  Hide autoscaling_min attributes Show autoscaling_min attributes object
  
  value integer(int32) Required
  
  Amount of resource
  
  resource string Required
  
  Type of resource. In ESS the resource used should always be memory.
  
  Values are memory or storage.
  
  autoscaling_max object
  
  Measured by the amount of a resource. The final cluster size is calculated using multipliers from the topology instance configuration.
  
  Hide autoscaling_max attributes Show autoscaling_max attributes object
  
  value integer(int32) Required
  
  Amount of resource
  
  resource string Required
  
  Type of resource. In ESS the resource used should always be memory.
  
  Values are memory or storage.
  
  autoscaling_policy_override_json object
  
  An arbitrary JSON object overriding the default autoscaling policy. Don't set unless you really know what you are doing.
  
  topology_element_control object
  
  Controls for the topology element. Only used as part of the deployment template. Ignored if included as part of a deployment.
  
  Hide topology_element_control attribute Show topology_element_control attribute object
  
  min object Required
  
  Measured by the amount of a resource. The final cluster size is calculated using multipliers from the topology instance configuration.
  
  Hide min attributes Show min attributes object
  
  value integer(int32) Required
  
  Amount of resource
  
  resource string Required
  
  Type of resource. In ESS the resource used should always be memory.
  
  Values are memory or storage.
  
  autoscaling_tier_override boolean
  
  Set to true to enable autoscaling for this topology element, even if the cluster-level 'autoscaling_enabled' field is false. Note that 'autoscaling_tier_override' cannot be set to false if cluster-level 'autoscaling_enabled' is true. Currently only supported for the 'ml' tier
  
  elasticsearch object Required
  
  The Elasticsearch cluster settings. When specified at the top level, provides a field-by-field default. When specified at the topology level, provides the override settings.
  
  Hide elasticsearch attributes Show elasticsearch attributes object
  
  version string
  
  The version of the Elasticsearch cluster (must be one of the ECE supported versions). Currently cannot be different across the topology (and is generally specified in the globals). Defaults to the latest version if not specified.
  
  docker_image string
  
  A docker URI that allows overriding of the default docker image specified for this version
  
  system_settings object
  
  A subset of Elasticsearch settings. TIP: To define the complete set of Elasticsearch settings, use ElasticsearchSystemSettings with user_settings_override* and user_settings*.
  
  Hide system_settings attributes Show system_settings attributes object
  
  scripting object
  
  Controls the languages supported by the Elasticsearch cluster, such as Painless, Mustache, and Expressions. Controls how the languages are used, such as file, index, and inline. TIP: For complex configurations, leave these blank and configure these settings in the user YAML or JSON.
  
  Hide scripting attributes Show scripting attributes object
  
  painless_enabled boolean
  
  (5.x+ only) If enabled (the default) then the painless scripting engine is allowed as a sandboxed language. Sandboxed languages are the only ones allowed if 'sandbox_mode' is set to true. NOTES: (Corresponds to the parameters 'script.engine.painless.[file|stored|inline]')
  
  mustache_enabled boolean
  
  (5.x+ only) If enabled (the default) then the mustache scripting engine is allowed as a sandboxed language. Sandboxed languages are the only ones allowed if 'sandbox_mode' is set to true. NOTES: (Corresponds to the parameters 'script.engine.mustache.[file|stored|inline]')
  
  expressions_enabled boolean
  
  (5.x+ only) If enabled (the default) then the expressions scripting engine is allowed as a sandboxed language. Sandboxed languages are the only ones allowed if 'sandbox_mode' is set to true. NOTES: (Corresponds to the parameters 'script.engine.expression.[file|stored|inline]')
  
  stored object
  
  Enables scripting for the specified type and controls other parameters. Store scripts in indexes (stored), upload in file bundles (file), or use in API requests (inline).
  
  Hide stored attributes Show stored attributes object
  
  enabled boolean
  
  If enabled (default: true) then scripts are enabled, either for sandboxing languages (by default), or for all installed languages if 'sandbox_mode' is disabled (or for 6.x). NOTES: (Corresponds to the parameter 'script.file|stored/indexed|inline')
  
  sandbox_mode boolean
  
  If enabled (default: true) and this script type is enabled, then only the sandbox languages are allowed. By default the sandbox languages are painless, expressions and mustache, but this can be restricted via the 'painless_enabled', 'mustache_enabled' 'expression_enabled' settings.NOTES: Not supported in 6.x. (Corresponds to the parameters 'script.engine.[painless|mustache|expressions].[file|stored|inline]')
  
  file object
  
  Enables scripting for the specified type and controls other parameters. Store scripts in indexes (stored), upload in file bundles (file), or use in API requests (inline).
  
  Hide file attributes Show file attributes object
  
  enabled boolean
  
  If enabled (default: true) then scripts are enabled, either for sandboxing languages (by default), or for all installed languages if 'sandbox_mode' is disabled (or for 6.x). NOTES: (Corresponds to the parameter 'script.file|stored/indexed|inline')
  
  sandbox_mode boolean
  
  If enabled (default: true) and this script type is enabled, then only the sandbox languages are allowed. By default the sandbox languages are painless, expressions and mustache, but this can be restricted via the 'painless_enabled', 'mustache_enabled' 'expression_enabled' settings.NOTES: Not supported in 6.x. (Corresponds to the parameters 'script.engine.[painless|mustache|expressions].[file|stored|inline]')
  
  inline object
  
  Enables scripting for the specified type and controls other parameters. Store scripts in indexes (stored), upload in file bundles (file), or use in API requests (inline).
  
  Hide inline attributes Show inline attributes object
  
  enabled boolean
  
  If enabled (default: true) then scripts are enabled, either for sandboxing languages (by default), or for all installed languages if 'sandbox_mode' is disabled (or for 6.x). NOTES: (Corresponds to the parameter 'script.file|stored/indexed|inline')
  
  sandbox_mode boolean
  
  If enabled (default: true) and this script type is enabled, then only the sandbox languages are allowed. By default the sandbox languages are painless, expressions and mustache, but this can be restricted via the 'painless_enabled', 'mustache_enabled' 'expression_enabled' settings.NOTES: Not supported in 6.x. (Corresponds to the parameters 'script.engine.[painless|mustache|expressions].[file|stored|inline]')
  
  reindex_whitelist array[string]
  
  Limits remote Elasticsearch clusters that can be used as the source for '_reindex' API commands
  
  auto_create_index boolean
  
  If true (the default), then any write operation on an index that does not currently exist will create it. NOTES: (Corresponds to the parameter 'action.auto_create_index')
  
  enable_close_index boolean
  
  Defaults to false on versions <= 7.2.0, true otherwise. If false, then the API commands to close indices are disabled. This is important because Elasticsearch does not snapshot or migrate close indices on versions under 7.2.0, therefore standard Elastic Cloud configuration operations will cause irretrievable loss of indices' data. NOTES: (Corresponds to the parameter 'cluster.indices.close.enable')
  
  destructive_requires_name boolean
  
  If true (default is false) then the index deletion API will not support wildcards or '_all'. NOTES: (Corresponds to the parameter 'action.destructive_requires_name')
  
  watcher_trigger_engine string
  
  The trigger engine for Watcher, defaults to 'scheduler' - see the xpack documentation for more information. NOTES: (Corresponds to the parameter '(xpack.)watcher.trigger.schedule.engine', depending on version. Ignored from 6.x onwards.)
  
  default_shards_per_index integer(int32)
  
  (2.x only - to get the same result in 5.x template mappings must be used) Sets the default number of shards per index, defaulting to 1 if not specified. (Corresponds to the parameter 'index.number_of_shards' in 2.x, not supported in 5.x)
  
  monitoring_collection_interval integer(int32)
  
  The default interval at which monitoring information from the cluster if collected, if monitoring is enabled. NOTES: (Corresponds to the parameter 'marvel.agent.interval' in 2.x and 'xpack.monitoring.collection.interval' in 5.x)
  
  monitoring_history_duration string
  
  The duration for which monitoring history is stored (format '(NUMBER)d' eg '3d' for 3 days). NOTES: ('Corresponds to the parameter xpack.monitoring.history.duration' in 5.x, defaults to '7d')
  
  user_settings_json object
  
  An arbitrary JSON object allowing cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters arey are on the allowlist and not on the denylist. NOTES: (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Elasticsearch settings)
  
  user_settings_yaml string
  
  An arbitrary YAML object allowing cluster owners to set their parameters (only one of this and 'user_settings_json' is allowed), provided the parameters arey are on the allowlist and not on the denylist. NOTES: (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Elasticsearch settings)
  
  user_settings_override_json object
  
  An arbitrary JSON object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), ie in addition to the documented 'system_settings'. NOTES: (This field together with 'system_settings' and 'user_settings*' defines the total set of Elasticsearch settings)
  
  user_settings_override_yaml string
  
  An arbitrary YAML object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_json' is allowed), ie in addition to the documented 'system_settings'. NOTES: (This field together with 'system_settings' and 'user_settings*' defines the total set of Elasticsearch settings)
  
  enabled_built_in_plugins array[string]
  
  A list of plugin names from the Elastic-supported subset that are bundled with the version images. NOTES: (Users should consult the Elastic stack objects to see what plugins are available, this is currently only available from the UI)
  
  user_plugins array[object]
  
  A list of admin-uploaded plugin objects that are available for this user.
  
  A list of admin-uploaded plugin objects.
  
  Hide user_plugins attributes Show user_plugins attributes object
  
  name string Required
  
  The name of the plugin
  
  url string Required
  
  The URL of the plugin (must be accessible from the ECE infrastructure)
  
  elasticsearch_version string Required
  
  The supported Elasticsearch version (must match the version in the plan)
  
  user_bundles array[object]
  
  A list of admin-uploaded bundle objects (eg scripts, synonym files) that are available for this user.
  
  A list of admin-uploaded bundle objects, such as scripts and synonym files.
  
  Hide user_bundles attributes Show user_bundles attributes object
  
  name string Required
  
  The name of the bundle
  
  url string Required
  
  The URL of the bundle, which must be accessible from the ECE infrastructure. This URL could be cached by platform, make sure to change it when updating the bundle
  
  elasticsearch_version string Required
  
  The supported Elasticsearch version (must match the version in the plan)
  
  curation object
  
  The structure that defines the routing settings for index curation.
  
  Hide curation attributes Show curation attributes object
  
  from_instance_configuration_id string Required
  
  The source instance configuration
  
  to_instance_configuration_id string Required
  
  The destination instance configuration
  
  node_attributes object
  
  Defines the Elasticsearch node attributes for the instances in the topology
  
  Hide node_attributes attribute Show node_attributes attribute object
  
  * string Additional properties
  
  deployment_template object
  
  Specifies the deployment template used to create the plan.
  
  Hide deployment_template attributes Show deployment_template attributes object
  
  id string Required
  
  The unique identifier of the deployment template
  
  version string
  
  A version identifier to disambiguate multiple revisions of the same template
  
  transient object
  
  Defines the configuration parameters that control how the plan is applied. For example, the Elasticsearch cluster topology and Elasticsearch settings.
  
  Hide transient attributes Show transient attributes object
  
  strategy object
  
  The options for performing a plan change. Specify only one property each time. The default is grow_and_shrink.
  
  Hide strategy attributes Show strategy attributes object
  
  rolling object
  
  Performs inline, rolling configuration changes that mutate existing containers. TIP: This is the fastest way to update a plan, but can fail for complex plan changes, such as topology changes. Also, this is less safe for configuration changes that leave a cluster in a non running state. NOTE: When you perform a major version upgrade, and 'group_by' is set to 'pass:macros[all]';, rolling is required.
  
  Hide rolling attributes Show rolling attributes object
  
  group_by string
  
  Specifies the grouping attribute to use when rolling several instances. Instances that share the same value for the provided attribute key are rolled together as a unit. Examples that make sense to use are '__all__' (roll all instances as a single unit), 'logical_zone_name' (roll instances by zone), '__name__' (roll one instance at a time, the default if not specified). Note that '__all__' is required when performing a major version upgrade
  
  allow_inline_resize boolean
  
  Whether we allow changing the capacity of instances (default false). This is currently implemented by stopping, re-creating then starting the affected instance on its associated allocator when performing the changes. NOTES: This requires a round-trip through the allocation infrastructure of the active constructor, as it has to reserve the target capacity without over-committing
  
  skip_synced_flush boolean
  
  Whether to skip attempting to do a synced flush on the filesystem of the container (default: false), which is less safe but may be required if the container is unhealthy
  
  shard_init_wait_time integer(int64)
  
  The time, in seconds, to wait for shards that show no progress of initializing before rolling the next group (default: 10 minutes)
  
  grow_and_shrink object
  
  A strategy that creates instances with the new plan, migrates data from the old instances, then shuts down the old instances. GrowShrinkStrategyConfig is safer than 'rolling' and ensures single node availability during a plan change, but can be a lot slower on larger clusters.
  
  rolling_grow_and_shrink object
  
  A strategy that creates new Elasticsearch instances, Kibana instances, and APM Servers with the new plan, then migrates the node data to minimize the amount of spare capacity.
  
  autodetect object
  
  A strategy that lets constructor choose the most optimal way to execute the plan.
  
  plan_configuration object
  
  The configuration settings for the timeout and fallback parameters.
  
  Hide plan_configuration attributes Show plan_configuration attributes object
  
  timeout integer(int64)
  
  The total timeout in seconds after which the plan is cancelled even if it is not complete. Defaults to 4x the max memory capacity per node (in MB). NOTES: A 3 zone cluster with 2 nodes of 2048 each would have a timeout of 4*2048=8192 seconds. Timeout does not include time required to run rollback actions.
  
  calm_wait_time integer(int64)
  
  This timeout determines how long to give a cluster after it responds to API calls before performing actual operations on it. It defaults to 5s
  
  skip_snapshot boolean
  
  If true (default: false), does not take (or require) a successful snapshot to be taken before performing any potentially destructive changes to this cluster
  
  max_snapshot_attempts integer(int32)
  
  If taking a snapshot (ie unless 'skip_snapshots': true) then will retry on failure at most this number of times (default: 5)
  
  max_snapshot_age integer(int64)
  
  When you take a snapshot and 'skip_snapshots' is false, specifies the maximum age in seconds of the most recent snapshot before a new snapshot is created. Default is 300
  
  extended_maintenance boolean
  
  If true (default false), does not clear the maintenance flag (which prevents its API from being accessed except by the constructor) on new instances added until after a snapshot has been restored, otherwise, the maintenance flag is cleared once the new instances successfully join the new cluster
  
  cluster_reboot string
  
  Set to 'forced' to force a reboot as part of the upgrade plan. NOTES: (ie taking an existing plan and leaving it alone except for setting 'transient.plan_configuration.cluster_reboot': 'forced' will reboot the cluster)
  
  Value is forced.
  
  restore_snapshot object
  
  Restores a snapshot from a local or remote repository.
  
  Hide restore_snapshot attributes Show restore_snapshot attributes object
  
  repository_name string
  
  If specified, contains the name of the snapshot repository - else will default to the Elastic Cloud system repo ('found-snapshots')
  
  snapshot_name string Required
  
  The name of the snapshot to restore. Use '__latest_success__' to get the most recent snapshot from the specified repository
  
  repository_config object
  
  Configures the location of a remote repository. The default is the system repository.
  
  Hide repository_config attribute Show repository_config attribute object
  
  raw_settings object
  
  The remote snapshot settings raw JSON - see the Elasticsearch '_snapshot' documentation for more details on supported formats
  
  restore_payload object
  
  The configuration for the restore command, such as which indices you want to restore.
  
  Hide restore_payload attributes Show restore_payload attributes object
  
  indices array[string]
  
  The list of indices to restore (supports +ve and -ve selection and wildcarding - see the default Elasticsearch index format documentation)
  
  raw_settings object
  
  This JSON object (merged with the 'indices' field (if present) is passed untouched into the restore command - see the Elasticsearch '_snapshot' documentation for more details on supported formats
  
  strategy string
  
  The restore strategy to use. Defaults to a full restore. Partial restore will attempt to restore unavailable indices only
  
  Values are partial, full, or recovery.
  
  source_cluster_id string
  
  If specified, contains the name of the source cluster id. Do not send this if you are sending repository_config
  
  remote_clusters object
  
  The list of resources used as remote clusters
  
  Hide remote_clusters attribute Show remote_clusters attribute object
  
  resources array[object] Required
  
  The remote resources
  
  The Elasticsearch resource used as a Remote Cluster.
  
  Hide resources attributes Show resources attributes object
  
  deployment_id string Required
  
  The id of the deployment
  
  elasticsearch_ref_id string Required
  
  The locally-unique user-specified id of an Elasticsearch Resource
  
  alias string Required
  
  The alias for this remote cluster. Aliases must only contain letters, digits, dashes and underscores
  
  skip_unavailable boolean
  
  If true, skip this cluster during search if it is disconnected. Default: false
  
  info object
  
  Information about a Remote Cluster.
  
  Hide info attributes Show info attributes object
  
  healthy boolean Required
  
  Whether or not the remote cluster is healthy
  
  connected boolean Required
  
  Whether or not there is at least one connection to the remote cluster.
  
  compatible boolean Required
  
  Whether or not the remote cluster version is compatible with this cluster version.
  
  trusted boolean Required
  
  Whether or not the remote cluster is trusted by this cluster.
  
  trusted_back boolean Required
  
  Whether or not the remote cluster trusts this cluster back.
  
  cluster_settings_json object
  
  If specified, contains transient settings to be applied to an Elasticsearch cluster during changes,default values shown below applied. These can be overridden by specifying them in the map (or null to unset). Additional settings can also be set. Settings will be cleared after the plan has finished. If not specified, no settings will be applied. NOTE: These settings are only explicitly cleared for 5.x+ clusters, they must be hand-reset to their defaults in 2.x- (or a cluster reboot will clear them).
  
  indices.store.throttle.max_bytes_per_sec: 120Mb
  
  indices.recovery.max_bytes_per_sec: 120Mb
  
  cluster.routing.allocation.cluster_concurrent_rebalance: 5
  
  cluster.routing.allocation.node_initial_primaries_recoveries: 5
  
  cluster.routing.allocation.node_concurrent_incoming_recoveries: 5 For version 8.1 and later no defaults are provided through this mechanism, but instead hardware dependent settings are provided to each instance.
  
  autoscaling_enabled boolean
  
  Enable autoscaling for this Elasticsearch cluster.
  
  settings object
  
  The settings for an Elasticsearch cluster.
  
  Hide settings attributes Show settings attributes object
  
  snapshot object
  
  The snapshot configuration settings for an Elasticsearch cluster.
  
  Hide snapshot attributes Show snapshot attributes object
  
  interval string
  
  Interval between snapshots, with the format 'length unit' (space is optional), where unit can be one of: d (day), h (hour), min (minute). Default is 30 minutes
  
  retention object
  
  Information about the Elasticsearch cluster snapshot retention.
  
  Hide retention attributes Show retention attributes object
  
  snapshots integer(int32)
  
  Number of snapshots to retain
  
  max_age string
  
  Total retention period for all snapshots, with the format 'length unit' (space is optional), where unit can be one of: d (day), h (hour), min (minute)
  
  cron_expression string
  
  Cron expression indicating when should snapshots be taken. This can be enabled only if SLM is enabled for the deployment and 'interval' is not present
  
  monitoring object
  
  The settings for sending monitoring information to another cluster.
  
  Hide monitoring attribute Show monitoring attribute object
  
  target_cluster_id string Required
  
  The Id of the target cluster to which to send monitoring information
  
  metadata object
  
  The top-level configuration settings for the Elasticsearch cluster.
  
  Hide metadata attribute Show metadata attribute object
  
  name string
  
  The display name of the cluster
  
  curation object
  
  The index curation settings for an Elasticsearch cluster.
  
  Hide curation attribute Show curation attribute object
  
  specs array[object] Required
  
  Specifications for curation
  
  Specifies the conditions to trigger an Elasticsearch cluster curation.
  
  Hide specs attributes Show specs attributes object
  
  index_pattern string Required
  
  Index matching pattern
  
  trigger_interval_seconds integer(int32) Required
  
  Number of seconds after index creation to trigger this spec
  
  dedicated_masters_threshold integer(int32)
  
  Threshold starting from which the number of instances in the cluster results in the introduction of dedicated masters. If the cluster is downscaled to a number of nodes below this one, dedicated masters will be removed. Limit is inclusive. When provided the threshold setting is updated. A null value removes the field. Otherwise, the setting remains as it was set previously.
  
  traffic_filter object
  
  The configuration settings for the traffic filter.
  
  Hide traffic_filter attribute Show traffic_filter attribute object
  
  rulesets array[string] Required
  
  IDs of the traffic filter rulesets
  
  trust object
  
  Configuration of trust with other clusters.
  
  Hide trust attributes Show trust attributes object
  
  accounts array[object]
  
  The list of trust relationships with different accounts
  
  The trust relationship with the clusters of one account.
  
  Hide accounts attributes Show accounts attributes object
  
  account_id string Required
  
  the ID of the Account
  
  name string
  
  A human readable name of the trust relationship
  
  trust_all boolean Required
  
  If true, all clusters in this account will by default be trusted and the trust_allowlist is ignored.
  
  trust_allowlist array[string]
  
  The list of clusters to trust. Only used when trust_all is false.
  
  external array[object]
  
  The list of trust relationships with external entities
  
  The trust relationship with external entities (remote environments, remote accounts...).
  
  Hide external attributes Show external attributes object
  
  trust_relationship_id string Required
  
  The ID of the external trust relationship
  
  name string
  
  The name of the external trust relationship. Retrieved from the TrustRelationship and ignored on write.
  
  trust_all boolean Required
  
  If true, all clusters in this external entity will be trusted and the trust_allowlist is ignored.
  
  trust_allowlist array[string]
  
  The list of clusters to trust. Only used when trust_all is false.
  
  direct array[object]
  
  The list of trust relationships where the certificate is bundled with the trust setting. Allows configuring trust for clusters running outside of an Elastic Cloud managed environment or in an Elastic Cloud environment without an environment level trust established.
  
  The trust relationship with entities trusted directly having their certificate bundled together with the trust settings.
  
  Hide direct attributes Show direct attributes object
  
  uid string
  
  Auto generated identifier for this trust, allows distinguishing between update vs remove and add.
  
  name string Required
  
  a human readable name of the trust relationship
  
  type string
  
  The type can either be ESS, ECE, generic or proxy. If none is specified, then generic is assumed. If proxy is specified, trust_all should be false and trust_allowlist, scope_id and additional_node_names should be omitted.
  
  Values are ECE, ESS, generic, or proxy.
  
  trust_all boolean Required
  
  If true, scope_id is required and the trust_allowlist is ignored and all clusters matching the scope id will be trusted.
  
  trust_allowlist array[string]
  
  The list of clusters with matching scope to trust. Only used when trust_all is false. Providing one or more clusters makes scope_id mandatory.
  
  scope_id string
  
  A lowercase alphanumerical string of max 32 characters. Usually an organization id or an environment id, but could really be any suitable suffix for clusters using the CA certificate of this trust. Required unless trust_all is false and trust_allowlist is empty.
  
  additional_node_names array[string]
  
  A list of node names trusted in addition to those deducible from trust_allowlist and scope id. Allows trusting nodes that don't have a scoped name at the cost of maintaining the list. Mandatory if scope id is not defined. Wildcards are not allowed.
  
  certificates array[object] Required
  
  The public ca certificate(s) to trust. Only one is required, but it is possible to specify multiple certificates in order to facilitate key rotation.
  
  An x509 certificate used by a DirectTrustRelationship
  
  Hide certificates attributes Show certificates attributes object
  
  pem string Required
  
  The public ca certificate as string in PEM format.
  
  metadata object
  
  The certificate MetaData
  
  Hide metadata attributes Show metadata attributes object
  
  fingerprint string Required
  
  The fingerprint of the certificate
  
  valid_to string(date-time) Required
  
  The expiry date of the certificate in UTC
  
  valid_from string(date-time) Required
  
  The valid from date of the certificate in UTC
  
  also_trusted_by array[string]
  
  Other deployments also trusting this certificate
  
  keystore_contents object
  
  The contents of the Elasticsearch keystore.
  
  Hide keystore_contents attribute Show keystore_contents attribute object
  
  secrets object Required
  
  List of secrets
  
  Hide secrets attribute Show secrets attribute object
  
  * object Additional properties
  
  The value that you configure for the Elasticsearch keystore secret.
  
  Hide * attributes Show * attributes object
  
  value object
  
  Value of this setting. This can either be a string or a JSON object that is stored as a JSON string in the keystore. NOTE: When the keystore secret is unspecified, it is removed.
  
  as_file boolean
  
  Stores the keystore secret as a file. The default is false, which stores the keystore secret as string when value is a plain string, or true when value is an object.
- kibana array[object]
  
  A list of payloads for Kibana updates
  
  A Kibana creation request paired with the alias of the Elasticsearch cluster it should be paired with
  Hide kibana attributes Show kibana attributes object
  
  ref_id string Required
  
  A locally-unique user-specified id for Kibana
  
  elasticsearch_cluster_ref_id string Required
  
  Alias to the Elasticsearch Cluster to attach Kibana to
  
  display_name string
  
  The human readable name for the Kibana cluster (default: takes the name of its Elasticsearch cluster)
  
  region string Required
  
  The region where this resource exists
  
  plan object Required
  
  The plan for the Kibana instance.
  
  Hide plan attributes Show plan attributes object
  
  cluster_topology array[object]
  
  The topology of the Kibana nodes, including the number, capacity, and type of nodes, and where they can be allocated.
  
  Hide cluster_topology attributes Show cluster_topology attributes object
  
  instance_configuration_id string
  
  Controls the allocation of this topology element as well as allowed sizes and node_types. It needs to match the id of an existing instance configuration.
  
  instance_configuration_version integer(int32)
  
  The version of the Instance Configuration Id. If it is unset, the meaning depends on read vs writes. For deployment reads, it is equivalent to version 0 (or the IC is unversioned); for deployment creates and deployment template use, it is equivalent to 'the latest version'; and for deployment updates, it is equivalent to 'retain the current version'.
  
  size object
  
  Measured by the amount of a resource. The final cluster size is calculated using multipliers from the topology instance configuration.
  
  Hide size attributes Show size attributes object
  
  value integer(int32) Required
  
  Amount of resource
  
  resource string Required
  
  Type of resource. In ESS the resource used should always be memory.
  
  Values are memory or storage.
  
  zone_count integer(int32)
  
  number of zones in which nodes will be placed
  
  kibana object
  
  The Kibana instance settings. When specified at the top level, provides a field-by-field default. When specified at the topology level, provides the override settings.
  
  Hide kibana attributes Show kibana attributes object
  
  version string
  
  The version of the Kibana cluster (must be one of the ECE supported versions, and won't work unless it matches the Elasticsearch version. Leave blank to auto-detect version.)
  
  docker_image string
  
  A docker URI that allows overriding of the default docker image specified for this version
  
  system_settings object
  
  A subset of Kibana settings. TIP: To define the complete set of Elasticsearch settings, use KibanaSystemSettings with user_settings_override_ and user_settings_.
  
  Hide system_settings attributes Show system_settings attributes object
  
  elasticsearch_username string
  
  Optionally override the account within Elasticsearch - defaults to a system account that always exists (if specified, the password must also be specified). Note that this field is never returned from the API, it is write only.
  
  elasticsearch_password string
  
  Optionally override the account within Elasticsearch - defaults to a system account that always exists (if specified, the username must also be specified). Note that this field is never returned from the API, it is write only.
  
  user_settings_json object
  
  An arbitrary JSON object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters are on the allowlist and not on the denylist. (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Kibana settings)
  
  user_settings_yaml string
  
  An arbitrary YAML object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_json' is allowed), provided the parameters are on the allowlist and not on the denylist. (These field together with 'user_settings_override*' and 'system_settings' defines the total set of Kibana settings)
  
  user_settings_override_json object
  
  An arbitrary JSON object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Kibana settings)
  
  user_settings_override_yaml string
  
  An arbitrary YAML object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_json' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Kibana settings)
  
  kibana object Required
  
  The Kibana instance settings. When specified at the top level, provides a field-by-field default. When specified at the topology level, provides the override settings.
  
  Hide kibana attributes Show kibana attributes object
  
  version string
  
  The version of the Kibana cluster (must be one of the ECE supported versions, and won't work unless it matches the Elasticsearch version. Leave blank to auto-detect version.)
  
  docker_image string
  
  A docker URI that allows overriding of the default docker image specified for this version
  
  system_settings object
  
  A subset of Kibana settings. TIP: To define the complete set of Elasticsearch settings, use KibanaSystemSettings with user_settings_override_ and user_settings_.
  
  Hide system_settings attributes Show system_settings attributes object
  
  elasticsearch_username string
  
  Optionally override the account within Elasticsearch - defaults to a system account that always exists (if specified, the password must also be specified). Note that this field is never returned from the API, it is write only.
  
  elasticsearch_password string
  
  Optionally override the account within Elasticsearch - defaults to a system account that always exists (if specified, the username must also be specified). Note that this field is never returned from the API, it is write only.
  
  user_settings_json object
  
  An arbitrary JSON object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters are on the allowlist and not on the denylist. (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Kibana settings)
  
  user_settings_yaml string
  
  An arbitrary YAML object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_json' is allowed), provided the parameters are on the allowlist and not on the denylist. (These field together with 'user_settings_override*' and 'system_settings' defines the total set of Kibana settings)
  
  user_settings_override_json object
  
  An arbitrary JSON object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Kibana settings)
  
  user_settings_override_yaml string
  
  An arbitrary YAML object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_json' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Kibana settings)
  
  transient object
  
  Defines the configuration parameters that control how the plan is applied. For example, the Elasticsearch cluster topology and Kibana instance settings.
  
  Hide transient attributes Show transient attributes object
  
  strategy object
  
  The options for performing a plan change. Specify only one property each time. The default is grow_and_shrink.
  
  Hide strategy attributes Show strategy attributes object
  
  rolling object
  
  Performs inline, rolling configuration changes that mutate existing containers. TIP: This is the fastest way to update a plan, but can fail for complex plan changes, such as topology changes. Also, this is less safe for configuration changes that leave a cluster in a non running state. NOTE: When you perform a major version upgrade, and 'group_by' is set to 'pass:macros[all]';, rolling is required.
  
  Hide rolling attributes Show rolling attributes object
  
  group_by string
  
  Specifies the grouping attribute to use when rolling several instances. Instances that share the same value for the provided attribute key are rolled together as a unit. Examples that make sense to use are '__all__' (roll all instances as a single unit), 'logical_zone_name' (roll instances by zone), '__name__' (roll one instance at a time, the default if not specified). Note that '__all__' is required when performing a major version upgrade
  
  allow_inline_resize boolean
  
  Whether we allow changing the capacity of instances (default false). This is currently implemented by stopping, re-creating then starting the affected instance on its associated allocator when performing the changes. NOTES: This requires a round-trip through the allocation infrastructure of the active constructor, as it has to reserve the target capacity without over-committing
  
  skip_synced_flush boolean
  
  Whether to skip attempting to do a synced flush on the filesystem of the container (default: false), which is less safe but may be required if the container is unhealthy
  
  shard_init_wait_time integer(int64)
  
  The time, in seconds, to wait for shards that show no progress of initializing before rolling the next group (default: 10 minutes)
  
  grow_and_shrink object
  
  A strategy that creates instances with the new plan, migrates data from the old instances, then shuts down the old instances. GrowShrinkStrategyConfig is safer than 'rolling' and ensures single node availability during a plan change, but can be a lot slower on larger clusters.
  
  rolling_grow_and_shrink object
  
  A strategy that creates new Elasticsearch instances, Kibana instances, and APM Servers with the new plan, then migrates the node data to minimize the amount of spare capacity.
  
  autodetect object
  
  A strategy that lets constructor choose the most optimal way to execute the plan.
  
  plan_configuration object
  
  The configuration settings for the timeout and fallback parameters.
  
  Hide plan_configuration attributes Show plan_configuration attributes object
  
  timeout integer(int64)
  
  The total timeout in seconds after which the plan is cancelled even if it is not complete. Defaults to 4x the max memory capacity per node (in MB)
  
  calm_wait_time integer(int64)
  
  This timeout determines how long to give a cluster after it responds to API calls before performing actual operations on it. It defaults to 5s
  
  extended_maintenance boolean
  
  If true (default false), does not clear the maintenance flag (which prevents its API from being accessed except by the constructor) on new instances added until after a snapshot has been restored, otherwise, the maintenance flag is cleared once the new instances successfully join the new cluster
  
  cluster_reboot string
  
  Set to 'forced' to force a reboot as part of the upgrade plan
  
  Value is forced.
  
  settings object
  
  The settings for multiple Kibana instances.
  
  Hide settings attribute Show settings attribute object
  
  metadata object
  
  The top-level configuration settings for the Elasticsearch cluster.
  
  Hide metadata attribute Show metadata attribute object
  
  name string
  
  The display name of the cluster
- apm array[object]
  
  A list of payloads for APM updates
  
  An APM creation request paired with the alias of the Elasticsearch cluster it should be paired with
  Hide apm attributes Show apm attributes object
  
  ref_id string Required
  
  A locally-unique user-specified id for APM
  
  elasticsearch_cluster_ref_id string Required
  
  Alias to the Elasticsearch Cluster to attach APM to
  
  display_name string
  
  The human readable name for the APM cluster (default: takes the name of its Elasticsearch cluster)
  
  region string Required
  
  The region where this resource exists
  
  plan object Required
  
  The plan for the APM Server.
  
  Hide plan attributes Show plan attributes object
  
  cluster_topology array[object]
  
  Defines the topology of the APM Server nodes. For example, the number or capacity of the nodes, and where you can allocate the nodes.
  
  Hide cluster_topology attributes Show cluster_topology attributes object
  
  instance_configuration_id string
  
  Controls the allocation of this topology element as well as allowed sizes and node_types. It needs to match the id of an existing instance configuration.
  
  instance_configuration_version integer(int32)
  
  The version of the Instance Configuration Id. If it is unset, the meaning depends on read vs writes. For deployment reads, it is equivalent to version 0 (or the IC is unversioned); for deployment creates and deployment template use, it is equivalent to 'the latest version'; and for deployment updates, it is equivalent to 'retain the current version'.
  
  size object
  
  Measured by the amount of a resource. The final cluster size is calculated using multipliers from the topology instance configuration.
  
  Hide size attributes Show size attributes object
  
  value integer(int32) Required
  
  Amount of resource
  
  resource string Required
  
  Type of resource. In ESS the resource used should always be memory.
  
  Values are memory or storage.
  
  zone_count integer(int32)
  
  number of zones in which nodes will be placed
  
  apm object
  
  The configuration options for the APM Server.
  
  Hide apm attributes Show apm attributes object
  
  version string
  
  The version of the Apm cluster (must be one of the ECE supported versions, and won't work unless it matches the APM version. Leave blank to auto-detect version.)
  
  docker_image string
  
  A docker URI that allows overriding of the default docker image specified for this version
  
  system_settings object
  
  A structure that defines a curated subset of the APM Server settings. TIP: To define the complete set of APM Server setting, use ApmSystemSettings with user_settings_override_ and user_settings_.
  
  Hide system_settings attributes Show system_settings attributes object
  
  elasticsearch_username string
  
  Optionally override the account within APM - defaults to a system account that always exists (if specified, the password must also be specified). Note that this field is never returned from the API, it is write only.
  
  elasticsearch_password string
  
  Optionally override the account within APM - defaults to a system account that always exists (if specified, the username must also be specified). Note that this field is never returned from the API, it is write only.
  
  secret_token string
  
  Optionally override the secret token within APM - defaults to the previously existing secretToken
  
  debug_enabled boolean
  
  Optionally enable debug mode for APM servers - defaults false
  
  user_settings_json object
  
  An arbitrary JSON object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters are on the allowlist and not on the denylist. (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Apm settings)
  
  user_settings_yaml string
  
  An arbitrary YAML object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_json' is allowed), provided the parameters are on the allowlist and not on the denylist. (These field together with 'user_settings_override*' and 'system_settings' defines the total set of Apm settings)
  
  user_settings_override_json object
  
  An arbitrary JSON object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Apm settings)
  
  user_settings_override_yaml string
  
  An arbitrary YAML object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_json' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Apm settings)
  
  apm object Required
  
  The configuration options for the APM Server.
  
  Hide apm attributes Show apm attributes object
  
  version string
  
  The version of the Apm cluster (must be one of the ECE supported versions, and won't work unless it matches the APM version. Leave blank to auto-detect version.)
  
  docker_image string
  
  A docker URI that allows overriding of the default docker image specified for this version
  
  system_settings object
  
  A structure that defines a curated subset of the APM Server settings. TIP: To define the complete set of APM Server setting, use ApmSystemSettings with user_settings_override_ and user_settings_.
  
  Hide system_settings attributes Show system_settings attributes object
  
  elasticsearch_username string
  
  Optionally override the account within APM - defaults to a system account that always exists (if specified, the password must also be specified). Note that this field is never returned from the API, it is write only.
  
  elasticsearch_password string
  
  Optionally override the account within APM - defaults to a system account that always exists (if specified, the username must also be specified). Note that this field is never returned from the API, it is write only.
  
  secret_token string
  
  Optionally override the secret token within APM - defaults to the previously existing secretToken
  
  debug_enabled boolean
  
  Optionally enable debug mode for APM servers - defaults false
  
  user_settings_json object
  
  An arbitrary JSON object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters are on the allowlist and not on the denylist. (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Apm settings)
  
  user_settings_yaml string
  
  An arbitrary YAML object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_json' is allowed), provided the parameters are on the allowlist and not on the denylist. (These field together with 'user_settings_override*' and 'system_settings' defines the total set of Apm settings)
  
  user_settings_override_json object
  
  An arbitrary JSON object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Apm settings)
  
  user_settings_override_yaml string
  
  An arbitrary YAML object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_json' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Apm settings)
  
  transient object
  
  Defines the configuration parameters that control how the plan is applied. For example, the Elasticsearch cluster topology and APM Server settings.
  
  Hide transient attributes Show transient attributes object
  
  strategy object
  
  The options for performing a plan change. Specify only one property each time. The default is grow_and_shrink.
  
  Hide strategy attributes Show strategy attributes object
  
  rolling object
  
  Performs inline, rolling configuration changes that mutate existing containers. TIP: This is the fastest way to update a plan, but can fail for complex plan changes, such as topology changes. Also, this is less safe for configuration changes that leave a cluster in a non running state. NOTE: When you perform a major version upgrade, and 'group_by' is set to 'pass:macros[all]';, rolling is required.
  
  Hide rolling attributes Show rolling attributes object
  
  group_by string
  
  Specifies the grouping attribute to use when rolling several instances. Instances that share the same value for the provided attribute key are rolled together as a unit. Examples that make sense to use are '__all__' (roll all instances as a single unit), 'logical_zone_name' (roll instances by zone), '__name__' (roll one instance at a time, the default if not specified). Note that '__all__' is required when performing a major version upgrade
  
  allow_inline_resize boolean
  
  Whether we allow changing the capacity of instances (default false). This is currently implemented by stopping, re-creating then starting the affected instance on its associated allocator when performing the changes. NOTES: This requires a round-trip through the allocation infrastructure of the active constructor, as it has to reserve the target capacity without over-committing
  
  skip_synced_flush boolean
  
  Whether to skip attempting to do a synced flush on the filesystem of the container (default: false), which is less safe but may be required if the container is unhealthy
  
  shard_init_wait_time integer(int64)
  
  The time, in seconds, to wait for shards that show no progress of initializing before rolling the next group (default: 10 minutes)
  
  grow_and_shrink object
  
  A strategy that creates instances with the new plan, migrates data from the old instances, then shuts down the old instances. GrowShrinkStrategyConfig is safer than 'rolling' and ensures single node availability during a plan change, but can be a lot slower on larger clusters.
  
  rolling_grow_and_shrink object
  
  A strategy that creates new Elasticsearch instances, Kibana instances, and APM Servers with the new plan, then migrates the node data to minimize the amount of spare capacity.
  
  autodetect object
  
  A strategy that lets constructor choose the most optimal way to execute the plan.
  
  plan_configuration object
  
  The plan control configuration options for the APM Server.
  
  Hide plan_configuration attributes Show plan_configuration attributes object
  
  timeout integer(int64)
  
  The total timeout in seconds after which the plan is cancelled even if it is not complete. Defaults to 4x the max memory capacity per node (in MB)
  
  calm_wait_time integer(int64)
  
  This timeout determines how long to give a cluster after it responds to API calls before performing actual operations on it. It defaults to 5s
  
  extended_maintenance boolean
  
  If true (default false), does not clear the maintenance flag (which prevents its API from being accessed except by the constructor) on new instances added until after a snapshot has been restored, otherwise, the maintenance flag is cleared once the new instances successfully join the new cluster
  
  cluster_reboot string
  
  Set to 'forced' to force a reboot as part of the upgrade plan
  
  Value is forced.
  
  settings object
  
  The settings for the APM Server.
  
  Hide settings attribute Show settings attribute object
  
  metadata object
  
  The top-level configuration settings for the Elasticsearch cluster.
  
  Hide metadata attribute Show metadata attribute object
  
  name string
  
  The display name of the cluster
- appsearch array[object]
  
  A list of payloads for AppSearch updates. AppSearch has been replaced by Enterprise Search in the Elastic Stack 7.7 and higher
  
  An AppSearch creation request paired with the alias of the Elasticsearch cluster it should be paired with
  Hide appsearch attributes Show appsearch attributes object
  
  ref_id string Required
  
  A locally-unique user-specified id for AppSearch
  
  elasticsearch_cluster_ref_id string Required
  
  Alias to the Elasticsearch Cluster to attach AppSearch to
  
  display_name string
  
  The human readable name for the AppSearch cluster (default: takes the name of its Elasticsearch cluster)
  
  region string Required
  
  The region where this resource exists
  
  plan object Required
  
  The plan for the App Search cluster.
  
  Hide plan attributes Show plan attributes object
  
  cluster_topology array[object]
  
  Defines the topology of the AppSearch nodes (eg number/capacity of nodes, and where they can be allocated)
  
  Hide cluster_topology attributes Show cluster_topology attributes object
  
  node_type object
  
  Node types to enable for an AppSearch instance
  
  Hide node_type attributes Show node_type attributes object
  
  appserver boolean Required
  
  Defines whether this instance should run as Application/API server
  
  worker boolean Required
  
  Defines whether this instance should run as background worker
  
  instance_configuration_id string
  
  Controls the allocation of this topology element as well as allowed sizes and node_types. It needs to match the id of an existing instance configuration.
  
  instance_configuration_version integer(int32)
  
  The version of the Instance Configuration Id. If it is unset, the meaning depends on read vs writes. For deployment reads, it is equivalent to version 0 (or the IC is unversioned); for deployment creates and deployment template use, it is equivalent to 'the latest version'; and for deployment updates, it is equivalent to 'retain the current version'.
  
  size object
  
  Measured by the amount of a resource. The final cluster size is calculated using multipliers from the topology instance configuration.
  
  Hide size attributes Show size attributes object
  
  value integer(int32) Required
  
  Amount of resource
  
  resource string Required
  
  Type of resource. In ESS the resource used should always be memory.
  
  Values are memory or storage.
  
  zone_count integer(int32)
  
  number of zones in which nodes will be placed
  
  appsearch object
  
  Hide appsearch attributes Show appsearch attributes object
  
  version string
  
  The version of the AppSearch cluster (must be one of the ECE supported versions, and won't work unless it matches the Elasticsearch version. Leave blank to auto-detect version.)
  
  docker_image string
  
  A docker URI that allows overriding of the default docker image specified for this version
  
  system_settings object
  
  This structure defines a curated subset of the AppSearch settings. (This field together with 'user_settings_override*' and 'user_settings*' defines the total set of AppSearch settings)
  
  Hide system_settings attributes Show system_settings attributes object
  
  elasticsearch_url string
  
  Optionally override the URL to which to send data (for advanced users only, if unspecified the system selects an internal URL)
  
  elasticsearch_username string
  
  Optionally override the account within App Search - defaults to a system account that always exists (if specified, the password must also be specified). Note that this field is never returned from the API, it is write only.
  
  elasticsearch_password string
  
  Optionally override the account within App Search - defaults to a system account that always exists (if specified, the username must also be specified). Note that this field is never returned from the API, it is write only.
  
  secret_session_key string
  
  Optionally override the secret session key within App Search - defaults to the previously existing secretSession. Note that this field is never returned from the API, it is write only.
  
  user_settings_json object
  
  An arbitrary JSON object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters are on the allowlist and not on the denylist. (This field together with 'user_settings_override*' and 'system_settings' defines the total set of AppSearch settings)
  
  user_settings_yaml string
  
  An arbitrary YAML object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_json' is allowed), provided the parameters are on the allowlist and not on the denylist. (These field together with 'user_settings_override*' and 'system_settings' defines the total set of AppSearch settings)
  
  user_settings_override_json object
  
  An arbitrary JSON object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of AppSearch settings)
  
  user_settings_override_yaml string
  
  An arbitrary YAML object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_json' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of AppSearch settings)
  
  appsearch object Required
  
  Hide appsearch attributes Show appsearch attributes object
  
  version string
  
  The version of the AppSearch cluster (must be one of the ECE supported versions, and won't work unless it matches the Elasticsearch version. Leave blank to auto-detect version.)
  
  docker_image string
  
  A docker URI that allows overriding of the default docker image specified for this version
  
  system_settings object
  
  This structure defines a curated subset of the AppSearch settings. (This field together with 'user_settings_override*' and 'user_settings*' defines the total set of AppSearch settings)
  
  Hide system_settings attributes Show system_settings attributes object
  
  elasticsearch_url string
  
  Optionally override the URL to which to send data (for advanced users only, if unspecified the system selects an internal URL)
  
  elasticsearch_username string
  
  Optionally override the account within App Search - defaults to a system account that always exists (if specified, the password must also be specified). Note that this field is never returned from the API, it is write only.
  
  elasticsearch_password string
  
  Optionally override the account within App Search - defaults to a system account that always exists (if specified, the username must also be specified). Note that this field is never returned from the API, it is write only.
  
  secret_session_key string
  
  Optionally override the secret session key within App Search - defaults to the previously existing secretSession. Note that this field is never returned from the API, it is write only.
  
  user_settings_json object
  
  An arbitrary JSON object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters are on the allowlist and not on the denylist. (This field together with 'user_settings_override*' and 'system_settings' defines the total set of AppSearch settings)
  
  user_settings_yaml string
  
  An arbitrary YAML object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_json' is allowed), provided the parameters are on the allowlist and not on the denylist. (These field together with 'user_settings_override*' and 'system_settings' defines the total set of AppSearch settings)
  
  user_settings_override_json object
  
  An arbitrary JSON object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of AppSearch settings)
  
  user_settings_override_yaml string
  
  An arbitrary YAML object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_json' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of AppSearch settings)
  
  transient object
  
  Defines configuration parameters that control how the plan (ie consisting of the cluster topology and AppSearch settings) is applied
  
  Hide transient attributes Show transient attributes object
  
  strategy object
  
  The options for performing a plan change. Specify only one property each time. The default is grow_and_shrink.
  
  Hide strategy attributes Show strategy attributes object
  
  rolling object
  
  Performs inline, rolling configuration changes that mutate existing containers. TIP: This is the fastest way to update a plan, but can fail for complex plan changes, such as topology changes. Also, this is less safe for configuration changes that leave a cluster in a non running state. NOTE: When you perform a major version upgrade, and 'group_by' is set to 'pass:macros[all]';, rolling is required.
  
  Hide rolling attributes Show rolling attributes object
  
  group_by string
  
  Specifies the grouping attribute to use when rolling several instances. Instances that share the same value for the provided attribute key are rolled together as a unit. Examples that make sense to use are '__all__' (roll all instances as a single unit), 'logical_zone_name' (roll instances by zone), '__name__' (roll one instance at a time, the default if not specified). Note that '__all__' is required when performing a major version upgrade
  
  allow_inline_resize boolean
  
  Whether we allow changing the capacity of instances (default false). This is currently implemented by stopping, re-creating then starting the affected instance on its associated allocator when performing the changes. NOTES: This requires a round-trip through the allocation infrastructure of the active constructor, as it has to reserve the target capacity without over-committing
  
  skip_synced_flush boolean
  
  Whether to skip attempting to do a synced flush on the filesystem of the container (default: false), which is less safe but may be required if the container is unhealthy
  
  shard_init_wait_time integer(int64)
  
  The time, in seconds, to wait for shards that show no progress of initializing before rolling the next group (default: 10 minutes)
  
  grow_and_shrink object
  
  A strategy that creates instances with the new plan, migrates data from the old instances, then shuts down the old instances. GrowShrinkStrategyConfig is safer than 'rolling' and ensures single node availability during a plan change, but can be a lot slower on larger clusters.
  
  rolling_grow_and_shrink object
  
  A strategy that creates new Elasticsearch instances, Kibana instances, and APM Servers with the new plan, then migrates the node data to minimize the amount of spare capacity.
  
  autodetect object
  
  A strategy that lets constructor choose the most optimal way to execute the plan.
  
  plan_configuration object
  
  Hide plan_configuration attributes Show plan_configuration attributes object
  
  timeout integer(int64)
  
  The total timeout in seconds after which the plan is cancelled even if it is not complete. Defaults to 4x the max memory capacity per node (in MB)
  
  calm_wait_time integer(int64)
  
  This timeout determines how long to give a cluster after it responds to API calls before performing actual operations on it. It defaults to 5s
  
  move_instances array[object]
  
  The request that specifies the Elasticsearch or stateless (eg Kibana) instances to move to allocators as part of the upgrade plan. When used in conjunction with '__all__' (roll all instances as a single unit) strategy, these instances are not restarted, which can sometimes enable recovery plans when these instances are boot-looping.
  
  Hide move_instances attributes Show move_instances attributes object
  
  from string Required
  
  The instance id that is going to be moved
  
  to array[string]
  
  An optional list of allocator ids to which the instance should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)
  
  instance_down boolean
  
  Tells the infrastructure that the instance should be considered as permanently down when deciding how to migrate data to new nodes. If left blank then the system will automatically decide (currently: will treat the instances as up)
  
  move_allocators array[object]
  
  As part of the upgrade plan, identifies the move requests for the Kibana instances or APM Servers on the allocators.
  
  Hide move_allocators attributes Show move_allocators attributes object
  
  from string Required
  
  The allocator id off which all instances in the cluster should be moved
  
  to array[string]
  
  An optional list of allocator ids to which the instance(s) should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)
  
  allocator_down boolean
  
  Tells the infrastructure that all instances on the allocator should be considered as permanently down when deciding how to migrate data to new nodes. If left blank then the system will auto-decide (currently: will treat the allocator as up)
  
  reallocate_instances boolean
  
  If true (default: false) does not allow re-using any existing instances currently in the cluster, ie even unchanged instances will be re-created
  
  preferred_allocators array[string]
  
  List of allocators on which instances are placed if possible (if not possible/not specified then any available allocator with space is used)
  
  extended_maintenance boolean
  
  If true (default false), does not clear the maintenance flag (which prevents its API from being accessed except by the constructor) on new instances added until after a snapshot has been restored, otherwise, the maintenance flag is cleared once the new instances successfully join the new cluster
  
  cluster_reboot string
  
  Set to 'forced' to force a reboot as part of the upgrade plan
  
  Value is forced.
  
  settings object
  
  The settings for the App Search.
  
  Hide settings attribute Show settings attribute object
  
  metadata object
  
  The top-level configuration settings for the Elasticsearch cluster.
  
  Hide metadata attribute Show metadata attribute object
  
  name string
  
  The display name of the cluster
- enterprise_search array[object]
  
  A list of payloads for Enterprise Search updates
  
  An Enterprise Search creation request paired with the alias of the Elasticsearch cluster it should be paired with
  Hide enterprise_search attributes Show enterprise_search attributes object
  
  ref_id string Required
  
  A locally-unique user-specified id for Enterprise Search
  
  elasticsearch_cluster_ref_id string Required
  
  Alias to the Elasticsearch Cluster to attach Enterprise Search to
  
  display_name string
  
  The human readable name for the Enterprise Search cluster (default: takes the name of its Elasticsearch cluster)
  
  region string Required
  
  The region where this resource exists
  
  plan object Required
  
  The plan for the Enterprise Search cluster.
  
  Hide plan attributes Show plan attributes object
  
  cluster_topology array[object]
  
  Defines the topology of the Enterprise Search nodes (e.g. number/capacity of nodes, and where they can be allocated)
  
  Hide cluster_topology attributes Show cluster_topology attributes object
  
  node_type object
  
  Node types to enable for an Enterprise Search instance
  
  Hide node_type attributes Show node_type attributes object
  
  appserver boolean Required
  
  Defines whether this instance should run as Application/API server
  
  worker boolean Required
  
  Defines whether this instance should run as background worker
  
  connector boolean Required
  
  Defines whether this instance should run as Connector
  
  instance_configuration_id string
  
  Controls the allocation of this topology element as well as allowed sizes and node_types. It needs to match the id of an existing instance configuration.
  
  instance_configuration_version integer(int32)
  
  The version of the Instance Configuration Id. If it is unset, the meaning depends on read vs writes. For deployment reads, it is equivalent to version 0 (or the IC is unversioned); for deployment creates and deployment template use, it is equivalent to 'the latest version'; and for deployment updates, it is equivalent to 'retain the current version'.
  
  size object
  
  Measured by the amount of a resource. The final cluster size is calculated using multipliers from the topology instance configuration.
  
  Hide size attributes Show size attributes object
  
  value integer(int32) Required
  
  Amount of resource
  
  resource string Required
  
  Type of resource. In ESS the resource used should always be memory.
  
  Values are memory or storage.
  
  zone_count integer(int32)
  
  number of zones in which nodes will be placed
  
  enterprise_search object
  
  Hide enterprise_search attributes Show enterprise_search attributes object
  
  version string
  
  The version of the Enterprise Search cluster (must be one of the ECE supported versions, and won't work unless it matches the Elasticsearch version. Leave blank to auto-detect version.)
  
  docker_image string
  
  A docker URI that allows overriding of the default docker image specified for this version
  
  system_settings object
  
  This structure defines a curated subset of the Enterprise Search settings. (This field together with 'user_settings_override*' and 'user_settings*' defines the total set of Enterprise Search settings)
  
  Hide system_settings attributes Show system_settings attributes object
  
  elasticsearch_username string
  
  Optionally override the account within Enterprise Search - defaults to a system account that always exists (if specified, the password must also be specified). Note that this field is never returned from the API, it is write only.
  
  elasticsearch_password string
  
  Optionally override the account within Enterprise Search - defaults to a system account that always exists (if specified, the username must also be specified). Note that this field is never returned from the API, it is write only.
  
  secret_session_key string
  
  Optionally override the secret session key within Enterprise Search - defaults to the previously existing secretSession. Note that this field is never returned from the API, it is write only.
  
  user_settings_json object
  
  An arbitrary JSON object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters are on the allowlist and not on the denylist. (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Enterprise Search settings)
  
  user_settings_yaml string
  
  An arbitrary YAML object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_json' is allowed), provided the parameters are on the allowlist and not on the denylist. (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Enterprise Search settings)
  
  user_settings_override_json object
  
  An arbitrary JSON object allowing ECE admins to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), i.e. in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Enterprise Search settings)
  
  user_settings_override_yaml string
  
  An arbitrary YAML object allowing ECE admins to set clusters' parameters (only one of this and 'user_settings_override_json' is allowed), i.e. in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Enterprise Search settings)
  
  allocator_filter object
  
  node_configuration string
  
  memory_per_node object
  
  node_count_per_zone object
  
  enterprise_search object Required
  
  Hide enterprise_search attributes Show enterprise_search attributes object
  
  version string
  
  The version of the Enterprise Search cluster (must be one of the ECE supported versions, and won't work unless it matches the Elasticsearch version. Leave blank to auto-detect version.)
  
  docker_image string
  
  A docker URI that allows overriding of the default docker image specified for this version
  
  system_settings object
  
  This structure defines a curated subset of the Enterprise Search settings. (This field together with 'user_settings_override*' and 'user_settings*' defines the total set of Enterprise Search settings)
  
  Hide system_settings attributes Show system_settings attributes object
  
  elasticsearch_username string
  
  Optionally override the account within Enterprise Search - defaults to a system account that always exists (if specified, the password must also be specified). Note that this field is never returned from the API, it is write only.
  
  elasticsearch_password string
  
  Optionally override the account within Enterprise Search - defaults to a system account that always exists (if specified, the username must also be specified). Note that this field is never returned from the API, it is write only.
  
  secret_session_key string
  
  Optionally override the secret session key within Enterprise Search - defaults to the previously existing secretSession. Note that this field is never returned from the API, it is write only.
  
  user_settings_json object
  
  An arbitrary JSON object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters are on the allowlist and not on the denylist. (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Enterprise Search settings)
  
  user_settings_yaml string
  
  An arbitrary YAML object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_json' is allowed), provided the parameters are on the allowlist and not on the denylist. (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Enterprise Search settings)
  
  user_settings_override_json object
  
  An arbitrary JSON object allowing ECE admins to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), i.e. in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Enterprise Search settings)
  
  user_settings_override_yaml string
  
  An arbitrary YAML object allowing ECE admins to set clusters' parameters (only one of this and 'user_settings_override_json' is allowed), i.e. in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Enterprise Search settings)
  
  transient object
  
  Defines configuration parameters that control how the plan (i.e. consisting of the cluster topology and Enterprise Search settings) is applied
  
  Hide transient attributes Show transient attributes object
  
  strategy object
  
  The options for performing a plan change. Specify only one property each time. The default is grow_and_shrink.
  
  Hide strategy attributes Show strategy attributes object
  
  rolling object
  
  Performs inline, rolling configuration changes that mutate existing containers. TIP: This is the fastest way to update a plan, but can fail for complex plan changes, such as topology changes. Also, this is less safe for configuration changes that leave a cluster in a non running state. NOTE: When you perform a major version upgrade, and 'group_by' is set to 'pass:macros[all]';, rolling is required.
  
  Hide rolling attributes Show rolling attributes object
  
  group_by string
  
  Specifies the grouping attribute to use when rolling several instances. Instances that share the same value for the provided attribute key are rolled together as a unit. Examples that make sense to use are '__all__' (roll all instances as a single unit), 'logical_zone_name' (roll instances by zone), '__name__' (roll one instance at a time, the default if not specified). Note that '__all__' is required when performing a major version upgrade
  
  allow_inline_resize boolean
  
  Whether we allow changing the capacity of instances (default false). This is currently implemented by stopping, re-creating then starting the affected instance on its associated allocator when performing the changes. NOTES: This requires a round-trip through the allocation infrastructure of the active constructor, as it has to reserve the target capacity without over-committing
  
  skip_synced_flush boolean
  
  Whether to skip attempting to do a synced flush on the filesystem of the container (default: false), which is less safe but may be required if the container is unhealthy
  
  shard_init_wait_time integer(int64)
  
  The time, in seconds, to wait for shards that show no progress of initializing before rolling the next group (default: 10 minutes)
  
  grow_and_shrink object
  
  A strategy that creates instances with the new plan, migrates data from the old instances, then shuts down the old instances. GrowShrinkStrategyConfig is safer than 'rolling' and ensures single node availability during a plan change, but can be a lot slower on larger clusters.
  
  rolling_grow_and_shrink object
  
  A strategy that creates new Elasticsearch instances, Kibana instances, and APM Servers with the new plan, then migrates the node data to minimize the amount of spare capacity.
  
  autodetect object
  
  A strategy that lets constructor choose the most optimal way to execute the plan.
  
  plan_configuration object
  
  Hide plan_configuration attributes Show plan_configuration attributes object
  
  timeout integer(int64)
  
  The total timeout in seconds after which the plan is cancelled even if it is not complete. Defaults to 4x the max memory capacity per node (in MB)
  
  calm_wait_time integer(int64)
  
  This timeout determines how long to give a cluster after it responds to API calls before performing actual operations on it. It defaults to 5s
  
  move_instances array[object]
  
  The request that specifies the Elasticsearch or stateless (eg Kibana) instances to move to allocators as part of the upgrade plan. When used in conjunction with '__all__' (roll all instances as a single unit) strategy, these instances are not restarted, which can sometimes enable recovery plans when these instances are boot-looping.
  
  Hide move_instances attributes Show move_instances attributes object
  
  from string Required
  
  The instance id that is going to be moved
  
  to array[string]
  
  An optional list of allocator ids to which the instance should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)
  
  instance_down boolean
  
  Tells the infrastructure that the instance should be considered as permanently down when deciding how to migrate data to new nodes. If left blank then the system will automatically decide (currently: will treat the instances as up)
  
  move_allocators array[object]
  
  As part of the upgrade plan, identifies the move requests for the Kibana instances or APM Servers on the allocators.
  
  Hide move_allocators attributes Show move_allocators attributes object
  
  from string Required
  
  The allocator id off which all instances in the cluster should be moved
  
  to array[string]
  
  An optional list of allocator ids to which the instance(s) should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)
  
  allocator_down boolean
  
  Tells the infrastructure that all instances on the allocator should be considered as permanently down when deciding how to migrate data to new nodes. If left blank then the system will auto-decide (currently: will treat the allocator as up)
  
  reallocate_instances boolean
  
  If true (default: false) does not allow re-using any existing instances currently in the cluster, i.e. even unchanged instances will be re-created
  
  preferred_allocators array[string]
  
  List of allocators on which instances are placed if possible (if not possible/not specified then any available allocator with space is used)
  
  extended_maintenance boolean
  
  If true (default false), does not clear the maintenance flag (which prevents its API from being accessed except by the constructor) on new instances added until after a snapshot has been restored, otherwise, the maintenance flag is cleared once the new instances successfully join the new cluster
  
  cluster_reboot string
  
  Set to 'forced' to force a reboot as part of the upgrade plan
  
  Value is forced.
  
  settings object
  
  The settings for the Enterprise Search.
  
  Hide settings attribute Show settings attribute object
  
  metadata object
  
  The top-level configuration settings for the Elasticsearch cluster.
  
  Hide metadata attribute Show metadata attribute object
  
  name string
  
  The display name of the cluster
- integrations_server array[object]
  
  A list of payloads for Integrations Server updates
  
  An Integrations Server creation request paired with the alias of the Elasticsearch cluster it should be paired with
  Hide integrations_server attributes Show integrations_server attributes object
  
  ref_id string Required
  
  A locally-unique user-specified id for the Integrations Server
  
  elasticsearch_cluster_ref_id string Required
  
  Alias to the Elasticsearch Cluster to attach the Integrations Server to
  
  display_name string
  
  The human readable name for the Integrations Server cluster (default: takes the name of its Elasticsearch cluster)
  
  region string Required
  
  The region where this resource exists
  
  plan object Required
  
  The plan for the Integrations Server.
  
  Hide plan attributes Show plan attributes object
  
  cluster_topology array[object]
  
  Defines the topology of the Integrations Server nodes. For example, the number or capacity of the nodes, and where you can allocate the nodes.
  
  Hide cluster_topology attributes Show cluster_topology attributes object
  
  instance_configuration_id string
  
  Controls the allocation of this topology element as well as allowed sizes and node_types. It needs to match the id of an existing instance configuration.
  
  instance_configuration_version integer(int32)
  
  The version of the Instance Configuration Id. If it is unset, the meaning depends on read vs writes. For deployment reads, it is equivalent to version 0 (or the IC is unversioned); for deployment creates and deployment template use, it is equivalent to 'the latest version'; and for deployment updates, it is equivalent to 'retain the current version'.
  
  size object
  
  Measured by the amount of a resource. The final cluster size is calculated using multipliers from the topology instance configuration.
  
  Hide size attributes Show size attributes object
  
  value integer(int32) Required
  
  Amount of resource
  
  resource string Required
  
  Type of resource. In ESS the resource used should always be memory.
  
  Values are memory or storage.
  
  zone_count integer(int32)
  
  number of zones in which nodes will be placed
  
  integrations_server object
  
  The configuration options for the Integrations Server.
  
  Hide integrations_server attributes Show integrations_server attributes object
  
  version string
  
  The version of the Integrations Server cluster (must be one of the ECE supported versions, and won't work unless it matches the Integrations Server version. Leave blank to auto-detect version.)
  
  docker_image string
  
  A docker URI that allows overriding of the default docker image specified for this version
  
  system_settings object
  
  A structure that defines a curated subset of the Integrations Server settings. TIP: To define the complete set of Integrations Server setting, use IntegrationsSystemSettings with user_settings_override_ and user_settings_.
  
  Hide system_settings attributes Show system_settings attributes object
  
  elasticsearch_username string
  
  Optionally override the account within Integrations Server - defaults to a system account that always exists (if specified, the password must also be specified). Note that this field is never returned from the API, it is write only.
  
  elasticsearch_password string
  
  Optionally override the account within Integrations Server - defaults to a system account that always exists (if specified, the username must also be specified). Note that this field is never returned from the API, it is write only.
  
  secret_token string
  
  Optionally override the secret token within Integrations Server - defaults to the previously existing secretToken
  
  debug_enabled boolean
  
  Optionally enable debug mode for Integrations Server - defaults false
  
  user_settings_json object
  
  An arbitrary JSON object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters are on the allowlist and not on the denylist. (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Integrations Server settings)
  
  user_settings_yaml string
  
  An arbitrary YAML object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_json' is allowed), provided the parameters are on the allowlist and not on the denylist. (These field together with 'user_settings_override*' and 'system_settings' defines the total set of Integrations Server settings)
  
  user_settings_override_json object
  
  An arbitrary JSON object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Integrations Server settings)
  
  user_settings_override_yaml string
  
  An arbitrary YAML object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_json' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Integrations Server settings)
  
  mode string
  
  The mode the Integrations Server is operating in.
  
  Values are standalone or managed.
  
  integrations_server object Required
  
  The configuration options for the Integrations Server.
  
  Hide integrations_server attributes Show integrations_server attributes object
  
  version string
  
  The version of the Integrations Server cluster (must be one of the ECE supported versions, and won't work unless it matches the Integrations Server version. Leave blank to auto-detect version.)
  
  docker_image string
  
  A docker URI that allows overriding of the default docker image specified for this version
  
  system_settings object
  
  A structure that defines a curated subset of the Integrations Server settings. TIP: To define the complete set of Integrations Server setting, use IntegrationsSystemSettings with user_settings_override_ and user_settings_.
  
  Hide system_settings attributes Show system_settings attributes object
  
  elasticsearch_username string
  
  Optionally override the account within Integrations Server - defaults to a system account that always exists (if specified, the password must also be specified). Note that this field is never returned from the API, it is write only.
  
  elasticsearch_password string
  
  Optionally override the account within Integrations Server - defaults to a system account that always exists (if specified, the username must also be specified). Note that this field is never returned from the API, it is write only.
  
  secret_token string
  
  Optionally override the secret token within Integrations Server - defaults to the previously existing secretToken
  
  debug_enabled boolean
  
  Optionally enable debug mode for Integrations Server - defaults false
  
  user_settings_json object
  
  An arbitrary JSON object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters are on the allowlist and not on the denylist. (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Integrations Server settings)
  
  user_settings_yaml string
  
  An arbitrary YAML object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_json' is allowed), provided the parameters are on the allowlist and not on the denylist. (These field together with 'user_settings_override*' and 'system_settings' defines the total set of Integrations Server settings)
  
  user_settings_override_json object
  
  An arbitrary JSON object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Integrations Server settings)
  
  user_settings_override_yaml string
  
  An arbitrary YAML object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_json' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Integrations Server settings)
  
  mode string
  
  The mode the Integrations Server is operating in.
  
  Values are standalone or managed.
  
  transient object
  
  Defines the configuration parameters that control how the plan is applied. For example, the Elasticsearch cluster topology and Integrations Server settings.
  
  Hide transient attributes Show transient attributes object
  
  strategy object
  
  The options for performing a plan change. Specify only one property each time. The default is grow_and_shrink.
  
  Hide strategy attributes Show strategy attributes object
  
  rolling object
  
  Performs inline, rolling configuration changes that mutate existing containers. TIP: This is the fastest way to update a plan, but can fail for complex plan changes, such as topology changes. Also, this is less safe for configuration changes that leave a cluster in a non running state. NOTE: When you perform a major version upgrade, and 'group_by' is set to 'pass:macros[all]';, rolling is required.
  
  Hide rolling attributes Show rolling attributes object
  
  group_by string
  
  Specifies the grouping attribute to use when rolling several instances. Instances that share the same value for the provided attribute key are rolled together as a unit. Examples that make sense to use are '__all__' (roll all instances as a single unit), 'logical_zone_name' (roll instances by zone), '__name__' (roll one instance at a time, the default if not specified). Note that '__all__' is required when performing a major version upgrade
  
  allow_inline_resize boolean
  
  Whether we allow changing the capacity of instances (default false). This is currently implemented by stopping, re-creating then starting the affected instance on its associated allocator when performing the changes. NOTES: This requires a round-trip through the allocation infrastructure of the active constructor, as it has to reserve the target capacity without over-committing
  
  skip_synced_flush boolean
  
  Whether to skip attempting to do a synced flush on the filesystem of the container (default: false), which is less safe but may be required if the container is unhealthy
  
  shard_init_wait_time integer(int64)
  
  The time, in seconds, to wait for shards that show no progress of initializing before rolling the next group (default: 10 minutes)
  
  grow_and_shrink object
  
  A strategy that creates instances with the new plan, migrates data from the old instances, then shuts down the old instances. GrowShrinkStrategyConfig is safer than 'rolling' and ensures single node availability during a plan change, but can be a lot slower on larger clusters.
  
  rolling_grow_and_shrink object
  
  A strategy that creates new Elasticsearch instances, Kibana instances, and APM Servers with the new plan, then migrates the node data to minimize the amount of spare capacity.
  
  autodetect object
  
  A strategy that lets constructor choose the most optimal way to execute the plan.
  
  plan_configuration object
  
  The plan control configuration options for the Integrations Server.
  
  Hide plan_configuration attributes Show plan_configuration attributes object
  
  timeout integer(int64)
  
  The total timeout in seconds after which the plan is cancelled even if it is not complete. Defaults to 4x the max memory capacity per node (in MB)
  
  calm_wait_time integer(int64)
  
  This timeout determines how long to give a cluster after it responds to API calls before performing actual operations on it. It defaults to 5s
  
  extended_maintenance boolean
  
  If true (default false), does not clear the maintenance flag (which prevents its API from being accessed except by the constructor) on new instances added until after a snapshot has been restored, otherwise, the maintenance flag is cleared once the new instances successfully join the new cluster
  
  cluster_reboot string
  
  Set to 'forced' to force a reboot as part of the upgrade plan
  
  Value is forced.
  
  settings object
  
  The settings for the Integrations Server.
  
  Hide settings attribute Show settings attribute object
  
  metadata object
  
  The top-level configuration settings for the Elasticsearch cluster.
  
  Hide metadata attribute Show metadata attribute object
  
  name string
  
  The display name of the cluster
settings object

Additional configuration for the new deployment object.
Hide settings attributes Show settings attributes object
- observability object
  
  The observability settings for a deployment
  Hide observability attributes Show observability attributes object
  
  logging object
  
  The logging settings for a deployment
  
  Hide logging attribute Show logging attribute object
  
  destination object Required
  
  The destination to send logs and metrics to
  
  Hide destination attributes Show destination attributes object
  
  deployment_id string Required
  
  The deployment to send logs and/or metrics to. Contains either the deployment's ID or 'self'.
  
  ref_id string
  
  RefId of the Elasticsearch cluster to send logs and/or metrics to. If not specified, refId is resolved automatically as long as the destination deployment contains a single Elasticsearch resource.
  
  metrics object
  
  The metrics settings for a deployment
  
  Hide metrics attribute Show metrics attribute object
  
  destination object Required
  
  The destination to send logs and metrics to
  
  Hide destination attributes Show destination attributes object
  
  deployment_id string Required
  
  The deployment to send logs and/or metrics to. Contains either the deployment's ID or 'self'.
  
  ref_id string
  
  RefId of the Elasticsearch cluster to send logs and/or metrics to. If not specified, refId is resolved automatically as long as the destination deployment contains a single Elasticsearch resource.
- autoscaling_enabled boolean
  
  Enable autoscaling for this deployment.
- auto_ops object
  
  AutoOps settings for this deployment.
  Hide auto_ops attribute Show auto_ops attribute object
  
  status string Required
  
  See AutoOps integration status for this deployment.
  
  Values are connected, not_connected, or excluded.
metadata object

Additional information about the current deployment object.
Hide metadata attribute Show metadata attribute object
- tags array[object]
  
  Arbitrary user-defined metadata associated with this deployment
  
  The key-value pair.
  Hide tags attributes Show tags attributes object
  
  key string Required
  
  The metadata field name
  
  value string Required
  
  The metadata value
alias string

A user-defined alias to use in place of Cluster IDs for user-friendly URLs

Responses

200 application/json

The request was valid and the deployment was updated.
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 deployment
- name string Required
  
  The name of the deployment
- alias string
  
  A user-defined alias to use in place of ResourceIds for user-friendly resource URLs
- resources array[object] Required
  
  List of resources that are part of the deployment after the update operation.
  
  Data for a deployment resource
  
  Hide resources attributes Show resources attributes object
  
  ref_id string Required
  
  A locally-unique friendly alias for this Elasticsearch cluster
  
  elasticsearch_cluster_ref_id string
  
  The Elasticsearch cluster that this resource depends on.
  
  id string Required
  
  A system-unique id for the created resource
  
  kind string Required
  
  The kind of resource
  
  region string Required
  
  Identifier of the region in which this resource runs.
  
  cloud_id string
  
  An encoded string that provides other Elastic services with the necessary information to connect to this Elasticsearch and Kibana
  
  credentials object
  
  The username and password for the new Elasticsearch cluster, which is returned from the Elasticsearch cluster create command.
  
  Hide credentials attributes Show credentials attributes object
  
  username string Required
  
  The username of the newly created cluster
  
  password string Required
  
  The password of the newly created cluster
  
  secret_token string
  
  Secret token for using a created resource. Only provided on initial create and absent otherwise.
  
  warnings array[object]
  
  List of warnings generated from validating resource updates
  
  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
- shutdown_resources object
  
  Details about orphaned resources.
  
  Hide shutdown_resources attributes Show shutdown_resources 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
- diagnostics object
  
  Describes the diagnostics for a given Deployment-modifying payload
  
  Hide diagnostics attributes Show diagnostics attributes object
  
  creates object
  
  Holds diagnostics for resources that will be created
  
  Hide creates attributes Show creates attributes object
  
  elasticsearch array[object]
  
  Diagnostics for Elasticsearch clusters
  
  Holds diagnostics for an Elasticsearch cluster
  
  Hide elasticsearch attributes Show elasticsearch attributes object
  
  ref_id string Required
  
  A locally-unique user-specified id
  
  display_name string Required
  
  The human readable name for the cluster (defaults to the generated cluster id if not specified)
  
  backend_plan object Required
  
  The backend plan as JSON
  
  kibana array[object]
  
  Diagnostics for Kibanas
  
  Holds diagnostics for a Kibana resource
  
  Hide kibana attributes Show kibana attributes object
  
  ref_id string Required
  
  A locally-unique user-specified id
  
  display_name string Required
  
  The human readable name (defaults to the generated cluster id if not specified)
  
  elasticsearch_cluster_ref_id string Required
  
  The user-specified id of the Elasticsearch Cluster that this will link to
  
  backend_plan object Required
  
  The backend plan as JSON
  
  apm array[object]
  
  Diagnostics for APMs
  
  Holds diagnostics for an APM resource
  
  Hide apm attributes Show apm attributes object
  
  ref_id string Required
  
  A locally-unique user-specified id
  
  display_name string Required
  
  The human readable name (defaults to the generated cluster id if not specified)
  
  elasticsearch_cluster_ref_id string Required
  
  The user-specified id of the Elasticsearch Cluster that this will link to
  
  backend_plan object Required
  
  The backend plan as JSON
  
  integrations_server array[object]
  
  Diagnostics for Integrations Server
  
  Holds diagnostics for an Integrations Server resource
  
  Hide integrations_server attributes Show integrations_server attributes object
  
  ref_id string Required
  
  A locally-unique user-specified id
  
  display_name string Required
  
  The human readable name (defaults to the generated cluster id if not specified)
  
  elasticsearch_cluster_ref_id string Required
  
  The user-specified id of the Elasticsearch Cluster that this will link to
  
  backend_plan object Required
  
  The backend plan as JSON
  
  appsearch array[object]
  
  Diagnostics for AppSearches
  
  Holds diagnostics for an AppSearch resource
  
  Hide appsearch attributes Show appsearch attributes object
  
  ref_id string Required
  
  A locally-unique user-specified id
  
  display_name string Required
  
  The human readable name (defaults to the generated cluster id if not specified)
  
  elasticsearch_cluster_ref_id string Required
  
  The user-specified id of the Elasticsearch Cluster that this will link to
  
  backend_plan object Required
  
  The backend plan as JSON
  
  enterprise_search array[object]
  
  Diagnostics for Enterprise Search resources
  
  Holds diagnostics for an Enterprise Search resource
  
  Hide enterprise_search attributes Show enterprise_search attributes object
  
  ref_id string Required
  
  A locally-unique user-specified id
  
  display_name string Required
  
  The human readable name (defaults to the generated cluster id if not specified)
  
  elasticsearch_cluster_ref_id string Required
  
  The user-specified id of the Elasticsearch Cluster that this will link to
  
  backend_plan object Required
  
  The backend plan as JSON
  
  updates object
  
  Holds diagnostics for existing resources that might be updated
  
  Hide updates attributes Show updates attributes object
  
  elasticsearch array[object]
  
  Diagnostics for Elasticsearch clusters
  
  Holds diagnostics for an Elasticsearch cluster
  
  Hide elasticsearch attributes Show elasticsearch attributes object
  
  ref_id string Required
  
  A locally-unique user-specified id
  
  display_name string Required
  
  The human readable name for the cluster (defaults to the generated cluster id if not specified)
  
  backend_plan object Required
  
  The backend plan as JSON
  
  kibana array[object]
  
  Diagnostics for Kibanas
  
  Holds diagnostics for a Kibana resource
  
  Hide kibana attributes Show kibana attributes object
  
  ref_id string Required
  
  A locally-unique user-specified id
  
  display_name string Required
  
  The human readable name (defaults to the generated cluster id if not specified)
  
  elasticsearch_cluster_ref_id string Required
  
  The user-specified id of the Elasticsearch Cluster that this will link to
  
  backend_plan object Required
  
  The backend plan as JSON
  
  apm array[object]
  
  Diagnostics for APMs
  
  Holds diagnostics for an APM resource
  
  Hide apm attributes Show apm attributes object
  
  ref_id string Required
  
  A locally-unique user-specified id
  
  display_name string Required
  
  The human readable name (defaults to the generated cluster id if not specified)
  
  elasticsearch_cluster_ref_id string Required
  
  The user-specified id of the Elasticsearch Cluster that this will link to
  
  backend_plan object Required
  
  The backend plan as JSON
  
  integrations_server array[object]
  
  Diagnostics for Integrations Server
  
  Holds diagnostics for an Integrations Server resource
  
  Hide integrations_server attributes Show integrations_server attributes object
  
  ref_id string Required
  
  A locally-unique user-specified id
  
  display_name string Required
  
  The human readable name (defaults to the generated cluster id if not specified)
  
  elasticsearch_cluster_ref_id string Required
  
  The user-specified id of the Elasticsearch Cluster that this will link to
  
  backend_plan object Required
  
  The backend plan as JSON
  
  appsearch array[object]
  
  Diagnostics for AppSearches
  
  Holds diagnostics for an AppSearch resource
  
  Hide appsearch attributes Show appsearch attributes object
  
  ref_id string Required
  
  A locally-unique user-specified id
  
  display_name string Required
  
  The human readable name (defaults to the generated cluster id if not specified)
  
  elasticsearch_cluster_ref_id string Required
  
  The user-specified id of the Elasticsearch Cluster that this will link to
  
  backend_plan object Required
  
  The backend plan as JSON
  
  enterprise_search array[object]
  
  Diagnostics for Enterprise Search resources
  
  Holds diagnostics for an Enterprise Search resource
  
  Hide enterprise_search attributes Show enterprise_search attributes object
  
  ref_id string Required
  
  A locally-unique user-specified id
  
  display_name string Required
  
  The human readable name (defaults to the generated cluster id if not specified)
  
  elasticsearch_cluster_ref_id string Required
  
  The user-specified id of the Elasticsearch Cluster that this will link to
  
  backend_plan object Required
  
  The backend plan as JSON
- settings object
  
  Additional configuration about the current deployment object.
  
  Hide settings attributes Show settings attributes object
  
  traffic_filter_settings object
  
  The configuration settings for the traffic filter.
  
  Hide traffic_filter_settings attribute Show traffic_filter_settings attribute object
  
  rulesets array[string] Required
  
  IDs of the traffic filter rulesets
  
  observability object
  
  The observability settings for a deployment
  
  Hide observability attributes Show observability attributes object
  
  logging object
  
  The logging settings for a deployment
  
  Hide logging attribute Show logging attribute object
  
  destination object Required
  
  The destination to send logs and metrics to
  
  Hide destination attributes Show destination attributes object
  
  deployment_id string Required
  
  The deployment to send logs and/or metrics to. Contains either the deployment's ID or 'self'.
  
  ref_id string
  
  RefId of the Elasticsearch cluster to send logs and/or metrics to. If not specified, refId is resolved automatically as long as the destination deployment contains a single Elasticsearch resource.
  
  metrics object
  
  The metrics settings for a deployment
  
  Hide metrics attribute Show metrics attribute object
  
  destination object Required
  
  The destination to send logs and metrics to
  
  Hide destination attributes Show destination attributes object
  
  deployment_id string Required
  
  The deployment to send logs and/or metrics to. Contains either the deployment's ID or 'self'.
  
  ref_id string
  
  RefId of the Elasticsearch cluster to send logs and/or metrics to. If not specified, refId is resolved automatically as long as the destination deployment contains a single Elasticsearch resource.
  
  autoscaling_enabled boolean
  
  If autoscaling is enabled for this deployment.
  
  auto_ops object Required
  
  AutoOps settings for this deployment.
  
  Hide auto_ops attribute Show auto_ops attribute object
  
  status string Required
  
  See AutoOps integration status for this deployment.
  
  Values are connected, not_connected, or excluded.
  
  solution_type string
  
  An optional string that declares the deployment's expected application. Example supported values are: elasticsearch, observability, security.
400 application/json

The deployment request had errors.
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 application/json

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 application/json

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

PUT /deployments/{deployment_id}

curl \
 --request PUT 'https://api.elastic-cloud.com/api/v1/deployments/{deployment_id}' \
 --header "Content-Type: application/json" \
 --data '{"name":"string","prune_orphans":true,"resources":{"elasticsearch":[{"ref_id":"string","display_name":"string","region":"string","plan":{"cluster_topology":[{"id":"string","node_type":{"master":true,"data":true,"ingest":true,"ml":true},"node_roles":["master"],"zone_count":42,"elasticsearch":{"version":"string","docker_image":"string","system_settings":{"scripting":{"painless_enabled":true,"mustache_enabled":true,"expressions_enabled":true,"stored":{"enabled":true,"sandbox_mode":true},"file":{"enabled":true,"sandbox_mode":true},"inline":{"enabled":true,"sandbox_mode":true}},"reindex_whitelist":["string"],"auto_create_index":true,"enable_close_index":true,"destructive_requires_name":true,"watcher_trigger_engine":"string","default_shards_per_index":42,"monitoring_collection_interval":42,"monitoring_history_duration":"string"},"user_settings_json":{},"user_settings_yaml":"string","user_settings_override_json":{},"user_settings_override_yaml":"string","enabled_built_in_plugins":["string"],"user_plugins":[{"name":"string","url":"string","elasticsearch_version":"string"}],"user_bundles":[{"name":"string","url":"string","elasticsearch_version":"string"}],"curation":{"from_instance_configuration_id":"string","to_instance_configuration_id":"string"},"node_attributes":{"additionalProperty1":"string","additionalProperty2":"string"}},"instance_configuration_id":"string","instance_configuration_version":42,"size":{"value":42,"resource":"memory"},"autoscaling_min":{"value":42,"resource":"memory"},"autoscaling_max":{"value":42,"resource":"memory"},"autoscaling_policy_override_json":{},"topology_element_control":{"min":{"value":42,"resource":"memory"}},"autoscaling_tier_override":true}],"elasticsearch":{"version":"string","docker_image":"string","system_settings":{"scripting":{"painless_enabled":true,"mustache_enabled":true,"expressions_enabled":true,"stored":{"enabled":true,"sandbox_mode":true},"file":{"enabled":true,"sandbox_mode":true},"inline":{"enabled":true,"sandbox_mode":true}},"reindex_whitelist":["string"],"auto_create_index":true,"enable_close_index":true,"destructive_requires_name":true,"watcher_trigger_engine":"string","default_shards_per_index":42,"monitoring_collection_interval":42,"monitoring_history_duration":"string"},"user_settings_json":{},"user_settings_yaml":"string","user_settings_override_json":{},"user_settings_override_yaml":"string","enabled_built_in_plugins":["string"],"user_plugins":[{"name":"string","url":"string","elasticsearch_version":"string"}],"user_bundles":[{"name":"string","url":"string","elasticsearch_version":"string"}],"curation":{"from_instance_configuration_id":"string","to_instance_configuration_id":"string"},"node_attributes":{"additionalProperty1":"string","additionalProperty2":"string"}},"deployment_template":{"id":"string","version":"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,"skip_snapshot":true,"max_snapshot_attempts":42,"max_snapshot_age":42,"extended_maintenance":true,"cluster_reboot":"forced"},"restore_snapshot":{"repository_name":"string","snapshot_name":"string","repository_config":{"raw_settings":{}},"restore_payload":{"indices":["string"],"raw_settings":{}},"strategy":"partial","source_cluster_id":"string"},"remote_clusters":{"resources":[{"deployment_id":"string","elasticsearch_ref_id":"string","alias":"string","skip_unavailable":true,"info":{"healthy":true,"connected":true,"compatible":true,"trusted":true,"trusted_back":true}}]},"cluster_settings_json":{}},"autoscaling_enabled":true},"settings":{"snapshot":{"interval":"string","retention":{"snapshots":42,"max_age":"string"},"cron_expression":"string"},"monitoring":{"target_cluster_id":"string"},"metadata":{"name":"string"},"curation":{"specs":[{"index_pattern":"string","trigger_interval_seconds":42}]},"dedicated_masters_threshold":42,"traffic_filter":{"rulesets":["string"]},"trust":{"accounts":[{"account_id":"string","name":"string","trust_all":true,"trust_allowlist":["string"]}],"external":[{"trust_relationship_id":"string","name":"string","trust_all":true,"trust_allowlist":["string"]}],"direct":[{"uid":"string","name":"string","type":"ECE","trust_all":true,"trust_allowlist":["string"],"scope_id":"abc123","additional_node_names":["string"],"certificates":[{"pem":"string","metadata":{"fingerprint":"string","valid_to":"2025-05-04T09:42:00Z","valid_from":"2025-05-04T09:42:00Z","also_trusted_by":["string"]}}]}]},"keystore_contents":{"secrets":{"additionalProperty1":{"value":{},"as_file":true},"additionalProperty2":{"value":{},"as_file":true}}}}}],"kibana":[{"ref_id":"string","elasticsearch_cluster_ref_id":"string","display_name":"string","region":"string","plan":{"cluster_topology":[{"instance_configuration_id":"string","instance_configuration_version":42,"size":{"value":42,"resource":"memory"},"zone_count":42,"kibana":{"version":"string","docker_image":"string","system_settings":{"elasticsearch_username":"string","elasticsearch_password":"string"},"user_settings_json":{},"user_settings_yaml":"string","user_settings_override_json":{},"user_settings_override_yaml":"string"}}],"kibana":{"version":"string","docker_image":"string","system_settings":{"elasticsearch_username":"string","elasticsearch_password":"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,"extended_maintenance":true,"cluster_reboot":"forced"}}},"settings":{"metadata":{"name":"string"}}}],"apm":[{"ref_id":"string","elasticsearch_cluster_ref_id":"string","display_name":"string","region":"string","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_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_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,"extended_maintenance":true,"cluster_reboot":"forced"}}},"settings":{"metadata":{"name":"string"}}}],"appsearch":[{"ref_id":"string","elasticsearch_cluster_ref_id":"string","display_name":"string","region":"string","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"],"extended_maintenance":true,"cluster_reboot":"forced"}}},"settings":{"metadata":{"name":"string"}}}],"enterprise_search":[{"ref_id":"string","elasticsearch_cluster_ref_id":"string","display_name":"string","region":"string","plan":{"cluster_topology":[{"node_type":{"appserver":true,"worker":true,"connector":true},"instance_configuration_id":"string","instance_configuration_version":42,"size":{"value":42,"resource":"memory"},"zone_count":42,"enterprise_search":{"version":"string","docker_image":"string","system_settings":{"elasticsearch_username":"string","elasticsearch_password":"string","secret_session_key":"string"},"user_settings_json":{},"user_settings_yaml":"string","user_settings_override_json":{},"user_settings_override_yaml":"string"},"allocator_filter":{},"node_configuration":"string","memory_per_node":{},"node_count_per_zone":{}}],"enterprise_search":{"version":"string","docker_image":"string","system_settings":{"elasticsearch_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"],"extended_maintenance":true,"cluster_reboot":"forced"}}},"settings":{"metadata":{"name":"string"}}}],"integrations_server":[{"ref_id":"string","elasticsearch_cluster_ref_id":"string","display_name":"string","region":"string","plan":{"cluster_topology":[{"instance_configuration_id":"string","instance_configuration_version":42,"size":{"value":42,"resource":"memory"},"zone_count":42,"integrations_server":{"version":"string","docker_image":"string","system_settings":{"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","mode":"standalone"}}],"integrations_server":{"version":"string","docker_image":"string","system_settings":{"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","mode":"standalone"},"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,"extended_maintenance":true,"cluster_reboot":"forced"}}},"settings":{"metadata":{"name":"string"}}}]},"settings":{"observability":{"logging":{"destination":{"deployment_id":"string","ref_id":"string"}},"metrics":{"destination":{"deployment_id":"string","ref_id":"string"}}},"autoscaling_enabled":true,"auto_ops":{"status":"connected"}},"metadata":{"tags":[{"key":"string","value":"string"}]},"alias":"string"}'

Shuts down Deployment

POST /deployments/{deployment_id}/_shutdown

Shuts down all resources in a Deployment.

Path parameters

deployment_id string Required

Identifier for the Deployment

Query parameters

hide boolean

Whether or not to hide the deployment and its resources.Only applicable for Platform administrators.
skip_snapshot boolean

Whether or not to skip snapshots before shutting down the resources

Default value is false.

Responses

200 application/json

The request was valid and the resources of the deployment were shutdown.
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
  
  Details about orphaned resources.
  
  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 application/json

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
401 application/json

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 application/json

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

POST /deployments/{deployment_id}/_shutdown

curl \
 --request POST 'https://api.elastic-cloud.com/api/v1/deployments/{deployment_id}/_shutdown'

Set AppSearch read-only status

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

Enable/Disable read-only mode on the given App Search resource.

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

Responses

200 application/json

Standard response
Hide response attribute Show response attribute object
- enabled boolean Required
  
  Whether read-only mode is enabled or disabled
404 application/json

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
  
  Value is 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 application/json

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}/read_only_mode

curl \
 --request GET 'https://api.elastic-cloud.com/api/v1/deployments/{deployment_id}/appsearch/{ref_id}/read_only_mode'

Set AppSearch read-only status

PUT /deployments/{deployment_id}/appsearch/{ref_id}/read_only_mode

Enable/Disable read-only mode on the given App Search resource.

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

application/json

Body Required

read-only request body

enabled boolean Required

Enabled or disabled read-only mode

Responses

200 application/json

Standard response
Hide response attribute Show response attribute object
- enabled boolean Required
  
  Whether read-only mode is enabled or disabled
404 application/json

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
  
  Value is 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 application/json

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

PUT /deployments/{deployment_id}/appsearch/{ref_id}/read_only_mode

curl \
 --request PUT 'https://api.elastic-cloud.com/api/v1/deployments/{deployment_id}/appsearch/{ref_id}/read_only_mode' \
 --header "Content-Type: application/json" \
 --data '{"enabled":true}'

Get the items in the Elasticsearch resource keystore

GET /deployments/{deployment_id}/elasticsearch/{ref_id}/keystore

Fetches the current fields and metadata (but not the values) of the keystore for the Elasticsearch resource.

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)

Responses

200 application/json

The contents of the Elasticsearch keystore, with values redacted
Hide response attribute Show response attribute object
- secrets object Required
  
  List of secrets
  
  Hide secrets attribute Show secrets attribute object
  
  * object Additional properties
  
  The value that you configure for the Elasticsearch keystore secret.
  
  Hide * attributes Show * attributes object
  
  value object
  
  Value of this setting. This can either be a string or a JSON object that is stored as a JSON string in the keystore. NOTE: When the keystore secret is unspecified, it is removed.
  
  as_file boolean
  
  Stores the keystore secret as a file. The default is false, which stores the keystore secret as string when value is a plain string, or true when value is an object.
404 application/json
- 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 application/json

We have failed you. (code: deployments.metadata_internal_error)
Hide headers attribute Show headers attribute
- x-cloud-error-codes string
  
  The error codes associated with the response
  
  Value is deployments.metadata_internal_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

GET /deployments/{deployment_id}/elasticsearch/{ref_id}/keystore

curl \
 --request GET 'https://api.elastic-cloud.com/api/v1/deployments/{deployment_id}/elasticsearch/{ref_id}/keystore'

Get certificate based remote clusters

GET /deployments/{deployment_id}/elasticsearch/{ref_id}/remote-clusters

Returns the list of certificate based remote clusters for the elasticsearch resource.

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

Responses

200 application/json

List of certificate based remote clusters for the resource
Hide response attribute Show response attribute object
- resources array[object] Required
  
  The remote resources
  
  The Elasticsearch resource used as a Remote Cluster.
  
  Hide resources attributes Show resources attributes object
  
  deployment_id string Required
  
  The id of the deployment
  
  elasticsearch_ref_id string Required
  
  The locally-unique user-specified id of an Elasticsearch Resource
  
  alias string Required
  
  The alias for this remote cluster. Aliases must only contain letters, digits, dashes and underscores
  
  skip_unavailable boolean
  
  If true, skip this cluster during search if it is disconnected. Default: false
  
  info object
  
  Information about a Remote Cluster.
  
  Hide info attributes Show info attributes object
  
  healthy boolean Required
  
  Whether or not the remote cluster is healthy
  
  connected boolean Required
  
  Whether or not there is at least one connection to the remote cluster.
  
  compatible boolean Required
  
  Whether or not the remote cluster version is compatible with this cluster version.
  
  trusted boolean Required
  
  Whether or not the remote cluster is trusted by this cluster.
  
  trusted_back boolean Required
  
  Whether or not the remote cluster trusts this cluster back.
404 application/json
- 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

GET /deployments/{deployment_id}/elasticsearch/{ref_id}/remote-clusters

curl \
 --request GET 'https://api.elastic-cloud.com/api/v1/deployments/{deployment_id}/elasticsearch/{ref_id}/remote-clusters'

Get Deployment Enterprise Search Resource Info

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

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

Path parameters

deployment_id string Required

Identifier for the Deployment
ref_id string Required

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

Query parameters

show_metadata boolean

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

Default value is false.
show_plans boolean

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

Default value is true.
show_plan_logs boolean

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

Default value is false.
show_plan_history boolean

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

Default value is false.
show_plan_defaults boolean

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

Default value is false.
show_settings boolean

Whether to show cluster settings in the response.

Default value is false.
clear_transient boolean

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

Default value is false.

Responses

200 application/json

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

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 application/json

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

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

curl \
 --request GET 'https://api.elastic-cloud.com/api/v1/deployments/{deployment_id}/enterprise_search/{ref_id}'

Build request to migrate deployment to a different template

GET /deployments/{deployment_id}/migrate_template

Returns a deployment update request that would migrate this deployment to a different template.

Path parameters

deployment_id string Required

Identifier for the Deployment

Query parameters

template_id string Required

The ID of the deployment template to migrate to

Responses

200 application/json

The request was valid and the deployment can be migrated to the template with the provided ID.
Hide response attributes Show response attributes object
- name string
  
  A new name for the deployment, otherwise stays the same.
- prune_orphans boolean Required
  
  Whether or not to prune orphan resources that are no longer mentioned in this request. Note that resourcesare tracked by ref_id, and if a resource's ref_id is changed, any previous running resources created with that previousref_id are considered to be orphaned as well.
- resources object
  
  Describes the Deployment resource updates
  
  Hide resources attributes Show resources attributes object
  
  elasticsearch array[object]
  
  A list of payloads for Elasticsearch cluster updates
  
  An alias for an Elasticsearch Cluster paired with a request for creating one
  
  Hide elasticsearch attributes Show elasticsearch attributes object
  
  ref_id string Required
  
  A locally-unique user-specified id for this Elasticsearch cluster
  
  display_name string
  
  The human readable name for the cluster (defaults to the generated cluster id if not specified)
  
  region string Required
  
  The region where this resource exists
  
  plan object Required
  
  The plan for the Elasticsearch cluster.
  
  Hide plan attributes Show plan attributes object
  
  cluster_topology array[object] Required
  
  The topology of the Elasticsearch nodes, including the number, capacity, and type of nodes, and where they can be allocated.
  
  Hide cluster_topology attributes Show cluster_topology attributes object
  
  id string
  
  Unique identifier of this topology element
  
  node_type object
  
  Controls the combinations of Elasticsearch node types. TIP: By default, the Elasticsearch node is master eligible, can hold data, and run ingest pipelines. WARNING: Do not set for tiebreaker topologies.
  
  Hide node_type attributes Show node_type attributes object
  
  master boolean
  
  Defines whether this node can be elected master (default: false)
  
  data boolean
  
  Defines whether this node can hold data (default: false)
  
  ingest boolean
  
  Defines whether this node can run an ingest pipeline (default: false)
  
  ml boolean
  
  Defines whether this node can run ml jobs, valid only for versions 5.4.0 or greater (default: false)
  
  node_roles array[string]
  
  The list of node roles for this topology element (ES version >= 7.10). Allowable values are: master, ingest, ml, data_hot, data_content, data_warm, data_cold, data_frozen, remote_cluster_client, transform
  
  Values are master, ingest, ml, data_hot, data_content, data_warm, data_cold, data_frozen, remote_cluster_client, or transform.
  
  zone_count integer(int32)
  
  The default number of zones in which data nodes will be placed
  
  elasticsearch object
  
  The Elasticsearch cluster settings. When specified at the top level, provides a field-by-field default. When specified at the topology level, provides the override settings.
  
  Hide elasticsearch attributes Show elasticsearch attributes object
  
  version string
  
  The version of the Elasticsearch cluster (must be one of the ECE supported versions). Currently cannot be different across the topology (and is generally specified in the globals). Defaults to the latest version if not specified.
  
  docker_image string
  
  A docker URI that allows overriding of the default docker image specified for this version
  
  system_settings object
  
  A subset of Elasticsearch settings. TIP: To define the complete set of Elasticsearch settings, use ElasticsearchSystemSettings with user_settings_override* and user_settings*.
  
  Hide system_settings attributes Show system_settings attributes object
  
  scripting object
  
  Controls the languages supported by the Elasticsearch cluster, such as Painless, Mustache, and Expressions. Controls how the languages are used, such as file, index, and inline. TIP: For complex configurations, leave these blank and configure these settings in the user YAML or JSON.
  
  Hide scripting attributes Show scripting attributes object
  
  painless_enabled boolean
  
  (5.x+ only) If enabled (the default) then the painless scripting engine is allowed as a sandboxed language. Sandboxed languages are the only ones allowed if 'sandbox_mode' is set to true. NOTES: (Corresponds to the parameters 'script.engine.painless.[file|stored|inline]')
  
  mustache_enabled boolean
  
  (5.x+ only) If enabled (the default) then the mustache scripting engine is allowed as a sandboxed language. Sandboxed languages are the only ones allowed if 'sandbox_mode' is set to true. NOTES: (Corresponds to the parameters 'script.engine.mustache.[file|stored|inline]')
  
  expressions_enabled boolean
  
  (5.x+ only) If enabled (the default) then the expressions scripting engine is allowed as a sandboxed language. Sandboxed languages are the only ones allowed if 'sandbox_mode' is set to true. NOTES: (Corresponds to the parameters 'script.engine.expression.[file|stored|inline]')
  
  stored object
  
  Enables scripting for the specified type and controls other parameters. Store scripts in indexes (stored), upload in file bundles (file), or use in API requests (inline).
  
  Hide stored attributes Show stored attributes object
  
  enabled boolean
  
  If enabled (default: true) then scripts are enabled, either for sandboxing languages (by default), or for all installed languages if 'sandbox_mode' is disabled (or for 6.x). NOTES: (Corresponds to the parameter 'script.file|stored/indexed|inline')
  
  sandbox_mode boolean
  
  If enabled (default: true) and this script type is enabled, then only the sandbox languages are allowed. By default the sandbox languages are painless, expressions and mustache, but this can be restricted via the 'painless_enabled', 'mustache_enabled' 'expression_enabled' settings.NOTES: Not supported in 6.x. (Corresponds to the parameters 'script.engine.[painless|mustache|expressions].[file|stored|inline]')
  
  file object
  
  Enables scripting for the specified type and controls other parameters. Store scripts in indexes (stored), upload in file bundles (file), or use in API requests (inline).
  
  Hide file attributes Show file attributes object
  
  enabled boolean
  
  If enabled (default: true) then scripts are enabled, either for sandboxing languages (by default), or for all installed languages if 'sandbox_mode' is disabled (or for 6.x). NOTES: (Corresponds to the parameter 'script.file|stored/indexed|inline')
  
  sandbox_mode boolean
  
  If enabled (default: true) and this script type is enabled, then only the sandbox languages are allowed. By default the sandbox languages are painless, expressions and mustache, but this can be restricted via the 'painless_enabled', 'mustache_enabled' 'expression_enabled' settings.NOTES: Not supported in 6.x. (Corresponds to the parameters 'script.engine.[painless|mustache|expressions].[file|stored|inline]')
  
  inline object
  
  Enables scripting for the specified type and controls other parameters. Store scripts in indexes (stored), upload in file bundles (file), or use in API requests (inline).
  
  Hide inline attributes Show inline attributes object
  
  enabled boolean
  
  If enabled (default: true) then scripts are enabled, either for sandboxing languages (by default), or for all installed languages if 'sandbox_mode' is disabled (or for 6.x). NOTES: (Corresponds to the parameter 'script.file|stored/indexed|inline')
  
  sandbox_mode boolean
  
  If enabled (default: true) and this script type is enabled, then only the sandbox languages are allowed. By default the sandbox languages are painless, expressions and mustache, but this can be restricted via the 'painless_enabled', 'mustache_enabled' 'expression_enabled' settings.NOTES: Not supported in 6.x. (Corresponds to the parameters 'script.engine.[painless|mustache|expressions].[file|stored|inline]')
  
  reindex_whitelist array[string]
  
  Limits remote Elasticsearch clusters that can be used as the source for '_reindex' API commands
  
  auto_create_index boolean
  
  If true (the default), then any write operation on an index that does not currently exist will create it. NOTES: (Corresponds to the parameter 'action.auto_create_index')
  
  enable_close_index boolean
  
  Defaults to false on versions <= 7.2.0, true otherwise. If false, then the API commands to close indices are disabled. This is important because Elasticsearch does not snapshot or migrate close indices on versions under 7.2.0, therefore standard Elastic Cloud configuration operations will cause irretrievable loss of indices' data. NOTES: (Corresponds to the parameter 'cluster.indices.close.enable')
  
  destructive_requires_name boolean
  
  If true (default is false) then the index deletion API will not support wildcards or '_all'. NOTES: (Corresponds to the parameter 'action.destructive_requires_name')
  
  watcher_trigger_engine string
  
  The trigger engine for Watcher, defaults to 'scheduler' - see the xpack documentation for more information. NOTES: (Corresponds to the parameter '(xpack.)watcher.trigger.schedule.engine', depending on version. Ignored from 6.x onwards.)
  
  default_shards_per_index integer(int32)
  
  (2.x only - to get the same result in 5.x template mappings must be used) Sets the default number of shards per index, defaulting to 1 if not specified. (Corresponds to the parameter 'index.number_of_shards' in 2.x, not supported in 5.x)
  
  monitoring_collection_interval integer(int32)
  
  The default interval at which monitoring information from the cluster if collected, if monitoring is enabled. NOTES: (Corresponds to the parameter 'marvel.agent.interval' in 2.x and 'xpack.monitoring.collection.interval' in 5.x)
  
  monitoring_history_duration string
  
  The duration for which monitoring history is stored (format '(NUMBER)d' eg '3d' for 3 days). NOTES: ('Corresponds to the parameter xpack.monitoring.history.duration' in 5.x, defaults to '7d')
  
  user_settings_json object
  
  An arbitrary JSON object allowing cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters arey are on the allowlist and not on the denylist. NOTES: (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Elasticsearch settings)
  
  user_settings_yaml string
  
  An arbitrary YAML object allowing cluster owners to set their parameters (only one of this and 'user_settings_json' is allowed), provided the parameters arey are on the allowlist and not on the denylist. NOTES: (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Elasticsearch settings)
  
  user_settings_override_json object
  
  An arbitrary JSON object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), ie in addition to the documented 'system_settings'. NOTES: (This field together with 'system_settings' and 'user_settings*' defines the total set of Elasticsearch settings)
  
  user_settings_override_yaml string
  
  An arbitrary YAML object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_json' is allowed), ie in addition to the documented 'system_settings'. NOTES: (This field together with 'system_settings' and 'user_settings*' defines the total set of Elasticsearch settings)
  
  enabled_built_in_plugins array[string]
  
  A list of plugin names from the Elastic-supported subset that are bundled with the version images. NOTES: (Users should consult the Elastic stack objects to see what plugins are available, this is currently only available from the UI)
  
  user_plugins array[object]
  
  A list of admin-uploaded plugin objects that are available for this user.
  
  A list of admin-uploaded plugin objects.
  
  Hide user_plugins attributes Show user_plugins attributes object
  
  name string Required
  
  The name of the plugin
  
  url string Required
  
  The URL of the plugin (must be accessible from the ECE infrastructure)
  
  elasticsearch_version string Required
  
  The supported Elasticsearch version (must match the version in the plan)
  
  user_bundles array[object]
  
  A list of admin-uploaded bundle objects (eg scripts, synonym files) that are available for this user.
  
  A list of admin-uploaded bundle objects, such as scripts and synonym files.
  
  Hide user_bundles attributes Show user_bundles attributes object
  
  name string Required
  
  The name of the bundle
  
  url string Required
  
  The URL of the bundle, which must be accessible from the ECE infrastructure. This URL could be cached by platform, make sure to change it when updating the bundle
  
  elasticsearch_version string Required
  
  The supported Elasticsearch version (must match the version in the plan)
  
  curation object
  
  The structure that defines the routing settings for index curation.
  
  Hide curation attributes Show curation attributes object
  
  from_instance_configuration_id string Required
  
  The source instance configuration
  
  to_instance_configuration_id string Required
  
  The destination instance configuration
  
  node_attributes object
  
  Defines the Elasticsearch node attributes for the instances in the topology
  
  Hide node_attributes attribute Show node_attributes attribute object
  
  * string Additional properties
  
  instance_configuration_id string
  
  Controls the allocation of this topology element as well as allowed sizes and node_types. It needs to match the id of an existing instance configuration.
  
  instance_configuration_version integer(int32)
  
  The version of the Instance Configuration Id. If it is unset, the meaning depends on read vs writes. For deployment reads, it is equivalent to version 0 (or the IC is unversioned); for deployment creates and deployment template use, it is equivalent to 'the latest version'; and for deployment updates, it is equivalent to 'retain the current version'.
  
  size object
  
  Measured by the amount of a resource. The final cluster size is calculated using multipliers from the topology instance configuration.
  
  Hide size attributes Show size attributes object
  
  value integer(int32) Required
  
  Amount of resource
  
  resource string Required
  
  Type of resource. In ESS the resource used should always be memory.
  
  Values are memory or storage.
  
  autoscaling_min object
  
  Measured by the amount of a resource. The final cluster size is calculated using multipliers from the topology instance configuration.
  
  Hide autoscaling_min attributes Show autoscaling_min attributes object
  
  value integer(int32) Required
  
  Amount of resource
  
  resource string Required
  
  Type of resource. In ESS the resource used should always be memory.
  
  Values are memory or storage.
  
  autoscaling_max object
  
  Measured by the amount of a resource. The final cluster size is calculated using multipliers from the topology instance configuration.
  
  Hide autoscaling_max attributes Show autoscaling_max attributes object
  
  value integer(int32) Required
  
  Amount of resource
  
  resource string Required
  
  Type of resource. In ESS the resource used should always be memory.
  
  Values are memory or storage.
  
  autoscaling_policy_override_json object
  
  An arbitrary JSON object overriding the default autoscaling policy. Don't set unless you really know what you are doing.
  
  topology_element_control object
  
  Controls for the topology element. Only used as part of the deployment template. Ignored if included as part of a deployment.
  
  Hide topology_element_control attribute Show topology_element_control attribute object
  
  min object Required
  
  Measured by the amount of a resource. The final cluster size is calculated using multipliers from the topology instance configuration.
  
  Hide min attributes Show min attributes object
  
  value integer(int32) Required
  
  Amount of resource
  
  resource string Required
  
  Type of resource. In ESS the resource used should always be memory.
  
  Values are memory or storage.
  
  autoscaling_tier_override boolean
  
  Set to true to enable autoscaling for this topology element, even if the cluster-level 'autoscaling_enabled' field is false. Note that 'autoscaling_tier_override' cannot be set to false if cluster-level 'autoscaling_enabled' is true. Currently only supported for the 'ml' tier
  
  elasticsearch object Required
  
  The Elasticsearch cluster settings. When specified at the top level, provides a field-by-field default. When specified at the topology level, provides the override settings.
  
  Hide elasticsearch attributes Show elasticsearch attributes object
  
  version string
  
  The version of the Elasticsearch cluster (must be one of the ECE supported versions). Currently cannot be different across the topology (and is generally specified in the globals). Defaults to the latest version if not specified.
  
  docker_image string
  
  A docker URI that allows overriding of the default docker image specified for this version
  
  system_settings object
  
  A subset of Elasticsearch settings. TIP: To define the complete set of Elasticsearch settings, use ElasticsearchSystemSettings with user_settings_override* and user_settings*.
  
  Hide system_settings attributes Show system_settings attributes object
  
  scripting object
  
  Controls the languages supported by the Elasticsearch cluster, such as Painless, Mustache, and Expressions. Controls how the languages are used, such as file, index, and inline. TIP: For complex configurations, leave these blank and configure these settings in the user YAML or JSON.
  
  Hide scripting attributes Show scripting attributes object
  
  painless_enabled boolean
  
  (5.x+ only) If enabled (the default) then the painless scripting engine is allowed as a sandboxed language. Sandboxed languages are the only ones allowed if 'sandbox_mode' is set to true. NOTES: (Corresponds to the parameters 'script.engine.painless.[file|stored|inline]')
  
  mustache_enabled boolean
  
  (5.x+ only) If enabled (the default) then the mustache scripting engine is allowed as a sandboxed language. Sandboxed languages are the only ones allowed if 'sandbox_mode' is set to true. NOTES: (Corresponds to the parameters 'script.engine.mustache.[file|stored|inline]')
  
  expressions_enabled boolean
  
  (5.x+ only) If enabled (the default) then the expressions scripting engine is allowed as a sandboxed language. Sandboxed languages are the only ones allowed if 'sandbox_mode' is set to true. NOTES: (Corresponds to the parameters 'script.engine.expression.[file|stored|inline]')
  
  stored object
  
  Enables scripting for the specified type and controls other parameters. Store scripts in indexes (stored), upload in file bundles (file), or use in API requests (inline).
  
  Hide stored attributes Show stored attributes object
  
  enabled boolean
  
  If enabled (default: true) then scripts are enabled, either for sandboxing languages (by default), or for all installed languages if 'sandbox_mode' is disabled (or for 6.x). NOTES: (Corresponds to the parameter 'script.file|stored/indexed|inline')
  
  sandbox_mode boolean
  
  If enabled (default: true) and this script type is enabled, then only the sandbox languages are allowed. By default the sandbox languages are painless, expressions and mustache, but this can be restricted via the 'painless_enabled', 'mustache_enabled' 'expression_enabled' settings.NOTES: Not supported in 6.x. (Corresponds to the parameters 'script.engine.[painless|mustache|expressions].[file|stored|inline]')
  
  file object
  
  Enables scripting for the specified type and controls other parameters. Store scripts in indexes (stored), upload in file bundles (file), or use in API requests (inline).
  
  Hide file attributes Show file attributes object
  
  enabled boolean
  
  If enabled (default: true) then scripts are enabled, either for sandboxing languages (by default), or for all installed languages if 'sandbox_mode' is disabled (or for 6.x). NOTES: (Corresponds to the parameter 'script.file|stored/indexed|inline')
  
  sandbox_mode boolean
  
  If enabled (default: true) and this script type is enabled, then only the sandbox languages are allowed. By default the sandbox languages are painless, expressions and mustache, but this can be restricted via the 'painless_enabled', 'mustache_enabled' 'expression_enabled' settings.NOTES: Not supported in 6.x. (Corresponds to the parameters 'script.engine.[painless|mustache|expressions].[file|stored|inline]')
  
  inline object
  
  Enables scripting for the specified type and controls other parameters. Store scripts in indexes (stored), upload in file bundles (file), or use in API requests (inline).
  
  Hide inline attributes Show inline attributes object
  
  enabled boolean
  
  If enabled (default: true) then scripts are enabled, either for sandboxing languages (by default), or for all installed languages if 'sandbox_mode' is disabled (or for 6.x). NOTES: (Corresponds to the parameter 'script.file|stored/indexed|inline')
  
  sandbox_mode boolean
  
  If enabled (default: true) and this script type is enabled, then only the sandbox languages are allowed. By default the sandbox languages are painless, expressions and mustache, but this can be restricted via the 'painless_enabled', 'mustache_enabled' 'expression_enabled' settings.NOTES: Not supported in 6.x. (Corresponds to the parameters 'script.engine.[painless|mustache|expressions].[file|stored|inline]')
  
  reindex_whitelist array[string]
  
  Limits remote Elasticsearch clusters that can be used as the source for '_reindex' API commands
  
  auto_create_index boolean
  
  If true (the default), then any write operation on an index that does not currently exist will create it. NOTES: (Corresponds to the parameter 'action.auto_create_index')
  
  enable_close_index boolean
  
  Defaults to false on versions <= 7.2.0, true otherwise. If false, then the API commands to close indices are disabled. This is important because Elasticsearch does not snapshot or migrate close indices on versions under 7.2.0, therefore standard Elastic Cloud configuration operations will cause irretrievable loss of indices' data. NOTES: (Corresponds to the parameter 'cluster.indices.close.enable')
  
  destructive_requires_name boolean
  
  If true (default is false) then the index deletion API will not support wildcards or '_all'. NOTES: (Corresponds to the parameter 'action.destructive_requires_name')
  
  watcher_trigger_engine string
  
  The trigger engine for Watcher, defaults to 'scheduler' - see the xpack documentation for more information. NOTES: (Corresponds to the parameter '(xpack.)watcher.trigger.schedule.engine', depending on version. Ignored from 6.x onwards.)
  
  default_shards_per_index integer(int32)
  
  (2.x only - to get the same result in 5.x template mappings must be used) Sets the default number of shards per index, defaulting to 1 if not specified. (Corresponds to the parameter 'index.number_of_shards' in 2.x, not supported in 5.x)
  
  monitoring_collection_interval integer(int32)
  
  The default interval at which monitoring information from the cluster if collected, if monitoring is enabled. NOTES: (Corresponds to the parameter 'marvel.agent.interval' in 2.x and 'xpack.monitoring.collection.interval' in 5.x)
  
  monitoring_history_duration string
  
  The duration for which monitoring history is stored (format '(NUMBER)d' eg '3d' for 3 days). NOTES: ('Corresponds to the parameter xpack.monitoring.history.duration' in 5.x, defaults to '7d')
  
  user_settings_json object
  
  An arbitrary JSON object allowing cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters arey are on the allowlist and not on the denylist. NOTES: (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Elasticsearch settings)
  
  user_settings_yaml string
  
  An arbitrary YAML object allowing cluster owners to set their parameters (only one of this and 'user_settings_json' is allowed), provided the parameters arey are on the allowlist and not on the denylist. NOTES: (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Elasticsearch settings)
  
  user_settings_override_json object
  
  An arbitrary JSON object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), ie in addition to the documented 'system_settings'. NOTES: (This field together with 'system_settings' and 'user_settings*' defines the total set of Elasticsearch settings)
  
  user_settings_override_yaml string
  
  An arbitrary YAML object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_json' is allowed), ie in addition to the documented 'system_settings'. NOTES: (This field together with 'system_settings' and 'user_settings*' defines the total set of Elasticsearch settings)
  
  enabled_built_in_plugins array[string]
  
  A list of plugin names from the Elastic-supported subset that are bundled with the version images. NOTES: (Users should consult the Elastic stack objects to see what plugins are available, this is currently only available from the UI)
  
  user_plugins array[object]
  
  A list of admin-uploaded plugin objects that are available for this user.
  
  A list of admin-uploaded plugin objects.
  
  Hide user_plugins attributes Show user_plugins attributes object
  
  name string Required
  
  The name of the plugin
  
  url string Required
  
  The URL of the plugin (must be accessible from the ECE infrastructure)
  
  elasticsearch_version string Required
  
  The supported Elasticsearch version (must match the version in the plan)
  
  user_bundles array[object]
  
  A list of admin-uploaded bundle objects (eg scripts, synonym files) that are available for this user.
  
  A list of admin-uploaded bundle objects, such as scripts and synonym files.
  
  Hide user_bundles attributes Show user_bundles attributes object
  
  name string Required
  
  The name of the bundle
  
  url string Required
  
  The URL of the bundle, which must be accessible from the ECE infrastructure. This URL could be cached by platform, make sure to change it when updating the bundle
  
  elasticsearch_version string Required
  
  The supported Elasticsearch version (must match the version in the plan)
  
  curation object
  
  The structure that defines the routing settings for index curation.
  
  Hide curation attributes Show curation attributes object
  
  from_instance_configuration_id string Required
  
  The source instance configuration
  
  to_instance_configuration_id string Required
  
  The destination instance configuration
  
  node_attributes object
  
  Defines the Elasticsearch node attributes for the instances in the topology
  
  Hide node_attributes attribute Show node_attributes attribute object
  
  * string Additional properties
  
  deployment_template object
  
  Specifies the deployment template used to create the plan.
  
  Hide deployment_template attributes Show deployment_template attributes object
  
  id string Required
  
  The unique identifier of the deployment template
  
  version string
  
  A version identifier to disambiguate multiple revisions of the same template
  
  transient object
  
  Defines the configuration parameters that control how the plan is applied. For example, the Elasticsearch cluster topology and Elasticsearch settings.
  
  Hide transient attributes Show transient attributes object
  
  strategy object
  
  The options for performing a plan change. Specify only one property each time. The default is grow_and_shrink.
  
  Hide strategy attributes Show strategy attributes object
  
  rolling object
  
  Performs inline, rolling configuration changes that mutate existing containers. TIP: This is the fastest way to update a plan, but can fail for complex plan changes, such as topology changes. Also, this is less safe for configuration changes that leave a cluster in a non running state. NOTE: When you perform a major version upgrade, and 'group_by' is set to 'pass:macros[all]';, rolling is required.
  
  Hide rolling attributes Show rolling attributes object
  
  group_by string
  
  Specifies the grouping attribute to use when rolling several instances. Instances that share the same value for the provided attribute key are rolled together as a unit. Examples that make sense to use are '__all__' (roll all instances as a single unit), 'logical_zone_name' (roll instances by zone), '__name__' (roll one instance at a time, the default if not specified). Note that '__all__' is required when performing a major version upgrade
  
  allow_inline_resize boolean
  
  Whether we allow changing the capacity of instances (default false). This is currently implemented by stopping, re-creating then starting the affected instance on its associated allocator when performing the changes. NOTES: This requires a round-trip through the allocation infrastructure of the active constructor, as it has to reserve the target capacity without over-committing
  
  skip_synced_flush boolean
  
  Whether to skip attempting to do a synced flush on the filesystem of the container (default: false), which is less safe but may be required if the container is unhealthy
  
  shard_init_wait_time integer(int64)
  
  The time, in seconds, to wait for shards that show no progress of initializing before rolling the next group (default: 10 minutes)
  
  grow_and_shrink object
  
  A strategy that creates instances with the new plan, migrates data from the old instances, then shuts down the old instances. GrowShrinkStrategyConfig is safer than 'rolling' and ensures single node availability during a plan change, but can be a lot slower on larger clusters.
  
  rolling_grow_and_shrink object
  
  A strategy that creates new Elasticsearch instances, Kibana instances, and APM Servers with the new plan, then migrates the node data to minimize the amount of spare capacity.
  
  autodetect object
  
  A strategy that lets constructor choose the most optimal way to execute the plan.
  
  plan_configuration object
  
  The configuration settings for the timeout and fallback parameters.
  
  Hide plan_configuration attributes Show plan_configuration attributes object
  
  timeout integer(int64)
  
  The total timeout in seconds after which the plan is cancelled even if it is not complete. Defaults to 4x the max memory capacity per node (in MB). NOTES: A 3 zone cluster with 2 nodes of 2048 each would have a timeout of 4*2048=8192 seconds. Timeout does not include time required to run rollback actions.
  
  calm_wait_time integer(int64)
  
  This timeout determines how long to give a cluster after it responds to API calls before performing actual operations on it. It defaults to 5s
  
  skip_snapshot boolean
  
  If true (default: false), does not take (or require) a successful snapshot to be taken before performing any potentially destructive changes to this cluster
  
  max_snapshot_attempts integer(int32)
  
  If taking a snapshot (ie unless 'skip_snapshots': true) then will retry on failure at most this number of times (default: 5)
  
  max_snapshot_age integer(int64)
  
  When you take a snapshot and 'skip_snapshots' is false, specifies the maximum age in seconds of the most recent snapshot before a new snapshot is created. Default is 300
  
  extended_maintenance boolean
  
  If true (default false), does not clear the maintenance flag (which prevents its API from being accessed except by the constructor) on new instances added until after a snapshot has been restored, otherwise, the maintenance flag is cleared once the new instances successfully join the new cluster
  
  cluster_reboot string
  
  Set to 'forced' to force a reboot as part of the upgrade plan. NOTES: (ie taking an existing plan and leaving it alone except for setting 'transient.plan_configuration.cluster_reboot': 'forced' will reboot the cluster)
  
  Value is forced.
  
  restore_snapshot object
  
  Restores a snapshot from a local or remote repository.
  
  Hide restore_snapshot attributes Show restore_snapshot attributes object
  
  repository_name string
  
  If specified, contains the name of the snapshot repository - else will default to the Elastic Cloud system repo ('found-snapshots')
  
  snapshot_name string Required
  
  The name of the snapshot to restore. Use '__latest_success__' to get the most recent snapshot from the specified repository
  
  repository_config object
  
  Configures the location of a remote repository. The default is the system repository.
  
  Hide repository_config attribute Show repository_config attribute object
  
  raw_settings object
  
  The remote snapshot settings raw JSON - see the Elasticsearch '_snapshot' documentation for more details on supported formats
  
  restore_payload object
  
  The configuration for the restore command, such as which indices you want to restore.
  
  Hide restore_payload attributes Show restore_payload attributes object
  
  indices array[string]
  
  The list of indices to restore (supports +ve and -ve selection and wildcarding - see the default Elasticsearch index format documentation)
  
  raw_settings object
  
  This JSON object (merged with the 'indices' field (if present) is passed untouched into the restore command - see the Elasticsearch '_snapshot' documentation for more details on supported formats
  
  strategy string
  
  The restore strategy to use. Defaults to a full restore. Partial restore will attempt to restore unavailable indices only
  
  Values are partial, full, or recovery.
  
  source_cluster_id string
  
  If specified, contains the name of the source cluster id. Do not send this if you are sending repository_config
  
  remote_clusters object
  
  The list of resources used as remote clusters
  
  Hide remote_clusters attribute Show remote_clusters attribute object
  
  resources array[object] Required
  
  The remote resources
  
  The Elasticsearch resource used as a Remote Cluster.
  
  Hide resources attributes Show resources attributes object
  
  deployment_id string Required
  
  The id of the deployment
  
  elasticsearch_ref_id string Required
  
  The locally-unique user-specified id of an Elasticsearch Resource
  
  alias string Required
  
  The alias for this remote cluster. Aliases must only contain letters, digits, dashes and underscores
  
  skip_unavailable boolean
  
  If true, skip this cluster during search if it is disconnected. Default: false
  
  info object
  
  Information about a Remote Cluster.
  
  Hide info attributes Show info attributes object
  
  healthy boolean Required
  
  Whether or not the remote cluster is healthy
  
  connected boolean Required
  
  Whether or not there is at least one connection to the remote cluster.
  
  compatible boolean Required
  
  Whether or not the remote cluster version is compatible with this cluster version.
  
  trusted boolean Required
  
  Whether or not the remote cluster is trusted by this cluster.
  
  trusted_back boolean Required
  
  Whether or not the remote cluster trusts this cluster back.
  
  cluster_settings_json object
  
  If specified, contains transient settings to be applied to an Elasticsearch cluster during changes,default values shown below applied. These can be overridden by specifying them in the map (or null to unset). Additional settings can also be set. Settings will be cleared after the plan has finished. If not specified, no settings will be applied. NOTE: These settings are only explicitly cleared for 5.x+ clusters, they must be hand-reset to their defaults in 2.x- (or a cluster reboot will clear them).
  
  indices.store.throttle.max_bytes_per_sec: 120Mb
  
  indices.recovery.max_bytes_per_sec: 120Mb
  
  cluster.routing.allocation.cluster_concurrent_rebalance: 5
  
  cluster.routing.allocation.node_initial_primaries_recoveries: 5
  
  cluster.routing.allocation.node_concurrent_incoming_recoveries: 5 For version 8.1 and later no defaults are provided through this mechanism, but instead hardware dependent settings are provided to each instance.
  
  autoscaling_enabled boolean
  
  Enable autoscaling for this Elasticsearch cluster.
  
  settings object
  
  The settings for an Elasticsearch cluster.
  
  Hide settings attributes Show settings attributes object
  
  snapshot object
  
  The snapshot configuration settings for an Elasticsearch cluster.
  
  Hide snapshot attributes Show snapshot attributes object
  
  interval string
  
  Interval between snapshots, with the format 'length unit' (space is optional), where unit can be one of: d (day), h (hour), min (minute). Default is 30 minutes
  
  retention object
  
  Information about the Elasticsearch cluster snapshot retention.
  
  Hide retention attributes Show retention attributes object
  
  snapshots integer(int32)
  
  Number of snapshots to retain
  
  max_age string
  
  Total retention period for all snapshots, with the format 'length unit' (space is optional), where unit can be one of: d (day), h (hour), min (minute)
  
  slm boolean
  
  When set to true, the deployment will have SLM enabled. Default value is true.
  
  cron_expression string
  
  Cron expression indicating when should snapshots be taken. This can be enabled only if SLM is enabled for the deployment and 'interval' is not present
  
  monitoring object
  
  The settings for sending monitoring information to another cluster.
  
  Hide monitoring attribute Show monitoring attribute object
  
  target_cluster_id string Required
  
  The Id of the target cluster to which to send monitoring information
  
  metadata object
  
  The top-level configuration settings for the Elasticsearch cluster.
  
  Hide metadata attribute Show metadata attribute object
  
  name string
  
  The display name of the cluster
  
  curation object
  
  The index curation settings for an Elasticsearch cluster.
  
  Hide curation attribute Show curation attribute object
  
  specs array[object] Required
  
  Specifications for curation
  
  Specifies the conditions to trigger an Elasticsearch cluster curation.
  
  Hide specs attributes Show specs attributes object
  
  index_pattern string Required
  
  Index matching pattern
  
  trigger_interval_seconds integer(int32) Required
  
  Number of seconds after index creation to trigger this spec
  
  dedicated_masters_threshold integer(int32)
  
  Threshold starting from which the number of instances in the cluster results in the introduction of dedicated masters. If the cluster is downscaled to a number of nodes below this one, dedicated masters will be removed. Limit is inclusive. When provided the threshold setting is updated. A null value removes the field. Otherwise, the setting remains as it was set previously.
  
  traffic_filter object
  
  The configuration settings for the traffic filter.
  
  Hide traffic_filter attribute Show traffic_filter attribute object
  
  rulesets array[string] Required
  
  IDs of the traffic filter rulesets
  
  trust object
  
  Configuration of trust with other clusters.
  
  Hide trust attributes Show trust attributes object
  
  accounts array[object]
  
  The list of trust relationships with different accounts
  
  The trust relationship with the clusters of one account.
  
  Hide accounts attributes Show accounts attributes object
  
  account_id string Required
  
  the ID of the Account
  
  name string
  
  A human readable name of the trust relationship
  
  trust_all boolean Required
  
  If true, all clusters in this account will by default be trusted and the trust_allowlist is ignored.
  
  trust_allowlist array[string]
  
  The list of clusters to trust. Only used when trust_all is false.
  
  external array[object]
  
  The list of trust relationships with external entities
  
  The trust relationship with external entities (remote environments, remote accounts...).
  
  Hide external attributes Show external attributes object
  
  trust_relationship_id string Required
  
  The ID of the external trust relationship
  
  name string
  
  The name of the external trust relationship. Retrieved from the TrustRelationship and ignored on write.
  
  trust_all boolean Required
  
  If true, all clusters in this external entity will be trusted and the trust_allowlist is ignored.
  
  trust_allowlist array[string]
  
  The list of clusters to trust. Only used when trust_all is false.
  
  direct array[object]
  
  The list of trust relationships where the certificate is bundled with the trust setting. Allows configuring trust for clusters running outside of an Elastic Cloud managed environment or in an Elastic Cloud environment without an environment level trust established.
  
  The trust relationship with entities trusted directly having their certificate bundled together with the trust settings.
  
  Hide direct attributes Show direct attributes object
  
  uid string
  
  Auto generated identifier for this trust, allows distinguishing between update vs remove and add.
  
  name string Required
  
  a human readable name of the trust relationship
  
  type string
  
  The type can either be ESS, ECE, generic or proxy. If none is specified, then generic is assumed. If proxy is specified, trust_all should be false and trust_allowlist, scope_id and additional_node_names should be omitted.
  
  Values are ECE, ESS, generic, or proxy.
  
  trust_all boolean Required
  
  If true, scope_id is required and the trust_allowlist is ignored and all clusters matching the scope id will be trusted.
  
  trust_allowlist array[string]
  
  The list of clusters with matching scope to trust. Only used when trust_all is false. Providing one or more clusters makes scope_id mandatory.
  
  scope_id string
  
  A lowercase alphanumerical string of max 32 characters. Usually an organization id or an environment id, but could really be any suitable suffix for clusters using the CA certificate of this trust. Required unless trust_all is false and trust_allowlist is empty.
  
  additional_node_names array[string]
  
  A list of node names trusted in addition to those deducible from trust_allowlist and scope id. Allows trusting nodes that don't have a scoped name at the cost of maintaining the list. Mandatory if scope id is not defined. Wildcards are not allowed.
  
  certificates array[object] Required
  
  The public ca certificate(s) to trust. Only one is required, but it is possible to specify multiple certificates in order to facilitate key rotation.
  
  An x509 certificate used by a DirectTrustRelationship
  
  Hide certificates attributes Show certificates attributes object
  
  pem string Required
  
  The public ca certificate as string in PEM format.
  
  metadata object
  
  The certificate MetaData
  
  Hide metadata attributes Show metadata attributes object
  
  fingerprint string Required
  
  The fingerprint of the certificate
  
  valid_to string(date-time) Required
  
  The expiry date of the certificate in UTC
  
  valid_from string(date-time) Required
  
  The valid from date of the certificate in UTC
  
  also_trusted_by array[string]
  
  Other deployments also trusting this certificate
  
  keystore_contents object
  
  The contents of the Elasticsearch keystore.
  
  Hide keystore_contents attribute Show keystore_contents attribute object
  
  secrets object Required
  
  List of secrets
  
  Hide secrets attribute Show secrets attribute object
  
  * object Additional properties
  
  The value that you configure for the Elasticsearch keystore secret.
  
  Hide * attributes Show * attributes object
  
  value object
  
  Value of this setting. This can either be a string or a JSON object that is stored as a JSON string in the keystore. NOTE: When the keystore secret is unspecified, it is removed.
  
  as_file boolean
  
  Stores the keystore secret as a file. The default is false, which stores the keystore secret as string when value is a plain string, or true when value is an object.
  
  kibana array[object]
  
  A list of payloads for Kibana updates
  
  A Kibana creation request paired with the alias of the Elasticsearch cluster it should be paired with
  
  Hide kibana attributes Show kibana attributes object
  
  ref_id string Required
  
  A locally-unique user-specified id for Kibana
  
  elasticsearch_cluster_ref_id string Required
  
  Alias to the Elasticsearch Cluster to attach Kibana to
  
  display_name string
  
  The human readable name for the Kibana cluster (default: takes the name of its Elasticsearch cluster)
  
  region string Required
  
  The region where this resource exists
  
  plan object Required
  
  The plan for the Kibana instance.
  
  Hide plan attributes Show plan attributes object
  
  cluster_topology array[object]
  
  The topology of the Kibana nodes, including the number, capacity, and type of nodes, and where they can be allocated.
  
  Hide cluster_topology attributes Show cluster_topology attributes object
  
  instance_configuration_id string
  
  Controls the allocation of this topology element as well as allowed sizes and node_types. It needs to match the id of an existing instance configuration.
  
  instance_configuration_version integer(int32)
  
  The version of the Instance Configuration Id. If it is unset, the meaning depends on read vs writes. For deployment reads, it is equivalent to version 0 (or the IC is unversioned); for deployment creates and deployment template use, it is equivalent to 'the latest version'; and for deployment updates, it is equivalent to 'retain the current version'.
  
  size object
  
  Measured by the amount of a resource. The final cluster size is calculated using multipliers from the topology instance configuration.
  
  Hide size attributes Show size attributes object
  
  value integer(int32) Required
  
  Amount of resource
  
  resource string Required
  
  Type of resource. In ESS the resource used should always be memory.
  
  Values are memory or storage.
  
  zone_count integer(int32)
  
  number of zones in which nodes will be placed
  
  kibana object
  
  The Kibana instance settings. When specified at the top level, provides a field-by-field default. When specified at the topology level, provides the override settings.
  
  Hide kibana attributes Show kibana attributes object
  
  version string
  
  The version of the Kibana cluster (must be one of the ECE supported versions, and won't work unless it matches the Elasticsearch version. Leave blank to auto-detect version.)
  
  docker_image string
  
  A docker URI that allows overriding of the default docker image specified for this version
  
  system_settings object
  
  A subset of Kibana settings. TIP: To define the complete set of Elasticsearch settings, use KibanaSystemSettings with user_settings_override_ and user_settings_.
  
  Hide system_settings attributes Show system_settings attributes object
  
  elasticsearch_username string
  
  Optionally override the account within Elasticsearch - defaults to a system account that always exists (if specified, the password must also be specified). Note that this field is never returned from the API, it is write only.
  
  elasticsearch_password string
  
  Optionally override the account within Elasticsearch - defaults to a system account that always exists (if specified, the username must also be specified). Note that this field is never returned from the API, it is write only.
  
  user_settings_json object
  
  An arbitrary JSON object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters are on the allowlist and not on the denylist. (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Kibana settings)
  
  user_settings_yaml string
  
  An arbitrary YAML object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_json' is allowed), provided the parameters are on the allowlist and not on the denylist. (These field together with 'user_settings_override*' and 'system_settings' defines the total set of Kibana settings)
  
  user_settings_override_json object
  
  An arbitrary JSON object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Kibana settings)
  
  user_settings_override_yaml string
  
  An arbitrary YAML object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_json' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Kibana settings)
  
  kibana object Required
  
  The Kibana instance settings. When specified at the top level, provides a field-by-field default. When specified at the topology level, provides the override settings.
  
  Hide kibana attributes Show kibana attributes object
  
  version string
  
  The version of the Kibana cluster (must be one of the ECE supported versions, and won't work unless it matches the Elasticsearch version. Leave blank to auto-detect version.)
  
  docker_image string
  
  A docker URI that allows overriding of the default docker image specified for this version
  
  system_settings object
  
  A subset of Kibana settings. TIP: To define the complete set of Elasticsearch settings, use KibanaSystemSettings with user_settings_override_ and user_settings_.
  
  Hide system_settings attributes Show system_settings attributes object
  
  elasticsearch_username string
  
  Optionally override the account within Elasticsearch - defaults to a system account that always exists (if specified, the password must also be specified). Note that this field is never returned from the API, it is write only.
  
  elasticsearch_password string
  
  Optionally override the account within Elasticsearch - defaults to a system account that always exists (if specified, the username must also be specified). Note that this field is never returned from the API, it is write only.
  
  user_settings_json object
  
  An arbitrary JSON object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters are on the allowlist and not on the denylist. (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Kibana settings)
  
  user_settings_yaml string
  
  An arbitrary YAML object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_json' is allowed), provided the parameters are on the allowlist and not on the denylist. (These field together with 'user_settings_override*' and 'system_settings' defines the total set of Kibana settings)
  
  user_settings_override_json object
  
  An arbitrary JSON object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Kibana settings)
  
  user_settings_override_yaml string
  
  An arbitrary YAML object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_json' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Kibana settings)
  
  transient object
  
  Defines the configuration parameters that control how the plan is applied. For example, the Elasticsearch cluster topology and Kibana instance settings.
  
  Hide transient attributes Show transient attributes object
  
  strategy object
  
  The options for performing a plan change. Specify only one property each time. The default is grow_and_shrink.
  
  Hide strategy attributes Show strategy attributes object
  
  rolling object
  
  Performs inline, rolling configuration changes that mutate existing containers. TIP: This is the fastest way to update a plan, but can fail for complex plan changes, such as topology changes. Also, this is less safe for configuration changes that leave a cluster in a non running state. NOTE: When you perform a major version upgrade, and 'group_by' is set to 'pass:macros[all]';, rolling is required.
  
  Hide rolling attributes Show rolling attributes object
  
  group_by string
  
  Specifies the grouping attribute to use when rolling several instances. Instances that share the same value for the provided attribute key are rolled together as a unit. Examples that make sense to use are '__all__' (roll all instances as a single unit), 'logical_zone_name' (roll instances by zone), '__name__' (roll one instance at a time, the default if not specified). Note that '__all__' is required when performing a major version upgrade
  
  allow_inline_resize boolean
  
  Whether we allow changing the capacity of instances (default false). This is currently implemented by stopping, re-creating then starting the affected instance on its associated allocator when performing the changes. NOTES: This requires a round-trip through the allocation infrastructure of the active constructor, as it has to reserve the target capacity without over-committing
  
  skip_synced_flush boolean
  
  Whether to skip attempting to do a synced flush on the filesystem of the container (default: false), which is less safe but may be required if the container is unhealthy
  
  shard_init_wait_time integer(int64)
  
  The time, in seconds, to wait for shards that show no progress of initializing before rolling the next group (default: 10 minutes)
  
  grow_and_shrink object
  
  A strategy that creates instances with the new plan, migrates data from the old instances, then shuts down the old instances. GrowShrinkStrategyConfig is safer than 'rolling' and ensures single node availability during a plan change, but can be a lot slower on larger clusters.
  
  rolling_grow_and_shrink object
  
  A strategy that creates new Elasticsearch instances, Kibana instances, and APM Servers with the new plan, then migrates the node data to minimize the amount of spare capacity.
  
  autodetect object
  
  A strategy that lets constructor choose the most optimal way to execute the plan.
  
  plan_configuration object
  
  The configuration settings for the timeout and fallback parameters.
  
  Hide plan_configuration attributes Show plan_configuration attributes object
  
  timeout integer(int64)
  
  The total timeout in seconds after which the plan is cancelled even if it is not complete. Defaults to 4x the max memory capacity per node (in MB)
  
  calm_wait_time integer(int64)
  
  This timeout determines how long to give a cluster after it responds to API calls before performing actual operations on it. It defaults to 5s
  
  extended_maintenance boolean
  
  If true (default false), does not clear the maintenance flag (which prevents its API from being accessed except by the constructor) on new instances added until after a snapshot has been restored, otherwise, the maintenance flag is cleared once the new instances successfully join the new cluster
  
  cluster_reboot string
  
  Set to 'forced' to force a reboot as part of the upgrade plan
  
  Value is forced.
  
  settings object
  
  The settings for multiple Kibana instances.
  
  Hide settings attribute Show settings attribute object
  
  metadata object
  
  The top-level configuration settings for the Elasticsearch cluster.
  
  Hide metadata attribute Show metadata attribute object
  
  name string
  
  The display name of the cluster
  
  apm array[object]
  
  A list of payloads for APM updates
  
  An APM creation request paired with the alias of the Elasticsearch cluster it should be paired with
  
  Hide apm attributes Show apm attributes object
  
  ref_id string Required
  
  A locally-unique user-specified id for APM
  
  elasticsearch_cluster_ref_id string Required
  
  Alias to the Elasticsearch Cluster to attach APM to
  
  display_name string
  
  The human readable name for the APM cluster (default: takes the name of its Elasticsearch cluster)
  
  region string Required
  
  The region where this resource exists
  
  plan object Required
  
  The plan for the APM Server.
  
  Hide plan attributes Show plan attributes object
  
  cluster_topology array[object]
  
  Defines the topology of the APM Server nodes. For example, the number or capacity of the nodes, and where you can allocate the nodes.
  
  Hide cluster_topology attributes Show cluster_topology attributes object
  
  instance_configuration_id string
  
  Controls the allocation of this topology element as well as allowed sizes and node_types. It needs to match the id of an existing instance configuration.
  
  instance_configuration_version integer(int32)
  
  The version of the Instance Configuration Id. If it is unset, the meaning depends on read vs writes. For deployment reads, it is equivalent to version 0 (or the IC is unversioned); for deployment creates and deployment template use, it is equivalent to 'the latest version'; and for deployment updates, it is equivalent to 'retain the current version'.
  
  size object
  
  Measured by the amount of a resource. The final cluster size is calculated using multipliers from the topology instance configuration.
  
  Hide size attributes Show size attributes object
  
  value integer(int32) Required
  
  Amount of resource
  
  resource string Required
  
  Type of resource. In ESS the resource used should always be memory.
  
  Values are memory or storage.
  
  zone_count integer(int32)
  
  number of zones in which nodes will be placed
  
  apm object
  
  The configuration options for the APM Server.
  
  Hide apm attributes Show apm attributes object
  
  version string
  
  The version of the Apm cluster (must be one of the ECE supported versions, and won't work unless it matches the APM version. Leave blank to auto-detect version.)
  
  docker_image string
  
  A docker URI that allows overriding of the default docker image specified for this version
  
  system_settings object
  
  A structure that defines a curated subset of the APM Server settings. TIP: To define the complete set of APM Server setting, use ApmSystemSettings with user_settings_override_ and user_settings_.
  
  Hide system_settings attributes Show system_settings attributes object
  
  elasticsearch_username string
  
  Optionally override the account within APM - defaults to a system account that always exists (if specified, the password must also be specified). Note that this field is never returned from the API, it is write only.
  
  elasticsearch_password string
  
  Optionally override the account within APM - defaults to a system account that always exists (if specified, the username must also be specified). Note that this field is never returned from the API, it is write only.
  
  secret_token string
  
  Optionally override the secret token within APM - defaults to the previously existing secretToken
  
  debug_enabled boolean
  
  Optionally enable debug mode for APM servers - defaults false
  
  user_settings_json object
  
  An arbitrary JSON object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters are on the allowlist and not on the denylist. (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Apm settings)
  
  user_settings_yaml string
  
  An arbitrary YAML object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_json' is allowed), provided the parameters are on the allowlist and not on the denylist. (These field together with 'user_settings_override*' and 'system_settings' defines the total set of Apm settings)
  
  user_settings_override_json object
  
  An arbitrary JSON object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Apm settings)
  
  user_settings_override_yaml string
  
  An arbitrary YAML object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_json' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Apm settings)
  
  apm object Required
  
  The configuration options for the APM Server.
  
  Hide apm attributes Show apm attributes object
  
  version string
  
  The version of the Apm cluster (must be one of the ECE supported versions, and won't work unless it matches the APM version. Leave blank to auto-detect version.)
  
  docker_image string
  
  A docker URI that allows overriding of the default docker image specified for this version
  
  system_settings object
  
  A structure that defines a curated subset of the APM Server settings. TIP: To define the complete set of APM Server setting, use ApmSystemSettings with user_settings_override_ and user_settings_.
  
  Hide system_settings attributes Show system_settings attributes object
  
  elasticsearch_username string
  
  Optionally override the account within APM - defaults to a system account that always exists (if specified, the password must also be specified). Note that this field is never returned from the API, it is write only.
  
  elasticsearch_password string
  
  Optionally override the account within APM - defaults to a system account that always exists (if specified, the username must also be specified). Note that this field is never returned from the API, it is write only.
  
  secret_token string
  
  Optionally override the secret token within APM - defaults to the previously existing secretToken
  
  debug_enabled boolean
  
  Optionally enable debug mode for APM servers - defaults false
  
  user_settings_json object
  
  An arbitrary JSON object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters are on the allowlist and not on the denylist. (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Apm settings)
  
  user_settings_yaml string
  
  An arbitrary YAML object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_json' is allowed), provided the parameters are on the allowlist and not on the denylist. (These field together with 'user_settings_override*' and 'system_settings' defines the total set of Apm settings)
  
  user_settings_override_json object
  
  An arbitrary JSON object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Apm settings)
  
  user_settings_override_yaml string
  
  An arbitrary YAML object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_json' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Apm settings)
  
  transient object
  
  Defines the configuration parameters that control how the plan is applied. For example, the Elasticsearch cluster topology and APM Server settings.
  
  Hide transient attributes Show transient attributes object
  
  strategy object
  
  The options for performing a plan change. Specify only one property each time. The default is grow_and_shrink.
  
  Hide strategy attributes Show strategy attributes object
  
  rolling object
  
  Performs inline, rolling configuration changes that mutate existing containers. TIP: This is the fastest way to update a plan, but can fail for complex plan changes, such as topology changes. Also, this is less safe for configuration changes that leave a cluster in a non running state. NOTE: When you perform a major version upgrade, and 'group_by' is set to 'pass:macros[all]';, rolling is required.
  
  Hide rolling attributes Show rolling attributes object
  
  group_by string
  
  Specifies the grouping attribute to use when rolling several instances. Instances that share the same value for the provided attribute key are rolled together as a unit. Examples that make sense to use are '__all__' (roll all instances as a single unit), 'logical_zone_name' (roll instances by zone), '__name__' (roll one instance at a time, the default if not specified). Note that '__all__' is required when performing a major version upgrade
  
  allow_inline_resize boolean
  
  Whether we allow changing the capacity of instances (default false). This is currently implemented by stopping, re-creating then starting the affected instance on its associated allocator when performing the changes. NOTES: This requires a round-trip through the allocation infrastructure of the active constructor, as it has to reserve the target capacity without over-committing
  
  skip_synced_flush boolean
  
  Whether to skip attempting to do a synced flush on the filesystem of the container (default: false), which is less safe but may be required if the container is unhealthy
  
  shard_init_wait_time integer(int64)
  
  The time, in seconds, to wait for shards that show no progress of initializing before rolling the next group (default: 10 minutes)
  
  grow_and_shrink object
  
  A strategy that creates instances with the new plan, migrates data from the old instances, then shuts down the old instances. GrowShrinkStrategyConfig is safer than 'rolling' and ensures single node availability during a plan change, but can be a lot slower on larger clusters.
  
  rolling_grow_and_shrink object
  
  A strategy that creates new Elasticsearch instances, Kibana instances, and APM Servers with the new plan, then migrates the node data to minimize the amount of spare capacity.
  
  autodetect object
  
  A strategy that lets constructor choose the most optimal way to execute the plan.
  
  plan_configuration object
  
  The plan control configuration options for the APM Server.
  
  Hide plan_configuration attributes Show plan_configuration attributes object
  
  timeout integer(int64)
  
  The total timeout in seconds after which the plan is cancelled even if it is not complete. Defaults to 4x the max memory capacity per node (in MB)
  
  calm_wait_time integer(int64)
  
  This timeout determines how long to give a cluster after it responds to API calls before performing actual operations on it. It defaults to 5s
  
  extended_maintenance boolean
  
  If true (default false), does not clear the maintenance flag (which prevents its API from being accessed except by the constructor) on new instances added until after a snapshot has been restored, otherwise, the maintenance flag is cleared once the new instances successfully join the new cluster
  
  cluster_reboot string
  
  Set to 'forced' to force a reboot as part of the upgrade plan
  
  Value is forced.
  
  settings object
  
  The settings for the APM Server.
  
  Hide settings attribute Show settings attribute object
  
  metadata object
  
  The top-level configuration settings for the Elasticsearch cluster.
  
  Hide metadata attribute Show metadata attribute object
  
  name string
  
  The display name of the cluster
  
  appsearch array[object]
  
  A list of payloads for AppSearch updates. AppSearch has been replaced by Enterprise Search in the Elastic Stack 7.7 and higher
  
  An AppSearch creation request paired with the alias of the Elasticsearch cluster it should be paired with
  
  Hide appsearch attributes Show appsearch attributes object
  
  ref_id string Required
  
  A locally-unique user-specified id for AppSearch
  
  elasticsearch_cluster_ref_id string Required
  
  Alias to the Elasticsearch Cluster to attach AppSearch to
  
  display_name string
  
  The human readable name for the AppSearch cluster (default: takes the name of its Elasticsearch cluster)
  
  region string Required
  
  The region where this resource exists
  
  plan object Required
  
  The plan for the App Search cluster.
  
  Hide plan attributes Show plan attributes object
  
  cluster_topology array[object]
  
  Defines the topology of the AppSearch nodes (eg number/capacity of nodes, and where they can be allocated)
  
  Hide cluster_topology attributes Show cluster_topology attributes object
  
  node_type object
  
  Node types to enable for an AppSearch instance
  
  Hide node_type attributes Show node_type attributes object
  
  appserver boolean Required
  
  Defines whether this instance should run as Application/API server
  
  worker boolean Required
  
  Defines whether this instance should run as background worker
  
  instance_configuration_id string
  
  Controls the allocation of this topology element as well as allowed sizes and node_types. It needs to match the id of an existing instance configuration.
  
  instance_configuration_version integer(int32)
  
  The version of the Instance Configuration Id. If it is unset, the meaning depends on read vs writes. For deployment reads, it is equivalent to version 0 (or the IC is unversioned); for deployment creates and deployment template use, it is equivalent to 'the latest version'; and for deployment updates, it is equivalent to 'retain the current version'.
  
  size object
  
  Measured by the amount of a resource. The final cluster size is calculated using multipliers from the topology instance configuration.
  
  Hide size attributes Show size attributes object
  
  value integer(int32) Required
  
  Amount of resource
  
  resource string Required
  
  Type of resource. In ESS the resource used should always be memory.
  
  Values are memory or storage.
  
  zone_count integer(int32)
  
  number of zones in which nodes will be placed
  
  appsearch object
  
  Hide appsearch attributes Show appsearch attributes object
  
  version string
  
  The version of the AppSearch cluster (must be one of the ECE supported versions, and won't work unless it matches the Elasticsearch version. Leave blank to auto-detect version.)
  
  docker_image string
  
  A docker URI that allows overriding of the default docker image specified for this version
  
  system_settings object
  
  This structure defines a curated subset of the AppSearch settings. (This field together with 'user_settings_override*' and 'user_settings*' defines the total set of AppSearch settings)
  
  Hide system_settings attributes Show system_settings attributes object
  
  elasticsearch_url string
  
  Optionally override the URL to which to send data (for advanced users only, if unspecified the system selects an internal URL)
  
  elasticsearch_username string
  
  Optionally override the account within App Search - defaults to a system account that always exists (if specified, the password must also be specified). Note that this field is never returned from the API, it is write only.
  
  elasticsearch_password string
  
  Optionally override the account within App Search - defaults to a system account that always exists (if specified, the username must also be specified). Note that this field is never returned from the API, it is write only.
  
  secret_session_key string
  
  Optionally override the secret session key within App Search - defaults to the previously existing secretSession. Note that this field is never returned from the API, it is write only.
  
  user_settings_json object
  
  An arbitrary JSON object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters are on the allowlist and not on the denylist. (This field together with 'user_settings_override*' and 'system_settings' defines the total set of AppSearch settings)
  
  user_settings_yaml string
  
  An arbitrary YAML object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_json' is allowed), provided the parameters are on the allowlist and not on the denylist. (These field together with 'user_settings_override*' and 'system_settings' defines the total set of AppSearch settings)
  
  user_settings_override_json object
  
  An arbitrary JSON object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of AppSearch settings)
  
  user_settings_override_yaml string
  
  An arbitrary YAML object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_json' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of AppSearch settings)
  
  appsearch object Required
  
  Hide appsearch attributes Show appsearch attributes object
  
  version string
  
  The version of the AppSearch cluster (must be one of the ECE supported versions, and won't work unless it matches the Elasticsearch version. Leave blank to auto-detect version.)
  
  docker_image string
  
  A docker URI that allows overriding of the default docker image specified for this version
  
  system_settings object
  
  This structure defines a curated subset of the AppSearch settings. (This field together with 'user_settings_override*' and 'user_settings*' defines the total set of AppSearch settings)
  
  Hide system_settings attributes Show system_settings attributes object
  
  elasticsearch_url string
  
  Optionally override the URL to which to send data (for advanced users only, if unspecified the system selects an internal URL)
  
  elasticsearch_username string
  
  Optionally override the account within App Search - defaults to a system account that always exists (if specified, the password must also be specified). Note that this field is never returned from the API, it is write only.
  
  elasticsearch_password string
  
  Optionally override the account within App Search - defaults to a system account that always exists (if specified, the username must also be specified). Note that this field is never returned from the API, it is write only.
  
  secret_session_key string
  
  Optionally override the secret session key within App Search - defaults to the previously existing secretSession. Note that this field is never returned from the API, it is write only.
  
  user_settings_json object
  
  An arbitrary JSON object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters are on the allowlist and not on the denylist. (This field together with 'user_settings_override*' and 'system_settings' defines the total set of AppSearch settings)
  
  user_settings_yaml string
  
  An arbitrary YAML object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_json' is allowed), provided the parameters are on the allowlist and not on the denylist. (These field together with 'user_settings_override*' and 'system_settings' defines the total set of AppSearch settings)
  
  user_settings_override_json object
  
  An arbitrary JSON object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of AppSearch settings)
  
  user_settings_override_yaml string
  
  An arbitrary YAML object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_json' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of AppSearch settings)
  
  transient object
  
  Defines configuration parameters that control how the plan (ie consisting of the cluster topology and AppSearch settings) is applied
  
  Hide transient attributes Show transient attributes object
  
  strategy object
  
  The options for performing a plan change. Specify only one property each time. The default is grow_and_shrink.
  
  Hide strategy attributes Show strategy attributes object
  
  rolling object
  
  Performs inline, rolling configuration changes that mutate existing containers. TIP: This is the fastest way to update a plan, but can fail for complex plan changes, such as topology changes. Also, this is less safe for configuration changes that leave a cluster in a non running state. NOTE: When you perform a major version upgrade, and 'group_by' is set to 'pass:macros[all]';, rolling is required.
  
  Hide rolling attributes Show rolling attributes object
  
  group_by string
  
  Specifies the grouping attribute to use when rolling several instances. Instances that share the same value for the provided attribute key are rolled together as a unit. Examples that make sense to use are '__all__' (roll all instances as a single unit), 'logical_zone_name' (roll instances by zone), '__name__' (roll one instance at a time, the default if not specified). Note that '__all__' is required when performing a major version upgrade
  
  allow_inline_resize boolean
  
  Whether we allow changing the capacity of instances (default false). This is currently implemented by stopping, re-creating then starting the affected instance on its associated allocator when performing the changes. NOTES: This requires a round-trip through the allocation infrastructure of the active constructor, as it has to reserve the target capacity without over-committing
  
  skip_synced_flush boolean
  
  Whether to skip attempting to do a synced flush on the filesystem of the container (default: false), which is less safe but may be required if the container is unhealthy
  
  shard_init_wait_time integer(int64)
  
  The time, in seconds, to wait for shards that show no progress of initializing before rolling the next group (default: 10 minutes)
  
  grow_and_shrink object
  
  A strategy that creates instances with the new plan, migrates data from the old instances, then shuts down the old instances. GrowShrinkStrategyConfig is safer than 'rolling' and ensures single node availability during a plan change, but can be a lot slower on larger clusters.
  
  rolling_grow_and_shrink object
  
  A strategy that creates new Elasticsearch instances, Kibana instances, and APM Servers with the new plan, then migrates the node data to minimize the amount of spare capacity.
  
  autodetect object
  
  A strategy that lets constructor choose the most optimal way to execute the plan.
  
  plan_configuration object
  
  Hide plan_configuration attributes Show plan_configuration attributes object
  
  timeout integer(int64)
  
  The total timeout in seconds after which the plan is cancelled even if it is not complete. Defaults to 4x the max memory capacity per node (in MB)
  
  calm_wait_time integer(int64)
  
  This timeout determines how long to give a cluster after it responds to API calls before performing actual operations on it. It defaults to 5s
  
  move_instances array[object]
  
  The request that specifies the Elasticsearch or stateless (eg Kibana) instances to move to allocators as part of the upgrade plan. When used in conjunction with '__all__' (roll all instances as a single unit) strategy, these instances are not restarted, which can sometimes enable recovery plans when these instances are boot-looping.
  
  Hide move_instances attributes Show move_instances attributes object
  
  from string Required
  
  The instance id that is going to be moved
  
  to array[string]
  
  An optional list of allocator ids to which the instance should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)
  
  instance_down boolean
  
  Tells the infrastructure that the instance should be considered as permanently down when deciding how to migrate data to new nodes. If left blank then the system will automatically decide (currently: will treat the instances as up)
  
  move_allocators array[object]
  
  As part of the upgrade plan, identifies the move requests for the Kibana instances or APM Servers on the allocators.
  
  Hide move_allocators attributes Show move_allocators attributes object
  
  from string Required
  
  The allocator id off which all instances in the cluster should be moved
  
  to array[string]
  
  An optional list of allocator ids to which the instance(s) should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)
  
  allocator_down boolean
  
  Tells the infrastructure that all instances on the allocator should be considered as permanently down when deciding how to migrate data to new nodes. If left blank then the system will auto-decide (currently: will treat the allocator as up)
  
  reallocate_instances boolean
  
  If true (default: false) does not allow re-using any existing instances currently in the cluster, ie even unchanged instances will be re-created
  
  preferred_allocators array[string]
  
  List of allocators on which instances are placed if possible (if not possible/not specified then any available allocator with space is used)
  
  extended_maintenance boolean
  
  If true (default false), does not clear the maintenance flag (which prevents its API from being accessed except by the constructor) on new instances added until after a snapshot has been restored, otherwise, the maintenance flag is cleared once the new instances successfully join the new cluster
  
  cluster_reboot string
  
  Set to 'forced' to force a reboot as part of the upgrade plan
  
  Value is forced.
  
  settings object
  
  The settings for the App Search.
  
  Hide settings attribute Show settings attribute object
  
  metadata object
  
  The top-level configuration settings for the Elasticsearch cluster.
  
  Hide metadata attribute Show metadata attribute object
  
  name string
  
  The display name of the cluster
  
  enterprise_search array[object]
  
  A list of payloads for Enterprise Search updates
  
  An Enterprise Search creation request paired with the alias of the Elasticsearch cluster it should be paired with
  
  Hide enterprise_search attributes Show enterprise_search attributes object
  
  ref_id string Required
  
  A locally-unique user-specified id for Enterprise Search
  
  elasticsearch_cluster_ref_id string Required
  
  Alias to the Elasticsearch Cluster to attach Enterprise Search to
  
  display_name string
  
  The human readable name for the Enterprise Search cluster (default: takes the name of its Elasticsearch cluster)
  
  region string Required
  
  The region where this resource exists
  
  plan object Required
  
  The plan for the Enterprise Search cluster.
  
  Hide plan attributes Show plan attributes object
  
  cluster_topology array[object]
  
  Defines the topology of the Enterprise Search nodes (e.g. number/capacity of nodes, and where they can be allocated)
  
  Hide cluster_topology attributes Show cluster_topology attributes object
  
  node_type object
  
  Node types to enable for an Enterprise Search instance
  
  Hide node_type attributes Show node_type attributes object
  
  appserver boolean Required
  
  Defines whether this instance should run as Application/API server
  
  worker boolean Required
  
  Defines whether this instance should run as background worker
  
  connector boolean Required
  
  Defines whether this instance should run as Connector
  
  instance_configuration_id string
  
  Controls the allocation of this topology element as well as allowed sizes and node_types. It needs to match the id of an existing instance configuration.
  
  instance_configuration_version integer(int32)
  
  The version of the Instance Configuration Id. If it is unset, the meaning depends on read vs writes. For deployment reads, it is equivalent to version 0 (or the IC is unversioned); for deployment creates and deployment template use, it is equivalent to 'the latest version'; and for deployment updates, it is equivalent to 'retain the current version'.
  
  size object
  
  Measured by the amount of a resource. The final cluster size is calculated using multipliers from the topology instance configuration.
  
  Hide size attributes Show size attributes object
  
  value integer(int32) Required
  
  Amount of resource
  
  resource string Required
  
  Type of resource. In ESS the resource used should always be memory.
  
  Values are memory or storage.
  
  zone_count integer(int32)
  
  number of zones in which nodes will be placed
  
  enterprise_search object
  
  Hide enterprise_search attributes Show enterprise_search attributes object
  
  version string
  
  The version of the Enterprise Search cluster (must be one of the ECE supported versions, and won't work unless it matches the Elasticsearch version. Leave blank to auto-detect version.)
  
  docker_image string
  
  A docker URI that allows overriding of the default docker image specified for this version
  
  system_settings object
  
  This structure defines a curated subset of the Enterprise Search settings. (This field together with 'user_settings_override*' and 'user_settings*' defines the total set of Enterprise Search settings)
  
  Hide system_settings attributes Show system_settings attributes object
  
  elasticsearch_username string
  
  Optionally override the account within Enterprise Search - defaults to a system account that always exists (if specified, the password must also be specified). Note that this field is never returned from the API, it is write only.
  
  elasticsearch_password string
  
  Optionally override the account within Enterprise Search - defaults to a system account that always exists (if specified, the username must also be specified). Note that this field is never returned from the API, it is write only.
  
  secret_session_key string
  
  Optionally override the secret session key within Enterprise Search - defaults to the previously existing secretSession. Note that this field is never returned from the API, it is write only.
  
  user_settings_json object
  
  An arbitrary JSON object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters are on the allowlist and not on the denylist. (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Enterprise Search settings)
  
  user_settings_yaml string
  
  An arbitrary YAML object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_json' is allowed), provided the parameters are on the allowlist and not on the denylist. (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Enterprise Search settings)
  
  user_settings_override_json object
  
  An arbitrary JSON object allowing ECE admins to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), i.e. in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Enterprise Search settings)
  
  user_settings_override_yaml string
  
  An arbitrary YAML object allowing ECE admins to set clusters' parameters (only one of this and 'user_settings_override_json' is allowed), i.e. in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Enterprise Search settings)
  
  allocator_filter object
  
  node_configuration string
  
  memory_per_node object
  
  node_count_per_zone object
  
  enterprise_search object Required
  
  Hide enterprise_search attributes Show enterprise_search attributes object
  
  version string
  
  The version of the Enterprise Search cluster (must be one of the ECE supported versions, and won't work unless it matches the Elasticsearch version. Leave blank to auto-detect version.)
  
  docker_image string
  
  A docker URI that allows overriding of the default docker image specified for this version
  
  system_settings object
  
  This structure defines a curated subset of the Enterprise Search settings. (This field together with 'user_settings_override*' and 'user_settings*' defines the total set of Enterprise Search settings)
  
  Hide system_settings attributes Show system_settings attributes object
  
  elasticsearch_username string
  
  Optionally override the account within Enterprise Search - defaults to a system account that always exists (if specified, the password must also be specified). Note that this field is never returned from the API, it is write only.
  
  elasticsearch_password string
  
  Optionally override the account within Enterprise Search - defaults to a system account that always exists (if specified, the username must also be specified). Note that this field is never returned from the API, it is write only.
  
  secret_session_key string
  
  Optionally override the secret session key within Enterprise Search - defaults to the previously existing secretSession. Note that this field is never returned from the API, it is write only.
  
  user_settings_json object
  
  An arbitrary JSON object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters are on the allowlist and not on the denylist. (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Enterprise Search settings)
  
  user_settings_yaml string
  
  An arbitrary YAML object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_json' is allowed), provided the parameters are on the allowlist and not on the denylist. (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Enterprise Search settings)
  
  user_settings_override_json object
  
  An arbitrary JSON object allowing ECE admins to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), i.e. in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Enterprise Search settings)
  
  user_settings_override_yaml string
  
  An arbitrary YAML object allowing ECE admins to set clusters' parameters (only one of this and 'user_settings_override_json' is allowed), i.e. in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Enterprise Search settings)
  
  transient object
  
  Defines configuration parameters that control how the plan (i.e. consisting of the cluster topology and Enterprise Search settings) is applied
  
  Hide transient attributes Show transient attributes object
  
  strategy object
  
  The options for performing a plan change. Specify only one property each time. The default is grow_and_shrink.
  
  Hide strategy attributes Show strategy attributes object
  
  rolling object
  
  Performs inline, rolling configuration changes that mutate existing containers. TIP: This is the fastest way to update a plan, but can fail for complex plan changes, such as topology changes. Also, this is less safe for configuration changes that leave a cluster in a non running state. NOTE: When you perform a major version upgrade, and 'group_by' is set to 'pass:macros[all]';, rolling is required.
  
  Hide rolling attributes Show rolling attributes object
  
  group_by string
  
  Specifies the grouping attribute to use when rolling several instances. Instances that share the same value for the provided attribute key are rolled together as a unit. Examples that make sense to use are '__all__' (roll all instances as a single unit), 'logical_zone_name' (roll instances by zone), '__name__' (roll one instance at a time, the default if not specified). Note that '__all__' is required when performing a major version upgrade
  
  allow_inline_resize boolean
  
  Whether we allow changing the capacity of instances (default false). This is currently implemented by stopping, re-creating then starting the affected instance on its associated allocator when performing the changes. NOTES: This requires a round-trip through the allocation infrastructure of the active constructor, as it has to reserve the target capacity without over-committing
  
  skip_synced_flush boolean
  
  Whether to skip attempting to do a synced flush on the filesystem of the container (default: false), which is less safe but may be required if the container is unhealthy
  
  shard_init_wait_time integer(int64)
  
  The time, in seconds, to wait for shards that show no progress of initializing before rolling the next group (default: 10 minutes)
  
  grow_and_shrink object
  
  A strategy that creates instances with the new plan, migrates data from the old instances, then shuts down the old instances. GrowShrinkStrategyConfig is safer than 'rolling' and ensures single node availability during a plan change, but can be a lot slower on larger clusters.
  
  rolling_grow_and_shrink object
  
  A strategy that creates new Elasticsearch instances, Kibana instances, and APM Servers with the new plan, then migrates the node data to minimize the amount of spare capacity.
  
  autodetect object
  
  A strategy that lets constructor choose the most optimal way to execute the plan.
  
  plan_configuration object
  
  Hide plan_configuration attributes Show plan_configuration attributes object
  
  timeout integer(int64)
  
  The total timeout in seconds after which the plan is cancelled even if it is not complete. Defaults to 4x the max memory capacity per node (in MB)
  
  calm_wait_time integer(int64)
  
  This timeout determines how long to give a cluster after it responds to API calls before performing actual operations on it. It defaults to 5s
  
  move_instances array[object]
  
  The request that specifies the Elasticsearch or stateless (eg Kibana) instances to move to allocators as part of the upgrade plan. When used in conjunction with '__all__' (roll all instances as a single unit) strategy, these instances are not restarted, which can sometimes enable recovery plans when these instances are boot-looping.
  
  Hide move_instances attributes Show move_instances attributes object
  
  from string Required
  
  The instance id that is going to be moved
  
  to array[string]
  
  An optional list of allocator ids to which the instance should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)
  
  instance_down boolean
  
  Tells the infrastructure that the instance should be considered as permanently down when deciding how to migrate data to new nodes. If left blank then the system will automatically decide (currently: will treat the instances as up)
  
  move_allocators array[object]
  
  As part of the upgrade plan, identifies the move requests for the Kibana instances or APM Servers on the allocators.
  
  Hide move_allocators attributes Show move_allocators attributes object
  
  from string Required
  
  The allocator id off which all instances in the cluster should be moved
  
  to array[string]
  
  An optional list of allocator ids to which the instance(s) should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)
  
  allocator_down boolean
  
  Tells the infrastructure that all instances on the allocator should be considered as permanently down when deciding how to migrate data to new nodes. If left blank then the system will auto-decide (currently: will treat the allocator as up)
  
  reallocate_instances boolean
  
  If true (default: false) does not allow re-using any existing instances currently in the cluster, i.e. even unchanged instances will be re-created
  
  preferred_allocators array[string]
  
  List of allocators on which instances are placed if possible (if not possible/not specified then any available allocator with space is used)
  
  extended_maintenance boolean
  
  If true (default false), does not clear the maintenance flag (which prevents its API from being accessed except by the constructor) on new instances added until after a snapshot has been restored, otherwise, the maintenance flag is cleared once the new instances successfully join the new cluster
  
  cluster_reboot string
  
  Set to 'forced' to force a reboot as part of the upgrade plan
  
  Value is forced.
  
  settings object
  
  The settings for the Enterprise Search.
  
  Hide settings attribute Show settings attribute object
  
  metadata object
  
  The top-level configuration settings for the Elasticsearch cluster.
  
  Hide metadata attribute Show metadata attribute object
  
  name string
  
  The display name of the cluster
  
  integrations_server array[object]
  
  A list of payloads for Integrations Server updates
  
  An Integrations Server creation request paired with the alias of the Elasticsearch cluster it should be paired with
  
  Hide integrations_server attributes Show integrations_server attributes object
  
  ref_id string Required
  
  A locally-unique user-specified id for the Integrations Server
  
  elasticsearch_cluster_ref_id string Required
  
  Alias to the Elasticsearch Cluster to attach the Integrations Server to
  
  display_name string
  
  The human readable name for the Integrations Server cluster (default: takes the name of its Elasticsearch cluster)
  
  region string Required
  
  The region where this resource exists
  
  plan object Required
  
  The plan for the Integrations Server.
  
  Hide plan attributes Show plan attributes object
  
  cluster_topology array[object]
  
  Defines the topology of the Integrations Server nodes. For example, the number or capacity of the nodes, and where you can allocate the nodes.
  
  Hide cluster_topology attributes Show cluster_topology attributes object
  
  instance_configuration_id string
  
  Controls the allocation of this topology element as well as allowed sizes and node_types. It needs to match the id of an existing instance configuration.
  
  instance_configuration_version integer(int32)
  
  The version of the Instance Configuration Id. If it is unset, the meaning depends on read vs writes. For deployment reads, it is equivalent to version 0 (or the IC is unversioned); for deployment creates and deployment template use, it is equivalent to 'the latest version'; and for deployment updates, it is equivalent to 'retain the current version'.
  
  size object
  
  Measured by the amount of a resource. The final cluster size is calculated using multipliers from the topology instance configuration.
  
  Hide size attributes Show size attributes object
  
  value integer(int32) Required
  
  Amount of resource
  
  resource string Required
  
  Type of resource. In ESS the resource used should always be memory.
  
  Values are memory or storage.
  
  zone_count integer(int32)
  
  number of zones in which nodes will be placed
  
  integrations_server object
  
  The configuration options for the Integrations Server.
  
  Hide integrations_server attributes Show integrations_server attributes object
  
  version string
  
  The version of the Integrations Server cluster (must be one of the ECE supported versions, and won't work unless it matches the Integrations Server version. Leave blank to auto-detect version.)
  
  docker_image string
  
  A docker URI that allows overriding of the default docker image specified for this version
  
  system_settings object
  
  A structure that defines a curated subset of the Integrations Server settings. TIP: To define the complete set of Integrations Server setting, use IntegrationsSystemSettings with user_settings_override_ and user_settings_.
  
  Hide system_settings attributes Show system_settings attributes object
  
  elasticsearch_username string
  
  Optionally override the account within Integrations Server - defaults to a system account that always exists (if specified, the password must also be specified). Note that this field is never returned from the API, it is write only.
  
  elasticsearch_password string
  
  Optionally override the account within Integrations Server - defaults to a system account that always exists (if specified, the username must also be specified). Note that this field is never returned from the API, it is write only.
  
  secret_token string
  
  Optionally override the secret token within Integrations Server - defaults to the previously existing secretToken
  
  debug_enabled boolean
  
  Optionally enable debug mode for Integrations Server - defaults false
  
  user_settings_json object
  
  An arbitrary JSON object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters are on the allowlist and not on the denylist. (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Integrations Server settings)
  
  user_settings_yaml string
  
  An arbitrary YAML object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_json' is allowed), provided the parameters are on the allowlist and not on the denylist. (These field together with 'user_settings_override*' and 'system_settings' defines the total set of Integrations Server settings)
  
  user_settings_override_json object
  
  An arbitrary JSON object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Integrations Server settings)
  
  user_settings_override_yaml string
  
  An arbitrary YAML object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_json' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Integrations Server settings)
  
  mode string
  
  The mode the Integrations Server is operating in.
  
  Values are standalone or managed.
  
  integrations_server object Required
  
  The configuration options for the Integrations Server.
  
  Hide integrations_server attributes Show integrations_server attributes object
  
  version string
  
  The version of the Integrations Server cluster (must be one of the ECE supported versions, and won't work unless it matches the Integrations Server version. Leave blank to auto-detect version.)
  
  docker_image string
  
  A docker URI that allows overriding of the default docker image specified for this version
  
  system_settings object
  
  A structure that defines a curated subset of the Integrations Server settings. TIP: To define the complete set of Integrations Server setting, use IntegrationsSystemSettings with user_settings_override_ and user_settings_.
  
  Hide system_settings attributes Show system_settings attributes object
  
  elasticsearch_username string
  
  Optionally override the account within Integrations Server - defaults to a system account that always exists (if specified, the password must also be specified). Note that this field is never returned from the API, it is write only.
  
  elasticsearch_password string
  
  Optionally override the account within Integrations Server - defaults to a system account that always exists (if specified, the username must also be specified). Note that this field is never returned from the API, it is write only.
  
  secret_token string
  
  Optionally override the secret token within Integrations Server - defaults to the previously existing secretToken
  
  debug_enabled boolean
  
  Optionally enable debug mode for Integrations Server - defaults false
  
  user_settings_json object
  
  An arbitrary JSON object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters are on the allowlist and not on the denylist. (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Integrations Server settings)
  
  user_settings_yaml string
  
  An arbitrary YAML object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_json' is allowed), provided the parameters are on the allowlist and not on the denylist. (These field together with 'user_settings_override*' and 'system_settings' defines the total set of Integrations Server settings)
  
  user_settings_override_json object
  
  An arbitrary JSON object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Integrations Server settings)
  
  user_settings_override_yaml string
  
  An arbitrary YAML object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_json' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Integrations Server settings)
  
  mode string
  
  The mode the Integrations Server is operating in.
  
  Values are standalone or managed.
  
  transient object
  
  Defines the configuration parameters that control how the plan is applied. For example, the Elasticsearch cluster topology and Integrations Server settings.
  
  Hide transient attributes Show transient attributes object
  
  strategy object
  
  The options for performing a plan change. Specify only one property each time. The default is grow_and_shrink.
  
  Hide strategy attributes Show strategy attributes object
  
  rolling object
  
  Performs inline, rolling configuration changes that mutate existing containers. TIP: This is the fastest way to update a plan, but can fail for complex plan changes, such as topology changes. Also, this is less safe for configuration changes that leave a cluster in a non running state. NOTE: When you perform a major version upgrade, and 'group_by' is set to 'pass:macros[all]';, rolling is required.
  
  Hide rolling attributes Show rolling attributes object
  
  group_by string
  
  Specifies the grouping attribute to use when rolling several instances. Instances that share the same value for the provided attribute key are rolled together as a unit. Examples that make sense to use are '__all__' (roll all instances as a single unit), 'logical_zone_name' (roll instances by zone), '__name__' (roll one instance at a time, the default if not specified). Note that '__all__' is required when performing a major version upgrade
  
  allow_inline_resize boolean
  
  Whether we allow changing the capacity of instances (default false). This is currently implemented by stopping, re-creating then starting the affected instance on its associated allocator when performing the changes. NOTES: This requires a round-trip through the allocation infrastructure of the active constructor, as it has to reserve the target capacity without over-committing
  
  skip_synced_flush boolean
  
  Whether to skip attempting to do a synced flush on the filesystem of the container (default: false), which is less safe but may be required if the container is unhealthy
  
  shard_init_wait_time integer(int64)
  
  The time, in seconds, to wait for shards that show no progress of initializing before rolling the next group (default: 10 minutes)
  
  grow_and_shrink object
  
  A strategy that creates instances with the new plan, migrates data from the old instances, then shuts down the old instances. GrowShrinkStrategyConfig is safer than 'rolling' and ensures single node availability during a plan change, but can be a lot slower on larger clusters.
  
  rolling_grow_and_shrink object
  
  A strategy that creates new Elasticsearch instances, Kibana instances, and APM Servers with the new plan, then migrates the node data to minimize the amount of spare capacity.
  
  autodetect object
  
  A strategy that lets constructor choose the most optimal way to execute the plan.
  
  plan_configuration object
  
  The plan control configuration options for the Integrations Server.
  
  Hide plan_configuration attributes Show plan_configuration attributes object
  
  timeout integer(int64)
  
  The total timeout in seconds after which the plan is cancelled even if it is not complete. Defaults to 4x the max memory capacity per node (in MB)
  
  calm_wait_time integer(int64)
  
  This timeout determines how long to give a cluster after it responds to API calls before performing actual operations on it. It defaults to 5s
  
  extended_maintenance boolean
  
  If true (default false), does not clear the maintenance flag (which prevents its API from being accessed except by the constructor) on new instances added until after a snapshot has been restored, otherwise, the maintenance flag is cleared once the new instances successfully join the new cluster
  
  cluster_reboot string
  
  Set to 'forced' to force a reboot as part of the upgrade plan
  
  Value is forced.
  
  settings object
  
  The settings for the Integrations Server.
  
  Hide settings attribute Show settings attribute object
  
  metadata object
  
  The top-level configuration settings for the Elasticsearch cluster.
  
  Hide metadata attribute Show metadata attribute object
  
  name string
  
  The display name of the cluster
- settings object
  
  Additional configuration for the new deployment object.
  
  Hide settings attributes Show settings attributes object
  
  observability object
  
  The observability settings for a deployment
  
  Hide observability attributes Show observability attributes object
  
  logging object
  
  The logging settings for a deployment
  
  Hide logging attribute Show logging attribute object
  
  destination object Required
  
  The destination to send logs and metrics to
  
  Hide destination attributes Show destination attributes object
  
  deployment_id string Required
  
  The deployment to send logs and/or metrics to. Contains either the deployment's ID or 'self'.
  
  ref_id string
  
  RefId of the Elasticsearch cluster to send logs and/or metrics to. If not specified, refId is resolved automatically as long as the destination deployment contains a single Elasticsearch resource.
  
  metrics object
  
  The metrics settings for a deployment
  
  Hide metrics attribute Show metrics attribute object
  
  destination object Required
  
  The destination to send logs and metrics to
  
  Hide destination attributes Show destination attributes object
  
  deployment_id string Required
  
  The deployment to send logs and/or metrics to. Contains either the deployment's ID or 'self'.
  
  ref_id string
  
  RefId of the Elasticsearch cluster to send logs and/or metrics to. If not specified, refId is resolved automatically as long as the destination deployment contains a single Elasticsearch resource.
  
  autoscaling_enabled boolean
  
  Enable autoscaling for this deployment.
  
  auto_ops object
  
  AutoOps settings for this deployment.
  
  Hide auto_ops attribute Show auto_ops attribute object
  
  status string Required
  
  See AutoOps integration status for this deployment.
  
  Values are connected, not_connected, or excluded.
- metadata object
  
  Additional information about the current deployment object.
  
  Hide metadata attribute Show metadata attribute object
  
  tags array[object]
  
  Arbitrary user-defined metadata associated with this deployment
  
  The key-value pair.
  
  Hide tags attributes Show tags attributes object
  
  key string Required
  
  The metadata field name
  
  value string Required
  
  The metadata value
- alias string
  
  A user-defined alias to use in place of Cluster IDs for user-friendly URLs
400 application/json

The deployment cannot be successfully migrated to the template with the provided ID.
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 application/json

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 application/json

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

GET /deployments/{deployment_id}/migrate_template

curl \
 --request GET 'https://api.elastic-cloud.com/api/v1/deployments/{deployment_id}/migrate_template?template_id=string'

Stop instances

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

Stops 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 application/json

The stop 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 application/json

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 application/json
- 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 application/json

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}/_stop

curl \
 --request POST 'https://api.elastic-cloud.com/api/v1/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/{instance_ids}/_stop'

Stop maintenance mode

POST /deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/{instance_ids}/maintenance-mode/_stop

Stops maintenance mode of instances belonging to a 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 application/json

The stop maintenance mode 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 application/json

The stop 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 application/json
- 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 application/json

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}/maintenance-mode/_stop

curl \
 --request POST 'https://api.elastic-cloud.com/api/v1/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/{instance_ids}/maintenance-mode/_stop'

List Extensions

GET /deployments/extensions

Retrieves all of the available extensions.

Responses

200 application/json

The extensions that are available
Hide response attribute Show response attribute object
- extensions array[object] Required
  
  The list of extensions.
  
  An API extension. It represents clusters' plugins and bundles
  
  Hide extensions attributes Show extensions attributes object
  
  id string Required
  
  The extension ID
  
  name string Required
  
  The extension name.
  
  description string
  
  The extension description.
  
  url string Required
  
  The extension URL to be used in the plan.
  
  download_url string
  
  The download URL specified during extension creation.
  
  extension_type string Required
  
  The extension type.
  
  Values are plugin or bundle.
  
  version string Required
  
  The Elasticsearch version.
  
  deployments array[string]
  
  List of deployments using this extension. Up to only 10000 deployments will be included in the list.
  
  file_metadata object
  
  Hide file_metadata attributes Show file_metadata attributes object
  
  last_modified_date string(date-time)
  
  The date and time the extension was last modified.
  
  size integer(int64)
  
  The extension file size in bytes.
  
  url string(uri)
  
  The temporary URL to download the extension file. Usable for verification.

GET /deployments/extensions

curl \
 --request GET 'https://api.elastic-cloud.com/api/v1/deployments/extensions'

Create an extension

POST /deployments/extensions

Creates the extension. The extensions API supports two types of usage patterns. A). Specify a download_url, http or https URL, where the extension is currently hosted. This will result in extension being copied to elastic repository. B). Create only the extension metadata using the POST endpoint and then use PUT to upload the extension file. Leave the download_url unspecified in this case.

application/json

Body Required

the data that creates the extension

name string Required

The extension name. Only ASCII alphanumeric and [_.-] characters allowed
description string

The extension description.
download_url string

The URL to download the extension archive.
extension_type string Required

The extension type.

Values are plugin or bundle.
version string Required

The Elasticsearch version.

Responses

201 application/json

The extension that was just created.
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 extension ID
- name string Required
  
  The extension name.
- description string
  
  The extension description.
- url string Required
  
  The extension URL to be used in the plan.
- download_url string
  
  The download URL specified during extension creation.
- extension_type string Required
  
  The extension type.
  
  Values are plugin or bundle.
- version string Required
  
  The Elasticsearch version.
- deployments array[string]
  
  List of deployments using this extension. Up to only 10000 deployments will be included in the list.
- file_metadata object
  
  Hide file_metadata attributes Show file_metadata attributes object
  
  last_modified_date string(date-time)
  
  The date and time the extension was last modified.
  
  size integer(int64)
  
  The extension file size in bytes.
  
  url string(uri)
  
  The temporary URL to download the extension file. Usable for verification.
400 application/json

Could not download the extension from the specified URL. (code: extensions.request_execution_failed)
Hide headers attribute Show headers attribute
- x-cloud-error-codes string
  
  The error codes associated with the response
  
  Value is extensions.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
404 application/json

Your current session does not have a user id associated with it. (code: extensions.no_user_id)
Hide headers attribute Show headers attribute
- x-cloud-error-codes string
  
  The error codes associated with the response
  
  Value is extensions.no_user_id.
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
409 application/json

An extension already exists with the generated id. Please try again. (code: extensions.id_already_exists)
Hide headers attribute Show headers attribute
- x-cloud-error-codes string
  
  The error codes associated with the response
  
  Value is extensions.id_already_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/extensions

curl \
 --request POST 'https://api.elastic-cloud.com/api/v1/deployments/extensions' \
 --header "Content-Type: application/json" \
 --data '{"name":"string","description":"string","download_url":"string","extension_type":"plugin","version":"string"}'

Get Extension

GET /deployments/extensions/{extension_id}

Retrieves an extension.

Path parameters

extension_id string Required

Id of an extension

Query parameters

include_deployments boolean

Include deployments referencing this extension. Up to only 10000 deployments will be included.

Default value is false.

Responses

200 application/json

The Extension
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 extension ID
- name string Required
  
  The extension name.
- description string
  
  The extension description.
- url string Required
  
  The extension URL to be used in the plan.
- download_url string
  
  The download URL specified during extension creation.
- extension_type string Required
  
  The extension type.
  
  Values are plugin or bundle.
- version string Required
  
  The Elasticsearch version.
- deployments array[string]
  
  List of deployments using this extension. Up to only 10000 deployments will be included in the list.
- file_metadata object
  
  Hide file_metadata attributes Show file_metadata attributes object
  
  last_modified_date string(date-time)
  
  The date and time the extension was last modified.
  
  size integer(int64)
  
  The extension file size in bytes.
  
  url string(uri)
  
  The temporary URL to download the extension file. Usable for verification.
404 application/json

The extension requested does not exist. (code: extensions.not_found)
Hide headers attribute Show headers attribute
- x-cloud-error-codes string
  
  The error codes associated with the response
  
  Value is extensions.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 /deployments/extensions/{extension_id}

curl \
 --request GET 'https://api.elastic-cloud.com/api/v1/deployments/extensions/{extension_id}'

Update Extension

POST /deployments/extensions/{extension_id}

Updates an extension.

Path parameters

extension_id string Required

Id of an extension

application/json

Body Required

The extension update data.

name string Required

The extension name.
description string

The extension description.
download_url string

The URL to download the extension archive.
extension_type string Required

The extension type.

Values are plugin or bundle.
version string Required

The Elasticsearch version.

Responses

200 application/json

Extension updated successfully.
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 extension ID
- name string Required
  
  The extension name.
- description string
  
  The extension description.
- url string Required
  
  The extension URL to be used in the plan.
- download_url string
  
  The download URL specified during extension creation.
- extension_type string Required
  
  The extension type.
  
  Values are plugin or bundle.
- version string Required
  
  The Elasticsearch version.
- deployments array[string]
  
  List of deployments using this extension. Up to only 10000 deployments will be included in the list.
- file_metadata object
  
  Hide file_metadata attributes Show file_metadata attributes object
  
  last_modified_date string(date-time)
  
  The date and time the extension was last modified.
  
  size integer(int64)
  
  The extension file size in bytes.
  
  url string(uri)
  
  The temporary URL to download the extension file. Usable for verification.
400 application/json

Could not download the extension from the specified URL. (code: extensions.request_execution_failed)
Hide headers attribute Show headers attribute
- x-cloud-error-codes string
  
  The error codes associated with the response
  
  Value is extensions.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
401 application/json
- The extension does not belong to you. (code: extensions.unauthorised)
- Your current session does not have a user id associated with it. (code: extensions.no_user_id)
Hide headers attribute Show headers attribute
- x-cloud-error-codes string
  
  The error codes associated with the response
  
  Values are extensions.unauthorised or extensions.no_user_id.
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 application/json

The extension you want does not exist. (code: extensions.not_found)
Hide headers attribute Show headers attribute
- x-cloud-error-codes string
  
  The error codes associated with the response
  
  Value is extensions.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
409 application/json

The version you sent does not match the persisted version. (code: extensions.version_conflict)
Hide headers attribute Show headers attribute
- x-cloud-error-codes string
  
  The error codes associated with the response
  
  Value is extensions.version_conflict.
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/extensions/{extension_id}

curl \
 --request POST 'https://api.elastic-cloud.com/api/v1/deployments/extensions/{extension_id}' \
 --header "Content-Type: application/json" \
 --data '{"name":"string","description":"string","download_url":"string","extension_type":"plugin","version":"string"}'

Claim a link id

POST /deployments/traffic-filter/link-ids/_claim

Claim the ownership of a link id.

application/json

Body Required

The specification for traffic filter claimed link id.

link_id string

Link id. A GCP private service connect ID or AWS 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
region string Required

The claimed link id can be used only for traffic filter in the specific region

Responses

201 application/json

The ruleset definition is valid and the creation has started.
Hide response attributes Show response attributes object
- link_id string
  
  Link id. A GCP private service connect ID or AWS 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
- region string Required
  
  The claimed link id can be used only for traffic filter in the specific region
500 application/json

Error creating the traffic filter ruleset. (code: traffic_filter_claimed_link_id.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_claimed_link_id.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/link-ids/_claim

curl \
 --request POST 'https://api.elastic-cloud.com/api/v1/deployments/traffic-filter/link-ids/_claim' \
 --header "Content-Type: application/json" \
 --data '{"link_id":"string","azure_endpoint_name":"string","azure_endpoint_guid":"string","region":"string"}'

List traffic filter rulesets

GET /deployments/traffic-filter/rulesets

List all of the traffic filter rulesets.

Query parameters

include_associations boolean

Retrieves a list of resources that are associated to the specified ruleset.

Default value is false.
region string

If provided limits the rulesets to that region only.
organization_id string

Retrieves a list of resources that are associated to the specified organization ID. It only takes effect if the user is an admin.

Responses

200 application/json

The collection of traffic filter routes
Hide response attribute Show response attribute object
- rulesets array[object] Required
  
  List of traffic filter rules
  
  The container for a set of traffic filter rules.
  
  Hide rulesets attributes Show rulesets attributes object
  
  id string Required
  
  The ruleset ID
  
  name string Required
  
  Name of the ruleset
  
  description string
  
  Description of the ruleset
  
  type string Required
  
  Type of the ruleset
  
  Values are ip, azure_private_endpoint, gcp_private_service_connect_endpoint, vpce, egress_firewall, or remote_cluster.
  
  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
  
  The rule detail for a traffic filter egress rule.
  
  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.
  
  associations array[object]
  
  List of associations. Returned only when include_associations query parameter is true
  
  The association with a ruleset or user auth token for a deployment, template, or product.
  
  Hide associations attributes Show associations attributes object
  
  entity_type string Required
  
  Type of the traffic filter ruleset association, such as 'deployment', 'cluster'
  
  id string Required
  
  ID of the entity, such as the deployment ID or Elasticsearch cluster ID.
  
  total_associations integer(int32)
  
  Total number of associations. This includes associations the user does not have permission to view.Returned only when include_associations query parameter is true
500 application/json

Error fetching traffic filter rulesets. (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

GET /deployments/traffic-filter/rulesets

curl \
 --request GET 'https://api.elastic-cloud.com/api/v1/deployments/traffic-filter/rulesets'

List organizations

GET /organizations

Fetch organizations available to the current user. Currently unavailable in self-hosted ECE.

Responses

200 application/json

Organizations fetched successfully
Hide response attributes Show response attributes object
- organizations array[object] Required
  
  The list of organizations
  
  An organization
  
  Hide organizations attributes Show organizations attributes object
  
  id string Required
  
  The organization's identifier
  
  name string Required
  
  The organization's friendly name
  
  default_disk_usage_alerts_enabled boolean
  
  Whether the default disk alerts are enabled
  
  notifications_allowed_email_domains array[string]
  
  The list of allowed domains for notification-email recipients
  
  billing_contacts array[string]
  
  The list of contacts for billing notifications, if specified
  
  operational_contacts array[string]
  
  The list of contacts for operational notifications, if specified
  
  sso_login_identifier string
  
  The login identifier for initiating SSO
- next_page string
  
  A cursor to get the next page of results
401 application/json

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

curl \
 --request GET 'https://api.elastic-cloud.com/api/v1/organizations'

Tear down organization IdP

DELETE /organizations/{organization_id}/idp

Tear down up an organization's IdP. Currently unavailable in self-hosted ECE.

Path parameters

organization_id string Required

Identifier for the Organization

Responses

200 application/json

The IdP was successfully removed
404 application/json

Organization IdP not configured. (code: org.idp.idp_not_configured)
Hide headers attribute Show headers attribute
- x-cloud-error-codes string
  
  The error codes associated with the response
  
  Value is org.idp.idp_not_configured.
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 /organizations/{organization_id}/idp

curl \
 --request DELETE 'https://api.elastic-cloud.com/api/v1/organizations/{organization_id}/idp'

Get organization service provider SAML2 metadata.xml for configuring the identity provider

GET /organizations/{organization_id}/idp/metadata.xml

Gets the oranization's IdP metadata.xml. Currently unavailable in self-hosted ECE.

Path parameters

organization_id string Required

Identifier for the Organization

Responses

200 application/xml

The IdP info
404 application/xml

IdP was not configured yet. (code: org.idp.idp_not_configured)
Hide headers attribute Show headers attribute
- x-cloud-error-codes string
  
  The error codes associated with the response
  
  Value is org.idp.idp_not_configured.
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 /organizations/{organization_id}/idp/metadata.xml

curl \
 --request GET 'https://api.elastic-cloud.com/api/v1/organizations/{organization_id}/idp/metadata.xml'

List organization invitations

GET /organizations/{organization_id}/invitations

Fetch open invitations to the selected organization. Currently unavailable in self-hosted ECE.

Path parameters

organization_id string Required

Identifier for the Organization

Responses

200 application/json

Organization invitations fetched successfully
Hide response attribute Show response attribute object
- invitations array[object] Required
  
  The list of organization invitations
  
  An invitation to an organization
  
  Hide invitations attributes Show invitations attributes object
  
  token string Required
  
  The token used to accept the invitation
  
  email string Required
  
  The email address to invite to the organization
  
  created_at string(date-time) Required
  
  The date and time when the invitation was created
  
  expires_at string(date-time) Required
  
  The date and time when the invitation expires
  
  expired boolean Required
  
  True if the invitation is expired
  
  accepted_at string(date-time)
  
  The date and time when the invitation was accepted
  
  organization object Required
  
  An organization
  
  Hide organization attributes Show organization attributes object
  
  id string Required
  
  The organization's identifier
  
  name string Required
  
  The organization's friendly name
  
  default_disk_usage_alerts_enabled boolean
  
  Whether the default disk alerts are enabled
  
  notifications_allowed_email_domains array[string]
  
  The list of allowed domains for notification-email recipients
  
  billing_contacts array[string]
  
  The list of contacts for billing notifications, if specified
  
  operational_contacts array[string]
  
  The list of contacts for operational notifications, if specified
  
  sso_login_identifier string
  
  The login identifier for initiating SSO
  
  role_assignments object
  
  Roles assigned to users, API keys or organization invitations. Currently unavailable in self-hosted ECE.
  
  Hide role_assignments attributes Show role_assignments attributes object
  
  platform array[object]
  
  Assignments for roles with platform scope.
  
  Assignment for a role with platform scope.
  
  Hide platform attribute Show platform attribute object
  
  role_id string Required
  
  The ID of the role that is assigned.
  
  organization array[object]
  
  Assignments for roles with organization scope.
  
  Assignment for a role with organization scope.
  
  Hide organization attributes Show organization attributes object
  
  role_id string Required
  
  The ID of the role that is assigned.
  
  organization_id string Required
  
  The ID of the organization the role is scoped to.
  
  deployment array[object]
  
  Assignments for roles with deployment scope.
  
  Assignment for a role with deployment scope.
  
  Hide deployment attributes Show deployment attributes object
  
  role_id string Required
  
  The ID of the role that is assigned.
  
  organization_id string Required
  
  The ID of the organization the role is scoped to.
  
  all boolean
  
  When true, the role applies to all deployments in the organization, otherwise the role is scoped to the deployments specified in deployment_ids.
  
  deployment_ids array[string]
  
  The IDs of the deployments the role is scoped to. Must be absent if all is true, and present if all is false.
  
  application_roles array[string]
  
  If provided, the user assigned this role assignment will be granted this application role when signing in to the deployment(s) specified in the role assignment.
  
  project object
  
  Assignments for roles with project scope.
  
  Hide project attributes Show project attributes object
  
  elasticsearch array[object]
  
  The Elasticsearch project-scoped role assignments to set
  
  Assignment for a role with project scope.
  
  Hide elasticsearch attributes Show elasticsearch attributes object
  
  role_id string Required
  
  The ID of the role that is assigned.
  
  organization_id string Required
  
  The ID of the organization the role is scoped to.
  
  all boolean
  
  When true, the role applies to all projects in the organization, otherwise the role is scoped to the projects specified in project_ids.
  
  project_ids array[string]
  
  The IDs of the projects the role is scoped to. Must be absent if all is true, and present if all is false.
  
  application_roles array[string]
  
  If provided, the user assigned this role assignment will be granted this application role when signing in to the project(s) specified in the role assignment.
  
  observability array[object]
  
  The Observability project-scoped role assignments to set
  
  Assignment for a role with project scope.
  
  Hide observability attributes Show observability attributes object
  
  role_id string Required
  
  The ID of the role that is assigned.
  
  organization_id string Required
  
  The ID of the organization the role is scoped to.
  
  all boolean
  
  When true, the role applies to all projects in the organization, otherwise the role is scoped to the projects specified in project_ids.
  
  project_ids array[string]
  
  The IDs of the projects the role is scoped to. Must be absent if all is true, and present if all is false.
  
  application_roles array[string]
  
  If provided, the user assigned this role assignment will be granted this application role when signing in to the project(s) specified in the role assignment.
  
  security array[object]
  
  The Security project-scoped role assignments to set
  
  Assignment for a role with project scope.
  
  Hide security attributes Show security attributes object
  
  role_id string Required
  
  The ID of the role that is assigned.
  
  organization_id string Required
  
  The ID of the organization the role is scoped to.
  
  all boolean
  
  When true, the role applies to all projects in the organization, otherwise the role is scoped to the projects specified in project_ids.
  
  project_ids array[string]
  
  The IDs of the projects the role is scoped to. Must be absent if all is true, and present if all is false.
  
  application_roles array[string]
  
  If provided, the user assigned this role assignment will be granted this application role when signing in to the project(s) specified in the role assignment.
404 application/json

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

GET /organizations/{organization_id}/invitations

curl \
 --request GET 'https://api.elastic-cloud.com/api/v1/organizations/{organization_id}/invitations'

Delete organization memberships

DELETE /organizations/{organization_id}/members/{user_ids}

Deletes one or more organization memberships. Currently unavailable in self-hosted ECE.

Path parameters

organization_id string Required

Identifier for the Organization
user_ids string Required

CSV list of User identifiers

Query parameters

force boolean

Whether or not to force the removal of Org memberships (effective only for Platform Admins)

Default value is false.

Responses

200 application/json

Organization membership deleted successfully
404 application/json
- User not found. (code: user.not_found)
- Organization not found. (code: organization.not_found)
- Organization membership not found. (code: organization.membership_not_found)
Hide headers attribute Show headers attribute
- x-cloud-error-codes string
  
  The error codes associated with the response
  
  Values are user.not_found, organization.not_found, or organization.membership_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 /organizations/{organization_id}/members/{user_ids}

curl \
 --request DELETE 'https://api.elastic-cloud.com/api/v1/organizations/{organization_id}/members/{user_ids}'

Updates role mappings

PUT /organizations/{organization_id}/role_mappings

Updates the role assignments applicable when logging via SSO. Currently unavailable in self-hosted ECE.

Path parameters

organization_id string Required

Identifier for the Organization

application/json

Body Required

The role mappings to update

mappings array[object] Required

The rules for mapping role assignments in the organization
Hide mappings attributes Show mappings attributes object
- enabled boolean Required
  
  Whether or not the role mapping is enabled
- name string Required
  
  The name of the role mapping
- rule object Required
  Hide rule attributes Show rule attributes object
  
  any array[object]
  
  The rules that must match. Only one rule must match for the role assignment to be applied.
  
  Hide any attribute Show any attribute object
  
  group string Required
  
  The group to match. Can have wildcards.
  
  all array[object]
  
  The rules that must match. All rules must match for the role assignment to be applied.
  
  Hide all attribute Show all attribute object
  
  group string Required
  
  The group to match. Can have wildcards.
- role_assignments object Required
  
  Roles assigned to users, API keys or organization invitations. Currently unavailable in self-hosted ECE.
  Hide role_assignments attributes Show role_assignments attributes object
  
  platform array[object]
  
  Assignments for roles with platform scope.
  
  Assignment for a role with platform scope.
  
  Hide platform attribute Show platform attribute object
  
  role_id string Required
  
  The ID of the role that is assigned.
  
  organization array[object]
  
  Assignments for roles with organization scope.
  
  Assignment for a role with organization scope.
  
  Hide organization attributes Show organization attributes object
  
  role_id string Required
  
  The ID of the role that is assigned.
  
  organization_id string Required
  
  The ID of the organization the role is scoped to.
  
  deployment array[object]
  
  Assignments for roles with deployment scope.
  
  Assignment for a role with deployment scope.
  
  Hide deployment attributes Show deployment attributes object
  
  role_id string Required
  
  The ID of the role that is assigned.
  
  organization_id string Required
  
  The ID of the organization the role is scoped to.
  
  all boolean
  
  When true, the role applies to all deployments in the organization, otherwise the role is scoped to the deployments specified in deployment_ids.
  
  deployment_ids array[string]
  
  The IDs of the deployments the role is scoped to. Must be absent if all is true, and present if all is false.
  
  application_roles array[string]
  
  If provided, the user assigned this role assignment will be granted this application role when signing in to the deployment(s) specified in the role assignment.
  
  project object
  
  Assignments for roles with project scope.
  
  Hide project attributes Show project attributes object
  
  elasticsearch array[object]
  
  The Elasticsearch project-scoped role assignments to set
  
  Assignment for a role with project scope.
  
  Hide elasticsearch attributes Show elasticsearch attributes object
  
  role_id string Required
  
  The ID of the role that is assigned.
  
  organization_id string Required
  
  The ID of the organization the role is scoped to.
  
  all boolean
  
  When true, the role applies to all projects in the organization, otherwise the role is scoped to the projects specified in project_ids.
  
  project_ids array[string]
  
  The IDs of the projects the role is scoped to. Must be absent if all is true, and present if all is false.
  
  application_roles array[string]
  
  If provided, the user assigned this role assignment will be granted this application role when signing in to the project(s) specified in the role assignment.
  
  observability array[object]
  
  The Observability project-scoped role assignments to set
  
  Assignment for a role with project scope.
  
  Hide observability attributes Show observability attributes object
  
  role_id string Required
  
  The ID of the role that is assigned.
  
  organization_id string Required
  
  The ID of the organization the role is scoped to.
  
  all boolean
  
  When true, the role applies to all projects in the organization, otherwise the role is scoped to the projects specified in project_ids.
  
  project_ids array[string]
  
  The IDs of the projects the role is scoped to. Must be absent if all is true, and present if all is false.
  
  application_roles array[string]
  
  If provided, the user assigned this role assignment will be granted this application role when signing in to the project(s) specified in the role assignment.
  
  security array[object]
  
  The Security project-scoped role assignments to set
  
  Assignment for a role with project scope.
  
  Hide security attributes Show security attributes object
  
  role_id string Required
  
  The ID of the role that is assigned.
  
  organization_id string Required
  
  The ID of the organization the role is scoped to.
  
  all boolean
  
  When true, the role applies to all projects in the organization, otherwise the role is scoped to the projects specified in project_ids.
  
  project_ids array[string]
  
  The IDs of the projects the role is scoped to. Must be absent if all is true, and present if all is false.
  
  application_roles array[string]
  
  If provided, the user assigned this role assignment will be granted this application role when signing in to the project(s) specified in the role assignment.

Responses

200 application/json

An empty response
400 application/json

Validation error. (code: org.role_mapping_rule.syntax_error)
Hide headers attribute Show headers attribute
- x-cloud-error-codes string
  
  The error codes associated with the response
  
  Value is org.role_mapping_rule.syntax_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 application/json

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

PUT /organizations/{organization_id}/role_mappings

curl \
 --request PUT 'https://api.elastic-cloud.com/api/v1/organizations/{organization_id}/role_mappings' \
 --header "Content-Type: application/json" \
 --data '{"mappings":[{"enabled":true,"name":"string","rule":{"any":[{"group":"string"}],"all":[{"group":"string"}]},"role_assignments":{"platform":[{"role_id":"string"}],"organization":[{"role_id":"string","organization_id":"string"}],"deployment":[{"role_id":"string","organization_id":"string","all":true,"deployment_ids":["string"],"application_roles":["string"]}],"project":{"elasticsearch":[{"role_id":"string","organization_id":"string","all":true,"project_ids":["string"],"application_roles":["string"]}],"observability":[{"role_id":"string","organization_id":"string","all":true,"project_ids":["string"],"application_roles":["string"]}],"security":[{"role_id":"string","organization_id":"string","all":true,"project_ids":["string"],"application_roles":["string"]}]}}}]}'

Fetch current account information

Responses

Create API key

Body Required

Responses

Delete API key

Path parameters

Responses

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

Path parameters

Query parameters

Responses

Get charts by deployment. Currently unavailable in self-hosted ECE. Deprecated

Path parameters

Query parameters

Responses

Deployments

List Deployments

Responses

Update Deployment

Path parameters

Query parameters

Body Required

Responses

Shuts down Deployment

Path parameters

Query parameters

Responses

Set AppSearch read-only status

Path parameters

Responses

Set AppSearch read-only status

Path parameters

Body Required

Responses

Get the items in the Elasticsearch resource keystore

Path parameters

Responses

Get certificate based remote clusters

Path parameters

Responses

Get Deployment Enterprise Search Resource Info

Path parameters

Query parameters

Responses

Build request to migrate deployment to a different template

Path parameters

Query parameters

Responses

Stop instances

Path parameters

Query parameters

Responses

Stop maintenance mode

Path parameters

Query parameters

Responses

List Extensions

Responses

Create an extension

Body Required

Responses

Get Extension

Path parameters

Query parameters

Responses

Update Extension

Path parameters

Body Required

Responses

Deployments - Templates

Claim a link id

Body Required

Responses

List traffic filter rulesets

Query parameters

Responses

List organizations

Responses

Tear down organization IdP