Elastic Cloud Enterprise API
1

Base URL
https://{{hostname}}/api/v1

This RESTful API enables you to create and manage both your Elastic Stack deployments and the ECE platform.

NOTE: This documentation applies to the Elastic Cloud Enterprise API only. If you are using Elasticsearch Service, use the Elastic Cloud API.

This API supports both key-based and token-based authentication. Key-based is generally the preferred method. For details about creating an API key or bearer token, refer to Authentication.

Documentation source and versions

This documentation is derived from https://api.elastic-cloud.com/api/v1/api-docs/swagger.json. It is provided under license Attribution-NonCommercial-NoDerivatives 4.0 International.

This is version 1 of this API documentation. Last update on Oct 29, 2024.



Fetch current account information

GET /account

Fetch current account information.

Responses

  • 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

      Additional properties are allowed.

      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

  • Account not found. (code: accounts.not_found)

    Hide headers attribute Show headers attribute
    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 \
 -X GET https://{{hostname}}/api/v1/account
Response examples (200)
{
  "id": "string",
  "trust": {
    "trust_all": true
  }
}
Response examples (404)
# Headers
x-cloud-error-codes: accounts.not_found

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








Authentication

Manage your Elasticsearch Service API keys.

























Delete API keys

DELETE /users/auth/keys

Delete or invalidate API keys.

Body Required

The request to delete API keys

  • keys array[string] Required

    The list of API key IDs.

Responses

  • The API keys are deleted.

    Additional properties are allowed.

DELETE /users/auth/keys
curl \
 -X DELETE https://{{hostname}}/api/v1/users/auth/keys \
 -d '{"keys":["string"]}'
Request examples
{
  "keys": [
    "string"
  ]
}
Response examples (200)
{}












Delete API key

DELETE /users/auth/keys/{api_key_id}

Delete or invalidate the API key.

Path parameters

Responses

  • The API key is deleted.

    Additional properties are allowed.

  • The {api_key_id} can't be found. (code: api_keys.key_not_found)

    Hide headers attribute Show headers attribute
    • 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 \
 -X DELETE https://{{hostname}}/api/v1/users/auth/keys/{api_key_id}
Response examples (200)
{}
Response examples (404)
# Headers
x-cloud-error-codes: api_keys.key_not_found

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









































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

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

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.

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

    Values are daily or monthly. Default value is Daily.

Responses

  • The usage charts of a deployment.

    Hide response attribute Show response attribute object
    • data array[object] Required

      The list of 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

        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

  • The specified date range is invalid. (code: costs.invalid_date_range)

    Hide headers attribute Show headers attribute
    • 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

  • The current user does not have access to the requested organization. (code: organization.invalid_access)

    Hide headers attribute Show headers attribute
    • 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

  • Organization not found. (code: organization.not_found)

    Hide headers attribute Show headers attribute
    • 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

  • Too many requests. (code: billing_service.rate_limited)

    Hide headers attribute Show headers attribute
    • 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

  • Error fetching the itemized costs for the organization. (code: billing_service.failed_request)

    Hide headers attribute Show headers attribute
    • 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 \
 -X GET https://{{hostname}}/api/v1/billing/costs/{organization_id}/deployments/{deployment_id}/charts
Response examples (200)
{
  "data": [
    {
      "timestamp": 42,
      "values": [
        {
          "id": "string",
          "name": "string",
          "value": 42.0
        }
      ]
    }
  ]
}
Response examples (400)
# Headers
x-cloud-error-codes: costs.invalid_date_range

# Payload
{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}
Response examples (403)
# Headers
x-cloud-error-codes: organization.invalid_access

# Payload
{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}
Response examples (404)
# Headers
x-cloud-error-codes: organization.not_found

# Payload
{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}
Response examples (429)
# Headers
x-cloud-error-codes: billing_service.rate_limited

# Payload
{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}
Response examples (500)
# Headers
x-cloud-error-codes: billing_service.failed_request

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





















Update Comment

PUT /comments/{resource_type}/{resource_id}/{comment_id}

Updates a Comment.

Path parameters

  • resource_type string Required

    The kind of Resource that a Comment belongs to. Should be one of [elasticsearch, kibana, apm, appsearch, enterprise_search, integrations_server, allocator, constructor, runner, proxy].

  • resource_id string Required

    Id of the Resource that a Comment belongs to.

  • comment_id string Required

    Id of a Comment

Query parameters

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

Body Required

The Comment update data.

  • message string Required

    The message for the Comment.

Responses

  • Comment updated successfully.

    Hide headers attributes Show headers attributes
    Hide response attributes Show response attributes object
    • id string Required

      The id of this Comment

    • user_id string Required

      The user id of the user who wrote this Comment

    • message string Required

      The message content of this Comment

    • The Comment does not belong to you. (code: comments.unauthorised)
    • Your current session does not have a user id associated with it. (code: comments.no_user_id)
    Hide headers attribute Show headers attribute
    • The error codes associated with the response

      Values are comments.unauthorised or comments.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

  • The Comment you want does not exist. (code: comments.comment_does_not_exist)

    Hide headers attribute Show headers attribute
    • The error codes associated with the response

      Value is comments.comment_does_not_exist.

    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

  • The version you sent does not match the persisted version. (code: comments.version_conflict)

    Hide headers attribute Show headers attribute
    • The error codes associated with the response

      Value is comments.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

PUT /comments/{resource_type}/{resource_id}/{comment_id}
curl \
 -X PUT https://{{hostname}}/api/v1/comments/{resource_type}/{resource_id}/{comment_id} \
 -d '{"message":"string"}'
Request examples
{
  "message": "string"
}
Response examples (200)
# Headers
x-cloud-resource-version: string
x-cloud-resource-created: string
x-cloud-resource-last-modified: string

# Payload
{
  "id": "string",
  "user_id": "string",
  "message": "string"
}
Response examples (401)
# Headers
x-cloud-error-codes: comments.unauthorised

# Payload
{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}
Response examples (404)
# Headers
x-cloud-error-codes: comments.comment_does_not_exist

# Payload
{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}
Response examples (409)
# Headers
x-cloud-error-codes: comments.version_conflict

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









Create Deployment

POST /deployments

Creates a Deployment.

Query parameters

  • An optional idempotency token - if two create requests share the same request_id token (min size 32 characters, max 128) then only one deployment will be created, the second request will return the info of that deployment (in the same format described below, but with blanks for auth-related fields)

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

    Default value is false.

  • An optional template id - if present, the referenced template will be used to fill in the resources field of the deployment creation request. If any resources are present in the request together with the template, the ones coming in the request will prevail and no merging with the template will be performed.

Body Required

The deployment definition

  • name string

    A name for the deployment; otherwise this will be the generated deployment id

  • The Resources that will belong to this Deployment

    Additional properties are allowed.

    Hide resources attributes Show resources attributes object
    • elasticsearch array[object]

      A list of payloads for Elasticsearch cluster creation.

      Hide elasticsearch attributes Show elasticsearch attributes object
      • ref_id string Required

        A locally-unique user-specified id for this Elasticsearch cluster

      • 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 building this Elasticsearch cluster

        Additional properties are allowed.

        Hide plan attributes Show plan attributes object
        • cluster_topology array[object] Required
          Hide cluster_topology attributes Show cluster_topology attributes object
          • id string

            Unique identifier of this topology element

          • Controls the combinations of Elasticsearch node types. TIP: By default, the Elasticsearch node is master eligible, can hold data, and run ingest pipelines. WARNING: Do not set for tiebreaker topologies.

            Additional properties are allowed.

            Hide node_type attributes Show node_type attributes object
            • master boolean

              Defines whether this node can be elected master (default: false)

            • data boolean

              Defines whether this node can hold data (default: false)

            • ingest boolean

              Defines whether this node can run an ingest pipeline (default: false)

            • ml boolean

              Defines whether this node can run ml jobs, valid only for versions 5.4.0 or greater (default: false)

          • node_roles array[string]

            The list of node roles for this topology element (ES version >= 7.10). Allowable values are: master, ingest, ml, data_hot, data_content, data_warm, data_cold, data_frozen, remote_cluster_client, transform

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

          • memory_per_node integer(int32)

            The memory capacity in MB for each node of this type built in each zone.

          • node_count_per_zone integer(int32)

            The number of nodes of this type that are allocated within each zone. (i.e. total capacity per zone = node_count_per_zone * memory_per_node in MB). Cannot be set for tiebreaker topologies. For dedicated master nodes, must be 1 if an entry exists.

          • zone_count integer(int32)

            The default number of zones in which data nodes will be placed

          • The Elasticsearch cluster settings. When specified at the top level, provides a field-by-field default. When specified at the topology level, provides the override settings.

            Additional properties are allowed.

            Hide elasticsearch attributes Show elasticsearch attributes object
            • version string

              The version of the Elasticsearch cluster (must be one of the ECE supported versions). Currently cannot be different across the topology (and is generally specified in the globals). Defaults to the latest version if not specified.

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

            • A subset of Elasticsearch settings. TIP: To define the complete set of Elasticsearch settings, use ElasticsearchSystemSettings with user_settings_override* and user_settings*.

              Additional properties are allowed.

              Hide system_settings attributes Show system_settings attributes object
              • Controls the languages supported by the Elasticsearch cluster, such as Painless, Mustache, and Expressions. Controls how the languages are used, such as file, index, and inline. TIP: For complex configurations, leave these blank and configure these settings in the user YAML or JSON.

                Additional properties are allowed.

                Hide scripting attributes Show scripting attributes object
                • (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]')

                • (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]')

                • (5.x+ only) If enabled (the default) then the expressions scripting engine is allowed as a sandboxed language. Sandboxed languages are the only ones allowed if 'sandbox_mode' is set to true. NOTES: (Corresponds to the parameters 'script.engine.expression.[file|stored|inline]')

                • stored object

                  Enables scripting for the specified type and controls other parameters. Store scripts in indexes (stored), upload in file bundles (file), or use in API requests (inline).

                  Additional properties are allowed.

                  Hide stored attributes Show stored attributes object
                  • enabled boolean

                    If enabled (default: true) then scripts are enabled, either for sandboxing languages (by default), or for all installed languages if 'sandbox_mode' is disabled (or for 6.x). NOTES: (Corresponds to the parameter 'script.file|stored/indexed|inline')

                  • If enabled (default: true) and this script type is enabled, then only the sandbox languages are allowed. By default the sandbox languages are painless, expressions and mustache, but this can be restricted via the 'painless_enabled', 'mustache_enabled' 'expression_enabled' settings.NOTES: Not supported in 6.x. (Corresponds to the parameters 'script.engine.[painless|mustache|expressions].[file|stored|inline]')

                • file object

                  Enables scripting for the specified type and controls other parameters. Store scripts in indexes (stored), upload in file bundles (file), or use in API requests (inline).

                  Additional properties are allowed.

                  Hide file attributes Show file attributes object
                  • enabled boolean

                    If enabled (default: true) then scripts are enabled, either for sandboxing languages (by default), or for all installed languages if 'sandbox_mode' is disabled (or for 6.x). NOTES: (Corresponds to the parameter 'script.file|stored/indexed|inline')

                  • If enabled (default: true) and this script type is enabled, then only the sandbox languages are allowed. By default the sandbox languages are painless, expressions and mustache, but this can be restricted via the 'painless_enabled', 'mustache_enabled' 'expression_enabled' settings.NOTES: Not supported in 6.x. (Corresponds to the parameters 'script.engine.[painless|mustache|expressions].[file|stored|inline]')

                • inline object

                  Enables scripting for the specified type and controls other parameters. Store scripts in indexes (stored), upload in file bundles (file), or use in API requests (inline).

                  Additional properties are allowed.

                  Hide inline attributes Show inline attributes object
                  • enabled boolean

                    If enabled (default: true) then scripts are enabled, either for sandboxing languages (by default), or for all installed languages if 'sandbox_mode' is disabled (or for 6.x). NOTES: (Corresponds to the parameter 'script.file|stored/indexed|inline')

                  • 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

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

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

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

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

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

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

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

            • An arbitrary JSON object allowing cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters arey are on the allowlist and not on the denylist. NOTES: (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Elasticsearch settings)

              Additional properties are allowed.

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

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

              Additional properties are allowed.

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

            • A list of plugin names from the Elastic-supported subset that are bundled with the version images. NOTES: (Users should consult the Elastic stack objects to see what plugins are available, this is currently only available from the UI)

            • user_plugins array[object]

              A list of admin-uploaded plugin objects that are available for this user.

              Hide user_plugins attributes Show user_plugins attributes object
              • name string Required

                The name of the plugin

              • url string Required

                The URL of the plugin (must be accessible from the ECE infrastructure)

              • elasticsearch_version string Required

                The supported Elasticsearch version (must match the version in the plan)

            • user_bundles array[object]

              A list of admin-uploaded bundle objects (eg scripts, synonym files) that are available for this user.

              Hide user_bundles attributes Show user_bundles attributes object
              • name string Required

                The name of the bundle

              • url string Required

                The URL of the bundle, which must be accessible from the ECE infrastructure. This URL could be cached by platform, make sure to change it when updating the bundle

              • elasticsearch_version string Required

                The supported Elasticsearch version (must match the version in the plan)

            • curation object

              Defines the index curation routing for the cluster

              Additional properties are allowed.

              Hide curation attributes Show curation attributes object
            • Defines the Elasticsearch node attributes for the instances in the topology

              Hide node_attributes attribute Show node_attributes attribute object
              • * string Additional properties
          • 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.

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

          • size object

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

            Additional properties are allowed.

            Hide size attributes Show size attributes object
            • value integer(int32) Required

              Amount of resource

            • resource string Required

              Type of resource

              Values are memory or storage.

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

            Additional properties are allowed.

            Hide autoscaling_min attributes Show autoscaling_min attributes object
            • value integer(int32) Required

              Amount of resource

            • resource string Required

              Type of resource

              Values are memory or storage.

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

            Additional properties are allowed.

            Hide autoscaling_max attributes Show autoscaling_max attributes object
            • value integer(int32) Required

              Amount of resource

            • resource string Required

              Type of resource

              Values are memory or storage.

          • An arbitrary JSON object overriding the default autoscaling policy. Don't set unless you really know what you are doing.

            Additional properties are allowed.

          • Controls for the topology element. Only used as part of the deployment template. Ignored if included as part of a deployment.

            Additional properties are allowed.

            Hide topology_element_control attribute Show topology_element_control attribute object
            • min object Required

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

              Additional properties are allowed.

              Hide min attributes Show min attributes object
              • value integer(int32) Required

                Amount of resource

              • resource string Required

                Type of resource

                Values are memory or storage.

          • Set to true to enable autoscaling for this topology element, even if the cluster-level 'autoscaling_enabled' field is false. Note that 'autoscaling_tier_override' cannot be set to false if cluster-level 'autoscaling_enabled' is true. Currently only supported for the 'ml' tier

        • elasticsearch object Required

          The Elasticsearch cluster settings. When specified at the top level, provides a field-by-field default. When specified at the topology level, provides the override settings.

          Additional properties are allowed.

          Hide elasticsearch attributes Show elasticsearch attributes object
          • version string

            The version of the Elasticsearch cluster (must be one of the ECE supported versions). Currently cannot be different across the topology (and is generally specified in the globals). Defaults to the latest version if not specified.

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

          • A subset of Elasticsearch settings. TIP: To define the complete set of Elasticsearch settings, use ElasticsearchSystemSettings with user_settings_override* and user_settings*.

            Additional properties are allowed.

            Hide system_settings attributes Show system_settings attributes object
            • Controls the languages supported by the Elasticsearch cluster, such as Painless, Mustache, and Expressions. Controls how the languages are used, such as file, index, and inline. TIP: For complex configurations, leave these blank and configure these settings in the user YAML or JSON.

              Additional properties are allowed.

              Hide scripting attributes Show scripting attributes object
              • (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]')

              • (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]')

              • (5.x+ only) If enabled (the default) then the expressions scripting engine is allowed as a sandboxed language. Sandboxed languages are the only ones allowed if 'sandbox_mode' is set to true. NOTES: (Corresponds to the parameters 'script.engine.expression.[file|stored|inline]')

              • stored object

                Enables scripting for the specified type and controls other parameters. Store scripts in indexes (stored), upload in file bundles (file), or use in API requests (inline).

                Additional properties are allowed.

                Hide stored attributes Show stored attributes object
                • enabled boolean

                  If enabled (default: true) then scripts are enabled, either for sandboxing languages (by default), or for all installed languages if 'sandbox_mode' is disabled (or for 6.x). NOTES: (Corresponds to the parameter 'script.file|stored/indexed|inline')

                • If enabled (default: true) and this script type is enabled, then only the sandbox languages are allowed. By default the sandbox languages are painless, expressions and mustache, but this can be restricted via the 'painless_enabled', 'mustache_enabled' 'expression_enabled' settings.NOTES: Not supported in 6.x. (Corresponds to the parameters 'script.engine.[painless|mustache|expressions].[file|stored|inline]')

              • file object

                Enables scripting for the specified type and controls other parameters. Store scripts in indexes (stored), upload in file bundles (file), or use in API requests (inline).

                Additional properties are allowed.

                Hide file attributes Show file attributes object
                • enabled boolean

                  If enabled (default: true) then scripts are enabled, either for sandboxing languages (by default), or for all installed languages if 'sandbox_mode' is disabled (or for 6.x). NOTES: (Corresponds to the parameter 'script.file|stored/indexed|inline')

                • If enabled (default: true) and this script type is enabled, then only the sandbox languages are allowed. By default the sandbox languages are painless, expressions and mustache, but this can be restricted via the 'painless_enabled', 'mustache_enabled' 'expression_enabled' settings.NOTES: Not supported in 6.x. (Corresponds to the parameters 'script.engine.[painless|mustache|expressions].[file|stored|inline]')

              • inline object

                Enables scripting for the specified type and controls other parameters. Store scripts in indexes (stored), upload in file bundles (file), or use in API requests (inline).

                Additional properties are allowed.

                Hide inline attributes Show inline attributes object
                • enabled boolean

                  If enabled (default: true) then scripts are enabled, either for sandboxing languages (by default), or for all installed languages if 'sandbox_mode' is disabled (or for 6.x). NOTES: (Corresponds to the parameter 'script.file|stored/indexed|inline')

                • 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

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

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

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

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

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

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

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

          • An arbitrary JSON object allowing cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters arey are on the allowlist and not on the denylist. NOTES: (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Elasticsearch settings)

            Additional properties are allowed.

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

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

            Additional properties are allowed.

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

          • A list of plugin names from the Elastic-supported subset that are bundled with the version images. NOTES: (Users should consult the Elastic stack objects to see what plugins are available, this is currently only available from the UI)

          • user_plugins array[object]

            A list of admin-uploaded plugin objects that are available for this user.

            Hide user_plugins attributes Show user_plugins attributes object
            • name string Required

              The name of the plugin

            • url string Required

              The URL of the plugin (must be accessible from the ECE infrastructure)

            • elasticsearch_version string Required

              The supported Elasticsearch version (must match the version in the plan)

          • user_bundles array[object]

            A list of admin-uploaded bundle objects (eg scripts, synonym files) that are available for this user.

            Hide user_bundles attributes Show user_bundles attributes object
            • name string Required

              The name of the bundle

            • url string Required

              The URL of the bundle, which must be accessible from the ECE infrastructure. This URL could be cached by platform, make sure to change it when updating the bundle

            • elasticsearch_version string Required

              The supported Elasticsearch version (must match the version in the plan)

          • curation object

            Defines the index curation routing for the cluster

            Additional properties are allowed.

            Hide curation attributes Show curation attributes object
          • Defines the Elasticsearch node attributes for the instances in the topology

            Hide node_attributes attribute Show node_attributes attribute object
            • * string Additional properties
        • Documents which deployment template was used in the creation of this plan

          Additional properties are allowed.

          Hide deployment_template attributes Show deployment_template attributes object
          • id string Required

            The unique identifier of the deployment template

          • version string

            A version identifier to disambiguate multiple revisions of the same template

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

          Additional properties are allowed.

          Hide transient attributes Show transient attributes object
          • strategy object

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

            Additional properties are allowed.

            Hide strategy attributes Show strategy attributes object
            • rolling object

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

              Additional properties are allowed.

              Hide rolling attributes Show rolling attributes object
              • group_by string

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

              • 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

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

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

              Additional properties are allowed.

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

              Additional properties are allowed.

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

              Additional properties are allowed.

          • The configuration settings for the timeout and fallback parameters.

            Additional properties are allowed.

            Hide plan_configuration attributes Show plan_configuration attributes object
            • timeout integer(int64)

              The total timeout in seconds after which the plan is cancelled even if it is not complete. Defaults to 4x the max memory capacity per node (in MB). NOTES: A 3 zone cluster with 2 nodes of 2048 each would have a timeout of 4*2048=8192 seconds. Timeout does not include time required to run rollback actions.

            • calm_wait_time integer(int64)

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

            • move_instances array[object]
              Hide move_instances attributes Show move_instances attributes object
              • from string Required

                The instance id that is going to be moved

              • to array[string]

                An optional list of allocator ids to which the instance should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)

              • Tells the infrastructure that the instance should be considered as permanently down when deciding how to migrate data to new nodes. If left blank then the system will automatically decide (currently: will treat the instances as up)

            • move_allocators array[object]
              Hide move_allocators attributes Show move_allocators attributes object
              • from string Required

                The allocator id off which all instances in the cluster should be moved

              • to array[string]

                An optional list of allocator ids to which the instance(s) should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)

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

            • move_only boolean

              If true (default: false) only move_instances and move_allocators instructions will be executed, all other changes will be ignored

            • If true (default: false) does not allow re-using any existing instances currently in the cluster, ie even unchanged instances will be re-created

            • List of allocators on which instances are placed if possible (if not possible/not specified then any available allocator with space is used)

            • Map containing allocators tags in form of key value pairs, increasing the likelihood during move requests for allocators with matching tags, to be selected as target allocators

              Hide preferred_allocator_tags attribute Show preferred_allocator_tags attribute object
              • * string Additional properties
            • If true (default: false), does not take (or require) a successful snapshot to be taken before performing any potentially destructive changes to this cluster

            • 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

            • 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

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

            • If false (the default) then the plan will fail out if it believes the requested sequence of operations can result in data loss - this flag will override some of these restraints

            • If true (default: false) then the plan will not wait for data to be migrated from old instances to new instances before continuing the plan (potentially deleting the old instances and losing data)

            • If false, the cluster is checked for issues that should be resolved before migration (eg contains old Lucene segments), if true this is bypassed

            • If false (the default), the cluster will run (currently) 2.x->5.x operations for any plan change ending with a 5.x cluster (eg apply a cluster license, ensure Monitoring is configured)

            • If false (the default), the cluster will perform a snapshot after a major version upgrade takes place

          • Restores a snapshot from a local or remote repository.

            Additional properties are allowed.

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

            • Raw remote snapshot restore settings. Do not send this if you are sending source_cluster_id

              Additional properties are allowed.

              Hide repository_config attribute Show repository_config attribute object
              • The remote snapshot settings raw JSON - see the Elasticsearch '_snapshot' documentation for more details on supported formats

                Additional properties are allowed.

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

              Additional properties are allowed.

              Hide restore_payload attributes Show restore_payload attributes object
              • indices array[string]

                The list of indices to restore (supports +ve and -ve selection and wildcarding - see the default Elasticsearch index format documentation)

              • This JSON object (merged with the 'indices' field (if present) is passed untouched into the restore command - see the Elasticsearch '_snapshot' documentation for more details on supported formats

                Additional properties are allowed.

            • strategy string

              The restore strategy to use. Defaults to a full restore. Partial restore will attempt to restore unavailable indices only

              Values are partial, full, or recovery.

            • If specified, contains the name of the source cluster id. Do not send this if you are sending repository_config

          • The list of resources that will be configured as remote clusters

            Additional properties are allowed.

            Hide remote_clusters attribute Show remote_clusters attribute object
            • resources array[object] Required

              The remote resources

              Hide resources attributes Show resources attributes object
              • deployment_id string Required

                The id of the deployment

              • elasticsearch_ref_id string Required

                The locally-unique user-specified id of an Elasticsearch Resource

              • alias string Required

                The alias for this remote cluster. Aliases must only contain letters, digits, dashes and underscores

              • If true, skip this cluster during search if it is disconnected. Default: false

          • If specified, contains transient settings to be applied to an Elasticsearch cluster during changes,default values shown below applied. These can be overridden by specifying them in the map (or null to unset). Additional settings can also be set. Settings will be cleared after the plan has finished. If not specified, no settings will be applied. NOTE: These settings are only explicitly cleared for 5.x+ clusters, they must be hand-reset to their defaults in 2.x- (or a cluster reboot will clear them).

            • indices.store.throttle.max_bytes_per_sec: 120Mb
            • indices.recovery.max_bytes_per_sec: 120Mb
            • cluster.routing.allocation.cluster_concurrent_rebalance: 5
            • cluster.routing.allocation.node_initial_primaries_recoveries: 5
            • cluster.routing.allocation.node_concurrent_incoming_recoveries: 5 For version 8.1 and later no defaults are provided through this mechanism, but instead hardware dependent settings are provided to each instance.

            Additional properties are allowed.

        • Enable autoscaling for this Elasticsearch cluster.

      • settings object

        The settings for building this Elasticsearch cluster

        Additional properties are allowed.

        Hide settings attributes Show settings attributes object
        • snapshot object

          The snapshot settings for this deployment. When provided, snapshot settings are changed as specified. A null value reverts the field to the default value. Otherwise, all snapshot settings remain as they were set previously.

          Additional properties are allowed.

          Hide snapshot attributes Show snapshot attributes object
          • Snapshot repository configuration

            Additional properties are allowed.

            Hide repository attributes Show repository attributes object
            • static object

              Cluster snapshot static repository settings, containing repository type and settings

              Additional properties are allowed.

              Hide static attributes Show static attributes object
              • Type of snapshot repository, ie: S3

              • settings object

                Settings associated with snapshot repository

                Additional properties are allowed.

            • Cluster snapshot reference repository settings, containing the repository name in ECE fashion

              Additional properties are allowed.

              Hide reference attribute Show reference attribute object
              • ECE snapshot repository name, from the '/platform/configuration/snapshots/repositories' endpoint

            • default object

              Cluster snapshot default repository settings

              Additional properties are allowed.

          • 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

          • Interval between snapshot progress checks, with the format 'length unit' (space is optional), where unit can be one of: d (day), h (hour), min (minute). Default is 1 minute

          • The time to wait between snapshot phases (snapshot, purge), with the format 'length unit' (space is optional), where unit can be one of: d (day), h (hour), min (minute). Default is 10 minutes

          • enabled boolean

            Indicates if Snapshotting is enabled

          • suspended array[string]

            List of temporary snapshot suspensions

          • Cluster snapshot retention information

            Additional properties are allowed.

            Hide retention attributes Show retention attributes object
            • snapshots integer(int32)

              Number of snapshots to retain

            • max_age string

              Total retention period for all snapshots, with the format 'length unit' (space is optional), where unit can be one of: d (day), h (hour), min (minute)

          • 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

        • The monitoring settings for this deployment. When provided, monitoring settings are changed as specified. A null value reverts the field to the default value. Otherwise, all monitoring settings remain as they were set previously.

          Additional properties are allowed.

          Hide monitoring attribute Show monitoring attribute object
          • target_cluster_id string Required

            The Id of the target cluster to which to send monitoring information

        • metadata object

          The top-level configuration settings for the Elasticsearch cluster.

          Additional properties are allowed.

          Hide metadata attributes Show metadata attributes object
          • name string

            The display name of the cluster

          • owner_id string

            The user id (referencing whatever user database is in use) of the cluster owner

          • Subscription level of the cluster

          • Indicates if a cluster is system owned (restricts the set of operations that can be performed on it)

          • Contact email for the cluster

          • The top-level configuration settings for the Elasticsearch cluster resources.

            Additional properties are allowed.

            Hide resources attribute Show resources attribute object
            • cpu object

              Specifies the CPU resource settings for the Elasticsearch cluster.

              Additional properties are allowed.

              Hide cpu attributes Show cpu attributes object
              • boost boolean

                Indicates if the CPU boost flag is enabled or not.

              • hard_limit boolean

                Indicates if the CPU hard limit flag is enabled or not. When set to true (default), allocates CPU timeshare based on the total CPU time multiplied by the relative RAM capacity of the instance on a given host. When set to false, delegates CPU allocation to the operating system to schedule CPU timeshares.

        • curation object

          The curation settings for this deployment. When provided, curation settings are changed as specified. A null value reverts the field to the default value. Otherwise, all curation settings remain as they were set previously.

          Additional properties are allowed.

          Hide curation attribute Show curation attribute object
          • specs array[object] Required

            Specifications for curation

            Hide specs attributes Show specs attributes object
        • 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.

        • The rulesets to apply to all resources in this cluster. When specified, the set of rulesets is updated and the same rulesets will be applied to Kibana and APM clusters as well. If not specified, the rulesets remain as they were set previously.

          Additional properties are allowed.

          Hide traffic_filter attribute Show traffic_filter attribute object
          • rulesets array[string] Required

            IDs of the traffic filter rulesets

        • trust object

          Configuration of trust with other clusters. When provided, trust settings are changed as specified. A null value reverts the field to the default value. Otherwise, all trust settings remain as they were set previously.

          Additional properties are allowed.

          Hide trust attributes Show trust attributes object
          • accounts array[object]

            The list of trust relationships with different accounts

            Hide accounts attributes Show accounts attributes object
            • account_id string Required

              the ID of the Account

            • name string

              A human readable name of the trust relationship

            • trust_all boolean Required

              If true, all clusters in this account will by default be trusted and the trust_allowlist is ignored.

            • trust_allowlist array[string]

              The list of clusters to trust. Only used when trust_all is false.

          • external array[object]

            The list of trust relationships with external entities

            Hide external attributes Show external attributes object
            • trust_relationship_id string Required

              The ID of the external trust relationship

            • name string

              The name of the external trust relationship. Retrieved from the TrustRelationship and ignored on write.

            • trust_all boolean Required

              If true, all clusters in this external entity will be trusted and the trust_allowlist is ignored.

            • trust_allowlist array[string]

              The list of clusters to trust. Only used when trust_all is false.

          • direct array[object]

            The list of trust relationships where the certificate is bundled with the trust setting. Allows configuring trust for clusters running outside of an Elastic Cloud managed environment or in an Elastic Cloud environment without an environment level trust established.

            Hide direct attributes Show direct attributes object
            • uid string

              Auto generated identifier for this trust, allows distinguishing between update vs remove and add.

            • name string Required

              a human readable name of the trust relationship

            • type string

              The type can either be ESS, ECE, generic or proxy. If none is specified, then generic is assumed. If proxy is specified, trust_all should be false and trust_allowlist, scope_id and additional_node_names should be omitted.

              Values are ECE, ESS, generic, or proxy.

            • trust_all boolean Required

              If true, scope_id is required and the trust_allowlist is ignored and all clusters matching the scope id will be trusted.

            • trust_allowlist array[string]

              The list of clusters with matching scope to trust. Only used when trust_all is false. Providing one or more clusters makes scope_id mandatory.

            • scope_id string

              A lowercase alphanumerical string of max 32 characters. Usually an organization id or an environment id, but could really be any suitable suffix for clusters using the CA certificate of this trust. Required unless trust_all is false and trust_allowlist is empty.

            • A list of node names trusted in addition to those deducible from trust_allowlist and scope id. Allows trusting nodes that don't have a scoped name at the cost of maintaining the list. Mandatory if scope id is not defined. Wildcards are not allowed.

            • certificates array[object] Required

              The public ca certificate(s) to trust. Only one is required, but it is possible to specify multiple certificates in order to facilitate key rotation.

              Hide certificates attribute Show certificates attribute object
              • pem string Required

                The public ca certificate as string in PEM format.

        • The contents of the Elasticsearch keystore. It's a write only field.

          Additional properties are allowed.

          Hide keystore_contents attribute Show keystore_contents attribute object
          • secrets object Required

            List of secrets

            Hide secrets attribute Show secrets attribute object
            • * object Additional properties

              The value that you configure for the Elasticsearch keystore secret.

              Additional properties are allowed.

              Hide * attributes Show * attributes object
              • value object

                Value of this setting. This can either be a string or a JSON object that is stored as a JSON string in the keystore. NOTE: When the keystore secret is unspecified, it is removed.

                Additional properties are allowed.

              • as_file boolean

                Stores the keystore secret as a file. The default is false, which stores the keystore secret as string when value is a plain string, or true when value is an object.

    • kibana array[object]

      A list of payloads for Kibana creation.

      Hide kibana attributes Show kibana attributes object
      • ref_id string Required

        A locally-unique user-specified id for Kibana

      • Alias to the Elasticsearch Cluster to attach Kibana to

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

        Additional properties are allowed.

        Hide plan attributes Show plan attributes object
        • cluster_topology array[object]
          Hide cluster_topology attributes Show cluster_topology attributes object
          • memory_per_node integer(int32)

            The memory capacity in MB for each node of this type built in each zone.

          • node_count_per_zone integer(int32)

            The number of nodes of this type that are allocated within each zone (i.e. total capacity per zone = node_count_per_zone * memory_per_node in MB).

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

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

          • size object

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

            Additional properties are allowed.

            Hide size attributes Show size attributes object
            • value integer(int32) Required

              Amount of resource

            • resource string Required

              Type of resource

              Values are memory or storage.

          • zone_count integer(int32)

            number of zones in which nodes will be placed

          • kibana object

            The Kibana instance settings. When specified at the top level, provides a field-by-field default. When specified at the topology level, provides the override settings.

            Additional properties are allowed.

            Hide kibana attributes Show kibana attributes object
            • version string

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

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

            • A subset of Kibana settings. TIP: To define the complete set of Elasticsearch settings, use KibanaSystemSettings with user_settings_override_ and user_settings_.

              Additional properties are allowed.

              Hide system_settings attributes Show system_settings attributes object
              • DEPRECATED: Scheduled for removal in a future version of the API.

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

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

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

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

              Additional properties are allowed.

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

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

              Additional properties are allowed.

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

        • kibana object Required

          The Kibana instance settings. When specified at the top level, provides a field-by-field default. When specified at the topology level, provides the override settings.

          Additional properties are allowed.

          Hide kibana attributes Show kibana attributes object
          • version string

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

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

          • A subset of Kibana settings. TIP: To define the complete set of Elasticsearch settings, use KibanaSystemSettings with user_settings_override_ and user_settings_.

            Additional properties are allowed.

            Hide system_settings attributes Show system_settings attributes object
            • DEPRECATED: Scheduled for removal in a future version of the API.

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

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

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

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

            Additional properties are allowed.

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

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

            Additional properties are allowed.

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

        • Defines the configuration parameters that control how the plan is applied. For example, the Elasticsearch cluster topology and Kibana instance settings.

          Additional properties are allowed.

          Hide transient attributes Show transient attributes object
          • strategy object

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

            Additional properties are allowed.

            Hide strategy attributes Show strategy attributes object
            • rolling object

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

              Additional properties are allowed.

              Hide rolling attributes Show rolling attributes object
              • group_by string

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

              • 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

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

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

              Additional properties are allowed.

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

              Additional properties are allowed.

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

              Additional properties are allowed.

          • The configuration settings for the timeout and fallback parameters.

            Additional properties are allowed.

            Hide plan_configuration attributes Show plan_configuration attributes object
            • timeout integer(int64)

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

            • calm_wait_time integer(int64)

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

            • move_instances array[object]
              Hide move_instances attributes Show move_instances attributes object
              • from string Required

                The instance id that is going to be moved

              • to array[string]

                An optional list of allocator ids to which the instance should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)

              • Tells the infrastructure that the instance should be considered as permanently down when deciding how to migrate data to new nodes. If left blank then the system will automatically decide (currently: will treat the instances as up)

            • move_allocators array[object]
              Hide move_allocators attributes Show move_allocators attributes object
              • from string Required

                The allocator id off which all instances in the cluster should be moved

              • to array[string]

                An optional list of allocator ids to which the instance(s) should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)

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

            • If true (default: false) does not allow re-using any existing instances currently in the cluster, ie even unchanged instances will be re-created

            • List of allocators on which instances are placed if possible (if not possible/not specified then any available allocator with space is used)

            • Map containing allocators tags in form of key value pairs, increasing the likelihood during move requests for allocators with matching tags, to be selected as target allocators

              Hide preferred_allocator_tags attribute Show preferred_allocator_tags attribute object
              • * string Additional properties
            • 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

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

              Value is forced.

            • If false (the default), the plan fails if it determines that the request can result in unsafe operations. Setting this flag overrides some of these check restraints.

      • settings object

        The settings for building this Kibana cluster

        Additional properties are allowed.

        Hide settings attribute Show settings attribute object
        • metadata object

          The top-level configuration settings for the Elasticsearch cluster.

          Additional properties are allowed.

          Hide metadata attributes Show metadata attributes object
          • name string

            The display name of the cluster

          • owner_id string

            The user id (referencing whatever user database is in use) of the cluster owner

          • Subscription level of the cluster

          • Indicates if a cluster is system owned (restricts the set of operations that can be performed on it)

          • Contact email for the cluster

          • The top-level configuration settings for the Elasticsearch cluster resources.

            Additional properties are allowed.

            Hide resources attribute Show resources attribute object
            • cpu object

              Specifies the CPU resource settings for the Elasticsearch cluster.

              Additional properties are allowed.

              Hide cpu attributes Show cpu attributes object
              • boost boolean

                Indicates if the CPU boost flag is enabled or not.

              • hard_limit boolean

                Indicates if the CPU hard limit flag is enabled or not. When set to true (default), allocates CPU timeshare based on the total CPU time multiplied by the relative RAM capacity of the instance on a given host. When set to false, delegates CPU allocation to the operating system to schedule CPU timeshares.

    • apm array[object]

      A list of payloads for APM creation. WARNING: For stack versions 8.0.0 and higher the integrations_server payload should be used instead, as this field becomes deprecated.

      Hide apm attributes Show apm attributes object
      • ref_id string Required

        A locally-unique user-specified id for APM

      • Alias to the Elasticsearch Cluster to attach APM to

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

        Additional properties are allowed.

        Hide plan attributes Show plan attributes object
        • cluster_topology array[object]
          Hide cluster_topology attributes Show cluster_topology attributes object
          • 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.

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

          • size object

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

            Additional properties are allowed.

            Hide size attributes Show size attributes object
            • value integer(int32) Required

              Amount of resource

            • resource string Required

              Type of resource

              Values are memory or storage.

          • zone_count integer(int32)

            number of zones in which nodes will be placed

          • apm object

            The configuration options for the APM Server.

            Additional properties are allowed.

            Hide apm attributes Show apm attributes object
            • version string

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

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

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

              Additional properties are allowed.

              Hide system_settings attributes Show system_settings attributes object
              • DEPRECATED: Scheduled for removal in a future version of the API.

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

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

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

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

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

              • Optionally override the secret token within APM - defaults to the previously existing secretToken

              • Optionally enable debug mode for APM servers - defaults false

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

              Additional properties are allowed.

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

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

              Additional properties are allowed.

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

        • apm object Required

          The configuration options for the APM Server.

          Additional properties are allowed.

          Hide apm attributes Show apm attributes object
          • version string

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

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

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

            Additional properties are allowed.

            Hide system_settings attributes Show system_settings attributes object
            • DEPRECATED: Scheduled for removal in a future version of the API.

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

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

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

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

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

            • Optionally override the secret token within APM - defaults to the previously existing secretToken

            • Optionally enable debug mode for APM servers - defaults false

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

            Additional properties are allowed.

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

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

            Additional properties are allowed.

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

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

          Additional properties are allowed.

          Hide transient attributes Show transient attributes object
          • strategy object

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

            Additional properties are allowed.

            Hide strategy attributes Show strategy attributes object
            • rolling object

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

              Additional properties are allowed.

              Hide rolling attributes Show rolling attributes object
              • group_by string

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

              • 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

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

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

              Additional properties are allowed.

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

              Additional properties are allowed.

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

              Additional properties are allowed.

          • The plan control configuration options for the APM Server.

            Additional properties are allowed.

            Hide plan_configuration attributes Show plan_configuration attributes object
            • timeout integer(int64)

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

            • calm_wait_time integer(int64)

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

            • move_instances array[object]
              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)

              • Tells the infrastructure that the instance should be considered as permanently down when deciding how to migrate data to new nodes. If left blank then the system will automatically decide (currently: will treat the instances as up)

            • move_allocators array[object]
              Hide move_allocators attributes Show move_allocators attributes object
              • from string Required

                The allocator id off which all instances in the cluster should be moved

              • to array[string]

                An optional list of allocator ids to which the instance(s) should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)

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

            • If true (default: false) does not allow re-using any existing instances currently in the cluster, ie even unchanged instances will be re-created

            • List of allocators on which instances are placed if possible (if not possible/not specified then any available allocator with space is used)

            • Map containing allocators tags in form of key value pairs, increasing the likelihood during move requests for allocators with matching tags, to be selected as target allocators

              Hide preferred_allocator_tags attribute Show preferred_allocator_tags attribute object
              • * string Additional properties
            • 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

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

              Value is forced.

            • If false (the default), the plan fails if it determines that the request can result in unsafe operations. Setting this flag overrides some of these check restraints.

      • settings object

        The settings for building this APM cluster

        Additional properties are allowed.

        Hide settings attribute Show settings attribute object
        • metadata object

          The top-level configuration settings for the Elasticsearch cluster.

          Additional properties are allowed.

          Hide metadata attributes Show metadata attributes object
          • name string

            The display name of the cluster

          • owner_id string

            The user id (referencing whatever user database is in use) of the cluster owner

          • Subscription level of the cluster

          • Indicates if a cluster is system owned (restricts the set of operations that can be performed on it)

          • Contact email for the cluster

          • The top-level configuration settings for the Elasticsearch cluster resources.

            Additional properties are allowed.

            Hide resources attribute Show resources attribute object
            • cpu object

              Specifies the CPU resource settings for the Elasticsearch cluster.

              Additional properties are allowed.

              Hide cpu attributes Show cpu attributes object
              • boost boolean

                Indicates if the CPU boost flag is enabled or not.

              • hard_limit boolean

                Indicates if the CPU hard limit flag is enabled or not. When set to true (default), allocates CPU timeshare based on the total CPU time multiplied by the relative RAM capacity of the instance on a given host. When set to false, delegates CPU allocation to the operating system to schedule CPU timeshares.

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

      Hide appsearch attributes Show appsearch attributes object
      • ref_id string Required

        A locally-unique user-specified id for AppSearch

      • Alias to the Elasticsearch Cluster to attach AppSearch to

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

        Additional properties are allowed.

        Hide plan attributes Show plan attributes object
        • cluster_topology array[object]
          Hide cluster_topology attributes Show cluster_topology attributes object
          • Defines the AppSearch node type

            Additional properties are allowed.

            Hide node_type attributes Show node_type attributes object
            • appserver boolean Required

              Defines whether this instance should run as Application/API server

            • worker boolean Required

              Defines whether this instance should run as background worker

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

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

          • size object

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

            Additional properties are allowed.

            Hide size attributes Show size attributes object
            • value integer(int32) Required

              Amount of resource

            • resource string Required

              Type of resource

              Values are memory or storage.

          • zone_count integer(int32)

            number of zones in which nodes will be placed

          • Additional properties are allowed.

            Hide appsearch attributes Show appsearch attributes object
            • version string

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

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

            • This structure defines a curated subset of the AppSearch settings. (This field together with 'user_settings_override*' and 'user_settings*' defines the total set of AppSearch settings)

              Additional properties are allowed.

              Hide system_settings attributes Show system_settings attributes object
              • Optionally override the URL to which to send data (for advanced users only, if unspecified the system selects an internal URL)

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

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

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

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

              Additional properties are allowed.

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

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

              Additional properties are allowed.

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

        • appsearch object Required

          Additional properties are allowed.

          Hide appsearch attributes Show appsearch attributes object
          • version string

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

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

          • This structure defines a curated subset of the AppSearch settings. (This field together with 'user_settings_override*' and 'user_settings*' defines the total set of AppSearch settings)

            Additional properties are allowed.

            Hide system_settings attributes Show system_settings attributes object
            • Optionally override the URL to which to send data (for advanced users only, if unspecified the system selects an internal URL)

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

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

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

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

            Additional properties are allowed.

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

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

            Additional properties are allowed.

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

        • Defines configuration parameters that control how the plan (ie consisting of the cluster topology and AppSearch settings) is applied

          Additional properties are allowed.

          Hide transient attributes Show transient attributes object
          • strategy object

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

            Additional properties are allowed.

            Hide strategy attributes Show strategy attributes object
            • rolling object

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

              Additional properties are allowed.

              Hide rolling attributes Show rolling attributes object
              • group_by string

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

              • 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

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

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

              Additional properties are allowed.

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

              Additional properties are allowed.

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

              Additional properties are allowed.

          • Additional properties are allowed.

            Hide plan_configuration attributes Show plan_configuration attributes object
            • timeout integer(int64)

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

            • calm_wait_time integer(int64)

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

            • move_instances array[object]
              Hide move_instances attributes Show move_instances attributes object
              • from string Required

                The instance id that is going to be moved

              • to array[string]

                An optional list of allocator ids to which the instance should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)

              • Tells the infrastructure that the instance should be considered as permanently down when deciding how to migrate data to new nodes. If left blank then the system will automatically decide (currently: will treat the instances as up)

            • move_allocators array[object]
              Hide move_allocators attributes Show move_allocators attributes object
              • from string Required

                The allocator id off which all instances in the cluster should be moved

              • to array[string]

                An optional list of allocator ids to which the instance(s) should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)

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

            • If true (default: false) does not allow re-using any existing instances currently in the cluster, ie even unchanged instances will be re-created

            • List of allocators on which instances are placed if possible (if not possible/not specified then any available allocator with space is used)

            • Map containing allocators tags in form of key value pairs, increasing the likelihood during move requests for allocators with matching tags, to be selected as target allocators

              Hide preferred_allocator_tags attribute Show preferred_allocator_tags attribute object
              • * string Additional properties
            • 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

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

              Value is forced.

            • If false (the default), the plan fails if it determines that the request can result in unsafe operations. Setting this flag overrides some of these check restraints.

      • settings object

        The settings for building this AppSearch cluster

        Additional properties are allowed.

        Hide settings attribute Show settings attribute object
        • metadata object

          The top-level configuration settings for the Elasticsearch cluster.

          Additional properties are allowed.

          Hide metadata attributes Show metadata attributes object
          • name string

            The display name of the cluster

          • owner_id string

            The user id (referencing whatever user database is in use) of the cluster owner

          • Subscription level of the cluster

          • Indicates if a cluster is system owned (restricts the set of operations that can be performed on it)

          • Contact email for the cluster

          • The top-level configuration settings for the Elasticsearch cluster resources.

            Additional properties are allowed.

            Hide resources attribute Show resources attribute object
            • cpu object

              Specifies the CPU resource settings for the Elasticsearch cluster.

              Additional properties are allowed.

              Hide cpu attributes Show cpu attributes object
              • boost boolean

                Indicates if the CPU boost flag is enabled or not.

              • hard_limit boolean

                Indicates if the CPU hard limit flag is enabled or not. When set to true (default), allocates CPU timeshare based on the total CPU time multiplied by the relative RAM capacity of the instance on a given host. When set to false, delegates CPU allocation to the operating system to schedule CPU timeshares.

    • integrations_server array[object]

      A list of payloads for Integrations Server creation.

      Hide integrations_server attributes Show integrations_server attributes object
      • ref_id string Required

        A locally-unique user-specified id for the Integrations Server

      • Alias to the Elasticsearch Cluster to attach the Integrations Server to

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

        Additional properties are allowed.

        Hide plan attributes Show plan attributes object
        • cluster_topology array[object]
          Hide cluster_topology attributes Show cluster_topology attributes object
          • 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.

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

          • size object

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

            Additional properties are allowed.

            Hide size attributes Show size attributes object
            • value integer(int32) Required

              Amount of resource

            • resource string Required

              Type of resource

              Values are memory or storage.

          • zone_count integer(int32)

            number of zones in which nodes will be placed

          • The configuration options for the Integrations Server.

            Additional properties are allowed.

            Hide integrations_server attributes Show integrations_server attributes object
            • version string

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

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

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

              Additional properties are allowed.

              Hide system_settings attributes Show system_settings attributes object
              • DEPRECATED: Scheduled for removal in a future version of the API.

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

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

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

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

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

              • Optionally override the secret token within Integrations Server - defaults to the previously existing secretToken

              • Optionally enable debug mode for Integrations Server - defaults false

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

              Additional properties are allowed.

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

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

              Additional properties are allowed.

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

            • mode string

              The mode the Integrations Server is operating in.

              Values are standalone or managed.

        • integrations_server object Required

          The configuration options for the Integrations Server.

          Additional properties are allowed.

          Hide integrations_server attributes Show integrations_server attributes object
          • version string

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

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

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

            Additional properties are allowed.

            Hide system_settings attributes Show system_settings attributes object
            • DEPRECATED: Scheduled for removal in a future version of the API.

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

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

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

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

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

            • Optionally override the secret token within Integrations Server - defaults to the previously existing secretToken

            • Optionally enable debug mode for Integrations Server - defaults false

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

            Additional properties are allowed.

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

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

            Additional properties are allowed.

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

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

          Additional properties are allowed.

          Hide transient attributes Show transient attributes object
          • strategy object

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

            Additional properties are allowed.

            Hide strategy attributes Show strategy attributes object
            • rolling object

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

              Additional properties are allowed.

              Hide rolling attributes Show rolling attributes object
              • group_by string

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

              • 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

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

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

              Additional properties are allowed.

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

              Additional properties are allowed.

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

              Additional properties are allowed.

          • The plan control configuration options for the Integrations Server.

            Additional properties are allowed.

            Hide plan_configuration attributes Show plan_configuration attributes object
            • timeout integer(int64)

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

            • calm_wait_time integer(int64)

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

            • move_instances array[object]
              Hide move_instances attributes Show move_instances attributes object
              • from string Required

                The instance id that is going to be moved

              • to array[string]

                An optional list of allocator ids to which the instance should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)

              • Tells the infrastructure that the instance should be considered as permanently down when deciding how to migrate data to new nodes. If left blank then the system will automatically decide (currently: will treat the instances as up)

            • move_allocators array[object]
              Hide move_allocators attributes Show move_allocators attributes object
              • from string Required

                The allocator id off which all instances in the cluster should be moved

              • to array[string]

                An optional list of allocator ids to which the instance(s) should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)

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

            • If true (default: false) does not allow re-using any existing instances currently in the cluster, ie even unchanged instances will be re-created

            • List of allocators on which instances are placed if possible (if not possible/not specified then any available allocator with space is used)

            • Map containing allocators tags in form of key value pairs, increasing the likelihood during move requests for allocators with matching tags, to be selected as target allocators

              Hide preferred_allocator_tags attribute Show preferred_allocator_tags attribute object
              • * string Additional properties
            • 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

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

              Value is forced.

            • If false (the default), the plan fails if it determines that the request can result in unsafe operations. Setting this flag overrides some of these check restraints.

      • settings object

        The settings for building this Integrations Server cluster

        Additional properties are allowed.

        Hide settings attribute Show settings attribute object
        • metadata object

          The top-level configuration settings for the Elasticsearch cluster.

          Additional properties are allowed.

          Hide metadata attributes Show metadata attributes object
          • name string

            The display name of the cluster

          • owner_id string

            The user id (referencing whatever user database is in use) of the cluster owner

          • Subscription level of the cluster

          • Indicates if a cluster is system owned (restricts the set of operations that can be performed on it)

          • Contact email for the cluster

          • The top-level configuration settings for the Elasticsearch cluster resources.

            Additional properties are allowed.

            Hide resources attribute Show resources attribute object
            • cpu object

              Specifies the CPU resource settings for the Elasticsearch cluster.

              Additional properties are allowed.

              Hide cpu attributes Show cpu attributes object
              • boost boolean

                Indicates if the CPU boost flag is enabled or not.

              • hard_limit boolean

                Indicates if the CPU hard limit flag is enabled or not. When set to true (default), allocates CPU timeshare based on the total CPU time multiplied by the relative RAM capacity of the instance on a given host. When set to false, delegates CPU allocation to the operating system to schedule CPU timeshares.

  • settings object

    Additional configuration for this Deployment

    Additional properties are allowed.

    Hide settings attributes Show settings attributes object
    • The rulesets to apply to all resources in this cluster. When specified, the set of rulesets is updated and the same rulesets will be applied to Kibana and APM clusters as well. If not specified, the rulesets remain as they were set previously.

      Additional properties are allowed.

      Hide traffic_filter_settings attribute Show traffic_filter_settings attribute object
      • rulesets array[string] Required

        IDs of the traffic filter rulesets

    • Observability settings for this deployment

      Additional properties are allowed.

      Hide observability attributes Show observability attributes object
      • logging object

        The logging settings for the deployment

        Additional properties are allowed.

        Hide logging attribute Show logging attribute object
        • destination object Required

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

          Additional properties are allowed.

          Hide destination attributes Show destination attributes object
          • deployment_id string Required

            The deployment to send logs and/or metrics to. Contains either the deployment's ID or 'self'.

          • ref_id string

            RefId of the Elasticsearch cluster to send logs and/or metrics to. If not specified, refId is resolved automatically as long as the destination deployment contains a single Elasticsearch resource.

      • metrics object

        The metrics settings for the deployment

        Additional properties are allowed.

        Hide metrics attributes Show metrics attributes object
        • destination object Required

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

          Additional properties are allowed.

          Hide destination attributes Show destination attributes object
          • deployment_id string Required

            The deployment to send logs and/or metrics to. Contains either the deployment's ID or 'self'.

          • ref_id string

            RefId of the Elasticsearch cluster to send logs and/or metrics to. If not specified, refId is resolved automatically as long as the destination deployment contains a single Elasticsearch resource.

        • Set to true to force the deployment to use legacy monitoring instead of Metricbeat-based monitoring.

    • Enable autoscaling for this deployment.

  • metadata object

    Additional information about this deployment

    Additional properties are allowed.

    Hide metadata attributes Show metadata attributes object
    • Indicates if a deployment is system owned (restricts the set of operations that can be performed on it)

    • tags array[object]

      Arbitrary user-defined metadata associated with this deployment

      Hide tags attributes Show tags attributes object
      • key string Required

        The metadata field name

      • value string Required

        The metadata value

  • alias string

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

  • region string

    Identifier of the region to be used as the default for all the resources of the deployment

  • version string

    The version for all the resources of the deployment (must be one of the supported versions). Defaults to the latest version if not specified.

Responses

  • The request was valid (used when validate_only is true).

    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 deployment alias for user-friendly resource URLs

    • created boolean Required

      Whether or not the deployment was freshly created

    • resources array[object] Required

      List of created resources.

      Hide resources attributes Show resources attributes object
      • ref_id string Required

        A locally-unique friendly alias for this Elasticsearch cluster

      • 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 for logging into a created resource. Only provided on initial create and absent otherwise.

        Additional properties are allowed.

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

    • Backend diagnostics. Sent if validation is requested.

      Additional properties are allowed.

      Hide diagnostics attributes Show diagnostics attributes object
      • creates object

        Diagnostics for resources to be created

        Additional properties are allowed.

        Hide creates attributes Show creates attributes object
        • elasticsearch array[object]

          Diagnostics for Elasticsearch clusters

          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

            Additional properties are allowed.

        • kibana array[object]

          Diagnostics for Kibanas

          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)

          • The user-specified id of the Elasticsearch Cluster that this will link to

          • backend_plan object Required

            The backend plan as JSON

            Additional properties are allowed.

        • apm array[object]

          Diagnostics for APMs

          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)

          • The user-specified id of the Elasticsearch Cluster that this will link to

          • backend_plan object Required

            The backend plan as JSON

            Additional properties are allowed.

        • integrations_server array[object]

          Diagnostics for Integrations Server

          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)

          • The user-specified id of the Elasticsearch Cluster that this will link to

          • backend_plan object Required

            The backend plan as JSON

            Additional properties are allowed.

        • appsearch array[object]

          Diagnostics for AppSearches

          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)

          • The user-specified id of the Elasticsearch Cluster that this will link to

          • backend_plan object Required

            The backend plan as JSON

            Additional properties are allowed.

      • updates object

        Diagnostics for existing resources that may be updated

        Additional properties are allowed.

        Hide updates attributes Show updates attributes object
        • elasticsearch array[object]

          Diagnostics for Elasticsearch clusters

          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

            Additional properties are allowed.

        • kibana array[object]

          Diagnostics for Kibanas

          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)

          • The user-specified id of the Elasticsearch Cluster that this will link to

          • backend_plan object Required

            The backend plan as JSON

            Additional properties are allowed.

        • apm array[object]

          Diagnostics for APMs

          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)

          • The user-specified id of the Elasticsearch Cluster that this will link to

          • backend_plan object Required

            The backend plan as JSON

            Additional properties are allowed.

        • integrations_server array[object]

          Diagnostics for Integrations Server

          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)

          • The user-specified id of the Elasticsearch Cluster that this will link to

          • backend_plan object Required

            The backend plan as JSON

            Additional properties are allowed.

        • appsearch array[object]

          Diagnostics for AppSearches

          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)

          • The user-specified id of the Elasticsearch Cluster that this will link to

          • backend_plan object Required

            The backend plan as JSON

            Additional properties are allowed.

  • The request was valid and a new deployment was created

    Hide headers attributes Show headers attributes
    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 deployment alias for user-friendly resource URLs

    • created boolean Required

      Whether or not the deployment was freshly created

    • resources array[object] Required

      List of created resources.

      Hide resources attributes Show resources attributes object
      • ref_id string Required

        A locally-unique friendly alias for this Elasticsearch cluster

      • 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 for logging into a created resource. Only provided on initial create and absent otherwise.

        Additional properties are allowed.

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

    • Backend diagnostics. Sent if validation is requested.

      Additional properties are allowed.

      Hide diagnostics attributes Show diagnostics attributes object
      • creates object

        Diagnostics for resources to be created

        Additional properties are allowed.

        Hide creates attributes Show creates attributes object
        • elasticsearch array[object]

          Diagnostics for Elasticsearch clusters

          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

            Additional properties are allowed.

        • kibana array[object]

          Diagnostics for Kibanas

          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)

          • The user-specified id of the Elasticsearch Cluster that this will link to

          • backend_plan object Required

            The backend plan as JSON

            Additional properties are allowed.

        • apm array[object]

          Diagnostics for APMs

          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)

          • The user-specified id of the Elasticsearch Cluster that this will link to

          • backend_plan object Required

            The backend plan as JSON

            Additional properties are allowed.

        • integrations_server array[object]

          Diagnostics for Integrations Server

          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)

          • The user-specified id of the Elasticsearch Cluster that this will link to

          • backend_plan object Required

            The backend plan as JSON

            Additional properties are allowed.

        • appsearch array[object]

          Diagnostics for AppSearches

          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)

          • The user-specified id of the Elasticsearch Cluster that this will link to

          • backend_plan object Required

            The backend plan as JSON

            Additional properties are allowed.

      • updates object

        Diagnostics for existing resources that may be updated

        Additional properties are allowed.

        Hide updates attributes Show updates attributes object
        • elasticsearch array[object]

          Diagnostics for Elasticsearch clusters

          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

            Additional properties are allowed.

        • kibana array[object]

          Diagnostics for Kibanas

          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)

          • The user-specified id of the Elasticsearch Cluster that this will link to

          • backend_plan object Required

            The backend plan as JSON

            Additional properties are allowed.

        • apm array[object]

          Diagnostics for APMs

          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)

          • The user-specified id of the Elasticsearch Cluster that this will link to

          • backend_plan object Required

            The backend plan as JSON

            Additional properties are allowed.

        • integrations_server array[object]

          Diagnostics for Integrations Server

          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)

          • The user-specified id of the Elasticsearch Cluster that this will link to

          • backend_plan object Required

            The backend plan as JSON

            Additional properties are allowed.

        • appsearch array[object]

          Diagnostics for AppSearches

          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)

          • The user-specified id of the Elasticsearch Cluster that this will link to

          • backend_plan object Required

            The backend plan as JSON

            Additional properties are allowed.

  • The request was valid and deployment creation had already been started.

    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 deployment alias for user-friendly resource URLs

    • created boolean Required

      Whether or not the deployment was freshly created

    • resources array[object] Required

      List of created resources.

      Hide resources attributes Show resources attributes object
      • ref_id string Required

        A locally-unique friendly alias for this Elasticsearch cluster

      • 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 for logging into a created resource. Only provided on initial create and absent otherwise.

        Additional properties are allowed.

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

    • Backend diagnostics. Sent if validation is requested.

      Additional properties are allowed.

      Hide diagnostics attributes Show diagnostics attributes object
      • creates object

        Diagnostics for resources to be created

        Additional properties are allowed.

        Hide creates attributes Show creates attributes object
        • elasticsearch array[object]

          Diagnostics for Elasticsearch clusters

          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

            Additional properties are allowed.

        • kibana array[object]

          Diagnostics for Kibanas

          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)

          • The user-specified id of the Elasticsearch Cluster that this will link to

          • backend_plan object Required

            The backend plan as JSON

            Additional properties are allowed.

        • apm array[object]

          Diagnostics for APMs

          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)

          • The user-specified id of the Elasticsearch Cluster that this will link to

          • backend_plan object Required

            The backend plan as JSON

            Additional properties are allowed.

        • integrations_server array[object]

          Diagnostics for Integrations Server

          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)

          • The user-specified id of the Elasticsearch Cluster that this will link to

          • backend_plan object Required

            The backend plan as JSON

            Additional properties are allowed.

        • appsearch array[object]

          Diagnostics for AppSearches

          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)

          • The user-specified id of the Elasticsearch Cluster that this will link to

          • backend_plan object Required

            The backend plan as JSON

            Additional properties are allowed.

      • updates object

        Diagnostics for existing resources that may be updated

        Additional properties are allowed.

        Hide updates attributes Show updates attributes object
        • elasticsearch array[object]

          Diagnostics for Elasticsearch clusters

          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

            Additional properties are allowed.

        • kibana array[object]

          Diagnostics for Kibanas

          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)

          • The user-specified id of the Elasticsearch Cluster that this will link to

          • backend_plan object Required

            The backend plan as JSON

            Additional properties are allowed.

        • apm array[object]

          Diagnostics for APMs

          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)

          • The user-specified id of the Elasticsearch Cluster that this will link to

          • backend_plan object Required

            The backend plan as JSON

            Additional properties are allowed.

        • integrations_server array[object]

          Diagnostics for Integrations Server

          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)

          • The user-specified id of the Elasticsearch Cluster that this will link to

          • backend_plan object Required

            The backend plan as JSON

            Additional properties are allowed.

        • appsearch array[object]

          Diagnostics for AppSearches

          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)

          • The user-specified id of the Elasticsearch Cluster that this will link to

          • backend_plan object Required

            The backend plan as JSON

            Additional properties are allowed.

  • 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

  • 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

POST /deployments
curl \
 -X POST https://{{hostname}}/api/v1/deployments \
 -d '{"name":"string","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"],"memory_per_node":42,"node_count_per_zone":42,"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,"move_instances":[{"from":"string","to":["string"],"instance_down":true}],"move_allocators":[{"from":"string","to":["string"],"allocator_down":true}],"move_only":true,"reallocate_instances":true,"preferred_allocators":["string"],"preferred_allocator_tags":{"additionalProperty1":"string","additionalProperty2":"string"},"skip_snapshot":true,"max_snapshot_attempts":42,"max_snapshot_age":42,"extended_maintenance":true,"cluster_reboot":"forced","override_failsafe":true,"skip_data_migration":true,"skip_upgrade_checker":true,"skip_post_upgrade_steps":true,"skip_snapshot_post_major_upgrade":true},"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}]},"cluster_settings_json":{}},"autoscaling_enabled":true},"settings":{"snapshot":{"repository":{"static":{"repository_type":"string","settings":{}},"reference":{"repository_name":"string"},"default":{}},"interval":"string","pending_interval":"string","wait_time_after_snapshotting":"string","enabled":true,"suspended":["string"],"retention":{"snapshots":42,"max_age":"string"},"cron_expression":"string"},"monitoring":{"target_cluster_id":"string"},"metadata":{"name":"string","owner_id":"string","subscription_level":"string","system_owned":true,"contact_email":"string","resources":{"cpu":{"boost":true,"hard_limit":true}}},"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"}]}]},"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":[{"memory_per_node":42,"node_count_per_zone":42,"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_url":"string","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_url":"string","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,"move_instances":[{"from":"string","to":["string"],"instance_down":true}],"move_allocators":[{"from":"string","to":["string"],"allocator_down":true}],"reallocate_instances":true,"preferred_allocators":["string"],"preferred_allocator_tags":{"additionalProperty1":"string","additionalProperty2":"string"},"extended_maintenance":true,"cluster_reboot":"forced","override_failsafe":true}}},"settings":{"metadata":{"name":"string","owner_id":"string","subscription_level":"string","system_owned":true,"contact_email":"string","resources":{"cpu":{"boost":true,"hard_limit":true}}}}}],"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_url":"string","kibana_url":"string","elasticsearch_username":"string","elasticsearch_password":"string","secret_token":"string","debug_enabled":true},"user_settings_json":{},"user_settings_yaml":"string","user_settings_override_json":{},"user_settings_override_yaml":"string"}}],"apm":{"version":"string","docker_image":"string","system_settings":{"elasticsearch_url":"string","kibana_url":"string","elasticsearch_username":"string","elasticsearch_password":"string","secret_token":"string","debug_enabled":true},"user_settings_json":{},"user_settings_yaml":"string","user_settings_override_json":{},"user_settings_override_yaml":"string"},"transient":{"strategy":{"rolling":{"group_by":"string","allow_inline_resize":true,"skip_synced_flush":true,"shard_init_wait_time":42},"grow_and_shrink":{},"rolling_grow_and_shrink":{},"autodetect":{}},"plan_configuration":{"timeout":42,"calm_wait_time":42,"move_instances":[{"from":"string","to":["string"],"instance_down":true}],"move_allocators":[{"from":"string","to":["string"],"allocator_down":true}],"reallocate_instances":true,"preferred_allocators":["string"],"preferred_allocator_tags":{"additionalProperty1":"string","additionalProperty2":"string"},"extended_maintenance":true,"cluster_reboot":"forced","override_failsafe":true}}},"settings":{"metadata":{"name":"string","owner_id":"string","subscription_level":"string","system_owned":true,"contact_email":"string","resources":{"cpu":{"boost":true,"hard_limit":true}}}}}],"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"],"preferred_allocator_tags":{"additionalProperty1":"string","additionalProperty2":"string"},"extended_maintenance":true,"cluster_reboot":"forced","override_failsafe":true}}},"settings":{"metadata":{"name":"string","owner_id":"string","subscription_level":"string","system_owned":true,"contact_email":"string","resources":{"cpu":{"boost":true,"hard_limit":true}}}}}],"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_url":"string","elasticsearch_username":"string","elasticsearch_password":"string","secret_session_key":"string"},"user_settings_json":{},"user_settings_yaml":"string","user_settings_override_json":{},"user_settings_override_yaml":"string"},"allocator_filter":{},"node_configuration":"string","memory_per_node":{},"node_count_per_zone":{}}],"enterprise_search":{"version":"string","docker_image":"string","system_settings":{"elasticsearch_url":"string","elasticsearch_username":"string","elasticsearch_password":"string","secret_session_key":"string"},"user_settings_json":{},"user_settings_yaml":"string","user_settings_override_json":{},"user_settings_override_yaml":"string"},"transient":{"strategy":{"rolling":{"group_by":"string","allow_inline_resize":true,"skip_synced_flush":true,"shard_init_wait_time":42},"grow_and_shrink":{},"rolling_grow_and_shrink":{},"autodetect":{}},"plan_configuration":{"timeout":42,"calm_wait_time":42,"move_instances":[{"from":"string","to":["string"],"instance_down":true}],"move_allocators":[{"from":"string","to":["string"],"allocator_down":true}],"reallocate_instances":true,"preferred_allocators":["string"],"preferred_allocator_tags":{"additionalProperty1":"string","additionalProperty2":"string"},"extended_maintenance":true,"cluster_reboot":"forced","override_failsafe":true}}},"settings":{"metadata":{"name":"string","owner_id":"string","subscription_level":"string","system_owned":true,"contact_email":"string","resources":{"cpu":{"boost":true,"hard_limit":true}}}}}],"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_url":"string","kibana_url":"string","elasticsearch_username":"string","elasticsearch_password":"string","secret_token":"string","debug_enabled":true},"user_settings_json":{},"user_settings_yaml":"string","user_settings_override_json":{},"user_settings_override_yaml":"string","mode":"standalone"}}],"integrations_server":{"version":"string","docker_image":"string","system_settings":{"elasticsearch_url":"string","kibana_url":"string","elasticsearch_username":"string","elasticsearch_password":"string","secret_token":"string","debug_enabled":true},"user_settings_json":{},"user_settings_yaml":"string","user_settings_override_json":{},"user_settings_override_yaml":"string","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,"move_instances":[{"from":"string","to":["string"],"instance_down":true}],"move_allocators":[{"from":"string","to":["string"],"allocator_down":true}],"reallocate_instances":true,"preferred_allocators":["string"],"preferred_allocator_tags":{"additionalProperty1":"string","additionalProperty2":"string"},"extended_maintenance":true,"cluster_reboot":"forced","override_failsafe":true}}},"settings":{"metadata":{"name":"string","owner_id":"string","subscription_level":"string","system_owned":true,"contact_email":"string","resources":{"cpu":{"boost":true,"hard_limit":true}}}}}]},"settings":{"traffic_filter_settings":{"rulesets":["string"]},"observability":{"logging":{"destination":{"deployment_id":"string","ref_id":"string"}},"metrics":{"destination":{"deployment_id":"string","ref_id":"string"},"force_legacy_monitoring":true}},"autoscaling_enabled":true},"metadata":{"system_owned":true,"tags":[{"key":"string","value":"string"}]},"alias":"string","region":"string","version":"string"}'
Request examples
{
  "name": "string",
  "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"
              ],
              "memory_per_node": 42,
              "node_count_per_zone": 42,
              "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,
              "move_instances": [
                {
                  "from": "string",
                  "to": [
                    "string"
                  ],
                  "instance_down": true
                }
              ],
              "move_allocators": [
                {
                  "from": "string",
                  "to": [
                    "string"
                  ],
                  "allocator_down": true
                }
              ],
              "move_only": true,
              "reallocate_instances": true,
              "preferred_allocators": [
                "string"
              ],
              "preferred_allocator_tags": {
                "additionalProperty1": "string",
                "additionalProperty2": "string"
              },
              "skip_snapshot": true,
              "max_snapshot_attempts": 42,
              "max_snapshot_age": 42,
              "extended_maintenance": true,
              "cluster_reboot": "forced",
              "override_failsafe": true,
              "skip_data_migration": true,
              "skip_upgrade_checker": true,
              "skip_post_upgrade_steps": true,
              "skip_snapshot_post_major_upgrade": true
            },
            "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
                }
              ]
            },
            "cluster_settings_json": {}
          },
          "autoscaling_enabled": true
        },
        "settings": {
          "snapshot": {
            "repository": {
              "static": {
                "repository_type": "string",
                "settings": {}
              },
              "reference": {
                "repository_name": "string"
              },
              "default": {}
            },
            "interval": "string",
            "pending_interval": "string",
            "wait_time_after_snapshotting": "string",
            "enabled": true,
            "suspended": [
              "string"
            ],
            "retention": {
              "snapshots": 42,
              "max_age": "string"
            },
            "cron_expression": "string"
          },
          "monitoring": {
            "target_cluster_id": "string"
          },
          "metadata": {
            "name": "string",
            "owner_id": "string",
            "subscription_level": "string",
            "system_owned": true,
            "contact_email": "string",
            "resources": {
              "cpu": {
                "boost": true,
                "hard_limit": true
              }
            }
          },
          "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"
                  }
                ]
              }
            ]
          },
          "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": [
            {
              "memory_per_node": 42,
              "node_count_per_zone": 42,
              "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_url": "string",
                  "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_url": "string",
              "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,
              "move_instances": [
                {
                  "from": "string",
                  "to": [
                    "string"
                  ],
                  "instance_down": true
                }
              ],
              "move_allocators": [
                {
                  "from": "string",
                  "to": [
                    "string"
                  ],
                  "allocator_down": true
                }
              ],
              "reallocate_instances": true,
              "preferred_allocators": [
                "string"
              ],
              "preferred_allocator_tags": {
                "additionalProperty1": "string",
                "additionalProperty2": "string"
              },
              "extended_maintenance": true,
              "cluster_reboot": "forced",
              "override_failsafe": true
            }
          }
        },
        "settings": {
          "metadata": {
            "name": "string",
            "owner_id": "string",
            "subscription_level": "string",
            "system_owned": true,
            "contact_email": "string",
            "resources": {
              "cpu": {
                "boost": true,
                "hard_limit": true
              }
            }
          }
        }
      }
    ],
    "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_url": "string",
                  "kibana_url": "string",
                  "elasticsearch_username": "string",
                  "elasticsearch_password": "string",
                  "secret_token": "string",
                  "debug_enabled": true
                },
                "user_settings_json": {},
                "user_settings_yaml": "string",
                "user_settings_override_json": {},
                "user_settings_override_yaml": "string"
              }
            }
          ],
          "apm": {
            "version": "string",
            "docker_image": "string",
            "system_settings": {
              "elasticsearch_url": "string",
              "kibana_url": "string",
              "elasticsearch_username": "string",
              "elasticsearch_password": "string",
              "secret_token": "string",
              "debug_enabled": true
            },
            "user_settings_json": {},
            "user_settings_yaml": "string",
            "user_settings_override_json": {},
            "user_settings_override_yaml": "string"
          },
          "transient": {
            "strategy": {
              "rolling": {
                "group_by": "string",
                "allow_inline_resize": true,
                "skip_synced_flush": true,
                "shard_init_wait_time": 42
              },
              "grow_and_shrink": {},
              "rolling_grow_and_shrink": {},
              "autodetect": {}
            },
            "plan_configuration": {
              "timeout": 42,
              "calm_wait_time": 42,
              "move_instances": [
                {
                  "from": "string",
                  "to": [
                    "string"
                  ],
                  "instance_down": true
                }
              ],
              "move_allocators": [
                {
                  "from": "string",
                  "to": [
                    "string"
                  ],
                  "allocator_down": true
                }
              ],
              "reallocate_instances": true,
              "preferred_allocators": [
                "string"
              ],
              "preferred_allocator_tags": {
                "additionalProperty1": "string",
                "additionalProperty2": "string"
              },
              "extended_maintenance": true,
              "cluster_reboot": "forced",
              "override_failsafe": true
            }
          }
        },
        "settings": {
          "metadata": {
            "name": "string",
            "owner_id": "string",
            "subscription_level": "string",
            "system_owned": true,
            "contact_email": "string",
            "resources": {
              "cpu": {
                "boost": true,
                "hard_limit": true
              }
            }
          }
        }
      }
    ],
    "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"
              ],
              "preferred_allocator_tags": {
                "additionalProperty1": "string",
                "additionalProperty2": "string"
              },
              "extended_maintenance": true,
              "cluster_reboot": "forced",
              "override_failsafe": true
            }
          }
        },
        "settings": {
          "metadata": {
            "name": "string",
            "owner_id": "string",
            "subscription_level": "string",
            "system_owned": true,
            "contact_email": "string",
            "resources": {
              "cpu": {
                "boost": true,
                "hard_limit": true
              }
            }
          }
        }
      }
    ],
    "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_url": "string",
                  "elasticsearch_username": "string",
                  "elasticsearch_password": "string",
                  "secret_session_key": "string"
                },
                "user_settings_json": {},
                "user_settings_yaml": "string",
                "user_settings_override_json": {},
                "user_settings_override_yaml": "string"
              },
              "allocator_filter": {},
              "node_configuration": "string",
              "memory_per_node": {},
              "node_count_per_zone": {}
            }
          ],
          "enterprise_search": {
            "version": "string",
            "docker_image": "string",
            "system_settings": {
              "elasticsearch_url": "string",
              "elasticsearch_username": "string",
              "elasticsearch_password": "string",
              "secret_session_key": "string"
            },
            "user_settings_json": {},
            "user_settings_yaml": "string",
            "user_settings_override_json": {},
            "user_settings_override_yaml": "string"
          },
          "transient": {
            "strategy": {
              "rolling": {
                "group_by": "string",
                "allow_inline_resize": true,
                "skip_synced_flush": true,
                "shard_init_wait_time": 42
              },
              "grow_and_shrink": {},
              "rolling_grow_and_shrink": {},
              "autodetect": {}
            },
            "plan_configuration": {
              "timeout": 42,
              "calm_wait_time": 42,
              "move_instances": [
                {
                  "from": "string",
                  "to": [
                    "string"
                  ],
                  "instance_down": true
                }
              ],
              "move_allocators": [
                {
                  "from": "string",
                  "to": [
                    "string"
                  ],
                  "allocator_down": true
                }
              ],
              "reallocate_instances": true,
              "preferred_allocators": [
                "string"
              ],
              "preferred_allocator_tags": {
                "additionalProperty1": "string",
                "additionalProperty2": "string"
              },
              "extended_maintenance": true,
              "cluster_reboot": "forced",
              "override_failsafe": true
            }
          }
        },
        "settings": {
          "metadata": {
            "name": "string",
            "owner_id": "string",
            "subscription_level": "string",
            "system_owned": true,
            "contact_email": "string",
            "resources": {
              "cpu": {
                "boost": true,
                "hard_limit": true
              }
            }
          }
        }
      }
    ],
    "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_url": "string",
                  "kibana_url": "string",
                  "elasticsearch_username": "string",
                  "elasticsearch_password": "string",
                  "secret_token": "string",
                  "debug_enabled": true
                },
                "user_settings_json": {},
                "user_settings_yaml": "string",
                "user_settings_override_json": {},
                "user_settings_override_yaml": "string",
                "mode": "standalone"
              }
            }
          ],
          "integrations_server": {
            "version": "string",
            "docker_image": "string",
            "system_settings": {
              "elasticsearch_url": "string",
              "kibana_url": "string",
              "elasticsearch_username": "string",
              "elasticsearch_password": "string",
              "secret_token": "string",
              "debug_enabled": true
            },
            "user_settings_json": {},
            "user_settings_yaml": "string",
            "user_settings_override_json": {},
            "user_settings_override_yaml": "string",
            "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,
              "move_instances": [
                {
                  "from": "string",
                  "to": [
                    "string"
                  ],
                  "instance_down": true
                }
              ],
              "move_allocators": [
                {
                  "from": "string",
                  "to": [
                    "string"
                  ],
                  "allocator_down": true
                }
              ],
              "reallocate_instances": true,
              "preferred_allocators": [
                "string"
              ],
              "preferred_allocator_tags": {
                "additionalProperty1": "string",
                "additionalProperty2": "string"
              },
              "extended_maintenance": true,
              "cluster_reboot": "forced",
              "override_failsafe": true
            }
          }
        },
        "settings": {
          "metadata": {
            "name": "string",
            "owner_id": "string",
            "subscription_level": "string",
            "system_owned": true,
            "contact_email": "string",
            "resources": {
              "cpu": {
                "boost": true,
                "hard_limit": true
              }
            }
          }
        }
      }
    ]
  },
  "settings": {
    "traffic_filter_settings": {
      "rulesets": [
        "string"
      ]
    },
    "observability": {
      "logging": {
        "destination": {
          "deployment_id": "string",
          "ref_id": "string"
        }
      },
      "metrics": {
        "destination": {
          "deployment_id": "string",
          "ref_id": "string"
        },
        "force_legacy_monitoring": true
      }
    },
    "autoscaling_enabled": true
  },
  "metadata": {
    "system_owned": true,
    "tags": [
      {
        "key": "string",
        "value": "string"
      }
    ]
  },
  "alias": "string",
  "region": "string",
  "version": "string"
}
Response examples (200)
{
  "id": "string",
  "name": "string",
  "alias": "string",
  "created": true,
  "resources": [
    {
      "ref_id": "string",
      "elasticsearch_cluster_ref_id": "string",
      "id": "string",
      "kind": "string",
      "region": "string",
      "cloud_id": "string",
      "credentials": {
        "username": "string",
        "password": "string"
      },
      "secret_token": "string",
      "warnings": [
        {
          "code": "string",
          "message": "string"
        }
      ]
    }
  ],
  "diagnostics": {
    "creates": {
      "elasticsearch": [
        {
          "ref_id": "string",
          "display_name": "string",
          "backend_plan": {}
        }
      ],
      "kibana": [
        {
          "ref_id": "string",
          "display_name": "string",
          "elasticsearch_cluster_ref_id": "string",
          "backend_plan": {}
        }
      ],
      "apm": [
        {
          "ref_id": "string",
          "display_name": "string",
          "elasticsearch_cluster_ref_id": "string",
          "backend_plan": {}
        }
      ],
      "integrations_server": [
        {
          "ref_id": "string",
          "display_name": "string",
          "elasticsearch_cluster_ref_id": "string",
          "backend_plan": {}
        }
      ],
      "appsearch": [
        {
          "ref_id": "string",
          "display_name": "string",
          "elasticsearch_cluster_ref_id": "string",
          "backend_plan": {}
        }
      ],
      "enterprise_search": [
        {
          "ref_id": "string",
          "display_name": "string",
          "elasticsearch_cluster_ref_id": "string",
          "backend_plan": {}
        }
      ]
    },
    "updates": {
      "elasticsearch": [
        {
          "ref_id": "string",
          "display_name": "string",
          "backend_plan": {}
        }
      ],
      "kibana": [
        {
          "ref_id": "string",
          "display_name": "string",
          "elasticsearch_cluster_ref_id": "string",
          "backend_plan": {}
        }
      ],
      "apm": [
        {
          "ref_id": "string",
          "display_name": "string",
          "elasticsearch_cluster_ref_id": "string",
          "backend_plan": {}
        }
      ],
      "integrations_server": [
        {
          "ref_id": "string",
          "display_name": "string",
          "elasticsearch_cluster_ref_id": "string",
          "backend_plan": {}
        }
      ],
      "appsearch": [
        {
          "ref_id": "string",
          "display_name": "string",
          "elasticsearch_cluster_ref_id": "string",
          "backend_plan": {}
        }
      ],
      "enterprise_search": [
        {
          "ref_id": "string",
          "display_name": "string",
          "elasticsearch_cluster_ref_id": "string",
          "backend_plan": {}
        }
      ]
    }
  }
}
Response examples (201)
# Headers
x-cloud-resource-version: string
x-cloud-resource-created: string
x-cloud-resource-last-modified: string

# Payload
{
  "id": "string",
  "name": "string",
  "alias": "string",
  "created": true,
  "resources": [
    {
      "ref_id": "string",
      "elasticsearch_cluster_ref_id": "string",
      "id": "string",
      "kind": "string",
      "region": "string",
      "cloud_id": "string",
      "credentials": {
        "username": "string",
        "password": "string"
      },
      "secret_token": "string",
      "warnings": [
        {
          "code": "string",
          "message": "string"
        }
      ]
    }
  ],
  "diagnostics": {
    "creates": {
      "elasticsearch": [
        {
          "ref_id": "string",
          "display_name": "string",
          "backend_plan": {}
        }
      ],
      "kibana": [
        {
          "ref_id": "string",
          "display_name": "string",
          "elasticsearch_cluster_ref_id": "string",
          "backend_plan": {}
        }
      ],
      "apm": [
        {
          "ref_id": "string",
          "display_name": "string",
          "elasticsearch_cluster_ref_id": "string",
          "backend_plan": {}
        }
      ],
      "integrations_server": [
        {
          "ref_id": "string",
          "display_name": "string",
          "elasticsearch_cluster_ref_id": "string",
          "backend_plan": {}
        }
      ],
      "appsearch": [
        {
          "ref_id": "string",
          "display_name": "string",
          "elasticsearch_cluster_ref_id": "string",
          "backend_plan": {}
        }
      ],
      "enterprise_search": [
        {
          "ref_id": "string",
          "display_name": "string",
          "elasticsearch_cluster_ref_id": "string",
          "backend_plan": {}
        }
      ]
    },
    "updates": {
      "elasticsearch": [
        {
          "ref_id": "string",
          "display_name": "string",
          "backend_plan": {}
        }
      ],
      "kibana": [
        {
          "ref_id": "string",
          "display_name": "string",
          "elasticsearch_cluster_ref_id": "string",
          "backend_plan": {}
        }
      ],
      "apm": [
        {
          "ref_id": "string",
          "display_name": "string",
          "elasticsearch_cluster_ref_id": "string",
          "backend_plan": {}
        }
      ],
      "integrations_server": [
        {
          "ref_id": "string",
          "display_name": "string",
          "elasticsearch_cluster_ref_id": "string",
          "backend_plan": {}
        }
      ],
      "appsearch": [
        {
          "ref_id": "string",
          "display_name": "string",
          "elasticsearch_cluster_ref_id": "string",
          "backend_plan": {}
        }
      ],
      "enterprise_search": [
        {
          "ref_id": "string",
          "display_name": "string",
          "elasticsearch_cluster_ref_id": "string",
          "backend_plan": {}
        }
      ]
    }
  }
}
Response examples (202)
{
  "id": "string",
  "name": "string",
  "alias": "string",
  "created": true,
  "resources": [
    {
      "ref_id": "string",
      "elasticsearch_cluster_ref_id": "string",
      "id": "string",
      "kind": "string",
      "region": "string",
      "cloud_id": "string",
      "credentials": {
        "username": "string",
        "password": "string"
      },
      "secret_token": "string",
      "warnings": [
        {
          "code": "string",
          "message": "string"
        }
      ]
    }
  ],
  "diagnostics": {
    "creates": {
      "elasticsearch": [
        {
          "ref_id": "string",
          "display_name": "string",
          "backend_plan": {}
        }
      ],
      "kibana": [
        {
          "ref_id": "string",
          "display_name": "string",
          "elasticsearch_cluster_ref_id": "string",
          "backend_plan": {}
        }
      ],
      "apm": [
        {
          "ref_id": "string",
          "display_name": "string",
          "elasticsearch_cluster_ref_id": "string",
          "backend_plan": {}
        }
      ],
      "integrations_server": [
        {
          "ref_id": "string",
          "display_name": "string",
          "elasticsearch_cluster_ref_id": "string",
          "backend_plan": {}
        }
      ],
      "appsearch": [
        {
          "ref_id": "string",
          "display_name": "string",
          "elasticsearch_cluster_ref_id": "string",
          "backend_plan": {}
        }
      ],
      "enterprise_search": [
        {
          "ref_id": "string",
          "display_name": "string",
          "elasticsearch_cluster_ref_id": "string",
          "backend_plan": {}
        }
      ]
    },
    "updates": {
      "elasticsearch": [
        {
          "ref_id": "string",
          "display_name": "string",
          "backend_plan": {}
        }
      ],
      "kibana": [
        {
          "ref_id": "string",
          "display_name": "string",
          "elasticsearch_cluster_ref_id": "string",
          "backend_plan": {}
        }
      ],
      "apm": [
        {
          "ref_id": "string",
          "display_name": "string",
          "elasticsearch_cluster_ref_id": "string",
          "backend_plan": {}
        }
      ],
      "integrations_server": [
        {
          "ref_id": "string",
          "display_name": "string",
          "elasticsearch_cluster_ref_id": "string",
          "backend_plan": {}
        }
      ],
      "appsearch": [
        {
          "ref_id": "string",
          "display_name": "string",
          "elasticsearch_cluster_ref_id": "string",
          "backend_plan": {}
        }
      ],
      "enterprise_search": [
        {
          "ref_id": "string",
          "display_name": "string",
          "elasticsearch_cluster_ref_id": "string",
          "backend_plan": {}
        }
      ]
    }
  }
}
Response examples (400)
{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}
Response examples (401)
{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}
























































































































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

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

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

    Default value is false.

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

    Default value is false.

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

    Default value is false.

  • Whether to show cluster settings in the response.

    Default value is false.

  • 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

  • Standard response.

    Hide response attributes Show response attributes object
    • ref_id string Required

      The locally-unique user-specified id of a Resource

    • The Elasticsearch cluster that this resource depends on.

    • id string Required

      The randomly-generated id of a Resource

    • region string Required

      The region where this resource exists

    • info object Required

      Info for the resource.

      Additional properties are allowed.

      Hide info attributes Show info attributes object
      • id string Required

        The id of the Enterprise Search

      • name string Required

        The name of the Enterprise Search

      • elasticsearch_cluster object Required

        Information about the specified Elasticsearch cluster.

        Additional properties are allowed.

        Hide elasticsearch_cluster attributes Show elasticsearch_cluster attributes object
        • elasticsearch_id string Required

          The Elasticsearch cluster Id

      • The id of the deployment that this Enterprise Search belongs to.

      • healthy boolean Required

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

      • status string Required

        Enterprise Search status

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

      • plan_info object Required

        Information about current, pending, and past Enterprise Search Server plans.

        Additional properties are allowed.

        Hide plan_info attributes Show plan_info attributes object
        • healthy boolean Required

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

        • current object

          Information about the Enterprise Search Server plan.

          Additional properties are allowed.

          Hide current attributes Show current attributes object
          • A UUID for each plan attempt

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

          • healthy boolean Required

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

          • attempt_start_time string(date-time)

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

          • attempt_end_time string(date-time)

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

          • plan_end_time string(date-time)

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

          • plan object

            The plan for the Enterprise Search cluster.

            Additional properties are allowed.

            Hide plan attributes Show plan attributes object
            • cluster_topology array[object]
              Hide cluster_topology attributes Show cluster_topology attributes object
              • Defines the EnterpriseSearch node type

                Additional properties are allowed.

                Hide node_type attributes Show node_type attributes object
                • appserver boolean Required

                  Defines whether this instance should run as Application/API server

                • worker boolean Required

                  Defines whether this instance should run as background worker

                • connector boolean Required

                  Defines whether this instance should run as Connector

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

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

              • size object

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

                Additional properties are allowed.

                Hide size attributes Show size attributes object
                • value integer(int32) Required

                  Amount of resource

                • resource string Required

                  Type of resource

                  Values are memory or storage.

              • zone_count integer(int32)

                number of zones in which nodes will be placed

              • Additional properties are allowed.

              • Additional properties are allowed.

              • Additional properties are allowed.

            • Defines configuration parameters that control how the plan (i.e. consisting of the cluster topology and Enterprise Search settings) is applied

              Additional properties are allowed.

              Hide transient attributes Show transient attributes object
              • strategy object

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

                Additional properties are allowed.

                Hide strategy attributes Show strategy attributes object
                • rolling object

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

                  Additional properties are allowed.

                  Hide rolling attributes Show rolling attributes object
                  • group_by string

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

                  • 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

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

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

                  Additional properties are allowed.

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

                  Additional properties are allowed.

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

                  Additional properties are allowed.

              • Additional properties are allowed.

                Hide plan_configuration attributes Show plan_configuration attributes object
                • timeout integer(int64)

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

                • calm_wait_time integer(int64)

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

                • move_instances array[object]
                  Hide move_instances attributes Show move_instances attributes object
                  • from string Required

                    The instance id that is going to be moved

                  • to array[string]

                    An optional list of allocator ids to which the instance should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)

                  • Tells the infrastructure that the instance should be considered as permanently down when deciding how to migrate data to new nodes. If left blank then the system will automatically decide (currently: will treat the instances as up)

                • move_allocators array[object]
                  Hide move_allocators attributes Show move_allocators attributes object
                  • from string Required

                    The allocator id off which all instances in the cluster should be moved

                  • to array[string]

                    An optional list of allocator ids to which the instance(s) should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)

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

                • 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

                • List of allocators on which instances are placed if possible (if not possible/not specified then any available allocator with space is used)

                • Map containing allocators tags in form of key value pairs, increasing the likelihood during move requests for allocators with matching tags, to be selected as target allocators

                  Hide preferred_allocator_tags attribute Show preferred_allocator_tags attribute object
                  • * string Additional properties
                • 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

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

                  Value is forced.

                • If false (the default), the plan fails if it determines that the request can result in unsafe operations. Setting this flag overrides some of these check restraints.

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

              ID of current step

            • started string(date-time) Required

              When the step started (ISO format in UTC)

            • completed string(date-time)

              When the step completed (ISO format in UTC)

            • duration_in_millis integer(int64)

              The duration of the step in MS

            • status string Required

              The status of the step (success, warning, error - warning means something didn't go as expected but it was not serious enough to abort the plan)

              Values are success, warning, error, or pending.

            • stage string Required

              Current stage that the step is in

              Values are starting, completed, or in_progress.

            • info_log array[object] Required

              Human readable summaries of the step, including messages for each stage of the step

              Hide info_log attributes Show info_log attributes object
              • timestamp string(date-time) Required

                Timestamp marking on info log of step

              • delta_in_millis integer(int64)

                Time in milliseconds since previous log message

              • stage string Required

                Stage that info log message takes place in

                Values are starting, completed, or in_progress.

              • message string Required

                Human readable log message

              • details object Required

                A map with details for the log about what happened during the step execution. Keys and values for are always both strings, representing the name of the detail and its value, respectively.

                Hide details attribute Show details attribute object
                • * string Additional properties
              • A json object with sensitive details for the log, visible only to admins. May contain nested json objects.

                Hide internal_details attribute Show internal_details attribute object
                • * string Additional properties
              • The failure type, in case the step failed

          • source object

            Information describing the source that facilitated the plans current state

            Additional properties are allowed.

            Hide source attributes Show source attributes object
            • facilitator string Required

              The service where the change originated from

            • action string Required

              The type of plan change that was initiated

            • date string(date-time) Required

              The time the change was initiated

            • user_id string

              The user that requested the change

            • admin_id string

              The admin user that requested the change

            • remote_addresses array[string]

              The host addresses of the user that originated the change

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

              A unique warning code

            • message string Required

              A description of the warning

            • step_id string

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

          • error object

            Information about an error during a plan attempt.

            Additional properties are allowed.

            Hide error attributes Show error attributes object
            • timestamp string(date-time) Required

              Timestamp marking on info log of step

            • message string Required

              Human readable error message

            • details object Required

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

              Hide details attribute Show details attribute object
              • * string Additional properties
            • The failure type

        • pending object

          Information about the Enterprise Search Server plan.

          Additional properties are allowed.

          Hide pending attributes Show pending attributes object
          • A UUID for each plan attempt

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

          • healthy boolean Required

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

          • attempt_start_time string(date-time)

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

          • attempt_end_time string(date-time)

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

          • plan_end_time string(date-time)

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

          • plan object

            The plan for the Enterprise Search cluster.

            Additional properties are allowed.

            Hide plan attributes Show plan attributes object
            • cluster_topology array[object]
              Hide cluster_topology attributes Show cluster_topology attributes object
              • Defines the EnterpriseSearch node type

                Additional properties are allowed.

                Hide node_type attributes Show node_type attributes object
                • appserver boolean Required

                  Defines whether this instance should run as Application/API server

                • worker boolean Required

                  Defines whether this instance should run as background worker

                • connector boolean Required

                  Defines whether this instance should run as Connector

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

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

              • size object

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

                Additional properties are allowed.

                Hide size attributes Show size attributes object
                • value integer(int32) Required

                  Amount of resource

                • resource string Required

                  Type of resource

                  Values are memory or storage.

              • zone_count integer(int32)

                number of zones in which nodes will be placed

              • Additional properties are allowed.

              • Additional properties are allowed.

              • Additional properties are allowed.

            • Defines configuration parameters that control how the plan (i.e. consisting of the cluster topology and Enterprise Search settings) is applied

              Additional properties are allowed.

              Hide transient attributes Show transient attributes object
              • strategy object

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

                Additional properties are allowed.

                Hide strategy attributes Show strategy attributes object
                • rolling object

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

                  Additional properties are allowed.

                  Hide rolling attributes Show rolling attributes object
                  • group_by string

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

                  • 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

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

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

                  Additional properties are allowed.

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

                  Additional properties are allowed.

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

                  Additional properties are allowed.

              • Additional properties are allowed.

                Hide plan_configuration attributes Show plan_configuration attributes object
                • timeout integer(int64)

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

                • calm_wait_time integer(int64)

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

                • move_instances array[object]
                  Hide move_instances attributes Show move_instances attributes object
                  • from string Required

                    The instance id that is going to be moved

                  • to array[string]

                    An optional list of allocator ids to which the instance should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)

                  • Tells the infrastructure that the instance should be considered as permanently down when deciding how to migrate data to new nodes. If left blank then the system will automatically decide (currently: will treat the instances as up)

                • move_allocators array[object]
                  Hide move_allocators attributes Show move_allocators attributes object
                  • from string Required

                    The allocator id off which all instances in the cluster should be moved

                  • to array[string]

                    An optional list of allocator ids to which the instance(s) should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)

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

                • 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

                • List of allocators on which instances are placed if possible (if not possible/not specified then any available allocator with space is used)

                • Map containing allocators tags in form of key value pairs, increasing the likelihood during move requests for allocators with matching tags, to be selected as target allocators

                  Hide preferred_allocator_tags attribute Show preferred_allocator_tags attribute object
                  • * string Additional properties
                • 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

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

                  Value is forced.

                • If false (the default), the plan fails if it determines that the request can result in unsafe operations. Setting this flag overrides some of these check restraints.

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

              ID of current step

            • started string(date-time) Required

              When the step started (ISO format in UTC)

            • completed string(date-time)

              When the step completed (ISO format in UTC)

            • duration_in_millis integer(int64)

              The duration of the step in MS

            • status string Required

              The status of the step (success, warning, error - warning means something didn't go as expected but it was not serious enough to abort the plan)

              Values are success, warning, error, or pending.

            • stage string Required

              Current stage that the step is in

              Values are starting, completed, or in_progress.

            • info_log array[object] Required

              Human readable summaries of the step, including messages for each stage of the step

              Hide info_log attributes Show info_log attributes object
              • timestamp string(date-time) Required

                Timestamp marking on info log of step

              • delta_in_millis integer(int64)

                Time in milliseconds since previous log message

              • stage string Required

                Stage that info log message takes place in

                Values are starting, completed, or in_progress.

              • message string Required

                Human readable log message

              • details object Required

                A map with details for the log about what happened during the step execution. Keys and values for are always both strings, representing the name of the detail and its value, respectively.

                Hide details attribute Show details attribute object
                • * string Additional properties
              • A json object with sensitive details for the log, visible only to admins. May contain nested json objects.

                Hide internal_details attribute Show internal_details attribute object
                • * string Additional properties
              • The failure type, in case the step failed

          • source object

            Information describing the source that facilitated the plans current state

            Additional properties are allowed.

            Hide source attributes Show source attributes object
            • facilitator string Required

              The service where the change originated from

            • action string Required

              The type of plan change that was initiated

            • date string(date-time) Required

              The time the change was initiated

            • user_id string

              The user that requested the change

            • admin_id string

              The admin user that requested the change

            • remote_addresses array[string]

              The host addresses of the user that originated the change

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

              A unique warning code

            • message string Required

              A description of the warning

            • step_id string

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

          • error object

            Information about an error during a plan attempt.

            Additional properties are allowed.

            Hide error attributes Show error attributes object
            • timestamp string(date-time) Required

              Timestamp marking on info log of step

            • message string Required

              Human readable error message

            • details object Required

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

              Hide details attribute Show details attribute object
              • * string Additional properties
            • The failure type

        • history array[object] Required
          Hide history attributes Show history attributes object
          • A UUID for each plan attempt

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

          • healthy boolean Required

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

          • attempt_start_time string(date-time)

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

          • attempt_end_time string(date-time)

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

          • plan_end_time string(date-time)

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

          • plan object

            The plan for the Enterprise Search cluster.

            Additional properties are allowed.

            Hide plan attributes Show plan attributes object
            • cluster_topology array[object]
              Hide cluster_topology attributes Show cluster_topology attributes object
              • Defines the EnterpriseSearch node type

                Additional properties are allowed.

                Hide node_type attributes Show node_type attributes object
                • appserver boolean Required

                  Defines whether this instance should run as Application/API server

                • worker boolean Required

                  Defines whether this instance should run as background worker

                • connector boolean Required

                  Defines whether this instance should run as Connector

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

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

              • size object

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

                Additional properties are allowed.

                Hide size attributes Show size attributes object
                • value integer(int32) Required

                  Amount of resource

                • resource string Required

                  Type of resource

                  Values are memory or storage.

              • zone_count integer(int32)

                number of zones in which nodes will be placed

              • Additional properties are allowed.

              • Additional properties are allowed.

              • Additional properties are allowed.

            • Defines configuration parameters that control how the plan (i.e. consisting of the cluster topology and Enterprise Search settings) is applied

              Additional properties are allowed.

              Hide transient attributes Show transient attributes object
              • strategy object

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

                Additional properties are allowed.

                Hide strategy attributes Show strategy attributes object
                • rolling object

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

                  Additional properties are allowed.

                  Hide rolling attributes Show rolling attributes object
                  • group_by string

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

                  • 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

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

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

                  Additional properties are allowed.

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

                  Additional properties are allowed.

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

                  Additional properties are allowed.

              • Additional properties are allowed.

                Hide plan_configuration attributes Show plan_configuration attributes object
                • timeout integer(int64)

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

                • calm_wait_time integer(int64)

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

                • move_instances array[object]
                  Hide move_instances attributes Show move_instances attributes object
                  • from string Required

                    The instance id that is going to be moved

                  • to array[string]

                    An optional list of allocator ids to which the instance should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)

                  • Tells the infrastructure that the instance should be considered as permanently down when deciding how to migrate data to new nodes. If left blank then the system will automatically decide (currently: will treat the instances as up)

                • move_allocators array[object]
                  Hide move_allocators attributes Show move_allocators attributes object
                  • from string Required

                    The allocator id off which all instances in the cluster should be moved

                  • to array[string]

                    An optional list of allocator ids to which the instance(s) should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)

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

                • 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

                • List of allocators on which instances are placed if possible (if not possible/not specified then any available allocator with space is used)

                • Map containing allocators tags in form of key value pairs, increasing the likelihood during move requests for allocators with matching tags, to be selected as target allocators

                  Hide preferred_allocator_tags attribute Show preferred_allocator_tags attribute object
                  • * string Additional properties
                • 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

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

                  Value is forced.

                • If false (the default), the plan fails if it determines that the request can result in unsafe operations. Setting this flag overrides some of these check restraints.

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

              ID of current step

            • started string(date-time) Required

              When the step started (ISO format in UTC)

            • completed string(date-time)

              When the step completed (ISO format in UTC)

            • duration_in_millis integer(int64)

              The duration of the step in MS

            • status string Required

              The status of the step (success, warning, error - warning means something didn't go as expected but it was not serious enough to abort the plan)

              Values are success, warning, error, or pending.

            • stage string Required

              Current stage that the step is in

              Values are starting, completed, or in_progress.

            • info_log array[object] Required

              Human readable summaries of the step, including messages for each stage of the step

              Hide info_log attributes Show info_log attributes object
              • timestamp string(date-time) Required

                Timestamp marking on info log of step

              • delta_in_millis integer(int64)

                Time in milliseconds since previous log message

              • stage string Required

                Stage that info log message takes place in

                Values are starting, completed, or in_progress.

              • message string Required

                Human readable log message

              • details object Required

                A map with details for the log about what happened during the step execution. Keys and values for are always both strings, representing the name of the detail and its value, respectively.

                Hide details attribute Show details attribute object
                • * string Additional properties
              • A json object with sensitive details for the log, visible only to admins. May contain nested json objects.

                Hide internal_details attribute Show internal_details attribute object
                • * string Additional properties
              • The failure type, in case the step failed

          • source object

            Information describing the source that facilitated the plans current state

            Additional properties are allowed.

            Hide source attributes Show source attributes object
            • facilitator string Required

              The service where the change originated from

            • action string Required

              The type of plan change that was initiated

            • date string(date-time) Required

              The time the change was initiated

            • user_id string

              The user that requested the change

            • admin_id string

              The admin user that requested the change

            • remote_addresses array[string]

              The host addresses of the user that originated the change

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

              A unique warning code

            • message string Required

              A description of the warning

            • step_id string

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

          • error object

            Information about an error during a plan attempt.

            Additional properties are allowed.

            Hide error attributes Show error attributes object
            • timestamp string(date-time) Required

              Timestamp marking on info log of step

            • message string Required

              Human readable error message

            • details object Required

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

              Hide details attribute Show details attribute object
              • * string Additional properties
            • The failure type

      • metadata object

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

        Additional properties are allowed.

        Hide metadata attributes Show metadata attributes object
        • version integer(int32) Required

          The resource version number of the cluster metadata

        • last_modified string(date-time) Required

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

        • endpoint string

          The DNS name of the cluster endpoint, if available

        • The full URL to access this deployment resource

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

        • The full aliased URL to access this deployment resource

        • cloud_id string

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

        • raw object

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

          Additional properties are allowed.

        • ports object

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

          Additional properties are allowed.

          Hide ports attributes Show ports attributes object
          • http integer(int32) Required

            Port where the cluster listens for HTTP traffic

          • https integer(int32) Required

            Port where the cluster listens for HTTPS traffic

          • transport_passthrough integer(int32) Required

            Port where the cluster listens for transport traffic using TLS

        • services_urls array[object]

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

          Hide services_urls attributes Show services_urls attributes object
          • service string Required

            Name of the service

          • url string Required

            The full URL to access the service

      • topology object Required

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

        Additional properties are allowed.

        Hide topology attributes Show topology attributes object
        • healthy boolean Required

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

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

            The name of the instance in Elastic Cloud

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

            Additional properties are allowed.

            Hide instance_configuration attributes Show instance_configuration attributes object
            • id string Required

              The id of the configuration used to create the instance

            • name string Required

              The name of the configuration used to create the instance

            • config_version integer(int32)

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

            • resource string Required

              The resource type of the instance configuration

              Values are memory or storage.

          • 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

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

          • memory object

            Information about the specific instances memory capacity and its usage

            Additional properties are allowed.

            Hide memory attributes Show memory attributes object
            • instance_capacity integer(int32) Required

              The memory capacity in MB of the instance

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

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

          • disk object

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

            Additional properties are allowed.

            Hide disk attributes Show disk attributes object
            • disk_space_available integer(int64)

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

            • disk_space_used integer(int64) Required

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

            • storage_multiplier number(double) Required

              The storage multiplier originally defined to calculate disk space.

          • service_roles array[string]

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

          • node_roles array[string]

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

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

          • Instance overrides

            Additional properties are allowed.

            Hide instance_overrides attributes Show instance_overrides attributes object
            • capacity integer(int32)

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

            • storage_multiplier number(double)

              Overrides the disk quota multiplier for the instance

      • settings object

        The settings for building this Enterprise Search cluster

        Additional properties are allowed.

        Hide settings attribute Show settings attribute object
        • metadata object

          The top-level configuration settings for the Elasticsearch cluster.

          Additional properties are allowed.

          Hide metadata attributes Show metadata attributes object
          • name string

            The display name of the cluster

          • owner_id string

            The user id (referencing whatever user database is in use) of the cluster owner

          • The organization that owns the deployment

          • Subscription level of the cluster

          • Indicates if a cluster is system owned (restricts the set of operations that can be performed on it)

          • Contact email for the cluster

          • hidden boolean

            Whether or not this cluster is hidden from the normal clusters list

          • The top-level configuration settings for the Elasticsearch cluster resources.

            Additional properties are allowed.

            Hide resources attribute Show resources attribute object
            • cpu object

              Specifies the CPU resource settings for the Elasticsearch cluster.

              Additional properties are allowed.

              Hide cpu attributes Show cpu attributes object
              • boost boolean

                Indicates if the CPU boost flag is enabled or not.

              • hard_limit boolean

                Indicates if the CPU hard limit flag is enabled or not. When set to true (default), allocates CPU timeshare based on the total CPU time multiplied by the relative RAM capacity of the instance on a given host. When set to false, delegates CPU allocation to the operating system to schedule CPU timeshares.

      • region string

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

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

    Hide headers attribute Show headers attribute
    • 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

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

    Hide headers attribute Show headers attribute
    • The error codes associated with the response

      Value is deployments.deployment_resource_no_longer_exists.

    Hide response attribute Show response attribute object
    • errors array[object] Required

      A list of errors that occurred in the failing request

      Hide errors attributes Show errors attributes object
      • code string Required

        A structured code representing the error type that occurred

      • message string Required

        A human readable message describing the error that occurred

      • fields array[string]

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

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

# Payload
{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}
Response examples (500)
# Headers
x-cloud-error-codes: deployments.deployment_resource_no_longer_exists

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








Get Deployment Kibana Resource Info

GET /deployments/{deployment_id}/kibana/{ref_id}

Get info about a Kibana 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

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

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

    Default value is false.

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

    Default value is false.

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

    Default value is false.

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

    Default value is false.

  • Whether to show cluster settings in the response.

    Default value is false.

  • 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

  • Standard response.

    Hide response attributes Show response attributes object
    • ref_id string Required

      The locally-unique user-specified id of a Resource

    • The Elasticsearch cluster that this resource depends on.

    • id string Required

      The randomly-generated id of a Resource

    • region string Required

      The region where this resource exists

    • info object Required

      Info for the resource.

      Additional properties are allowed.

      Hide info attributes Show info attributes object
      • cluster_id string Required

        The id of the cluster

      • cluster_name string Required

        The name of the cluster

      • elasticsearch_cluster object Required

        Information about the specified Elasticsearch cluster.

        Additional properties are allowed.

        Hide elasticsearch_cluster attributes Show elasticsearch_cluster attributes object
        • elasticsearch_id string Required

          The Elasticsearch cluster Id

      • The id of the deployment to which this Kibana Server belongs to.

      • healthy boolean Required

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

      • status string Required

        Cluster status

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

      • plan_info object Required

        Information about the current, pending, or past Kibana instance plans.

        Additional properties are allowed.

        Hide plan_info attributes Show plan_info attributes object
        • healthy boolean Required

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

        • current object

          Information about the current, pending, or past Kibana instance plan.

          Additional properties are allowed.

          Hide current attributes Show current attributes object
          • A UUID for each plan attempt

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

          • healthy boolean Required

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

          • attempt_start_time string(date-time)

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

          • attempt_end_time string(date-time)

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

          • plan_end_time string(date-time)

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

          • plan object

            The plan for the Kibana instance.

            Additional properties are allowed.

            Hide plan attributes Show plan attributes object
            • cluster_topology array[object]
              Hide cluster_topology attributes Show cluster_topology attributes object
              • memory_per_node integer(int32)

                The memory capacity in MB for each node of this type built in each zone.

              • node_count_per_zone integer(int32)

                The number of nodes of this type that are allocated within each zone (i.e. total capacity per zone = node_count_per_zone * memory_per_node in MB).

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

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

              • size object

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

                Additional properties are allowed.

                Hide size attributes Show size attributes object
                • value integer(int32) Required

                  Amount of resource

                • resource string Required

                  Type of resource

                  Values are memory or storage.

              • zone_count integer(int32)

                number of zones in which nodes will be placed

              • kibana object

                The Kibana instance settings. When specified at the top level, provides a field-by-field default. When specified at the topology level, provides the override settings.

                Additional properties are allowed.

                Hide kibana attributes Show kibana attributes object
                • version string

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

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

                • A subset of Kibana settings. TIP: To define the complete set of Elasticsearch settings, use KibanaSystemSettings with user_settings_override_ and user_settings_.

                  Additional properties are allowed.

                  Hide system_settings attributes Show system_settings attributes object
                  • DEPRECATED: Scheduled for removal in a future version of the API.

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

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

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

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

                  Additional properties are allowed.

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

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

                  Additional properties are allowed.

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

            • kibana object Required

              The Kibana instance settings. When specified at the top level, provides a field-by-field default. When specified at the topology level, provides the override settings.

              Additional properties are allowed.

              Hide kibana attributes Show kibana attributes object
              • version string

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

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

              • A subset of Kibana settings. TIP: To define the complete set of Elasticsearch settings, use KibanaSystemSettings with user_settings_override_ and user_settings_.

                Additional properties are allowed.

                Hide system_settings attributes Show system_settings attributes object
                • DEPRECATED: Scheduled for removal in a future version of the API.

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

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

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

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

                Additional properties are allowed.

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

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

                Additional properties are allowed.

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

            • Defines the configuration parameters that control how the plan is applied. For example, the Elasticsearch cluster topology and Kibana instance settings.

              Additional properties are allowed.

              Hide transient attributes Show transient attributes object
              • strategy object

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

                Additional properties are allowed.

                Hide strategy attributes Show strategy attributes object
                • rolling object

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

                  Additional properties are allowed.

                  Hide rolling attributes Show rolling attributes object
                  • group_by string

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

                  • 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

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

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

                  Additional properties are allowed.

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

                  Additional properties are allowed.

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

                  Additional properties are allowed.

              • The configuration settings for the timeout and fallback parameters.

                Additional properties are allowed.

                Hide plan_configuration attributes Show plan_configuration attributes object
                • timeout integer(int64)

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

                • calm_wait_time integer(int64)

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

                • move_instances array[object]
                  Hide move_instances attributes Show move_instances attributes object
                  • from string Required

                    The instance id that is going to be moved

                  • to array[string]

                    An optional list of allocator ids to which the instance should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)

                  • Tells the infrastructure that the instance should be considered as permanently down when deciding how to migrate data to new nodes. If left blank then the system will automatically decide (currently: will treat the instances as up)

                • move_allocators array[object]
                  Hide move_allocators attributes Show move_allocators attributes object
                  • from string Required

                    The allocator id off which all instances in the cluster should be moved

                  • to array[string]

                    An optional list of allocator ids to which the instance(s) should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)

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

                • If true (default: false) does not allow re-using any existing instances currently in the cluster, ie even unchanged instances will be re-created

                • List of allocators on which instances are placed if possible (if not possible/not specified then any available allocator with space is used)

                • Map containing allocators tags in form of key value pairs, increasing the likelihood during move requests for allocators with matching tags, to be selected as target allocators

                  Hide preferred_allocator_tags attribute Show preferred_allocator_tags attribute object
                  • * string Additional properties
                • 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

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

                  Value is forced.

                • If false (the default), the plan fails if it determines that the request can result in unsafe operations. Setting this flag overrides some of these check restraints.

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

              ID of current step

            • started string(date-time) Required

              When the step started (ISO format in UTC)

            • completed string(date-time)

              When the step completed (ISO format in UTC)

            • duration_in_millis integer(int64)

              The duration of the step in MS

            • status string Required

              The status of the step (success, warning, error - warning means something didn't go as expected but it was not serious enough to abort the plan)

              Values are success, warning, error, or pending.

            • stage string Required

              Current stage that the step is in

              Values are starting, completed, or in_progress.

            • info_log array[object] Required

              Human readable summaries of the step, including messages for each stage of the step

              Hide info_log attributes Show info_log attributes object
              • timestamp string(date-time) Required

                Timestamp marking on info log of step

              • delta_in_millis integer(int64)

                Time in milliseconds since previous log message

              • stage string Required

                Stage that info log message takes place in

                Values are starting, completed, or in_progress.

              • message string Required

                Human readable log message

              • details object Required

                A map with details for the log about what happened during the step execution. Keys and values for are always both strings, representing the name of the detail and its value, respectively.

                Hide details attribute Show details attribute object
                • * string Additional properties
              • A json object with sensitive details for the log, visible only to admins. May contain nested json objects.

                Hide internal_details attribute Show internal_details attribute object
                • * string Additional properties
              • The failure type, in case the step failed

          • source object

            Information describing the source that facilitated the plans current state

            Additional properties are allowed.

            Hide source attributes Show source attributes object
            • facilitator string Required

              The service where the change originated from

            • action string Required

              The type of plan change that was initiated

            • date string(date-time) Required

              The time the change was initiated

            • user_id string

              The user that requested the change

            • admin_id string

              The admin user that requested the change

            • remote_addresses array[string]

              The host addresses of the user that originated the change

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

              A unique warning code

            • message string Required

              A description of the warning

            • step_id string

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

          • error object

            Information about an error during a plan attempt.

            Additional properties are allowed.

            Hide error attributes Show error attributes object
            • timestamp string(date-time) Required

              Timestamp marking on info log of step

            • message string Required

              Human readable error message

            • details object Required

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

              Hide details attribute Show details attribute object
              • * string Additional properties
            • The failure type

        • pending object

          Information about the current, pending, or past Kibana instance plan.

          Additional properties are allowed.

          Hide pending attributes Show pending attributes object
          • A UUID for each plan attempt

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

          • healthy boolean Required

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

          • attempt_start_time string(date-time)

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

          • attempt_end_time string(date-time)

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

          • plan_end_time string(date-time)

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

          • plan object

            The plan for the Kibana instance.

            Additional properties are allowed.

            Hide plan attributes Show plan attributes object
            • cluster_topology array[object]
              Hide cluster_topology attributes Show cluster_topology attributes object
              • memory_per_node integer(int32)

                The memory capacity in MB for each node of this type built in each zone.

              • node_count_per_zone integer(int32)

                The number of nodes of this type that are allocated within each zone (i.e. total capacity per zone = node_count_per_zone * memory_per_node in MB).

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

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

              • size object

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

                Additional properties are allowed.

                Hide size attributes Show size attributes object
                • value integer(int32) Required

                  Amount of resource

                • resource string Required

                  Type of resource

                  Values are memory or storage.

              • zone_count integer(int32)

                number of zones in which nodes will be placed

              • kibana object

                The Kibana instance settings. When specified at the top level, provides a field-by-field default. When specified at the topology level, provides the override settings.

                Additional properties are allowed.

                Hide kibana attributes Show kibana attributes object
                • version string

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

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

                • A subset of Kibana settings. TIP: To define the complete set of Elasticsearch settings, use KibanaSystemSettings with user_settings_override_ and user_settings_.

                  Additional properties are allowed.

                  Hide system_settings attributes Show system_settings attributes object
                  • DEPRECATED: Scheduled for removal in a future version of the API.

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

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

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

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

                  Additional properties are allowed.

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

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

                  Additional properties are allowed.

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

            • kibana object Required

              The Kibana instance settings. When specified at the top level, provides a field-by-field default. When specified at the topology level, provides the override settings.

              Additional properties are allowed.

              Hide kibana attributes Show kibana attributes object
              • version string

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

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

              • A subset of Kibana settings. TIP: To define the complete set of Elasticsearch settings, use KibanaSystemSettings with user_settings_override_ and user_settings_.

                Additional properties are allowed.

                Hide system_settings attributes Show system_settings attributes object
                • DEPRECATED: Scheduled for removal in a future version of the API.

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

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

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

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

                Additional properties are allowed.

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

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

                Additional properties are allowed.

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

            • Defines the configuration parameters that control how the plan is applied. For example, the Elasticsearch cluster topology and Kibana instance settings.

              Additional properties are allowed.

              Hide transient attributes Show transient attributes object
              • strategy object

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

                Additional properties are allowed.

                Hide strategy attributes Show strategy attributes object
                • rolling object

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

                  Additional properties are allowed.

                  Hide rolling attributes Show rolling attributes object
                  • group_by string

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

                  • 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

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

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

                  Additional properties are allowed.

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

                  Additional properties are allowed.

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

                  Additional properties are allowed.

              • The configuration settings for the timeout and fallback parameters.

                Additional properties are allowed.

                Hide plan_configuration attributes Show plan_configuration attributes object
                • timeout integer(int64)

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

                • calm_wait_time integer(int64)

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

                • move_instances array[object]
                  Hide move_instances attributes Show move_instances attributes object
                  • from string Required

                    The instance id that is going to be moved

                  • to array[string]

                    An optional list of allocator ids to which the instance should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)

                  • Tells the infrastructure that the instance should be considered as permanently down when deciding how to migrate data to new nodes. If left blank then the system will automatically decide (currently: will treat the instances as up)

                • move_allocators array[object]
                  Hide move_allocators attributes Show move_allocators attributes object
                  • from string Required

                    The allocator id off which all instances in the cluster should be moved

                  • to array[string]

                    An optional list of allocator ids to which the instance(s) should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)

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

                • If true (default: false) does not allow re-using any existing instances currently in the cluster, ie even unchanged instances will be re-created

                • List of allocators on which instances are placed if possible (if not possible/not specified then any available allocator with space is used)

                • Map containing allocators tags in form of key value pairs, increasing the likelihood during move requests for allocators with matching tags, to be selected as target allocators

                  Hide preferred_allocator_tags attribute Show preferred_allocator_tags attribute object
                  • * string Additional properties
                • 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

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

                  Value is forced.

                • If false (the default), the plan fails if it determines that the request can result in unsafe operations. Setting this flag overrides some of these check restraints.

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

              ID of current step

            • started string(date-time) Required

              When the step started (ISO format in UTC)

            • completed string(date-time)

              When the step completed (ISO format in UTC)

            • duration_in_millis integer(int64)

              The duration of the step in MS

            • status string Required

              The status of the step (success, warning, error - warning means something didn't go as expected but it was not serious enough to abort the plan)

              Values are success, warning, error, or pending.

            • stage string Required

              Current stage that the step is in

              Values are starting, completed, or in_progress.

            • info_log array[object] Required

              Human readable summaries of the step, including messages for each stage of the step

              Hide info_log attributes Show info_log attributes object
              • timestamp string(date-time) Required

                Timestamp marking on info log of step

              • delta_in_millis integer(int64)

                Time in milliseconds since previous log message

              • stage string Required

                Stage that info log message takes place in

                Values are starting, completed, or in_progress.

              • message string Required

                Human readable log message

              • details object Required

                A map with details for the log about what happened during the step execution. Keys and values for are always both strings, representing the name of the detail and its value, respectively.

                Hide details attribute Show details attribute object
                • * string Additional properties
              • A json object with sensitive details for the log, visible only to admins. May contain nested json objects.

                Hide internal_details attribute Show internal_details attribute object
                • * string Additional properties
              • The failure type, in case the step failed

          • source object

            Information describing the source that facilitated the plans current state

            Additional properties are allowed.

            Hide source attributes Show source attributes object
            • facilitator string Required

              The service where the change originated from

            • action string Required

              The type of plan change that was initiated

            • date string(date-time) Required

              The time the change was initiated

            • user_id string

              The user that requested the change

            • admin_id string

              The admin user that requested the change

            • remote_addresses array[string]

              The host addresses of the user that originated the change

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

              A unique warning code

            • message string Required

              A description of the warning

            • step_id string

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

          • error object

            Information about an error during a plan attempt.

            Additional properties are allowed.

            Hide error attributes Show error attributes object
            • timestamp string(date-time) Required

              Timestamp marking on info log of step

            • message string Required

              Human readable error message

            • details object Required

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

              Hide details attribute Show details attribute object
              • * string Additional properties
            • The failure type

        • history array[object] Required
          Hide history attributes Show history attributes object
          • A UUID for each plan attempt

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

          • healthy boolean Required

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

          • attempt_start_time string(date-time)

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

          • attempt_end_time string(date-time)

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

          • plan_end_time string(date-time)

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

          • plan object

            The plan for the Kibana instance.

            Additional properties are allowed.

            Hide plan attributes Show plan attributes object
            • cluster_topology array[object]
              Hide cluster_topology attributes Show cluster_topology attributes object
              • memory_per_node integer(int32)

                The memory capacity in MB for each node of this type built in each zone.

              • node_count_per_zone integer(int32)

                The number of nodes of this type that are allocated within each zone (i.e. total capacity per zone = node_count_per_zone * memory_per_node in MB).

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

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

              • size object

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

                Additional properties are allowed.

                Hide size attributes Show size attributes object
                • value integer(int32) Required

                  Amount of resource

                • resource string Required

                  Type of resource

                  Values are memory or storage.

              • zone_count integer(int32)

                number of zones in which nodes will be placed

              • kibana object

                The Kibana instance settings. When specified at the top level, provides a field-by-field default. When specified at the topology level, provides the override settings.

                Additional properties are allowed.

                Hide kibana attributes Show kibana attributes object
                • version string

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

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

                • A subset of Kibana settings. TIP: To define the complete set of Elasticsearch settings, use KibanaSystemSettings with user_settings_override_ and user_settings_.

                  Additional properties are allowed.

                  Hide system_settings attributes Show system_settings attributes object
                  • DEPRECATED: Scheduled for removal in a future version of the API.

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

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

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

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

                  Additional properties are allowed.

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

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

                  Additional properties are allowed.

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

            • kibana object Required

              The Kibana instance settings. When specified at the top level, provides a field-by-field default. When specified at the topology level, provides the override settings.

              Additional properties are allowed.

              Hide kibana attributes Show kibana attributes object
              • version string

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

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

              • A subset of Kibana settings. TIP: To define the complete set of Elasticsearch settings, use KibanaSystemSettings with user_settings_override_ and user_settings_.

                Additional properties are allowed.

                Hide system_settings attributes Show system_settings attributes object
                • DEPRECATED: Scheduled for removal in a future version of the API.

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

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

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

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

                Additional properties are allowed.

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

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

                Additional properties are allowed.

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

            • Defines the configuration parameters that control how the plan is applied. For example, the Elasticsearch cluster topology and Kibana instance settings.

              Additional properties are allowed.

              Hide transient attributes Show transient attributes object
              • strategy object

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

                Additional properties are allowed.

                Hide strategy attributes Show strategy attributes object
                • rolling object

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

                  Additional properties are allowed.

                  Hide rolling attributes Show rolling attributes object
                  • group_by string

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

                  • 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

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

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

                  Additional properties are allowed.

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

                  Additional properties are allowed.

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

                  Additional properties are allowed.

              • The configuration settings for the timeout and fallback parameters.

                Additional properties are allowed.

                Hide plan_configuration attributes Show plan_configuration attributes object
                • timeout integer(int64)

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

                • calm_wait_time integer(int64)

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

                • move_instances array[object]
                  Hide move_instances attributes Show move_instances attributes object
                  • from string Required

                    The instance id that is going to be moved

                  • to array[string]

                    An optional list of allocator ids to which the instance should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)

                  • Tells the infrastructure that the instance should be considered as permanently down when deciding how to migrate data to new nodes. If left blank then the system will automatically decide (currently: will treat the instances as up)

                • move_allocators array[object]
                  Hide move_allocators attributes Show move_allocators attributes object
                  • from string Required

                    The allocator id off which all instances in the cluster should be moved

                  • to array[string]

                    An optional list of allocator ids to which the instance(s) should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)

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

                • If true (default: false) does not allow re-using any existing instances currently in the cluster, ie even unchanged instances will be re-created

                • List of allocators on which instances are placed if possible (if not possible/not specified then any available allocator with space is used)

                • Map containing allocators tags in form of key value pairs, increasing the likelihood during move requests for allocators with matching tags, to be selected as target allocators

                  Hide preferred_allocator_tags attribute Show preferred_allocator_tags attribute object
                  • * string Additional properties
                • 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

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

                  Value is forced.

                • If false (the default), the plan fails if it determines that the request can result in unsafe operations. Setting this flag overrides some of these check restraints.

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

              ID of current step

            • started string(date-time) Required

              When the step started (ISO format in UTC)

            • completed string(date-time)

              When the step completed (ISO format in UTC)

            • duration_in_millis integer(int64)

              The duration of the step in MS

            • status string Required

              The status of the step (success, warning, error - warning means something didn't go as expected but it was not serious enough to abort the plan)

              Values are success, warning, error, or pending.

            • stage string Required

              Current stage that the step is in

              Values are starting, completed, or in_progress.

            • info_log array[object] Required

              Human readable summaries of the step, including messages for each stage of the step

              Hide info_log attributes Show info_log attributes object
              • timestamp string(date-time) Required

                Timestamp marking on info log of step

              • delta_in_millis integer(int64)

                Time in milliseconds since previous log message

              • stage string Required

                Stage that info log message takes place in

                Values are starting, completed, or in_progress.

              • message string Required

                Human readable log message

              • details object Required

                A map with details for the log about what happened during the step execution. Keys and values for are always both strings, representing the name of the detail and its value, respectively.

                Hide details attribute Show details attribute object
                • * string Additional properties
              • A json object with sensitive details for the log, visible only to admins. May contain nested json objects.

                Hide internal_details attribute Show internal_details attribute object
                • * string Additional properties
              • The failure type, in case the step failed

          • source object

            Information describing the source that facilitated the plans current state

            Additional properties are allowed.

            Hide source attributes Show source attributes object
            • facilitator string Required

              The service where the change originated from

            • action string Required

              The type of plan change that was initiated

            • date string(date-time) Required

              The time the change was initiated

            • user_id string

              The user that requested the change

            • admin_id string

              The admin user that requested the change

            • remote_addresses array[string]

              The host addresses of the user that originated the change

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

              A unique warning code

            • message string Required

              A description of the warning

            • step_id string

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

          • error object

            Information about an error during a plan attempt.

            Additional properties are allowed.

            Hide error attributes Show error attributes object
            • timestamp string(date-time) Required

              Timestamp marking on info log of step

            • message string Required

              Human readable error message

            • details object Required

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

              Hide details attribute Show details attribute object
              • * string Additional properties
            • The failure type

      • metadata object Required

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

        Additional properties are allowed.

        Hide metadata attributes Show metadata attributes object
        • version integer(int32) Required

          The resource version number of the cluster metadata

        • last_modified string(date-time) Required

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

        • endpoint string

          The DNS name of the cluster endpoint, if available

        • The full URL to access this deployment resource

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

        • The full aliased URL to access this deployment resource

        • cloud_id string

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

        • raw object

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

          Additional properties are allowed.

        • ports object

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

          Additional properties are allowed.

          Hide ports attributes Show ports attributes object
          • http integer(int32) Required

            Port where the cluster listens for HTTP traffic

          • https integer(int32) Required

            Port where the cluster listens for HTTPS traffic

          • transport_passthrough integer(int32) Required

            Port where the cluster listens for transport traffic using TLS

        • services_urls array[object]

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

          Hide services_urls attributes Show services_urls attributes object
          • service string Required

            Name of the service

          • url string Required

            The full URL to access the service

      • topology object Required

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

        Additional properties are allowed.

        Hide topology attributes Show topology attributes object
        • healthy boolean Required

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

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

            The name of the instance in Elastic Cloud

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

            Additional properties are allowed.

            Hide instance_configuration attributes Show instance_configuration attributes object
            • id string Required

              The id of the configuration used to create the instance

            • name string Required

              The name of the configuration used to create the instance

            • config_version integer(int32)

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

            • resource string Required

              The resource type of the instance configuration

              Values are memory or storage.

          • 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

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

          • memory object

            Information about the specific instances memory capacity and its usage

            Additional properties are allowed.

            Hide memory attributes Show memory attributes object
            • instance_capacity integer(int32) Required

              The memory capacity in MB of the instance

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

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

          • disk object

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

            Additional properties are allowed.

            Hide disk attributes Show disk attributes object
            • disk_space_available integer(int64)

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

            • disk_space_used integer(int64) Required

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

            • storage_multiplier number(double) Required

              The storage multiplier originally defined to calculate disk space.

          • service_roles array[string]

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

          • node_roles array[string]

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

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

          • Instance overrides

            Additional properties are allowed.

            Hide instance_overrides attributes Show instance_overrides attributes object
            • capacity integer(int32)

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

            • storage_multiplier number(double)

              Overrides the disk quota multiplier for the instance

      • settings object

        The settings for building this Kibana cluster

        Additional properties are allowed.

        Hide settings attribute Show settings attribute object
        • metadata object

          The top-level configuration settings for the Elasticsearch cluster.

          Additional properties are allowed.

          Hide metadata attributes Show metadata attributes object
          • name string

            The display name of the cluster

          • owner_id string

            The user id (referencing whatever user database is in use) of the cluster owner

          • The organization that owns the deployment

          • Subscription level of the cluster

          • Indicates if a cluster is system owned (restricts the set of operations that can be performed on it)

          • Contact email for the cluster

          • hidden boolean

            Whether or not this cluster is hidden from the normal clusters list

          • The top-level configuration settings for the Elasticsearch cluster resources.

            Additional properties are allowed.

            Hide resources attribute Show resources attribute object
            • cpu object

              Specifies the CPU resource settings for the Elasticsearch cluster.

              Additional properties are allowed.

              Hide cpu attributes Show cpu attributes object
              • boost boolean

                Indicates if the CPU boost flag is enabled or not.

              • hard_limit boolean

                Indicates if the CPU hard limit flag is enabled or not. When set to true (default), allocates CPU timeshare based on the total CPU time multiplied by the relative RAM capacity of the instance on a given host. When set to false, delegates CPU allocation to the operating system to schedule CPU timeshares.

      • region string

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

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

    Hide headers attribute Show headers attribute
    • 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

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

    Hide headers attribute Show headers attribute
    • 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}/kibana/{ref_id}
curl \
 -X GET https://{{hostname}}/api/v1/deployments/{deployment_id}/kibana/{ref_id}
Response examples (200)
{
  "ref_id": "string",
  "elasticsearch_cluster_ref_id": "string",
  "id": "string",
  "region": "string",
  "info": {
    "cluster_id": "string",
    "cluster_name": "string",
    "elasticsearch_cluster": {
      "elasticsearch_id": "string",
      "links": {
        "additionalProperty1": {
          "need_elevated_permissions": true
        },
        "additionalProperty2": {
          "need_elevated_permissions": true
        }
      }
    },
    "deployment_id": "string",
    "healthy": true,
    "status": "initializing",
    "plan_info": {
      "healthy": true,
      "current": {
        "plan_attempt_id": "string",
        "plan_attempt_name": "string",
        "healthy": true,
        "attempt_start_time": "2025-05-04T09:42:00+00:00",
        "attempt_end_time": "2025-05-04T09:42:00+00:00",
        "plan_end_time": "2025-05-04T09:42:00+00:00",
        "plan": {
          "cluster_topology": [
            {
              "memory_per_node": 42,
              "node_count_per_zone": 42,
              "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_url": "string",
                  "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_url": "string",
              "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,
              "move_instances": [
                {
                  "from": "string",
                  "to": [
                    "string"
                  ],
                  "instance_down": true
                }
              ],
              "move_allocators": [
                {
                  "from": "string",
                  "to": [
                    "string"
                  ],
                  "allocator_down": true
                }
              ],
              "reallocate_instances": true,
              "preferred_allocators": [
                "string"
              ],
              "preferred_allocator_tags": {
                "additionalProperty1": "string",
                "additionalProperty2": "string"
              },
              "extended_maintenance": true,
              "cluster_reboot": "forced",
              "override_failsafe": true
            }
          }
        },
        "plan_attempt_log": [
          {
            "step_id": "string",
            "started": "2025-05-04T09:42:00+00:00",
            "completed": "2025-05-04T09:42:00+00:00",
            "duration_in_millis": 42,
            "status": "success",
            "stage": "starting",
            "info_log": [
              {
                "timestamp": "2025-05-04T09:42:00+00:00",
                "delta_in_millis": 42,
                "stage": "starting",
                "message": "string",
                "details": {
                  "additionalProperty1": "string",
                  "additionalProperty2": "string"
                },
                "internal_details": {
                  "additionalProperty1": "string",
                  "additionalProperty2": "string"
                },
                "failure_type": "string"
              }
            ]
          }
        ],
        "source": {
          "facilitator": "string",
          "action": "string",
          "date": "2025-05-04T09:42:00+00:00",
          "user_id": "string",
          "admin_id": "string",
          "remote_addresses": [
            "string"
          ]
        },
        "warnings": [
          {
            "code": "string",
            "message": "string",
            "step_id": "string"
          }
        ],
        "error": {
          "timestamp": "2025-05-04T09:42:00+00:00",
          "message": "string",
          "details": {
            "additionalProperty1": "string",
            "additionalProperty2": "string"
          },
          "failure_type": "string"
        }
      },
      "pending": {
        "plan_attempt_id": "string",
        "plan_attempt_name": "string",
        "healthy": true,
        "attempt_start_time": "2025-05-04T09:42:00+00:00",
        "attempt_end_time": "2025-05-04T09:42:00+00:00",
        "plan_end_time": "2025-05-04T09:42:00+00:00",
        "plan": {
          "cluster_topology": [
            {
              "memory_per_node": 42,
              "node_count_per_zone": 42,
              "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_url": "string",
                  "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_url": "string",
              "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,
              "move_instances": [
                {
                  "from": "string",
                  "to": [
                    "string"
                  ],
                  "instance_down": true
                }
              ],
              "move_allocators": [
                {
                  "from": "string",
                  "to": [
                    "string"
                  ],
                  "allocator_down": true
                }
              ],
              "reallocate_instances": true,
              "preferred_allocators": [
                "string"
              ],
              "preferred_allocator_tags": {
                "additionalProperty1": "string",
                "additionalProperty2": "string"
              },
              "extended_maintenance": true,
              "cluster_reboot": "forced",
              "override_failsafe": true
            }
          }
        },
        "plan_attempt_log": [
          {
            "step_id": "string",
            "started": "2025-05-04T09:42:00+00:00",
            "completed": "2025-05-04T09:42:00+00:00",
            "duration_in_millis": 42,
            "status": "success",
            "stage": "starting",
            "info_log": [
              {
                "timestamp": "2025-05-04T09:42:00+00:00",
                "delta_in_millis": 42,
                "stage": "starting",
                "message": "string",
                "details": {
                  "additionalProperty1": "string",
                  "additionalProperty2": "string"
                },
                "internal_details": {
                  "additionalProperty1": "string",
                  "additionalProperty2": "string"
                },
                "failure_type": "string"
              }
            ]
          }
        ],
        "source": {
          "facilitator": "string",
          "action": "string",
          "date": "2025-05-04T09:42:00+00:00",
          "user_id": "string",
          "admin_id": "string",
          "remote_addresses": [
            "string"
          ]
        },
        "warnings": [
          {
            "code": "string",
            "message": "string",
            "step_id": "string"
          }
        ],
        "error": {
          "timestamp": "2025-05-04T09:42:00+00:00",
          "message": "string",
          "details": {
            "additionalProperty1": "string",
            "additionalProperty2": "string"
          },
          "failure_type": "string"
        }
      },
      "history": [
        {
          "plan_attempt_id": "string",
          "plan_attempt_name": "string",
          "healthy": true,
          "attempt_start_time": "2025-05-04T09:42:00+00:00",
          "attempt_end_time": "2025-05-04T09:42:00+00:00",
          "plan_end_time": "2025-05-04T09:42:00+00:00",
          "plan": {
            "cluster_topology": [
              {
                "memory_per_node": 42,
                "node_count_per_zone": 42,
                "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_url": "string",
                    "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_url": "string",
                "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,
                "move_instances": [
                  {
                    "from": "string",
                    "to": [
                      "string"
                    ],
                    "instance_down": true
                  }
                ],
                "move_allocators": [
                  {
                    "from": "string",
                    "to": [
                      "string"
                    ],
                    "allocator_down": true
                  }
                ],
                "reallocate_instances": true,
                "preferred_allocators": [
                  "string"
                ],
                "preferred_allocator_tags": {
                  "additionalProperty1": "string",
                  "additionalProperty2": "string"
                },
                "extended_maintenance": true,
                "cluster_reboot": "forced",
                "override_failsafe": true
              }
            }
          },
          "plan_attempt_log": [
            {
              "step_id": "string",
              "started": "2025-05-04T09:42:00+00:00",
              "completed": "2025-05-04T09:42:00+00:00",
              "duration_in_millis": 42,
              "status": "success",
              "stage": "starting",
              "info_log": [
                {
                  "timestamp": "2025-05-04T09:42:00+00:00",
                  "delta_in_millis": 42,
                  "stage": "starting",
                  "message": "string",
                  "details": {
                    "additionalProperty1": "string",
                    "additionalProperty2": "string"
                  },
                  "internal_details": {
                    "additionalProperty1": "string",
                    "additionalProperty2": "string"
                  },
                  "failure_type": "string"
                }
              ]
            }
          ],
          "source": {
            "facilitator": "string",
            "action": "string",
            "date": "2025-05-04T09:42:00+00:00",
            "user_id": "string",
            "admin_id": "string",
            "remote_addresses": [
              "string"
            ]
          },
          "warnings": [
            {
              "code": "string",
              "message": "string",
              "step_id": "string"
            }
          ],
          "error": {
            "timestamp": "2025-05-04T09:42:00+00:00",
            "message": "string",
            "details": {
              "additionalProperty1": "string",
              "additionalProperty2": "string"
            },
            "failure_type": "string"
          }
        }
      ]
    },
    "metadata": {
      "version": 42,
      "last_modified": "2025-05-04T09:42:00+00:00",
      "endpoint": "string",
      "service_url": "string",
      "aliased_endpoint": "string",
      "aliased_url": "string",
      "cloud_id": "string",
      "raw": {},
      "ports": {
        "http": 42,
        "https": 42,
        "transport_passthrough": 42
      },
      "services_urls": [
        {
          "service": "string",
          "url": "string"
        }
      ]
    },
    "topology": {
      "healthy": true,
      "instances": [
        {
          "instance_name": "string",
          "instance_configuration": {
            "id": "string",
            "name": "string",
            "config_version": 42,
            "resource": "memory"
          },
          "service_version": "string",
          "healthy": true,
          "container_started": true,
          "service_running": true,
          "maintenance_mode": true,
          "zone": "string",
          "allocator_id": "string",
          "memory": {
            "instance_capacity": 42,
            "instance_capacity_planned": 42,
            "memory_pressure": 42,
            "native_memory_pressure": 42
          },
          "disk": {
            "disk_space_available": 42,
            "disk_space_used": 42,
            "storage_multiplier": 42.0
          },
          "service_roles": [
            "string"
          ],
          "node_roles": [
            "master"
          ],
          "instance_overrides": {
            "capacity": 42,
            "storage_multiplier": 42.0
          }
        }
      ]
    },
    "external_links": [
      {
        "id": "string",
        "label": "string",
        "uri": "string"
      }
    ],
    "links": {
      "additionalProperty1": {
        "need_elevated_permissions": true
      },
      "additionalProperty2": {
        "need_elevated_permissions": true
      }
    },
    "settings": {
      "metadata": {
        "name": "string",
        "owner_id": "string",
        "organization_id": "string",
        "subscription_level": "string",
        "system_owned": true,
        "contact_email": "string",
        "hidden": true,
        "resources": {
          "cpu": {
            "boost": true,
            "hard_limit": true
          }
        }
      }
    },
    "region": "string"
  }
}
Response examples (404)
# Headers
x-cloud-error-codes: deployments.deployment_not_found

# Payload
{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}
Response examples (500)
# Headers
x-cloud-error-codes: deployments.deployment_resource_no_longer_exists

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




Get Deployment upgade assistant status

GET /deployments/{deployment_id}/upgrade_assistant/status

Get details about an Elasticsearch resource belonging to a given deployment.

Path parameters

Responses

  • The Upgrade Assistant returned the status successfully

    Hide response attributes Show response attributes object
    • ready_for_upgrade boolean Required

      A boolean indicating whether or not the cluster is ready to be upgraded

    • details string Required

      Message with information about the number of Elasticsearch and Kibana deprecations

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

    Hide headers attribute Show headers attribute
    • 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}/upgrade_assistant/status
curl \
 -X GET https://{{hostname}}/api/v1/deployments/{deployment_id}/upgrade_assistant/status
Response examples (200)
{
  "ready_for_upgrade": true,
  "details": "string"
}
Response examples (404)
# Headers
x-cloud-error-codes: deployments.deployment_not_found

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




























Set size overrides

PUT /deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/overrides

Applies size overrides for all of the instances belonging to the given resource. Instance size overrides will be reset with the next plan change.

Path parameters

  • deployment_id string Required

    Identifier for the Deployment.

  • resource_kind string Required

    The kind of resource. Only Elasticsearch resources are currently supported.

  • ref_id string Required

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

Query parameters

  • After overrides are set, restarts the instance to apply the changes.

    Default value is false.

Body Required

The overrides to apply to all instances. Capacity overrides the RAM size in MB of the instance, and storage multipler overrides the multiplier of the instance RAM size that determines the storage quota of the instance. Capacity must be in the range [1024, 65536] and storage multiplier must be in the range [1.0, 1000.0].

  • 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

Responses

  • The updated overrides

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

    • The deployment specified by {deployment_id} cannot be found. (code: deployments.deployment_not_found)
    • The Resource specified by {ref_id} cannot by found. (code: deployments.deployment_resource_not_found)
    • The specified override was out of range. Capacity must be in the range [1024, 65536] and storage multiplier must be in the range [1.0, 1000.0]. (code: instance_overrides.out_of_range)
    Hide headers attribute Show headers attribute
    • The error codes associated with the response

      Values are deployments.deployment_not_found, deployments.deployment_resource_not_found, or instance_overrides.out_of_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

PUT /deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/overrides
curl \
 -X PUT https://{{hostname}}/api/v1/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/overrides \
 -d '{"capacity":42,"storage_multiplier":42.0}'
Request examples
{
  "capacity": 42,
  "storage_multiplier": 42.0
}
Response examples (200)
{
  "capacity": 42,
  "storage_multiplier": 42.0
}
Response examples (404)
# Headers
x-cloud-error-codes: deployments.deployment_not_found

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








Start maintenance mode

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

Starts maintenance mode of 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

  • 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

  • The start maintenance 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

  • The start maintenance mode command was prohibited for the given Resource. (code: deployments.instance_update_prohibited_error)

    Hide headers attribute Show headers attribute
    • 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

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

  • A Resource that was previously stored no longer exists. (code: deployments.deployment_resource_no_longer_exists)

    Hide headers attribute Show headers attribute
    • 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/_start
curl \
 -X POST https://{{hostname}}/api/v1/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/{instance_ids}/maintenance-mode/_start
Response examples (202)
{
  "warnings": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}
Response examples (403)
# Headers
x-cloud-error-codes: deployments.instance_update_prohibited_error

# Payload
{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}
Response examples (404)
# Headers
x-cloud-error-codes: deployments.deployment_not_found

# Payload
{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}
Response examples (500)
# Headers
x-cloud-error-codes: deployments.deployment_resource_no_longer_exists

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








Capture a new on-demand heap dump for the given instance

POST /deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/{instance_id}/heap_dump/_capture

Captures a new on-demand heap dump for the given instance. The capture is completed asynchronously, and you can check its progress by getting heap dumps for the given resource.

Path parameters

  • deployment_id string Required

    Identifier for the Deployment.

  • resource_kind string Required

    The kind of resource (one of elasticsearch, kibana or apm).

  • ref_id string Required

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

  • instance_id string Required

    The instance identifier

Responses

  • Indicates that the capture has started

    Additional properties are allowed.

    • The Deployment specified by {deployment_id} cannot be found. (code: deployments.deployment_not_found)
    • The Resource specified by {ref_id} cannot be found. (code: deployments.deployment_resource_not_found)
    • The specified instance cannot be found. (code: deployments.instance_not_found_error)
    Hide headers attribute Show headers attribute
    • The error codes associated with the response

      Values are deployments.deployment_not_found, deployments.deployment_resource_not_found, or deployments.instance_not_found_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

POST /deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/{instance_id}/heap_dump/_capture
curl \
 -X POST https://{{hostname}}/api/v1/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/{instance_id}/heap_dump/_capture
Response examples (202)
{}
Response examples (404)
# Headers
x-cloud-error-codes: deployments.deployment_not_found

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




Capture a new thread dump for the given instance

POST /deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/{instance_id}/thread_dump/_capture

Captures a new thread dump for the given instance and returns the thread dump contents.

Path parameters

  • deployment_id string Required

    Identifier for the Deployment.

  • resource_kind string Required

    The kind of resource (one of elasticsearch, kibana or apm).

  • ref_id string Required

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

  • instance_id string Required

    The instance identifier

Responses

  • The thread dump contents

    • The Deployment specified by {deployment_id} cannot be found. (code: deployments.deployment_not_found)
    • The Resource specified by {ref_id} cannot be found. (code: deployments.deployment_resource_not_found)
    • The specified instance cannot be found. (code: deployments.instance_not_found_error)
    Hide headers attribute Show headers attribute
    • The error codes associated with the response

      Values are deployments.deployment_not_found, deployments.deployment_resource_not_found, or deployments.instance_not_found_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

POST /deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/{instance_id}/thread_dump/_capture
curl \
 -X POST https://{{hostname}}/api/v1/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/{instance_id}/thread_dump/_capture
Response examples (200)
string
Response examples (404)
# Headers
x-cloud-error-codes: deployments.deployment_not_found

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




















Proxy HTTP DELETE request

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

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

Headers

  • X-Management-Request string Required

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

Path parameters

  • deployment_id string Required

    Identifier for the Deployment

  • resource_kind string Required

    The kind of resource

    Values are elasticsearch, kibana, or enterprise_search.

  • ref_id string Required

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

  • proxy_path string Required

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

Body

The JSON payload to proxy to the deployment resource.

string string

Responses

  • The request has been processed successfully through the proxy.

    Hide response attribute Show response attribute object
    • The Deployment specified by {deployment_id} cannot be found. (code: deployments.deployment_not_found)
    • The Resource specified by {ref_id} cannot be found. (code: deployments.deployment_resource_not_found)
    • The Resource specified by {ref_id} cannot be found. (code: clusters.cluster_not_found)
    Hide headers attribute Show headers attribute
    • The error codes associated with the response

      Values are deployments.deployment_not_found, deployments.deployment_resource_not_found, or clusters.cluster_not_found.

    Hide response attribute Show response attribute object
    • errors array[object] Required

      A list of errors that occurred in the failing request

      Hide errors attributes Show errors attributes object
      • code string Required

        A structured code representing the error type that occurred

      • message string Required

        A human readable message describing the error that occurred

      • fields array[string]

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

DELETE /deployments/{deployment_id}/{resource_kind}/{ref_id}/proxy/{proxy_path}
curl \
 -X DELETE https://{{hostname}}/api/v1/deployments/{deployment_id}/{resource_kind}/{ref_id}/proxy/{proxy_path} \
 -H "X-Management-Request: string" \
 -d '"string"'
Request examples
# Headers
X-Management-Request: string

# Payload
string
Response examples (200)
{
  "value": "string"
}
Response examples (404)
# Headers
x-cloud-error-codes: deployments.deployment_not_found

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





































Delete Extension

DELETE /deployments/extensions/{extension_id}

Deletes a Extension.

Path parameters

Responses

  • Extension deleted successfully.

    Hide headers attributes Show headers attributes

    Additional properties are allowed.

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

  • The extension requested does not exist. (code: extensions.not_found)

    Hide headers attribute Show headers attribute
    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

  • The version you sent does not match the persisted version. (code: extensions.version_conflict)

    Hide headers attribute Show headers attribute
    • 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

DELETE /deployments/extensions/{extension_id}
curl \
 -X DELETE https://{{hostname}}/api/v1/deployments/extensions/{extension_id}
Response examples (200)
# Headers
x-cloud-resource-version: string
x-cloud-resource-created: string
x-cloud-resource-last-modified: string

# Payload
{}
Response examples (401)
# Headers
x-cloud-error-codes: extensions.unauthorised

# Payload
{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}
Response examples (404)
# Headers
x-cloud-error-codes: extensions.not_found

# Payload
{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}
Response examples (409)
# Headers
x-cloud-error-codes: extensions.version_conflict

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

Get deployment templates

GET /deployments/templates

Retrieves all deployment templates.

Query parameters

  • metadata string

    An optional key/value pair in the form of (key:value) that will act as a filter and exclude any templates that do not have a matching metadata item associated.

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

    Default value is true.

  • If true, will populate the max_zones field in the instance configurations. Only relevant if show_instance_configurations=true.

    Default value is false.

  • If present, it will cause the returned deployment templates to be adapted to return only the elements allowed in that version.

  • If true, templates flagged as hidden will be returned.

    Default value is false.

  • region string Required

    Region of the deployment templates

Responses

  • The deployment templates were returned successfully.

    Hide response attributes Show response attributes object
    • id string Required

      The unique identifier for the template.

    • name string Required

      A human readable name for the template.

    • An optional description for the template.

    • deployment_template object Required

      A request for creating a new Deployment consisting of multiple clusters

      Additional properties are allowed.

      Hide deployment_template attributes Show deployment_template attributes object
      • name string

        A name for the deployment; otherwise this will be the generated deployment id

      • The Resources that will belong to this Deployment

        Additional properties are allowed.

        Hide resources attributes Show resources attributes object
        • elasticsearch array[object]

          A list of payloads for Elasticsearch cluster creation.

          Hide elasticsearch attributes Show elasticsearch attributes object
          • ref_id string Required

            A locally-unique user-specified id for this Elasticsearch cluster

          • 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 building this Elasticsearch cluster

            Additional properties are allowed.

            Hide plan attributes Show plan attributes object
            • cluster_topology array[object] Required
              Hide cluster_topology attributes Show cluster_topology attributes object
              • id string

                Unique identifier of this topology element

              • Controls the combinations of Elasticsearch node types. TIP: By default, the Elasticsearch node is master eligible, can hold data, and run ingest pipelines. WARNING: Do not set for tiebreaker topologies.

                Additional properties are allowed.

                Hide node_type attributes Show node_type attributes object
                • master boolean

                  Defines whether this node can be elected master (default: false)

                • data boolean

                  Defines whether this node can hold data (default: false)

                • ingest boolean

                  Defines whether this node can run an ingest pipeline (default: false)

                • ml boolean

                  Defines whether this node can run ml jobs, valid only for versions 5.4.0 or greater (default: false)

              • node_roles array[string]

                The list of node roles for this topology element (ES version >= 7.10). Allowable values are: master, ingest, ml, data_hot, data_content, data_warm, data_cold, data_frozen, remote_cluster_client, transform

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

              • memory_per_node integer(int32)

                The memory capacity in MB for each node of this type built in each zone.

              • node_count_per_zone integer(int32)

                The number of nodes of this type that are allocated within each zone. (i.e. total capacity per zone = node_count_per_zone * memory_per_node in MB). Cannot be set for tiebreaker topologies. For dedicated master nodes, must be 1 if an entry exists.

              • zone_count integer(int32)

                The default number of zones in which data nodes will be placed

              • The Elasticsearch cluster settings. When specified at the top level, provides a field-by-field default. When specified at the topology level, provides the override settings.

                Additional properties are allowed.

                Hide elasticsearch attributes Show elasticsearch attributes object
                • version string

                  The version of the Elasticsearch cluster (must be one of the ECE supported versions). Currently cannot be different across the topology (and is generally specified in the globals). Defaults to the latest version if not specified.

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

                • A subset of Elasticsearch settings. TIP: To define the complete set of Elasticsearch settings, use ElasticsearchSystemSettings with user_settings_override* and user_settings*.

                  Additional properties are allowed.

                  Hide system_settings attributes Show system_settings attributes object
                  • Controls the languages supported by the Elasticsearch cluster, such as Painless, Mustache, and Expressions. Controls how the languages are used, such as file, index, and inline. TIP: For complex configurations, leave these blank and configure these settings in the user YAML or JSON.

                    Additional properties are allowed.

                    Hide scripting attributes Show scripting attributes object
                    • (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]')

                    • (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]')

                    • (5.x+ only) If enabled (the default) then the expressions scripting engine is allowed as a sandboxed language. Sandboxed languages are the only ones allowed if 'sandbox_mode' is set to true. NOTES: (Corresponds to the parameters 'script.engine.expression.[file|stored|inline]')

                    • stored object

                      Enables scripting for the specified type and controls other parameters. Store scripts in indexes (stored), upload in file bundles (file), or use in API requests (inline).

                      Additional properties are allowed.

                      Hide stored attributes Show stored attributes object
                      • enabled boolean

                        If enabled (default: true) then scripts are enabled, either for sandboxing languages (by default), or for all installed languages if 'sandbox_mode' is disabled (or for 6.x). NOTES: (Corresponds to the parameter 'script.file|stored/indexed|inline')

                      • If enabled (default: true) and this script type is enabled, then only the sandbox languages are allowed. By default the sandbox languages are painless, expressions and mustache, but this can be restricted via the 'painless_enabled', 'mustache_enabled' 'expression_enabled' settings.NOTES: Not supported in 6.x. (Corresponds to the parameters 'script.engine.[painless|mustache|expressions].[file|stored|inline]')

                    • file object

                      Enables scripting for the specified type and controls other parameters. Store scripts in indexes (stored), upload in file bundles (file), or use in API requests (inline).

                      Additional properties are allowed.

                      Hide file attributes Show file attributes object
                      • enabled boolean

                        If enabled (default: true) then scripts are enabled, either for sandboxing languages (by default), or for all installed languages if 'sandbox_mode' is disabled (or for 6.x). NOTES: (Corresponds to the parameter 'script.file|stored/indexed|inline')

                      • If enabled (default: true) and this script type is enabled, then only the sandbox languages are allowed. By default the sandbox languages are painless, expressions and mustache, but this can be restricted via the 'painless_enabled', 'mustache_enabled' 'expression_enabled' settings.NOTES: Not supported in 6.x. (Corresponds to the parameters 'script.engine.[painless|mustache|expressions].[file|stored|inline]')

                    • inline object

                      Enables scripting for the specified type and controls other parameters. Store scripts in indexes (stored), upload in file bundles (file), or use in API requests (inline).

                      Additional properties are allowed.

                      Hide inline attributes Show inline attributes object
                      • enabled boolean

                        If enabled (default: true) then scripts are enabled, either for sandboxing languages (by default), or for all installed languages if 'sandbox_mode' is disabled (or for 6.x). NOTES: (Corresponds to the parameter 'script.file|stored/indexed|inline')

                      • 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

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

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

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

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

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

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

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

                • An arbitrary JSON object allowing cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters arey are on the allowlist and not on the denylist. NOTES: (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Elasticsearch settings)

                  Additional properties are allowed.

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

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

                  Additional properties are allowed.

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

                • A list of plugin names from the Elastic-supported subset that are bundled with the version images. NOTES: (Users should consult the Elastic stack objects to see what plugins are available, this is currently only available from the UI)

                • user_plugins array[object]

                  A list of admin-uploaded plugin objects that are available for this user.

                  Hide user_plugins attributes Show user_plugins attributes object
                  • name string Required

                    The name of the plugin

                  • url string Required

                    The URL of the plugin (must be accessible from the ECE infrastructure)

                  • elasticsearch_version string Required

                    The supported Elasticsearch version (must match the version in the plan)

                • user_bundles array[object]

                  A list of admin-uploaded bundle objects (eg scripts, synonym files) that are available for this user.

                  Hide user_bundles attributes Show user_bundles attributes object
                  • name string Required

                    The name of the bundle

                  • url string Required

                    The URL of the bundle, which must be accessible from the ECE infrastructure. This URL could be cached by platform, make sure to change it when updating the bundle

                  • elasticsearch_version string Required

                    The supported Elasticsearch version (must match the version in the plan)

                • curation object

                  Defines the index curation routing for the cluster

                  Additional properties are allowed.

                  Hide curation attributes Show curation attributes object
                • Defines the Elasticsearch node attributes for the instances in the topology

                  Hide node_attributes attribute Show node_attributes attribute object
                  • * string Additional properties
              • 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.

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

              • size object

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

                Additional properties are allowed.

                Hide size attributes Show size attributes object
                • value integer(int32) Required

                  Amount of resource

                • resource string Required

                  Type of resource

                  Values are memory or storage.

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

                Additional properties are allowed.

                Hide autoscaling_min attributes Show autoscaling_min attributes object
                • value integer(int32) Required

                  Amount of resource

                • resource string Required

                  Type of resource

                  Values are memory or storage.

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

                Additional properties are allowed.

                Hide autoscaling_max attributes Show autoscaling_max attributes object
                • value integer(int32) Required

                  Amount of resource

                • resource string Required

                  Type of resource

                  Values are memory or storage.

              • An arbitrary JSON object overriding the default autoscaling policy. Don't set unless you really know what you are doing.

                Additional properties are allowed.

              • Controls for the topology element. Only used as part of the deployment template. Ignored if included as part of a deployment.

                Additional properties are allowed.

                Hide topology_element_control attribute Show topology_element_control attribute object
                • min object Required

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

                  Additional properties are allowed.

                  Hide min attributes Show min attributes object
                  • value integer(int32) Required

                    Amount of resource

                  • resource string Required

                    Type of resource

                    Values are memory or storage.

              • Set to true to enable autoscaling for this topology element, even if the cluster-level 'autoscaling_enabled' field is false. Note that 'autoscaling_tier_override' cannot be set to false if cluster-level 'autoscaling_enabled' is true. Currently only supported for the 'ml' tier

            • elasticsearch object Required

              The Elasticsearch cluster settings. When specified at the top level, provides a field-by-field default. When specified at the topology level, provides the override settings.

              Additional properties are allowed.

              Hide elasticsearch attributes Show elasticsearch attributes object
              • version string

                The version of the Elasticsearch cluster (must be one of the ECE supported versions). Currently cannot be different across the topology (and is generally specified in the globals). Defaults to the latest version if not specified.

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

              • A subset of Elasticsearch settings. TIP: To define the complete set of Elasticsearch settings, use ElasticsearchSystemSettings with user_settings_override* and user_settings*.

                Additional properties are allowed.

                Hide system_settings attributes Show system_settings attributes object
                • Controls the languages supported by the Elasticsearch cluster, such as Painless, Mustache, and Expressions. Controls how the languages are used, such as file, index, and inline. TIP: For complex configurations, leave these blank and configure these settings in the user YAML or JSON.

                  Additional properties are allowed.

                  Hide scripting attributes Show scripting attributes object
                  • (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]')

                  • (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]')

                  • (5.x+ only) If enabled (the default) then the expressions scripting engine is allowed as a sandboxed language. Sandboxed languages are the only ones allowed if 'sandbox_mode' is set to true. NOTES: (Corresponds to the parameters 'script.engine.expression.[file|stored|inline]')

                  • stored object

                    Enables scripting for the specified type and controls other parameters. Store scripts in indexes (stored), upload in file bundles (file), or use in API requests (inline).

                    Additional properties are allowed.

                    Hide stored attributes Show stored attributes object
                    • enabled boolean

                      If enabled (default: true) then scripts are enabled, either for sandboxing languages (by default), or for all installed languages if 'sandbox_mode' is disabled (or for 6.x). NOTES: (Corresponds to the parameter 'script.file|stored/indexed|inline')

                    • If enabled (default: true) and this script type is enabled, then only the sandbox languages are allowed. By default the sandbox languages are painless, expressions and mustache, but this can be restricted via the 'painless_enabled', 'mustache_enabled' 'expression_enabled' settings.NOTES: Not supported in 6.x. (Corresponds to the parameters 'script.engine.[painless|mustache|expressions].[file|stored|inline]')

                  • file object

                    Enables scripting for the specified type and controls other parameters. Store scripts in indexes (stored), upload in file bundles (file), or use in API requests (inline).

                    Additional properties are allowed.

                    Hide file attributes Show file attributes object
                    • enabled boolean

                      If enabled (default: true) then scripts are enabled, either for sandboxing languages (by default), or for all installed languages if 'sandbox_mode' is disabled (or for 6.x). NOTES: (Corresponds to the parameter 'script.file|stored/indexed|inline')

                    • If enabled (default: true) and this script type is enabled, then only the sandbox languages are allowed. By default the sandbox languages are painless, expressions and mustache, but this can be restricted via the 'painless_enabled', 'mustache_enabled' 'expression_enabled' settings.NOTES: Not supported in 6.x. (Corresponds to the parameters 'script.engine.[painless|mustache|expressions].[file|stored|inline]')

                  • inline object

                    Enables scripting for the specified type and controls other parameters. Store scripts in indexes (stored), upload in file bundles (file), or use in API requests (inline).

                    Additional properties are allowed.

                    Hide inline attributes Show inline attributes object
                    • enabled boolean

                      If enabled (default: true) then scripts are enabled, either for sandboxing languages (by default), or for all installed languages if 'sandbox_mode' is disabled (or for 6.x). NOTES: (Corresponds to the parameter 'script.file|stored/indexed|inline')

                    • 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

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

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

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

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

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

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

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

              • An arbitrary JSON object allowing cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters arey are on the allowlist and not on the denylist. NOTES: (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Elasticsearch settings)

                Additional properties are allowed.

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

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

                Additional properties are allowed.

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

              • A list of plugin names from the Elastic-supported subset that are bundled with the version images. NOTES: (Users should consult the Elastic stack objects to see what plugins are available, this is currently only available from the UI)

              • user_plugins array[object]

                A list of admin-uploaded plugin objects that are available for this user.

                Hide user_plugins attributes Show user_plugins attributes object
                • name string Required

                  The name of the plugin

                • url string Required

                  The URL of the plugin (must be accessible from the ECE infrastructure)

                • elasticsearch_version string Required

                  The supported Elasticsearch version (must match the version in the plan)

              • user_bundles array[object]

                A list of admin-uploaded bundle objects (eg scripts, synonym files) that are available for this user.

                Hide user_bundles attributes Show user_bundles attributes object
                • name string Required

                  The name of the bundle

                • url string Required

                  The URL of the bundle, which must be accessible from the ECE infrastructure. This URL could be cached by platform, make sure to change it when updating the bundle

                • elasticsearch_version string Required

                  The supported Elasticsearch version (must match the version in the plan)

              • curation object

                Defines the index curation routing for the cluster

                Additional properties are allowed.

                Hide curation attributes Show curation attributes object
              • Defines the Elasticsearch node attributes for the instances in the topology

                Hide node_attributes attribute Show node_attributes attribute object
                • * string Additional properties
            • Documents which deployment template was used in the creation of this plan

              Additional properties are allowed.

              Hide deployment_template attributes Show deployment_template attributes object
              • id string Required

                The unique identifier of the deployment template

              • version string

                A version identifier to disambiguate multiple revisions of the same template

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

              Additional properties are allowed.

              Hide transient attributes Show transient attributes object
              • strategy object

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

                Additional properties are allowed.

                Hide strategy attributes Show strategy attributes object
                • rolling object

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

                  Additional properties are allowed.

                  Hide rolling attributes Show rolling attributes object
                  • group_by string

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

                  • 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

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

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

                  Additional properties are allowed.

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

                  Additional properties are allowed.

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

                  Additional properties are allowed.

              • The configuration settings for the timeout and fallback parameters.

                Additional properties are allowed.

                Hide plan_configuration attributes Show plan_configuration attributes object
                • timeout integer(int64)

                  The total timeout in seconds after which the plan is cancelled even if it is not complete. Defaults to 4x the max memory capacity per node (in MB). NOTES: A 3 zone cluster with 2 nodes of 2048 each would have a timeout of 4*2048=8192 seconds. Timeout does not include time required to run rollback actions.

                • calm_wait_time integer(int64)

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

                • move_instances array[object]
                  Hide move_instances attributes Show move_instances attributes object
                  • from string Required

                    The instance id that is going to be moved

                  • to array[string]

                    An optional list of allocator ids to which the instance should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)

                  • Tells the infrastructure that the instance should be considered as permanently down when deciding how to migrate data to new nodes. If left blank then the system will automatically decide (currently: will treat the instances as up)

                • move_allocators array[object]
                  Hide move_allocators attributes Show move_allocators attributes object
                  • from string Required

                    The allocator id off which all instances in the cluster should be moved

                  • to array[string]

                    An optional list of allocator ids to which the instance(s) should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)

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

                • move_only boolean

                  If true (default: false) only move_instances and move_allocators instructions will be executed, all other changes will be ignored

                • If true (default: false) does not allow re-using any existing instances currently in the cluster, ie even unchanged instances will be re-created

                • List of allocators on which instances are placed if possible (if not possible/not specified then any available allocator with space is used)

                • Map containing allocators tags in form of key value pairs, increasing the likelihood during move requests for allocators with matching tags, to be selected as target allocators

                  Hide preferred_allocator_tags attribute Show preferred_allocator_tags attribute object
                  • * string Additional properties
                • If true (default: false), does not take (or require) a successful snapshot to be taken before performing any potentially destructive changes to this cluster

                • 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

                • 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

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

                • If false (the default) then the plan will fail out if it believes the requested sequence of operations can result in data loss - this flag will override some of these restraints

                • If true (default: false) then the plan will not wait for data to be migrated from old instances to new instances before continuing the plan (potentially deleting the old instances and losing data)

                • If false, the cluster is checked for issues that should be resolved before migration (eg contains old Lucene segments), if true this is bypassed

                • If false (the default), the cluster will run (currently) 2.x->5.x operations for any plan change ending with a 5.x cluster (eg apply a cluster license, ensure Monitoring is configured)

                • If false (the default), the cluster will perform a snapshot after a major version upgrade takes place

              • Restores a snapshot from a local or remote repository.

                Additional properties are allowed.

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

                • Raw remote snapshot restore settings. Do not send this if you are sending source_cluster_id

                  Additional properties are allowed.

                  Hide repository_config attribute Show repository_config attribute object
                  • The remote snapshot settings raw JSON - see the Elasticsearch '_snapshot' documentation for more details on supported formats

                    Additional properties are allowed.

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

                  Additional properties are allowed.

                  Hide restore_payload attributes Show restore_payload attributes object
                  • indices array[string]

                    The list of indices to restore (supports +ve and -ve selection and wildcarding - see the default Elasticsearch index format documentation)

                  • This JSON object (merged with the 'indices' field (if present) is passed untouched into the restore command - see the Elasticsearch '_snapshot' documentation for more details on supported formats

                    Additional properties are allowed.

                • strategy string

                  The restore strategy to use. Defaults to a full restore. Partial restore will attempt to restore unavailable indices only

                  Values are partial, full, or recovery.

                • If specified, contains the name of the source cluster id. Do not send this if you are sending repository_config

              • The list of resources that will be configured as remote clusters

                Additional properties are allowed.

                Hide remote_clusters attribute Show remote_clusters attribute object
                • resources array[object] Required

                  The remote resources

                  Hide resources attributes Show resources attributes object
                  • deployment_id string Required

                    The id of the deployment

                  • elasticsearch_ref_id string Required

                    The locally-unique user-specified id of an Elasticsearch Resource

                  • alias string Required

                    The alias for this remote cluster. Aliases must only contain letters, digits, dashes and underscores

                  • If true, skip this cluster during search if it is disconnected. Default: false

                  • info object

                    Information about a Remote Cluster.

                    Additional properties are allowed.

                    Hide info attributes Show info attributes object
                    • healthy boolean Required

                      Whether or not the remote cluster is healthy

                    • connected boolean Required

                      Whether or not there is at least one connection to the remote cluster.

                    • compatible boolean Required

                      Whether or not the remote cluster version is compatible with this cluster version.

                    • trusted boolean Required

                      Whether or not the remote cluster is trusted by this cluster.

                    • trusted_back boolean Required

                      Whether or not the remote cluster trusts this cluster back.

              • If specified, contains transient settings to be applied to an Elasticsearch cluster during changes,default values shown below applied. These can be overridden by specifying them in the map (or null to unset). Additional settings can also be set. Settings will be cleared after the plan has finished. If not specified, no settings will be applied. NOTE: These settings are only explicitly cleared for 5.x+ clusters, they must be hand-reset to their defaults in 2.x- (or a cluster reboot will clear them).

                • indices.store.throttle.max_bytes_per_sec: 120Mb
                • indices.recovery.max_bytes_per_sec: 120Mb
                • cluster.routing.allocation.cluster_concurrent_rebalance: 5
                • cluster.routing.allocation.node_initial_primaries_recoveries: 5
                • cluster.routing.allocation.node_concurrent_incoming_recoveries: 5 For version 8.1 and later no defaults are provided through this mechanism, but instead hardware dependent settings are provided to each instance.

                Additional properties are allowed.

            • Enable autoscaling for this Elasticsearch cluster.

          • settings object

            The settings for building this Elasticsearch cluster

            Additional properties are allowed.

            Hide settings attributes Show settings attributes object
            • snapshot object

              The snapshot settings for this deployment. When provided, snapshot settings are changed as specified. A null value reverts the field to the default value. Otherwise, all snapshot settings remain as they were set previously.

              Additional properties are allowed.

              Hide snapshot attributes Show snapshot attributes object
              • Snapshot repository configuration

                Additional properties are allowed.

                Hide repository attributes Show repository attributes object
                • static object

                  Cluster snapshot static repository settings, containing repository type and settings

                  Additional properties are allowed.

                  Hide static attributes Show static attributes object
                  • Type of snapshot repository, ie: S3

                  • settings object

                    Settings associated with snapshot repository

                    Additional properties are allowed.

                • Cluster snapshot reference repository settings, containing the repository name in ECE fashion

                  Additional properties are allowed.

                  Hide reference attribute Show reference attribute object
                  • ECE snapshot repository name, from the '/platform/configuration/snapshots/repositories' endpoint

                • default object

                  Cluster snapshot default repository settings

                  Additional properties are allowed.

              • 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

              • Interval between snapshot progress checks, with the format 'length unit' (space is optional), where unit can be one of: d (day), h (hour), min (minute). Default is 1 minute

              • The time to wait between snapshot phases (snapshot, purge), with the format 'length unit' (space is optional), where unit can be one of: d (day), h (hour), min (minute). Default is 10 minutes

              • enabled boolean

                Indicates if Snapshotting is enabled

              • suspended array[string]

                List of temporary snapshot suspensions

              • Cluster snapshot retention information

                Additional properties are allowed.

                Hide retention attributes Show retention attributes object
                • snapshots integer(int32)

                  Number of snapshots to retain

                • max_age string

                  Total retention period for all snapshots, with the format 'length unit' (space is optional), where unit can be one of: d (day), h (hour), min (minute)

              • slm boolean

                When set to true, the deployment will have SLM enabled. Default value is true.

              • Cron expression indicating when should snapshots be taken. This can be enabled only if SLM is enabled for the deployment and 'interval' is not present

            • The monitoring settings for this deployment. When provided, monitoring settings are changed as specified. A null value reverts the field to the default value. Otherwise, all monitoring settings remain as they were set previously.

              Additional properties are allowed.

              Hide monitoring attribute Show monitoring attribute object
              • target_cluster_id string Required

                The Id of the target cluster to which to send monitoring information

            • metadata object

              The top-level configuration settings for the Elasticsearch cluster.

              Additional properties are allowed.

              Hide metadata attributes Show metadata attributes object
              • name string

                The display name of the cluster

              • owner_id string

                The user id (referencing whatever user database is in use) of the cluster owner

              • The organization that owns the deployment

              • Subscription level of the cluster

              • Indicates if a cluster is system owned (restricts the set of operations that can be performed on it)

              • Contact email for the cluster

              • hidden boolean

                Whether or not this cluster is hidden from the normal clusters list

              • The top-level configuration settings for the Elasticsearch cluster resources.

                Additional properties are allowed.

                Hide resources attribute Show resources attribute object
                • cpu object

                  Specifies the CPU resource settings for the Elasticsearch cluster.

                  Additional properties are allowed.

                  Hide cpu attributes Show cpu attributes object
                  • boost boolean

                    Indicates if the CPU boost flag is enabled or not.

                  • hard_limit boolean

                    Indicates if the CPU hard limit flag is enabled or not. When set to true (default), allocates CPU timeshare based on the total CPU time multiplied by the relative RAM capacity of the instance on a given host. When set to false, delegates CPU allocation to the operating system to schedule CPU timeshares.

            • curation object

              The curation settings for this deployment. When provided, curation settings are changed as specified. A null value reverts the field to the default value. Otherwise, all curation settings remain as they were set previously.

              Additional properties are allowed.

              Hide curation attribute Show curation attribute object
              • specs array[object] Required

                Specifications for curation

                Hide specs attributes Show specs attributes object
            • 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.

            • The rulesets to apply to all resources in this cluster. When specified, the set of rulesets is updated and the same rulesets will be applied to Kibana and APM clusters as well. If not specified, the rulesets remain as they were set previously.

              Additional properties are allowed.

              Hide traffic_filter attribute Show traffic_filter attribute object
              • rulesets array[string] Required

                IDs of the traffic filter rulesets

            • trust object

              Configuration of trust with other clusters. When provided, trust settings are changed as specified. A null value reverts the field to the default value. Otherwise, all trust settings remain as they were set previously.

              Additional properties are allowed.

              Hide trust attributes Show trust attributes object
              • accounts array[object]

                The list of trust relationships with different accounts

                Hide accounts attributes Show accounts attributes object
                • account_id string Required

                  the ID of the Account

                • name string

                  A human readable name of the trust relationship

                • trust_all boolean Required

                  If true, all clusters in this account will by default be trusted and the trust_allowlist is ignored.

                • trust_allowlist array[string]

                  The list of clusters to trust. Only used when trust_all is false.

              • external array[object]

                The list of trust relationships with external entities

                Hide external attributes Show external attributes object
                • trust_relationship_id string Required

                  The ID of the external trust relationship

                • name string

                  The name of the external trust relationship. Retrieved from the TrustRelationship and ignored on write.

                • trust_all boolean Required

                  If true, all clusters in this external entity will be trusted and the trust_allowlist is ignored.

                • trust_allowlist array[string]

                  The list of clusters to trust. Only used when trust_all is false.

              • direct array[object]

                The list of trust relationships where the certificate is bundled with the trust setting. Allows configuring trust for clusters running outside of an Elastic Cloud managed environment or in an Elastic Cloud environment without an environment level trust established.

                Hide direct attributes Show direct attributes object
                • uid string

                  Auto generated identifier for this trust, allows distinguishing between update vs remove and add.

                • name string Required

                  a human readable name of the trust relationship

                • type string

                  The type can either be ESS, ECE, generic or proxy. If none is specified, then generic is assumed. If proxy is specified, trust_all should be false and trust_allowlist, scope_id and additional_node_names should be omitted.

                  Values are ECE, ESS, generic, or proxy.

                • trust_all boolean Required

                  If true, scope_id is required and the trust_allowlist is ignored and all clusters matching the scope id will be trusted.

                • trust_allowlist array[string]

                  The list of clusters with matching scope to trust. Only used when trust_all is false. Providing one or more clusters makes scope_id mandatory.

                • scope_id string

                  A lowercase alphanumerical string of max 32 characters. Usually an organization id or an environment id, but could really be any suitable suffix for clusters using the CA certificate of this trust. Required unless trust_all is false and trust_allowlist is empty.

                • A list of node names trusted in addition to those deducible from trust_allowlist and scope id. Allows trusting nodes that don't have a scoped name at the cost of maintaining the list. Mandatory if scope id is not defined. Wildcards are not allowed.

                • certificates array[object] Required

                  The public ca certificate(s) to trust. Only one is required, but it is possible to specify multiple certificates in order to facilitate key rotation.

                  Hide certificates attributes Show certificates attributes object
                  • pem string Required

                    The public ca certificate as string in PEM format.

                  • metadata object

                    Metadata about the certificate, including fingerprint and expiry date. Generated by the Cloud service and ignored on write.

                    Additional properties are allowed.

                    Hide metadata attributes Show metadata attributes object
                    • fingerprint string Required

                      The fingerprint of the certificate

                    • valid_to string(date-time) Required

                      The expiry date of the certificate in UTC

                    • valid_from string(date-time) Required

                      The valid from date of the certificate in UTC

                    • also_trusted_by array[string]

                      Other deployments also trusting this certificate

            • The contents of the Elasticsearch keystore. It's a write only field.

              Additional properties are allowed.

              Hide keystore_contents attribute Show keystore_contents attribute object
              • secrets object Required

                List of secrets

                Hide secrets attribute Show secrets attribute object
                • * object Additional properties

                  The value that you configure for the Elasticsearch keystore secret.

                  Additional properties are allowed.

                  Hide * attributes Show * attributes object
                  • value object

                    Value of this setting. This can either be a string or a JSON object that is stored as a JSON string in the keystore. NOTE: When the keystore secret is unspecified, it is removed.

                    Additional properties are allowed.

                  • as_file boolean

                    Stores the keystore secret as a file. The default is false, which stores the keystore secret as string when value is a plain string, or true when value is an object.

        • kibana array[object]

          A list of payloads for Kibana creation.

          Hide kibana attributes Show kibana attributes object
          • ref_id string Required

            A locally-unique user-specified id for Kibana

          • Alias to the Elasticsearch Cluster to attach Kibana to

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

            Additional properties are allowed.

            Hide plan attributes Show plan attributes object
            • cluster_topology array[object]
              Hide cluster_topology attributes Show cluster_topology attributes object
              • memory_per_node integer(int32)

                The memory capacity in MB for each node of this type built in each zone.

              • node_count_per_zone integer(int32)

                The number of nodes of this type that are allocated within each zone (i.e. total capacity per zone = node_count_per_zone * memory_per_node in MB).

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

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

              • size object

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

                Additional properties are allowed.

                Hide size attributes Show size attributes object
                • value integer(int32) Required

                  Amount of resource

                • resource string Required

                  Type of resource

                  Values are memory or storage.

              • zone_count integer(int32)

                number of zones in which nodes will be placed

              • kibana object

                The Kibana instance settings. When specified at the top level, provides a field-by-field default. When specified at the topology level, provides the override settings.

                Additional properties are allowed.

                Hide kibana attributes Show kibana attributes object
                • version string

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

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

                • A subset of Kibana settings. TIP: To define the complete set of Elasticsearch settings, use KibanaSystemSettings with user_settings_override_ and user_settings_.

                  Additional properties are allowed.

                  Hide system_settings attributes Show system_settings attributes object
                  • DEPRECATED: Scheduled for removal in a future version of the API.

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

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

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

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

                  Additional properties are allowed.

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

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

                  Additional properties are allowed.

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

            • kibana object Required

              The Kibana instance settings. When specified at the top level, provides a field-by-field default. When specified at the topology level, provides the override settings.

              Additional properties are allowed.

              Hide kibana attributes Show kibana attributes object
              • version string

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

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

              • A subset of Kibana settings. TIP: To define the complete set of Elasticsearch settings, use KibanaSystemSettings with user_settings_override_ and user_settings_.

                Additional properties are allowed.

                Hide system_settings attributes Show system_settings attributes object
                • DEPRECATED: Scheduled for removal in a future version of the API.

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

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

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

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

                Additional properties are allowed.

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

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

                Additional properties are allowed.

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

            • Defines the configuration parameters that control how the plan is applied. For example, the Elasticsearch cluster topology and Kibana instance settings.

              Additional properties are allowed.

              Hide transient attributes Show transient attributes object
              • strategy object

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

                Additional properties are allowed.

                Hide strategy attributes Show strategy attributes object
                • rolling object

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

                  Additional properties are allowed.

                  Hide rolling attributes Show rolling attributes object
                  • group_by string

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

                  • 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

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

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

                  Additional properties are allowed.

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

                  Additional properties are allowed.

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

                  Additional properties are allowed.

              • The configuration settings for the timeout and fallback parameters.

                Additional properties are allowed.

                Hide plan_configuration attributes Show plan_configuration attributes object
                • timeout integer(int64)

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

                • calm_wait_time integer(int64)

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

                • move_instances array[object]
                  Hide move_instances attributes Show move_instances attributes object
                  • from string Required

                    The instance id that is going to be moved

                  • to array[string]

                    An optional list of allocator ids to which the instance should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)

                  • Tells the infrastructure that the instance should be considered as permanently down when deciding how to migrate data to new nodes. If left blank then the system will automatically decide (currently: will treat the instances as up)

                • move_allocators array[object]
                  Hide move_allocators attributes Show move_allocators attributes object
                  • from string Required

                    The allocator id off which all instances in the cluster should be moved

                  • to array[string]

                    An optional list of allocator ids to which the instance(s) should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)

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

                • If true (default: false) does not allow re-using any existing instances currently in the cluster, ie even unchanged instances will be re-created

                • List of allocators on which instances are placed if possible (if not possible/not specified then any available allocator with space is used)

                • Map containing allocators tags in form of key value pairs, increasing the likelihood during move requests for allocators with matching tags, to be selected as target allocators

                  Hide preferred_allocator_tags attribute Show preferred_allocator_tags attribute object
                  • * string Additional properties
                • 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

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

                  Value is forced.

                • If false (the default), the plan fails if it determines that the request can result in unsafe operations. Setting this flag overrides some of these check restraints.

          • settings object

            The settings for building this Kibana cluster

            Additional properties are allowed.

            Hide settings attribute Show settings attribute object
            • metadata object

              The top-level configuration settings for the Elasticsearch cluster.

              Additional properties are allowed.

              Hide metadata attributes Show metadata attributes object
              • name string

                The display name of the cluster

              • owner_id string

                The user id (referencing whatever user database is in use) of the cluster owner

              • The organization that owns the deployment

              • Subscription level of the cluster

              • Indicates if a cluster is system owned (restricts the set of operations that can be performed on it)

              • Contact email for the cluster

              • hidden boolean

                Whether or not this cluster is hidden from the normal clusters list

              • The top-level configuration settings for the Elasticsearch cluster resources.

                Additional properties are allowed.

                Hide resources attribute Show resources attribute object
                • cpu object

                  Specifies the CPU resource settings for the Elasticsearch cluster.

                  Additional properties are allowed.

                  Hide cpu attributes Show cpu attributes object
                  • boost boolean

                    Indicates if the CPU boost flag is enabled or not.

                  • hard_limit boolean

                    Indicates if the CPU hard limit flag is enabled or not. When set to true (default), allocates CPU timeshare based on the total CPU time multiplied by the relative RAM capacity of the instance on a given host. When set to false, delegates CPU allocation to the operating system to schedule CPU timeshares.

        • apm array[object]

          A list of payloads for APM creation. WARNING: For stack versions 8.0.0 and higher the integrations_server payload should be used instead, as this field becomes deprecated.

          Hide apm attributes Show apm attributes object
          • ref_id string Required

            A locally-unique user-specified id for APM

          • Alias to the Elasticsearch Cluster to attach APM to

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

            Additional properties are allowed.

            Hide plan attributes Show plan attributes object
            • cluster_topology array[object]
              Hide cluster_topology attributes Show cluster_topology attributes object
              • 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.

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

              • size object

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

                Additional properties are allowed.

                Hide size attributes Show size attributes object
                • value integer(int32) Required

                  Amount of resource

                • resource string Required

                  Type of resource

                  Values are memory or storage.

              • zone_count integer(int32)

                number of zones in which nodes will be placed

              • apm object

                The configuration options for the APM Server.

                Additional properties are allowed.

                Hide apm attributes Show apm attributes object
                • version string

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

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

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

                  Additional properties are allowed.

                  Hide system_settings attributes Show system_settings attributes object
                  • DEPRECATED: Scheduled for removal in a future version of the API.

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

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

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

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

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

                  • Optionally override the secret token within APM - defaults to the previously existing secretToken

                  • Optionally enable debug mode for APM servers - defaults false

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

                  Additional properties are allowed.

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

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

                  Additional properties are allowed.

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

            • apm object Required

              The configuration options for the APM Server.

              Additional properties are allowed.

              Hide apm attributes Show apm attributes object
              • version string

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

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

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

                Additional properties are allowed.

                Hide system_settings attributes Show system_settings attributes object
                • DEPRECATED: Scheduled for removal in a future version of the API.

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

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

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

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

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

                • Optionally override the secret token within APM - defaults to the previously existing secretToken

                • Optionally enable debug mode for APM servers - defaults false

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

                Additional properties are allowed.

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

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

                Additional properties are allowed.

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

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

              Additional properties are allowed.

              Hide transient attributes Show transient attributes object
              • strategy object

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

                Additional properties are allowed.

                Hide strategy attributes Show strategy attributes object
                • rolling object

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

                  Additional properties are allowed.

                  Hide rolling attributes Show rolling attributes object
                  • group_by string

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

                  • 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

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

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

                  Additional properties are allowed.

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

                  Additional properties are allowed.

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

                  Additional properties are allowed.

              • The plan control configuration options for the APM Server.

                Additional properties are allowed.

                Hide plan_configuration attributes Show plan_configuration attributes object
                • timeout integer(int64)

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

                • calm_wait_time integer(int64)

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

                • move_instances array[object]
                  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)

                  • Tells the infrastructure that the instance should be considered as permanently down when deciding how to migrate data to new nodes. If left blank then the system will automatically decide (currently: will treat the instances as up)

                • move_allocators array[object]
                  Hide move_allocators attributes Show move_allocators attributes object
                  • from string Required

                    The allocator id off which all instances in the cluster should be moved

                  • to array[string]

                    An optional list of allocator ids to which the instance(s) should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)

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

                • If true (default: false) does not allow re-using any existing instances currently in the cluster, ie even unchanged instances will be re-created

                • List of allocators on which instances are placed if possible (if not possible/not specified then any available allocator with space is used)

                • Map containing allocators tags in form of key value pairs, increasing the likelihood during move requests for allocators with matching tags, to be selected as target allocators

                  Hide preferred_allocator_tags attribute Show preferred_allocator_tags attribute object
                  • * string Additional properties
                • 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

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

                  Value is forced.

                • If false (the default), the plan fails if it determines that the request can result in unsafe operations. Setting this flag overrides some of these check restraints.

          • settings object

            The settings for building this APM cluster

            Additional properties are allowed.

            Hide settings attribute Show settings attribute object
            • metadata object

              The top-level configuration settings for the Elasticsearch cluster.

              Additional properties are allowed.

              Hide metadata attributes Show metadata attributes object
              • name string

                The display name of the cluster

              • owner_id string

                The user id (referencing whatever user database is in use) of the cluster owner

              • The organization that owns the deployment

              • Subscription level of the cluster

              • Indicates if a cluster is system owned (restricts the set of operations that can be performed on it)

              • Contact email for the cluster

              • hidden boolean

                Whether or not this cluster is hidden from the normal clusters list

              • The top-level configuration settings for the Elasticsearch cluster resources.

                Additional properties are allowed.

                Hide resources attribute Show resources attribute object
                • cpu object

                  Specifies the CPU resource settings for the Elasticsearch cluster.

                  Additional properties are allowed.

                  Hide cpu attributes Show cpu attributes object
                  • boost boolean

                    Indicates if the CPU boost flag is enabled or not.

                  • hard_limit boolean

                    Indicates if the CPU hard limit flag is enabled or not. When set to true (default), allocates CPU timeshare based on the total CPU time multiplied by the relative RAM capacity of the instance on a given host. When set to false, delegates CPU allocation to the operating system to schedule CPU timeshares.

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

          Hide appsearch attributes Show appsearch attributes object
          • ref_id string Required

            A locally-unique user-specified id for AppSearch

          • Alias to the Elasticsearch Cluster to attach AppSearch to

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

            Additional properties are allowed.

            Hide plan attributes Show plan attributes object
            • cluster_topology array[object]
              Hide cluster_topology attributes Show cluster_topology attributes object
              • Defines the AppSearch node type

                Additional properties are allowed.

                Hide node_type attributes Show node_type attributes object
                • appserver boolean Required

                  Defines whether this instance should run as Application/API server

                • worker boolean Required

                  Defines whether this instance should run as background worker

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

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

              • size object

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

                Additional properties are allowed.

                Hide size attributes Show size attributes object
                • value integer(int32) Required

                  Amount of resource

                • resource string Required

                  Type of resource

                  Values are memory or storage.

              • zone_count integer(int32)

                number of zones in which nodes will be placed

              • Additional properties are allowed.

                Hide appsearch attributes Show appsearch attributes object
                • version string

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

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

                • This structure defines a curated subset of the AppSearch settings. (This field together with 'user_settings_override*' and 'user_settings*' defines the total set of AppSearch settings)

                  Additional properties are allowed.

                  Hide system_settings attributes Show system_settings attributes object
                  • Optionally override the URL to which to send data (for advanced users only, if unspecified the system selects an internal URL)

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

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

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

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

                  Additional properties are allowed.

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

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

                  Additional properties are allowed.

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

            • appsearch object Required

              Additional properties are allowed.

              Hide appsearch attributes Show appsearch attributes object
              • version string

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

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

              • This structure defines a curated subset of the AppSearch settings. (This field together with 'user_settings_override*' and 'user_settings*' defines the total set of AppSearch settings)

                Additional properties are allowed.

                Hide system_settings attributes Show system_settings attributes object
                • Optionally override the URL to which to send data (for advanced users only, if unspecified the system selects an internal URL)

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

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

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

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

                Additional properties are allowed.

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

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

                Additional properties are allowed.

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

            • Defines configuration parameters that control how the plan (ie consisting of the cluster topology and AppSearch settings) is applied

              Additional properties are allowed.

              Hide transient attributes Show transient attributes object
              • strategy object

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

                Additional properties are allowed.

                Hide strategy attributes Show strategy attributes object
                • rolling object

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

                  Additional properties are allowed.

                  Hide rolling attributes Show rolling attributes object
                  • group_by string

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

                  • 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

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

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

                  Additional properties are allowed.

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

                  Additional properties are allowed.

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

                  Additional properties are allowed.

              • Additional properties are allowed.

                Hide plan_configuration attributes Show plan_configuration attributes object
                • timeout integer(int64)

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

                • calm_wait_time integer(int64)

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

                • move_instances array[object]
                  Hide move_instances attributes Show move_instances attributes object
                  • from string Required

                    The instance id that is going to be moved

                  • to array[string]

                    An optional list of allocator ids to which the instance should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)

                  • Tells the infrastructure that the instance should be considered as permanently down when deciding how to migrate data to new nodes. If left blank then the system will automatically decide (currently: will treat the instances as up)

                • move_allocators array[object]
                  Hide move_allocators attributes Show move_allocators attributes object
                  • from string Required

                    The allocator id off which all instances in the cluster should be moved

                  • to array[string]

                    An optional list of allocator ids to which the instance(s) should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)

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

                • If true (default: false) does not allow re-using any existing instances currently in the cluster, ie even unchanged instances will be re-created

                • List of allocators on which instances are placed if possible (if not possible/not specified then any available allocator with space is used)

                • Map containing allocators tags in form of key value pairs, increasing the likelihood during move requests for allocators with matching tags, to be selected as target allocators

                  Hide preferred_allocator_tags attribute Show preferred_allocator_tags attribute object
                  • * string Additional properties
                • 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

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

                  Value is forced.

                • If false (the default), the plan fails if it determines that the request can result in unsafe operations. Setting this flag overrides some of these check restraints.

          • settings object

            The settings for building this AppSearch cluster

            Additional properties are allowed.

            Hide settings attribute Show settings attribute object
            • metadata object

              The top-level configuration settings for the Elasticsearch cluster.

              Additional properties are allowed.

              Hide metadata attributes Show metadata attributes object
              • name string

                The display name of the cluster

              • owner_id string

                The user id (referencing whatever user database is in use) of the cluster owner

              • The organization that owns the deployment

              • Subscription level of the cluster

              • Indicates if a cluster is system owned (restricts the set of operations that can be performed on it)

              • Contact email for the cluster

              • hidden boolean

                Whether or not this cluster is hidden from the normal clusters list

              • The top-level configuration settings for the Elasticsearch cluster resources.

                Additional properties are allowed.

                Hide resources attribute Show resources attribute object
                • cpu object

                  Specifies the CPU resource settings for the Elasticsearch cluster.

                  Additional properties are allowed.

                  Hide cpu attributes Show cpu attributes object
                  • boost boolean

                    Indicates if the CPU boost flag is enabled or not.

                  • hard_limit boolean

                    Indicates if the CPU hard limit flag is enabled or not. When set to true (default), allocates CPU timeshare based on the total CPU time multiplied by the relative RAM capacity of the instance on a given host. When set to false, delegates CPU allocation to the operating system to schedule CPU timeshares.

        • integrations_server array[object]

          A list of payloads for Integrations Server creation.

          Hide integrations_server attributes Show integrations_server attributes object
          • ref_id string Required

            A locally-unique user-specified id for the Integrations Server

          • Alias to the Elasticsearch Cluster to attach the Integrations Server to

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

            Additional properties are allowed.

            Hide plan attributes Show plan attributes object
            • cluster_topology array[object]
              Hide cluster_topology attributes Show cluster_topology attributes object
              • 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.

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

              • size object

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

                Additional properties are allowed.

                Hide size attributes Show size attributes object
                • value integer(int32) Required

                  Amount of resource

                • resource string Required

                  Type of resource

                  Values are memory or storage.

              • zone_count integer(int32)

                number of zones in which nodes will be placed

              • The configuration options for the Integrations Server.

                Additional properties are allowed.

                Hide integrations_server attributes Show integrations_server attributes object
                • version string

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

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

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

                  Additional properties are allowed.

                  Hide system_settings attributes Show system_settings attributes object
                  • DEPRECATED: Scheduled for removal in a future version of the API.

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

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

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

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

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

                  • Optionally override the secret token within Integrations Server - defaults to the previously existing secretToken

                  • Optionally enable debug mode for Integrations Server - defaults false

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

                  Additional properties are allowed.

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

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

                  Additional properties are allowed.

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

                • mode string

                  The mode the Integrations Server is operating in.

                  Values are standalone or managed.

            • integrations_server object Required

              The configuration options for the Integrations Server.

              Additional properties are allowed.

              Hide integrations_server attributes Show integrations_server attributes object
              • version string

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

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

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

                Additional properties are allowed.

                Hide system_settings attributes Show system_settings attributes object
                • DEPRECATED: Scheduled for removal in a future version of the API.

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

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

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

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

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

                • Optionally override the secret token within Integrations Server - defaults to the previously existing secretToken

                • Optionally enable debug mode for Integrations Server - defaults false

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

                Additional properties are allowed.

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

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

                Additional properties are allowed.

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

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

              Additional properties are allowed.

              Hide transient attributes Show transient attributes object
              • strategy object

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

                Additional properties are allowed.

                Hide strategy attributes Show strategy attributes object
                • rolling object

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

                  Additional properties are allowed.

                  Hide rolling attributes Show rolling attributes object
                  • group_by string

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

                  • 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

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

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

                  Additional properties are allowed.

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

                  Additional properties are allowed.

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

                  Additional properties are allowed.

              • The plan control configuration options for the Integrations Server.

                Additional properties are allowed.

                Hide plan_configuration attributes Show plan_configuration attributes object
                • timeout integer(int64)

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

                • calm_wait_time integer(int64)

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

                • move_instances array[object]
                  Hide move_instances attributes Show move_instances attributes object
                  • from string Required

                    The instance id that is going to be moved

                  • to array[string]

                    An optional list of allocator ids to which the instance should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)

                  • Tells the infrastructure that the instance should be considered as permanently down when deciding how to migrate data to new nodes. If left blank then the system will automatically decide (currently: will treat the instances as up)

                • move_allocators array[object]
                  Hide move_allocators attributes Show move_allocators attributes object
                  • from string Required

                    The allocator id off which all instances in the cluster should be moved

                  • to array[string]

                    An optional list of allocator ids to which the instance(s) should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)

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

                • If true (default: false) does not allow re-using any existing instances currently in the cluster, ie even unchanged instances will be re-created

                • List of allocators on which instances are placed if possible (if not possible/not specified then any available allocator with space is used)

                • Map containing allocators tags in form of key value pairs, increasing the likelihood during move requests for allocators with matching tags, to be selected as target allocators

                  Hide preferred_allocator_tags attribute Show preferred_allocator_tags attribute object
                  • * string Additional properties
                • 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

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

                  Value is forced.

                • If false (the default), the plan fails if it determines that the request can result in unsafe operations. Setting this flag overrides some of these check restraints.

          • settings object

            The settings for building this Integrations Server cluster

            Additional properties are allowed.

            Hide settings attribute Show settings attribute object
            • metadata object

              The top-level configuration settings for the Elasticsearch cluster.

              Additional properties are allowed.

              Hide metadata attributes Show metadata attributes object
              • name string

                The display name of the cluster

              • owner_id string

                The user id (referencing whatever user database is in use) of the cluster owner

              • The organization that owns the deployment

              • Subscription level of the cluster

              • Indicates if a cluster is system owned (restricts the set of operations that can be performed on it)

              • Contact email for the cluster

              • hidden boolean

                Whether or not this cluster is hidden from the normal clusters list

              • The top-level configuration settings for the Elasticsearch cluster resources.

                Additional properties are allowed.

                Hide resources attribute Show resources attribute object
                • cpu object

                  Specifies the CPU resource settings for the Elasticsearch cluster.

                  Additional properties are allowed.

                  Hide cpu attributes Show cpu attributes object
                  • boost boolean

                    Indicates if the CPU boost flag is enabled or not.

                  • hard_limit boolean

                    Indicates if the CPU hard limit flag is enabled or not. When set to true (default), allocates CPU timeshare based on the total CPU time multiplied by the relative RAM capacity of the instance on a given host. When set to false, delegates CPU allocation to the operating system to schedule CPU timeshares.

      • settings object

        Additional configuration for this Deployment

        Additional properties are allowed.

        Hide settings attributes Show settings attributes object
        • The rulesets to apply to all resources in this cluster. When specified, the set of rulesets is updated and the same rulesets will be applied to Kibana and APM clusters as well. If not specified, the rulesets remain as they were set previously.

          Additional properties are allowed.

          Hide traffic_filter_settings attribute Show traffic_filter_settings attribute object
          • rulesets array[string] Required

            IDs of the traffic filter rulesets

        • Observability settings for this deployment

          Additional properties are allowed.

          Hide observability attributes Show observability attributes object
          • logging object

            The logging settings for the deployment

            Additional properties are allowed.

            Hide logging attribute Show logging attribute object
            • destination object Required

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

              Additional properties are allowed.

              Hide destination attributes Show destination attributes object
              • deployment_id string Required

                The deployment to send logs and/or metrics to. Contains either the deployment's ID or 'self'.

              • ref_id string

                RefId of the Elasticsearch cluster to send logs and/or metrics to. If not specified, refId is resolved automatically as long as the destination deployment contains a single Elasticsearch resource.

          • metrics object

            The metrics settings for the deployment

            Additional properties are allowed.

            Hide metrics attributes Show metrics attributes object
            • destination object Required

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

              Additional properties are allowed.

              Hide destination attributes Show destination attributes object
              • deployment_id string Required

                The deployment to send logs and/or metrics to. Contains either the deployment's ID or 'self'.

              • ref_id string

                RefId of the Elasticsearch cluster to send logs and/or metrics to. If not specified, refId is resolved automatically as long as the destination deployment contains a single Elasticsearch resource.

            • Set to true to force the deployment to use legacy monitoring instead of Metricbeat-based monitoring.

        • Enable autoscaling for this deployment.

      • metadata object

        Additional information about this deployment

        Additional properties are allowed.

        Hide metadata attributes Show metadata attributes object
        • Indicates if a deployment is system owned (restricts the set of operations that can be performed on it)

        • tags array[object]

          Arbitrary user-defined metadata associated with this deployment

          Hide tags attributes Show tags attributes object
          • key string Required

            The metadata field name

          • value string Required

            The metadata value

      • alias string

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

      • region string

        Identifier of the region to be used as the default for all the resources of the deployment

      • version string

        The version for all the resources of the deployment (must be one of the supported versions). Defaults to the latest version if not specified.

    • Whether or not if this is system owned template.

    • source object

      Information describing the source that facilitated the plans current state

      Additional properties are allowed.

      Hide source attributes Show source attributes object
      • facilitator string Required

        The service where the change originated from

      • action string Required

        The type of plan change that was initiated

      • date string(date-time) Required

        The time the change was initiated

      • user_id string

        The user that requested the change

      • admin_id string

        The admin user that requested the change

      • remote_addresses array[string]

        The host addresses of the user that originated the change

    • metadata array[object]

      Optional arbitrary metadata to associate with this template.

      Hide metadata attributes Show metadata attributes object
      • key string Required

        The metadata field name

      • value string Required

        The metadata value

    • instance_configurations array[object] Required

      List of instance configurations used in the cluster template.

      Hide instance_configurations attributes Show instance_configurations attributes object
      • id string

        Unique identifier for the instance configuration

      • name string Required

        Display name for the instance configuration.

      • config_version integer(int32)

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

      • Optional description for the instance configuration

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

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

      • node_types array[string]

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

      • discrete_sizes object Required

        Numerics representing possible instance sizes that the instance configuration supports.

        Additional properties are allowed.

        Hide discrete_sizes attributes Show discrete_sizes attributes object
        • sizes array[integer(int32)] Required

          List of supported sizes

        • default_size integer(int32)

          The default size

        • resource string

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

          Values are memory or storage.

      • storage_multiplier number(double)

        Settings for the instance storage multiplier

      • cpu_multiplier number(double)

        Settings for the instance CPU multiplier

      • metadata object

        Optional arbitrary metadata to associate with this template.

        Additional properties are allowed.

      • max_zones integer(int32)

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

    • order integer(int32)

      Determines the order in which this template should be returned when listed. Templates are returned in ascending order. If not specified, then the template willbe appended to the end of the list.

    • hidden boolean

      Whether or not the deployment template is hidden by default.

    • Minimum stack version required by this template, if any.

    • Provider and version agnostic template identifier used for grouping related template types.

  • The requested region was not found. (code: templates.region_not_found)

    Hide headers attribute Show headers attribute
    • The error codes associated with the response

      Value is templates.region_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

  • The user is not authorized to access requested region. (code: templates.region_not_allowed)

    Hide headers attribute Show headers attribute
    • The error codes associated with the response

      Value is templates.region_not_allowed.

    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/templates
curl \
 -X GET https://{{hostname}}/api/v1/deployments/templates?region=string
Response examples (200)
[
  {
    "id": "string",
    "name": "string",
    "description": "string",
    "deployment_template": {
      "name": "string",
      "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"
                  ],
                  "memory_per_node": 42,
                  "node_count_per_zone": 42,
                  "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,
                  "move_instances": [
                    {
                      "from": "string",
                      "to": [
                        "string"
                      ],
                      "instance_down": true
                    }
                  ],
                  "move_allocators": [
                    {
                      "from": "string",
                      "to": [
                        "string"
                      ],
                      "allocator_down": true
                    }
                  ],
                  "move_only": true,
                  "reallocate_instances": true,
                  "preferred_allocators": [
                    "string"
                  ],
                  "preferred_allocator_tags": {
                    "additionalProperty1": "string",
                    "additionalProperty2": "string"
                  },
                  "skip_snapshot": true,
                  "max_snapshot_attempts": 42,
                  "max_snapshot_age": 42,
                  "extended_maintenance": true,
                  "cluster_reboot": "forced",
                  "override_failsafe": true,
                  "skip_data_migration": true,
                  "skip_upgrade_checker": true,
                  "skip_post_upgrade_steps": true,
                  "skip_snapshot_post_major_upgrade": true
                },
                "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": {
                "repository": {
                  "static": {
                    "repository_type": "string",
                    "settings": {}
                  },
                  "reference": {
                    "repository_name": "string"
                  },
                  "default": {}
                },
                "interval": "string",
                "pending_interval": "string",
                "wait_time_after_snapshotting": "string",
                "enabled": true,
                "suspended": [
                  "string"
                ],
                "retention": {
                  "snapshots": 42,
                  "max_age": "string"
                },
                "slm": true,
                "cron_expression": "string"
              },
              "monitoring": {
                "target_cluster_id": "string"
              },
              "metadata": {
                "name": "string",
                "owner_id": "string",
                "organization_id": "string",
                "subscription_level": "string",
                "system_owned": true,
                "contact_email": "string",
                "hidden": true,
                "resources": {
                  "cpu": {
                    "boost": true,
                    "hard_limit": true
                  }
                }
              },
              "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:00+00:00",
                          "valid_from": "2025-05-04T09:42:00+00:00",
                          "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": [
                {
                  "memory_per_node": 42,
                  "node_count_per_zone": 42,
                  "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_url": "string",
                      "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_url": "string",
                  "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,
                  "move_instances": [
                    {
                      "from": "string",
                      "to": [
                        "string"
                      ],
                      "instance_down": true
                    }
                  ],
                  "move_allocators": [
                    {
                      "from": "string",
                      "to": [
                        "string"
                      ],
                      "allocator_down": true
                    }
                  ],
                  "reallocate_instances": true,
                  "preferred_allocators": [
                    "string"
                  ],
                  "preferred_allocator_tags": {
                    "additionalProperty1": "string",
                    "additionalProperty2": "string"
                  },
                  "extended_maintenance": true,
                  "cluster_reboot": "forced",
                  "override_failsafe": true
                }
              }
            },
            "settings": {
              "metadata": {
                "name": "string",
                "owner_id": "string",
                "organization_id": "string",
                "subscription_level": "string",
                "system_owned": true,
                "contact_email": "string",
                "hidden": true,
                "resources": {
                  "cpu": {
                    "boost": true,
                    "hard_limit": true
                  }
                }
              }
            }
          }
        ],
        "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_url": "string",
                      "kibana_url": "string",
                      "elasticsearch_username": "string",
                      "elasticsearch_password": "string",
                      "secret_token": "string",
                      "debug_enabled": true
                    },
                    "user_settings_json": {},
                    "user_settings_yaml": "string",
                    "user_settings_override_json": {},
                    "user_settings_override_yaml": "string"
                  }
                }
              ],
              "apm": {
                "version": "string",
                "docker_image": "string",
                "system_settings": {
                  "elasticsearch_url": "string",
                  "kibana_url": "string",
                  "elasticsearch_username": "string",
                  "elasticsearch_password": "string",
                  "secret_token": "string",
                  "debug_enabled": true
                },
                "user_settings_json": {},
                "user_settings_yaml": "string",
                "user_settings_override_json": {},
                "user_settings_override_yaml": "string"
              },
              "transient": {
                "strategy": {
                  "rolling": {
                    "group_by": "string",
                    "allow_inline_resize": true,
                    "skip_synced_flush": true,
                    "shard_init_wait_time": 42
                  },
                  "grow_and_shrink": {},
                  "rolling_grow_and_shrink": {},
                  "autodetect": {}
                },
                "plan_configuration": {
                  "timeout": 42,
                  "calm_wait_time": 42,
                  "move_instances": [
                    {
                      "from": "string",
                      "to": [
                        "string"
                      ],
                      "instance_down": true
                    }
                  ],
                  "move_allocators": [
                    {
                      "from": "string",
                      "to": [
                        "string"
                      ],
                      "allocator_down": true
                    }
                  ],
                  "reallocate_instances": true,
                  "preferred_allocators": [
                    "string"
                  ],
                  "preferred_allocator_tags": {
                    "additionalProperty1": "string",
                    "additionalProperty2": "string"
                  },
                  "extended_maintenance": true,
                  "cluster_reboot": "forced",
                  "override_failsafe": true
                }
              }
            },
            "settings": {
              "metadata": {
                "name": "string",
                "owner_id": "string",
                "organization_id": "string",
                "subscription_level": "string",
                "system_owned": true,
                "contact_email": "string",
                "hidden": true,
                "resources": {
                  "cpu": {
                    "boost": true,
                    "hard_limit": true
                  }
                }
              }
            }
          }
        ],
        "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"
                  ],
                  "preferred_allocator_tags": {
                    "additionalProperty1": "string",
                    "additionalProperty2": "string"
                  },
                  "extended_maintenance": true,
                  "cluster_reboot": "forced",
                  "override_failsafe": true
                }
              }
            },
            "settings": {
              "metadata": {
                "name": "string",
                "owner_id": "string",
                "organization_id": "string",
                "subscription_level": "string",
                "system_owned": true,
                "contact_email": "string",
                "hidden": true,
                "resources": {
                  "cpu": {
                    "boost": true,
                    "hard_limit": true
                  }
                }
              }
            }
          }
        ],
        "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_url": "string",
                      "elasticsearch_username": "string",
                      "elasticsearch_password": "string",
                      "secret_session_key": "string"
                    },
                    "user_settings_json": {},
                    "user_settings_yaml": "string",
                    "user_settings_override_json": {},
                    "user_settings_override_yaml": "string"
                  },
                  "allocator_filter": {},
                  "node_configuration": "string",
                  "memory_per_node": {},
                  "node_count_per_zone": {}
                }
              ],
              "enterprise_search": {
                "version": "string",
                "docker_image": "string",
                "system_settings": {
                  "elasticsearch_url": "string",
                  "elasticsearch_username": "string",
                  "elasticsearch_password": "string",
                  "secret_session_key": "string"
                },
                "user_settings_json": {},
                "user_settings_yaml": "string",
                "user_settings_override_json": {},
                "user_settings_override_yaml": "string"
              },
              "transient": {
                "strategy": {
                  "rolling": {
                    "group_by": "string",
                    "allow_inline_resize": true,
                    "skip_synced_flush": true,
                    "shard_init_wait_time": 42
                  },
                  "grow_and_shrink": {},
                  "rolling_grow_and_shrink": {},
                  "autodetect": {}
                },
                "plan_configuration": {
                  "timeout": 42,
                  "calm_wait_time": 42,
                  "move_instances": [
                    {
                      "from": "string",
                      "to": [
                        "string"
                      ],
                      "instance_down": true
                    }
                  ],
                  "move_allocators": [
                    {
                      "from": "string",
                      "to": [
                        "string"
                      ],
                      "allocator_down": true
                    }
                  ],
                  "reallocate_instances": true,
                  "preferred_allocators": [
                    "string"
                  ],
                  "preferred_allocator_tags": {
                    "additionalProperty1": "string",
                    "additionalProperty2": "string"
                  },
                  "extended_maintenance": true,
                  "cluster_reboot": "forced",
                  "override_failsafe": true
                }
              }
            },
            "settings": {
              "metadata": {
                "name": "string",
                "owner_id": "string",
                "organization_id": "string",
                "subscription_level": "string",
                "system_owned": true,
                "contact_email": "string",
                "hidden": true,
                "resources": {
                  "cpu": {
                    "boost": true,
                    "hard_limit": true
                  }
                }
              }
            }
          }
        ],
        "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_url": "string",
                      "kibana_url": "string",
                      "elasticsearch_username": "string",
                      "elasticsearch_password": "string",
                      "secret_token": "string",
                      "debug_enabled": true
                    },
                    "user_settings_json": {},
                    "user_settings_yaml": "string",
                    "user_settings_override_json": {},
                    "user_settings_override_yaml": "string",
                    "mode": "standalone"
                  }
                }
              ],
              "integrations_server": {
                "version": "string",
                "docker_image": "string",
                "system_settings": {
                  "elasticsearch_url": "string",
                  "kibana_url": "string",
                  "elasticsearch_username": "string",
                  "elasticsearch_password": "string",
                  "secret_token": "string",
                  "debug_enabled": true
                },
                "user_settings_json": {},
                "user_settings_yaml": "string",
                "user_settings_override_json": {},
                "user_settings_override_yaml": "string",
                "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,
                  "move_instances": [
                    {
                      "from": "string",
                      "to": [
                        "string"
                      ],
                      "instance_down": true
                    }
                  ],
                  "move_allocators": [
                    {
                      "from": "string",
                      "to": [
                        "string"
                      ],
                      "allocator_down": true
                    }
                  ],
                  "reallocate_instances": true,
                  "preferred_allocators": [
                    "string"
                  ],
                  "preferred_allocator_tags": {
                    "additionalProperty1": "string",
                    "additionalProperty2": "string"
                  },
                  "extended_maintenance": true,
                  "cluster_reboot": "forced",
                  "override_failsafe": true
                }
              }
            },
            "settings": {
              "metadata": {
                "name": "string",
                "owner_id": "string",
                "organization_id": "string",
                "subscription_level": "string",
                "system_owned": true,
                "contact_email": "string",
                "hidden": true,
                "resources": {
                  "cpu": {
                    "boost": true,
                    "hard_limit": true
                  }
                }
              }
            }
          }
        ]
      },
      "settings": {
        "traffic_filter_settings": {
          "rulesets": [
            "string"
          ]
        },
        "observability": {
          "logging": {
            "destination": {
              "deployment_id": "string",
              "ref_id": "string"
            }
          },
          "metrics": {
            "destination": {
              "deployment_id": "string",
              "ref_id": "string"
            },
            "force_legacy_monitoring": true
          }
        },
        "autoscaling_enabled": true
      },
      "metadata": {
        "system_owned": true,
        "tags": [
          {
            "key": "string",
            "value": "string"
          }
        ]
      },
      "alias": "string",
      "region": "string",
      "version": "string"
    },
    "system_owned": true,
    "source": {
      "facilitator": "string",
      "action": "string",
      "date": "2025-05-04T09:42:00+00:00",
      "user_id": "string",
      "admin_id": "string",
      "remote_addresses": [
        "string"
      ]
    },
    "metadata": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "instance_configurations": [
      {
        "id": "string",
        "name": "string",
        "config_version": 42,
        "description": "string",
        "instance_type": "elasticsearch",
        "node_types": [
          "string"
        ],
        "discrete_sizes": {
          "sizes": [
            42
          ],
          "default_size": 42,
          "resource": "memory"
        },
        "storage_multiplier": 42.0,
        "cpu_multiplier": 42.0,
        "metadata": {},
        "max_zones": 42
      }
    ],
    "order": 42,
    "hidden": true,
    "min_version": "string",
    "template_category_id": "string",
    "kibana_deeplink": [
      {
        "semver": "string",
        "uri": "string"
      }
    ]
  }
]
Response examples (400)
# Headers
x-cloud-error-codes: templates.region_not_found

# Payload
{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}
Response examples (401)
# Headers
x-cloud-error-codes: templates.region_not_allowed

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

Create deployment template

POST /deployments/templates

Creates a deployment template.

Query parameters

  • If true, the deployment template definition will be validated but the template will not be created.

    Default value is false.

  • region string Required

    Region of the deployment template

Body Required

The deployment template definition.

  • name string Required

    A human readable name for the template.

  • An optional description for the template.

  • deployment_template object Required

    A request for creating a new Deployment consisting of multiple clusters

    Additional properties are allowed.

    Hide deployment_template attributes Show deployment_template attributes object
    • name string

      A name for the deployment; otherwise this will be the generated deployment id

    • The Resources that will belong to this Deployment

      Additional properties are allowed.

      Hide resources attributes Show resources attributes object
      • elasticsearch array[object]

        A list of payloads for Elasticsearch cluster creation.

        Hide elasticsearch attributes Show elasticsearch attributes object
        • ref_id string Required

          A locally-unique user-specified id for this Elasticsearch cluster

        • 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 building this Elasticsearch cluster

          Additional properties are allowed.

          Hide plan attributes Show plan attributes object
          • cluster_topology array[object] Required
            Hide cluster_topology attributes Show cluster_topology attributes object
            • id string

              Unique identifier of this topology element

            • Controls the combinations of Elasticsearch node types. TIP: By default, the Elasticsearch node is master eligible, can hold data, and run ingest pipelines. WARNING: Do not set for tiebreaker topologies.

              Additional properties are allowed.

              Hide node_type attributes Show node_type attributes object
              • master boolean

                Defines whether this node can be elected master (default: false)

              • data boolean

                Defines whether this node can hold data (default: false)

              • ingest boolean

                Defines whether this node can run an ingest pipeline (default: false)

              • ml boolean

                Defines whether this node can run ml jobs, valid only for versions 5.4.0 or greater (default: false)

            • node_roles array[string]

              The list of node roles for this topology element (ES version >= 7.10). Allowable values are: master, ingest, ml, data_hot, data_content, data_warm, data_cold, data_frozen, remote_cluster_client, transform

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

            • memory_per_node integer(int32)

              The memory capacity in MB for each node of this type built in each zone.

            • node_count_per_zone integer(int32)

              The number of nodes of this type that are allocated within each zone. (i.e. total capacity per zone = node_count_per_zone * memory_per_node in MB). Cannot be set for tiebreaker topologies. For dedicated master nodes, must be 1 if an entry exists.

            • zone_count integer(int32)

              The default number of zones in which data nodes will be placed

            • The Elasticsearch cluster settings. When specified at the top level, provides a field-by-field default. When specified at the topology level, provides the override settings.

              Additional properties are allowed.

              Hide elasticsearch attributes Show elasticsearch attributes object
              • version string

                The version of the Elasticsearch cluster (must be one of the ECE supported versions). Currently cannot be different across the topology (and is generally specified in the globals). Defaults to the latest version if not specified.

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

              • A subset of Elasticsearch settings. TIP: To define the complete set of Elasticsearch settings, use ElasticsearchSystemSettings with user_settings_override* and user_settings*.

                Additional properties are allowed.

                Hide system_settings attributes Show system_settings attributes object
                • Controls the languages supported by the Elasticsearch cluster, such as Painless, Mustache, and Expressions. Controls how the languages are used, such as file, index, and inline. TIP: For complex configurations, leave these blank and configure these settings in the user YAML or JSON.

                  Additional properties are allowed.

                  Hide scripting attributes Show scripting attributes object
                  • (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]')

                  • (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]')

                  • (5.x+ only) If enabled (the default) then the expressions scripting engine is allowed as a sandboxed language. Sandboxed languages are the only ones allowed if 'sandbox_mode' is set to true. NOTES: (Corresponds to the parameters 'script.engine.expression.[file|stored|inline]')

                  • stored object

                    Enables scripting for the specified type and controls other parameters. Store scripts in indexes (stored), upload in file bundles (file), or use in API requests (inline).

                    Additional properties are allowed.

                    Hide stored attributes Show stored attributes object
                    • enabled boolean

                      If enabled (default: true) then scripts are enabled, either for sandboxing languages (by default), or for all installed languages if 'sandbox_mode' is disabled (or for 6.x). NOTES: (Corresponds to the parameter 'script.file|stored/indexed|inline')

                    • If enabled (default: true) and this script type is enabled, then only the sandbox languages are allowed. By default the sandbox languages are painless, expressions and mustache, but this can be restricted via the 'painless_enabled', 'mustache_enabled' 'expression_enabled' settings.NOTES: Not supported in 6.x. (Corresponds to the parameters 'script.engine.[painless|mustache|expressions].[file|stored|inline]')

                  • file object

                    Enables scripting for the specified type and controls other parameters. Store scripts in indexes (stored), upload in file bundles (file), or use in API requests (inline).

                    Additional properties are allowed.

                    Hide file attributes Show file attributes object
                    • enabled boolean

                      If enabled (default: true) then scripts are enabled, either for sandboxing languages (by default), or for all installed languages if 'sandbox_mode' is disabled (or for 6.x). NOTES: (Corresponds to the parameter 'script.file|stored/indexed|inline')

                    • If enabled (default: true) and this script type is enabled, then only the sandbox languages are allowed. By default the sandbox languages are painless, expressions and mustache, but this can be restricted via the 'painless_enabled', 'mustache_enabled' 'expression_enabled' settings.NOTES: Not supported in 6.x. (Corresponds to the parameters 'script.engine.[painless|mustache|expressions].[file|stored|inline]')

                  • inline object

                    Enables scripting for the specified type and controls other parameters. Store scripts in indexes (stored), upload in file bundles (file), or use in API requests (inline).

                    Additional properties are allowed.

                    Hide inline attributes Show inline attributes object
                    • enabled boolean

                      If enabled (default: true) then scripts are enabled, either for sandboxing languages (by default), or for all installed languages if 'sandbox_mode' is disabled (or for 6.x). NOTES: (Corresponds to the parameter 'script.file|stored/indexed|inline')

                    • 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

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

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

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

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

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

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

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

              • An arbitrary JSON object allowing cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters arey are on the allowlist and not on the denylist. NOTES: (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Elasticsearch settings)

                Additional properties are allowed.

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

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

                Additional properties are allowed.

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

              • A list of plugin names from the Elastic-supported subset that are bundled with the version images. NOTES: (Users should consult the Elastic stack objects to see what plugins are available, this is currently only available from the UI)

              • user_plugins array[object]

                A list of admin-uploaded plugin objects that are available for this user.

                Hide user_plugins attributes Show user_plugins attributes object
                • name string Required

                  The name of the plugin

                • url string Required

                  The URL of the plugin (must be accessible from the ECE infrastructure)

                • elasticsearch_version string Required

                  The supported Elasticsearch version (must match the version in the plan)

              • user_bundles array[object]

                A list of admin-uploaded bundle objects (eg scripts, synonym files) that are available for this user.

                Hide user_bundles attributes Show user_bundles attributes object
                • name string Required

                  The name of the bundle

                • url string Required

                  The URL of the bundle, which must be accessible from the ECE infrastructure. This URL could be cached by platform, make sure to change it when updating the bundle

                • elasticsearch_version string Required

                  The supported Elasticsearch version (must match the version in the plan)

              • curation object

                Defines the index curation routing for the cluster

                Additional properties are allowed.

                Hide curation attributes Show curation attributes object
              • Defines the Elasticsearch node attributes for the instances in the topology

                Hide node_attributes attribute Show node_attributes attribute object
                • * string Additional properties
            • 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.

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

            • size object

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

              Additional properties are allowed.

              Hide size attributes Show size attributes object
              • value integer(int32) Required

                Amount of resource

              • resource string Required

                Type of resource

                Values are memory or storage.

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

              Additional properties are allowed.

              Hide autoscaling_min attributes Show autoscaling_min attributes object
              • value integer(int32) Required

                Amount of resource

              • resource string Required

                Type of resource

                Values are memory or storage.

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

              Additional properties are allowed.

              Hide autoscaling_max attributes Show autoscaling_max attributes object
              • value integer(int32) Required

                Amount of resource

              • resource string Required

                Type of resource

                Values are memory or storage.

            • An arbitrary JSON object overriding the default autoscaling policy. Don't set unless you really know what you are doing.

              Additional properties are allowed.

            • Controls for the topology element. Only used as part of the deployment template. Ignored if included as part of a deployment.

              Additional properties are allowed.

              Hide topology_element_control attribute Show topology_element_control attribute object
              • min object Required

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

                Additional properties are allowed.

                Hide min attributes Show min attributes object
                • value integer(int32) Required

                  Amount of resource

                • resource string Required

                  Type of resource

                  Values are memory or storage.

            • Set to true to enable autoscaling for this topology element, even if the cluster-level 'autoscaling_enabled' field is false. Note that 'autoscaling_tier_override' cannot be set to false if cluster-level 'autoscaling_enabled' is true. Currently only supported for the 'ml' tier

          • elasticsearch object Required

            The Elasticsearch cluster settings. When specified at the top level, provides a field-by-field default. When specified at the topology level, provides the override settings.

            Additional properties are allowed.

            Hide elasticsearch attributes Show elasticsearch attributes object
            • version string

              The version of the Elasticsearch cluster (must be one of the ECE supported versions). Currently cannot be different across the topology (and is generally specified in the globals). Defaults to the latest version if not specified.

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

            • A subset of Elasticsearch settings. TIP: To define the complete set of Elasticsearch settings, use ElasticsearchSystemSettings with user_settings_override* and user_settings*.

              Additional properties are allowed.

              Hide system_settings attributes Show system_settings attributes object
              • Controls the languages supported by the Elasticsearch cluster, such as Painless, Mustache, and Expressions. Controls how the languages are used, such as file, index, and inline. TIP: For complex configurations, leave these blank and configure these settings in the user YAML or JSON.

                Additional properties are allowed.

                Hide scripting attributes Show scripting attributes object
                • (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]')

                • (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]')

                • (5.x+ only) If enabled (the default) then the expressions scripting engine is allowed as a sandboxed language. Sandboxed languages are the only ones allowed if 'sandbox_mode' is set to true. NOTES: (Corresponds to the parameters 'script.engine.expression.[file|stored|inline]')

                • stored object

                  Enables scripting for the specified type and controls other parameters. Store scripts in indexes (stored), upload in file bundles (file), or use in API requests (inline).

                  Additional properties are allowed.

                  Hide stored attributes Show stored attributes object
                  • enabled boolean

                    If enabled (default: true) then scripts are enabled, either for sandboxing languages (by default), or for all installed languages if 'sandbox_mode' is disabled (or for 6.x). NOTES: (Corresponds to the parameter 'script.file|stored/indexed|inline')

                  • If enabled (default: true) and this script type is enabled, then only the sandbox languages are allowed. By default the sandbox languages are painless, expressions and mustache, but this can be restricted via the 'painless_enabled', 'mustache_enabled' 'expression_enabled' settings.NOTES: Not supported in 6.x. (Corresponds to the parameters 'script.engine.[painless|mustache|expressions].[file|stored|inline]')

                • file object

                  Enables scripting for the specified type and controls other parameters. Store scripts in indexes (stored), upload in file bundles (file), or use in API requests (inline).

                  Additional properties are allowed.

                  Hide file attributes Show file attributes object
                  • enabled boolean

                    If enabled (default: true) then scripts are enabled, either for sandboxing languages (by default), or for all installed languages if 'sandbox_mode' is disabled (or for 6.x). NOTES: (Corresponds to the parameter 'script.file|stored/indexed|inline')

                  • If enabled (default: true) and this script type is enabled, then only the sandbox languages are allowed. By default the sandbox languages are painless, expressions and mustache, but this can be restricted via the 'painless_enabled', 'mustache_enabled' 'expression_enabled' settings.NOTES: Not supported in 6.x. (Corresponds to the parameters 'script.engine.[painless|mustache|expressions].[file|stored|inline]')

                • inline object

                  Enables scripting for the specified type and controls other parameters. Store scripts in indexes (stored), upload in file bundles (file), or use in API requests (inline).

                  Additional properties are allowed.

                  Hide inline attributes Show inline attributes object
                  • enabled boolean

                    If enabled (default: true) then scripts are enabled, either for sandboxing languages (by default), or for all installed languages if 'sandbox_mode' is disabled (or for 6.x). NOTES: (Corresponds to the parameter 'script.file|stored/indexed|inline')

                  • 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

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

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

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

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

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

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

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

            • An arbitrary JSON object allowing cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters arey are on the allowlist and not on the denylist. NOTES: (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Elasticsearch settings)

              Additional properties are allowed.

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

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

              Additional properties are allowed.

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

            • A list of plugin names from the Elastic-supported subset that are bundled with the version images. NOTES: (Users should consult the Elastic stack objects to see what plugins are available, this is currently only available from the UI)

            • user_plugins array[object]

              A list of admin-uploaded plugin objects that are available for this user.

              Hide user_plugins attributes Show user_plugins attributes object
              • name string Required

                The name of the plugin

              • url string Required

                The URL of the plugin (must be accessible from the ECE infrastructure)

              • elasticsearch_version string Required

                The supported Elasticsearch version (must match the version in the plan)

            • user_bundles array[object]

              A list of admin-uploaded bundle objects (eg scripts, synonym files) that are available for this user.

              Hide user_bundles attributes Show user_bundles attributes object
              • name string Required

                The name of the bundle

              • url string Required

                The URL of the bundle, which must be accessible from the ECE infrastructure. This URL could be cached by platform, make sure to change it when updating the bundle

              • elasticsearch_version string Required

                The supported Elasticsearch version (must match the version in the plan)

            • curation object

              Defines the index curation routing for the cluster

              Additional properties are allowed.

              Hide curation attributes Show curation attributes object
            • Defines the Elasticsearch node attributes for the instances in the topology

              Hide node_attributes attribute Show node_attributes attribute object
              • * string Additional properties
          • Documents which deployment template was used in the creation of this plan

            Additional properties are allowed.

            Hide deployment_template attributes Show deployment_template attributes object
            • id string Required

              The unique identifier of the deployment template

            • version string

              A version identifier to disambiguate multiple revisions of the same template

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

            Additional properties are allowed.

            Hide transient attributes Show transient attributes object
            • strategy object

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

              Additional properties are allowed.

              Hide strategy attributes Show strategy attributes object
              • rolling object

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

                Additional properties are allowed.

                Hide rolling attributes Show rolling attributes object
                • group_by string

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

                • 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

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

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

                Additional properties are allowed.

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

                Additional properties are allowed.

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

                Additional properties are allowed.

            • The configuration settings for the timeout and fallback parameters.

              Additional properties are allowed.

              Hide plan_configuration attributes Show plan_configuration attributes object
              • timeout integer(int64)

                The total timeout in seconds after which the plan is cancelled even if it is not complete. Defaults to 4x the max memory capacity per node (in MB). NOTES: A 3 zone cluster with 2 nodes of 2048 each would have a timeout of 4*2048=8192 seconds. Timeout does not include time required to run rollback actions.

              • calm_wait_time integer(int64)

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

              • move_instances array[object]
                Hide move_instances attributes Show move_instances attributes object
                • from string Required

                  The instance id that is going to be moved

                • to array[string]

                  An optional list of allocator ids to which the instance should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)

                • Tells the infrastructure that the instance should be considered as permanently down when deciding how to migrate data to new nodes. If left blank then the system will automatically decide (currently: will treat the instances as up)

              • move_allocators array[object]
                Hide move_allocators attributes Show move_allocators attributes object
                • from string Required

                  The allocator id off which all instances in the cluster should be moved

                • to array[string]

                  An optional list of allocator ids to which the instance(s) should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)

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

              • move_only boolean

                If true (default: false) only move_instances and move_allocators instructions will be executed, all other changes will be ignored

              • If true (default: false) does not allow re-using any existing instances currently in the cluster, ie even unchanged instances will be re-created

              • List of allocators on which instances are placed if possible (if not possible/not specified then any available allocator with space is used)

              • Map containing allocators tags in form of key value pairs, increasing the likelihood during move requests for allocators with matching tags, to be selected as target allocators

                Hide preferred_allocator_tags attribute Show preferred_allocator_tags attribute object
                • * string Additional properties
              • If true (default: false), does not take (or require) a successful snapshot to be taken before performing any potentially destructive changes to this cluster

              • 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

              • 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

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

              • If false (the default) then the plan will fail out if it believes the requested sequence of operations can result in data loss - this flag will override some of these restraints

              • If true (default: false) then the plan will not wait for data to be migrated from old instances to new instances before continuing the plan (potentially deleting the old instances and losing data)

              • If false, the cluster is checked for issues that should be resolved before migration (eg contains old Lucene segments), if true this is bypassed

              • If false (the default), the cluster will run (currently) 2.x->5.x operations for any plan change ending with a 5.x cluster (eg apply a cluster license, ensure Monitoring is configured)

              • If false (the default), the cluster will perform a snapshot after a major version upgrade takes place

            • Restores a snapshot from a local or remote repository.

              Additional properties are allowed.

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

              • Raw remote snapshot restore settings. Do not send this if you are sending source_cluster_id

                Additional properties are allowed.

                Hide repository_config attribute Show repository_config attribute object
                • The remote snapshot settings raw JSON - see the Elasticsearch '_snapshot' documentation for more details on supported formats

                  Additional properties are allowed.

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

                Additional properties are allowed.

                Hide restore_payload attributes Show restore_payload attributes object
                • indices array[string]

                  The list of indices to restore (supports +ve and -ve selection and wildcarding - see the default Elasticsearch index format documentation)

                • This JSON object (merged with the 'indices' field (if present) is passed untouched into the restore command - see the Elasticsearch '_snapshot' documentation for more details on supported formats

                  Additional properties are allowed.

              • strategy string

                The restore strategy to use. Defaults to a full restore. Partial restore will attempt to restore unavailable indices only

                Values are partial, full, or recovery.

              • If specified, contains the name of the source cluster id. Do not send this if you are sending repository_config

            • The list of resources that will be configured as remote clusters

              Additional properties are allowed.

              Hide remote_clusters attribute Show remote_clusters attribute object
              • resources array[object] Required

                The remote resources

                Hide resources attributes Show resources attributes object
                • deployment_id string Required

                  The id of the deployment

                • elasticsearch_ref_id string Required

                  The locally-unique user-specified id of an Elasticsearch Resource

                • alias string Required

                  The alias for this remote cluster. Aliases must only contain letters, digits, dashes and underscores

                • If true, skip this cluster during search if it is disconnected. Default: false

            • If specified, contains transient settings to be applied to an Elasticsearch cluster during changes,default values shown below applied. These can be overridden by specifying them in the map (or null to unset). Additional settings can also be set. Settings will be cleared after the plan has finished. If not specified, no settings will be applied. NOTE: These settings are only explicitly cleared for 5.x+ clusters, they must be hand-reset to their defaults in 2.x- (or a cluster reboot will clear them).

              • indices.store.throttle.max_bytes_per_sec: 120Mb
              • indices.recovery.max_bytes_per_sec: 120Mb
              • cluster.routing.allocation.cluster_concurrent_rebalance: 5
              • cluster.routing.allocation.node_initial_primaries_recoveries: 5
              • cluster.routing.allocation.node_concurrent_incoming_recoveries: 5 For version 8.1 and later no defaults are provided through this mechanism, but instead hardware dependent settings are provided to each instance.

              Additional properties are allowed.

          • Enable autoscaling for this Elasticsearch cluster.

        • settings object

          The settings for building this Elasticsearch cluster

          Additional properties are allowed.

          Hide settings attributes Show settings attributes object
          • snapshot object

            The snapshot settings for this deployment. When provided, snapshot settings are changed as specified. A null value reverts the field to the default value. Otherwise, all snapshot settings remain as they were set previously.

            Additional properties are allowed.

            Hide snapshot attributes Show snapshot attributes object
            • Snapshot repository configuration

              Additional properties are allowed.

              Hide repository attributes Show repository attributes object
              • static object

                Cluster snapshot static repository settings, containing repository type and settings

                Additional properties are allowed.

                Hide static attributes Show static attributes object
                • Type of snapshot repository, ie: S3

                • settings object

                  Settings associated with snapshot repository

                  Additional properties are allowed.

              • Cluster snapshot reference repository settings, containing the repository name in ECE fashion

                Additional properties are allowed.

                Hide reference attribute Show reference attribute object
                • ECE snapshot repository name, from the '/platform/configuration/snapshots/repositories' endpoint

              • default object

                Cluster snapshot default repository settings

                Additional properties are allowed.

            • 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

            • Interval between snapshot progress checks, with the format 'length unit' (space is optional), where unit can be one of: d (day), h (hour), min (minute). Default is 1 minute

            • The time to wait between snapshot phases (snapshot, purge), with the format 'length unit' (space is optional), where unit can be one of: d (day), h (hour), min (minute). Default is 10 minutes

            • enabled boolean

              Indicates if Snapshotting is enabled

            • suspended array[string]

              List of temporary snapshot suspensions

            • Cluster snapshot retention information

              Additional properties are allowed.

              Hide retention attributes Show retention attributes object
              • snapshots integer(int32)

                Number of snapshots to retain

              • max_age string

                Total retention period for all snapshots, with the format 'length unit' (space is optional), where unit can be one of: d (day), h (hour), min (minute)

            • 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

          • The monitoring settings for this deployment. When provided, monitoring settings are changed as specified. A null value reverts the field to the default value. Otherwise, all monitoring settings remain as they were set previously.

            Additional properties are allowed.

            Hide monitoring attribute Show monitoring attribute object
            • target_cluster_id string Required

              The Id of the target cluster to which to send monitoring information

          • metadata object

            The top-level configuration settings for the Elasticsearch cluster.

            Additional properties are allowed.

            Hide metadata attributes Show metadata attributes object
            • name string

              The display name of the cluster

            • owner_id string

              The user id (referencing whatever user database is in use) of the cluster owner

            • Subscription level of the cluster

            • Indicates if a cluster is system owned (restricts the set of operations that can be performed on it)

            • Contact email for the cluster

            • The top-level configuration settings for the Elasticsearch cluster resources.

              Additional properties are allowed.

              Hide resources attribute Show resources attribute object
              • cpu object

                Specifies the CPU resource settings for the Elasticsearch cluster.

                Additional properties are allowed.

                Hide cpu attributes Show cpu attributes object
                • boost boolean

                  Indicates if the CPU boost flag is enabled or not.

                • hard_limit boolean

                  Indicates if the CPU hard limit flag is enabled or not. When set to true (default), allocates CPU timeshare based on the total CPU time multiplied by the relative RAM capacity of the instance on a given host. When set to false, delegates CPU allocation to the operating system to schedule CPU timeshares.

          • curation object

            The curation settings for this deployment. When provided, curation settings are changed as specified. A null value reverts the field to the default value. Otherwise, all curation settings remain as they were set previously.

            Additional properties are allowed.

            Hide curation attribute Show curation attribute object
            • specs array[object] Required

              Specifications for curation

              Hide specs attributes Show specs attributes object
          • 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.

          • The rulesets to apply to all resources in this cluster. When specified, the set of rulesets is updated and the same rulesets will be applied to Kibana and APM clusters as well. If not specified, the rulesets remain as they were set previously.

            Additional properties are allowed.

            Hide traffic_filter attribute Show traffic_filter attribute object
            • rulesets array[string] Required

              IDs of the traffic filter rulesets

          • trust object

            Configuration of trust with other clusters. When provided, trust settings are changed as specified. A null value reverts the field to the default value. Otherwise, all trust settings remain as they were set previously.

            Additional properties are allowed.

            Hide trust attributes Show trust attributes object
            • accounts array[object]

              The list of trust relationships with different accounts

              Hide accounts attributes Show accounts attributes object
              • account_id string Required

                the ID of the Account

              • name string

                A human readable name of the trust relationship

              • trust_all boolean Required

                If true, all clusters in this account will by default be trusted and the trust_allowlist is ignored.

              • trust_allowlist array[string]

                The list of clusters to trust. Only used when trust_all is false.

            • external array[object]

              The list of trust relationships with external entities

              Hide external attributes Show external attributes object
              • trust_relationship_id string Required

                The ID of the external trust relationship

              • name string

                The name of the external trust relationship. Retrieved from the TrustRelationship and ignored on write.

              • trust_all boolean Required

                If true, all clusters in this external entity will be trusted and the trust_allowlist is ignored.

              • trust_allowlist array[string]

                The list of clusters to trust. Only used when trust_all is false.

            • direct array[object]

              The list of trust relationships where the certificate is bundled with the trust setting. Allows configuring trust for clusters running outside of an Elastic Cloud managed environment or in an Elastic Cloud environment without an environment level trust established.

              Hide direct attributes Show direct attributes object
              • uid string

                Auto generated identifier for this trust, allows distinguishing between update vs remove and add.

              • name string Required

                a human readable name of the trust relationship

              • type string

                The type can either be ESS, ECE, generic or proxy. If none is specified, then generic is assumed. If proxy is specified, trust_all should be false and trust_allowlist, scope_id and additional_node_names should be omitted.

                Values are ECE, ESS, generic, or proxy.

              • trust_all boolean Required

                If true, scope_id is required and the trust_allowlist is ignored and all clusters matching the scope id will be trusted.

              • trust_allowlist array[string]

                The list of clusters with matching scope to trust. Only used when trust_all is false. Providing one or more clusters makes scope_id mandatory.

              • scope_id string

                A lowercase alphanumerical string of max 32 characters. Usually an organization id or an environment id, but could really be any suitable suffix for clusters using the CA certificate of this trust. Required unless trust_all is false and trust_allowlist is empty.

              • A list of node names trusted in addition to those deducible from trust_allowlist and scope id. Allows trusting nodes that don't have a scoped name at the cost of maintaining the list. Mandatory if scope id is not defined. Wildcards are not allowed.

              • certificates array[object] Required

                The public ca certificate(s) to trust. Only one is required, but it is possible to specify multiple certificates in order to facilitate key rotation.

                Hide certificates attribute Show certificates attribute object
                • pem string Required

                  The public ca certificate as string in PEM format.

          • The contents of the Elasticsearch keystore. It's a write only field.

            Additional properties are allowed.

            Hide keystore_contents attribute Show keystore_contents attribute object
            • secrets object Required

              List of secrets

              Hide secrets attribute Show secrets attribute object
              • * object Additional properties

                The value that you configure for the Elasticsearch keystore secret.

                Additional properties are allowed.

                Hide * attributes Show * attributes object
                • value object

                  Value of this setting. This can either be a string or a JSON object that is stored as a JSON string in the keystore. NOTE: When the keystore secret is unspecified, it is removed.

                  Additional properties are allowed.

                • as_file boolean

                  Stores the keystore secret as a file. The default is false, which stores the keystore secret as string when value is a plain string, or true when value is an object.

      • kibana array[object]

        A list of payloads for Kibana creation.

        Hide kibana attributes Show kibana attributes object
        • ref_id string Required

          A locally-unique user-specified id for Kibana

        • Alias to the Elasticsearch Cluster to attach Kibana to

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

          Additional properties are allowed.

          Hide plan attributes Show plan attributes object
          • cluster_topology array[object]
            Hide cluster_topology attributes Show cluster_topology attributes object
            • memory_per_node integer(int32)

              The memory capacity in MB for each node of this type built in each zone.

            • node_count_per_zone integer(int32)

              The number of nodes of this type that are allocated within each zone (i.e. total capacity per zone = node_count_per_zone * memory_per_node in MB).

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

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

            • size object

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

              Additional properties are allowed.

              Hide size attributes Show size attributes object
              • value integer(int32) Required

                Amount of resource

              • resource string Required

                Type of resource

                Values are memory or storage.

            • zone_count integer(int32)

              number of zones in which nodes will be placed

            • kibana object

              The Kibana instance settings. When specified at the top level, provides a field-by-field default. When specified at the topology level, provides the override settings.

              Additional properties are allowed.

              Hide kibana attributes Show kibana attributes object
              • version string

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

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

              • A subset of Kibana settings. TIP: To define the complete set of Elasticsearch settings, use KibanaSystemSettings with user_settings_override_ and user_settings_.

                Additional properties are allowed.

                Hide system_settings attributes Show system_settings attributes object
                • DEPRECATED: Scheduled for removal in a future version of the API.

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

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

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

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

                Additional properties are allowed.

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

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

                Additional properties are allowed.

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

          • kibana object Required

            The Kibana instance settings. When specified at the top level, provides a field-by-field default. When specified at the topology level, provides the override settings.

            Additional properties are allowed.

            Hide kibana attributes Show kibana attributes object
            • version string

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

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

            • A subset of Kibana settings. TIP: To define the complete set of Elasticsearch settings, use KibanaSystemSettings with user_settings_override_ and user_settings_.

              Additional properties are allowed.

              Hide system_settings attributes Show system_settings attributes object
              • DEPRECATED: Scheduled for removal in a future version of the API.

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

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

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

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

              Additional properties are allowed.

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

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

              Additional properties are allowed.

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

          • Defines the configuration parameters that control how the plan is applied. For example, the Elasticsearch cluster topology and Kibana instance settings.

            Additional properties are allowed.

            Hide transient attributes Show transient attributes object
            • strategy object

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

              Additional properties are allowed.

              Hide strategy attributes Show strategy attributes object
              • rolling object

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

                Additional properties are allowed.

                Hide rolling attributes Show rolling attributes object
                • group_by string

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

                • 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

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

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

                Additional properties are allowed.

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

                Additional properties are allowed.

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

                Additional properties are allowed.

            • The configuration settings for the timeout and fallback parameters.

              Additional properties are allowed.

              Hide plan_configuration attributes Show plan_configuration attributes object
              • timeout integer(int64)

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

              • calm_wait_time integer(int64)

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

              • move_instances array[object]
                Hide move_instances attributes Show move_instances attributes object
                • from string Required

                  The instance id that is going to be moved

                • to array[string]

                  An optional list of allocator ids to which the instance should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)

                • Tells the infrastructure that the instance should be considered as permanently down when deciding how to migrate data to new nodes. If left blank then the system will automatically decide (currently: will treat the instances as up)

              • move_allocators array[object]
                Hide move_allocators attributes Show move_allocators attributes object
                • from string Required

                  The allocator id off which all instances in the cluster should be moved

                • to array[string]

                  An optional list of allocator ids to which the instance(s) should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)

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

              • If true (default: false) does not allow re-using any existing instances currently in the cluster, ie even unchanged instances will be re-created

              • List of allocators on which instances are placed if possible (if not possible/not specified then any available allocator with space is used)

              • Map containing allocators tags in form of key value pairs, increasing the likelihood during move requests for allocators with matching tags, to be selected as target allocators

                Hide preferred_allocator_tags attribute Show preferred_allocator_tags attribute object
                • * string Additional properties
              • 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

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

                Value is forced.

              • If false (the default), the plan fails if it determines that the request can result in unsafe operations. Setting this flag overrides some of these check restraints.

        • settings object

          The settings for building this Kibana cluster

          Additional properties are allowed.

          Hide settings attribute Show settings attribute object
          • metadata object

            The top-level configuration settings for the Elasticsearch cluster.

            Additional properties are allowed.

            Hide metadata attributes Show metadata attributes object
            • name string

              The display name of the cluster

            • owner_id string

              The user id (referencing whatever user database is in use) of the cluster owner

            • Subscription level of the cluster

            • Indicates if a cluster is system owned (restricts the set of operations that can be performed on it)

            • Contact email for the cluster

            • The top-level configuration settings for the Elasticsearch cluster resources.

              Additional properties are allowed.

              Hide resources attribute Show resources attribute object
              • cpu object

                Specifies the CPU resource settings for the Elasticsearch cluster.

                Additional properties are allowed.

                Hide cpu attributes Show cpu attributes object
                • boost boolean

                  Indicates if the CPU boost flag is enabled or not.

                • hard_limit boolean

                  Indicates if the CPU hard limit flag is enabled or not. When set to true (default), allocates CPU timeshare based on the total CPU time multiplied by the relative RAM capacity of the instance on a given host. When set to false, delegates CPU allocation to the operating system to schedule CPU timeshares.

      • apm array[object]

        A list of payloads for APM creation. WARNING: For stack versions 8.0.0 and higher the integrations_server payload should be used instead, as this field becomes deprecated.

        Hide apm attributes Show apm attributes object
        • ref_id string Required

          A locally-unique user-specified id for APM

        • Alias to the Elasticsearch Cluster to attach APM to

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

          Additional properties are allowed.

          Hide plan attributes Show plan attributes object
          • cluster_topology array[object]
            Hide cluster_topology attributes Show cluster_topology attributes object
            • 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.

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

            • size object

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

              Additional properties are allowed.

              Hide size attributes Show size attributes object
              • value integer(int32) Required

                Amount of resource

              • resource string Required

                Type of resource

                Values are memory or storage.

            • zone_count integer(int32)

              number of zones in which nodes will be placed

            • apm object

              The configuration options for the APM Server.

              Additional properties are allowed.

              Hide apm attributes Show apm attributes object
              • version string

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

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

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

                Additional properties are allowed.

                Hide system_settings attributes Show system_settings attributes object
                • DEPRECATED: Scheduled for removal in a future version of the API.

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

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

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

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

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

                • Optionally override the secret token within APM - defaults to the previously existing secretToken

                • Optionally enable debug mode for APM servers - defaults false

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

                Additional properties are allowed.

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

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

                Additional properties are allowed.

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

          • apm object Required

            The configuration options for the APM Server.

            Additional properties are allowed.

            Hide apm attributes Show apm attributes object
            • version string

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

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

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

              Additional properties are allowed.

              Hide system_settings attributes Show system_settings attributes object
              • DEPRECATED: Scheduled for removal in a future version of the API.

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

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

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

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

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

              • Optionally override the secret token within APM - defaults to the previously existing secretToken

              • Optionally enable debug mode for APM servers - defaults false

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

              Additional properties are allowed.

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

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

              Additional properties are allowed.

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

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

            Additional properties are allowed.

            Hide transient attributes Show transient attributes object
            • strategy object

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

              Additional properties are allowed.

              Hide strategy attributes Show strategy attributes object
              • rolling object

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

                Additional properties are allowed.

                Hide rolling attributes Show rolling attributes object
                • group_by string

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

                • 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

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

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

                Additional properties are allowed.

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

                Additional properties are allowed.

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

                Additional properties are allowed.

            • The plan control configuration options for the APM Server.

              Additional properties are allowed.

              Hide plan_configuration attributes Show plan_configuration attributes object
              • timeout integer(int64)

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

              • calm_wait_time integer(int64)

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

              • move_instances array[object]
                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)

                • Tells the infrastructure that the instance should be considered as permanently down when deciding how to migrate data to new nodes. If left blank then the system will automatically decide (currently: will treat the instances as up)

              • move_allocators array[object]
                Hide move_allocators attributes Show move_allocators attributes object
                • from string Required

                  The allocator id off which all instances in the cluster should be moved

                • to array[string]

                  An optional list of allocator ids to which the instance(s) should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)

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

              • If true (default: false) does not allow re-using any existing instances currently in the cluster, ie even unchanged instances will be re-created

              • List of allocators on which instances are placed if possible (if not possible/not specified then any available allocator with space is used)

              • Map containing allocators tags in form of key value pairs, increasing the likelihood during move requests for allocators with matching tags, to be selected as target allocators

                Hide preferred_allocator_tags attribute Show preferred_allocator_tags attribute object
                • * string Additional properties
              • 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

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

                Value is forced.

              • If false (the default), the plan fails if it determines that the request can result in unsafe operations. Setting this flag overrides some of these check restraints.

        • settings object

          The settings for building this APM cluster

          Additional properties are allowed.

          Hide settings attribute Show settings attribute object
          • metadata object

            The top-level configuration settings for the Elasticsearch cluster.

            Additional properties are allowed.

            Hide metadata attributes Show metadata attributes object
            • name string

              The display name of the cluster

            • owner_id string

              The user id (referencing whatever user database is in use) of the cluster owner

            • Subscription level of the cluster

            • Indicates if a cluster is system owned (restricts the set of operations that can be performed on it)

            • Contact email for the cluster

            • The top-level configuration settings for the Elasticsearch cluster resources.

              Additional properties are allowed.

              Hide resources attribute Show resources attribute object
              • cpu object

                Specifies the CPU resource settings for the Elasticsearch cluster.

                Additional properties are allowed.

                Hide cpu attributes Show cpu attributes object
                • boost boolean

                  Indicates if the CPU boost flag is enabled or not.

                • hard_limit boolean

                  Indicates if the CPU hard limit flag is enabled or not. When set to true (default), allocates CPU timeshare based on the total CPU time multiplied by the relative RAM capacity of the instance on a given host. When set to false, delegates CPU allocation to the operating system to schedule CPU timeshares.

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

        Hide appsearch attributes Show appsearch attributes object
        • ref_id string Required

          A locally-unique user-specified id for AppSearch

        • Alias to the Elasticsearch Cluster to attach AppSearch to

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

          Additional properties are allowed.

          Hide plan attributes Show plan attributes object
          • cluster_topology array[object]
            Hide cluster_topology attributes Show cluster_topology attributes object
            • Defines the AppSearch node type

              Additional properties are allowed.

              Hide node_type attributes Show node_type attributes object
              • appserver boolean Required

                Defines whether this instance should run as Application/API server

              • worker boolean Required

                Defines whether this instance should run as background worker

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

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

            • size object

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

              Additional properties are allowed.

              Hide size attributes Show size attributes object
              • value integer(int32) Required

                Amount of resource

              • resource string Required

                Type of resource

                Values are memory or storage.

            • zone_count integer(int32)

              number of zones in which nodes will be placed

            • Additional properties are allowed.

              Hide appsearch attributes Show appsearch attributes object
              • version string

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

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

              • This structure defines a curated subset of the AppSearch settings. (This field together with 'user_settings_override*' and 'user_settings*' defines the total set of AppSearch settings)

                Additional properties are allowed.

                Hide system_settings attributes Show system_settings attributes object
                • Optionally override the URL to which to send data (for advanced users only, if unspecified the system selects an internal URL)

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

                • 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.

                • 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.

              • An arbitrary JSON object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters are on the allowlist and not on the denylist. (This field together with 'user_settings_override*' and 'system_settings' defines the total set of AppSearch settings)

                Additional properties are allowed.

              • 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)

              • An arbitrary JSON object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of AppSearch settings)

                Additional properties are allowed.

              • An arbitrary YAML object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_json' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of AppSearch settings)

          • appsearch object Required

            Additional properties are allowed.

            Hide appsearch attributes Show appsearch attributes object
            • version string

              The version of the AppSearch cluster (must be one of the ECE supported versions, and won't work unless it matches the Elasticsearch version. Leave blank to auto-detect version.)

            • A docker URI that allows overriding of the default docker image specified for this version

            • This structure defines a curated subset of the AppSearch settings. (This field together with 'user_settings_override*' and 'user_settings*' defines the total set of AppSearch settings)

              Additional properties are allowed.

              Hide system_settings attributes Show system_settings attributes object
              • Optionally override the URL to which to send data (for advanced users only, if unspecified the system selects an internal URL)

              • 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.

              • 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.

              • 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.

            • An arbitrary JSON object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters are on the allowlist and not on the denylist. (This field together with 'user_settings_override*' and 'system_settings' defines the total set of AppSearch settings)

              Additional properties are allowed.

            • 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)

            • An arbitrary JSON object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of AppSearch settings)

              Additional properties are allowed.

            • 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)

          • Defines configuration parameters that control how the plan (ie consisting of the cluster topology and AppSearch settings) is applied

            Additional properties are allowed.

            Hide transient attributes Show transient attributes object
            • strategy object

              The options for performing a plan change. Specify only one property each time. The default is grow_and_shrink.

              Additional properties are allowed.

              Hide strategy attributes Show strategy attributes object
              • rolling object

                Performs inline, rolling configuration changes that mutate existing containers. TIP: This is the fastest way to update a plan, but can fail for complex plan changes, such as topology changes. Also, this is less safe for configuration changes that leave a cluster in a non running state. NOTE: When you perform a major version upgrade, and 'group_by' is set to 'pass:macros[all]';, rolling is required.

                Additional properties are allowed.

                Hide rolling attributes Show rolling attributes object
                • group_by string

                  Specifies the grouping attribute to use when rolling several instances. Instances that share the same value for the provided attribute key are rolled together as a unit. Examples that make sense to use are '__all__' (roll all instances as a single unit), 'logical_zone_name' (roll instances by zone), '__name__' (roll one instance at a time, the default if not specified). Note that '__all__' is required when performing a major version upgrade

                • 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

                • 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)

              • A strategy that creates instances with the new plan, migrates data from the old instances, then shuts down the old instances. GrowShrinkStrategyConfig is safer than 'rolling' and ensures single node availability during a plan change, but can be a lot slower on larger clusters.

                Additional properties are allowed.

              • A strategy that creates new Elasticsearch instances, Kibana instances, and APM Servers with the new plan, then migrates the node data to minimize the amount of spare capacity.

                Additional properties are allowed.

              • A strategy that lets constructor choose the most optimal way to execute the plan.

                Additional properties are allowed.

            • Additional properties are allowed.

              Hide plan_configuration attributes Show plan_configuration attributes object
              • timeout integer(int64)

                The total timeout in seconds after which the plan is cancelled even if it is not complete. Defaults to 4x the max memory capacity per node (in MB)

              • calm_wait_time integer(int64)

                This timeout determines how long to give a cluster after it responds to API calls before performing actual operations on it. It defaults to 5s

              • move_instances array[object]
                Hide move_instances attributes Show move_instances attributes object
                • from string Required

                  The instance id that is going to be moved

                • to array[string]

                  An optional list of allocator ids to which the instance should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)

                • Tells the infrastructure that the instance should be considered as permanently down when deciding how to migrate data to new nodes. If left blank then the system will automatically decide (currently: will treat the instances as up)

              • move_allocators array[object]
                Hide move_allocators attributes Show move_allocators attributes object
                • from string Required

                  The allocator id off which all instances in the cluster should be moved

                • to array[string]

                  An optional list of allocator ids to which the instance(s) should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)

                • 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)

              • If true (default: false) does not allow re-using any existing instances currently in the cluster, ie even unchanged instances will be re-created

              • List of allocators on which instances are placed if possible (if not possible/not specified then any available allocator with space is used)

              • Map containing allocators tags in form of key value pairs, increasing the likelihood during move requests for allocators with matching tags, to be selected as target allocators

                Hide preferred_allocator_tags attribute Show preferred_allocator_tags attribute object
                • * string Additional properties
              • 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

              • Set to 'forced' to force a reboot as part of the upgrade plan

                Value is forced.

              • If false (the default), the plan fails if it determines that the request can result in unsafe operations. Setting this flag overrides some of these check restraints.

        • settings object

          The settings for building this AppSearch cluster

          Additional properties are allowed.

          Hide settings attribute Show settings attribute object
          • metadata object

            The top-level configuration settings for the Elasticsearch cluster.

            Additional properties are allowed.

            Hide metadata attributes Show metadata attributes object
            • name string

              The display name of the cluster

            • owner_id string

              The user id (referencing whatever user database is in use) of the cluster owner

            • Subscription level of the cluster

            • Indicates if a cluster is system owned (restricts the set of operations that can be performed on it)

            • Contact email for the cluster

            • The top-level configuration settings for the Elasticsearch cluster resources.

              Additional properties are allowed.

              Hide resources attribute Show resources attribute object
              • cpu object

                Specifies the CPU resource settings for the Elasticsearch cluster.

                Additional properties are allowed.

                Hide cpu attributes Show cpu attributes object
                • boost boolean

                  Indicates if the CPU boost flag is enabled or not.

                • hard_limit boolean

                  Indicates if the CPU hard limit flag is enabled or not. When set to true (default), allocates CPU timeshare based on the total CPU time multiplied by the relative RAM capacity of the instance on a given host. When set to false, delegates CPU allocation to the operating system to schedule CPU timeshares.

      • integrations_server array[object]

        A list of payloads for Integrations Server creation.

        Hide integrations_server attributes Show integrations_server attributes object
        • ref_id string Required

          A locally-unique user-specified id for the Integrations Server

        • Alias to the Elasticsearch Cluster to attach the Integrations Server to

        • 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.

          Additional properties are allowed.

          Hide plan attributes Show plan attributes object
          • cluster_topology array[object]
            Hide cluster_topology attributes Show cluster_topology attributes object
            • 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.

            • The version of the Instance Configuration Id. If it is unset, the meaning depends on read vs writes. For deployment reads, it is equivalent to version 0 (or the IC is unversioned); for deployment creates and deployment template use, it is equivalent to 'the latest version'; and for deployment updates, it is equivalent to 'retain the current version'.

            • size object

              Measured by the amount of a resource. The final cluster size is calculated using multipliers from the topology instance configuration.

              Additional properties are allowed.

              Hide size attributes Show size attributes object
              • value integer(int32) Required

                Amount of resource

              • resource string Required

                Type of resource

                Values are memory or storage.

            • zone_count integer(int32)

              number of zones in which nodes will be placed

            • The configuration options for the Integrations Server.

              Additional properties are allowed.

              Hide integrations_server attributes Show integrations_server attributes object
              • version string

                The version of the Integrations Server cluster (must be one of the ECE supported versions, and won't work unless it matches the Integrations Server version. Leave blank to auto-detect version.)

              • A docker URI that allows overriding of the default docker image specified for this version

              • A structure that defines a curated subset of the Integrations Server settings. TIP: To define the complete set of Integrations Server setting, use IntegrationsSystemSettings with user_settings_override_ and user_settings_.

                Additional properties are allowed.

                Hide system_settings attributes Show system_settings attributes object
                • DEPRECATED: Scheduled for removal in a future version of the API.

                  Optionally override the URL to which to send data (for advanced users only, if unspecified the system selects an internal URL)

                • DEPRECATED: Scheduled for removal in a future version of the API.

                  Optionally override the URL to which to send data (for advanced users only, if unspecified the system selects an internal URL)

                • 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.

                • 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.

                • Optionally override the secret token within Integrations Server - defaults to the previously existing secretToken

                • Optionally enable debug mode for Integrations Server - defaults false

              • An arbitrary JSON object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters are on the allowlist and not on the denylist. (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Integrations Server settings)

                Additional properties are allowed.

              • 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)

              • An arbitrary JSON object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Integrations Server settings)

                Additional properties are allowed.

              • An arbitrary YAML object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_json' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Integrations Server settings)

              • mode string

                The mode the Integrations Server is operating in.

                Values are standalone or managed.

          • integrations_server object Required

            The configuration options for the Integrations Server.

            Additional properties are allowed.

            Hide integrations_server attributes Show integrations_server attributes object
            • version string

              The version of the Integrations Server cluster (must be one of the ECE supported versions, and won't work unless it matches the Integrations Server version. Leave blank to auto-detect version.)

            • A docker URI that allows overriding of the default docker image specified for this version

            • A structure that defines a curated subset of the Integrations Server settings. TIP: To define the complete set of Integrations Server setting, use IntegrationsSystemSettings with user_settings_override_ and user_settings_.

              Additional properties are allowed.

              Hide system_settings attributes Show system_settings attributes object
              • DEPRECATED: Scheduled for removal in a future version of the API.

                Optionally override the URL to which to send data (for advanced users only, if unspecified the system selects an internal URL)

              • DEPRECATED: Scheduled for removal in a future version of the API.

                Optionally override the URL to which to send data (for advanced users only, if unspecified the system selects an internal URL)

              • 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.

              • 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.

              • Optionally override the secret token within Integrations Server - defaults to the previously existing secretToken

              • Optionally enable debug mode for Integrations Server - defaults false

            • An arbitrary JSON object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters are on the allowlist and not on the denylist. (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Integrations Server settings)

              Additional properties are allowed.

            • 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)

            • An arbitrary JSON object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Integrations Server settings)

              Additional properties are allowed.

            • 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.

          • Defines the configuration parameters that control how the plan is applied. For example, the Elasticsearch cluster topology and Integrations Server settings.

            Additional properties are allowed.

            Hide transient attributes Show transient attributes object
            • strategy object

              The options for performing a plan change. Specify only one property each time. The default is grow_and_shrink.

              Additional properties are allowed.

              Hide strategy attributes Show strategy attributes object
              • rolling object

                Performs inline, rolling configuration changes that mutate existing containers. TIP: This is the fastest way to update a plan, but can fail for complex plan changes, such as topology changes. Also, this is less safe for configuration changes that leave a cluster in a non running state. NOTE: When you perform a major version upgrade, and 'group_by' is set to 'pass:macros[all]';, rolling is required.

                Additional properties are allowed.

                Hide rolling attributes Show rolling attributes object
                • group_by string

                  Specifies the grouping attribute to use when rolling several instances. Instances that share the same value for the provided attribute key are rolled together as a unit. Examples that make sense to use are '__all__' (roll all instances as a single unit), 'logical_zone_name' (roll instances by zone), '__name__' (roll one instance at a time, the default if not specified). Note that '__all__' is required when performing a major version upgrade

                • 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

                • 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)

              • A strategy that creates instances with the new plan, migrates data from the old instances, then shuts down the old instances. GrowShrinkStrategyConfig is safer than 'rolling' and ensures single node availability during a plan change, but can be a lot slower on larger clusters.

                Additional properties are allowed.

              • A strategy that creates new Elasticsearch instances, Kibana instances, and APM Servers with the new plan, then migrates the node data to minimize the amount of spare capacity.

                Additional properties are allowed.

              • A strategy that lets constructor choose the most optimal way to execute the plan.

                Additional properties are allowed.

            • The plan control configuration options for the Integrations Server.

              Additional properties are allowed.

              Hide plan_configuration attributes Show plan_configuration attributes object
              • timeout integer(int64)

                The total timeout in seconds after which the plan is cancelled even if it is not complete. Defaults to 4x the max memory capacity per node (in MB)

              • calm_wait_time integer(int64)

                This timeout determines how long to give a cluster after it responds to API calls before performing actual operations on it. It defaults to 5s

              • move_instances array[object]
                Hide move_instances attributes Show move_instances attributes object
                • from string Required

                  The instance id that is going to be moved

                • to array[string]

                  An optional list of allocator ids to which the instance should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)

                • Tells the infrastructure that the instance should be considered as permanently down when deciding how to migrate data to new nodes. If left blank then the system will automatically decide (currently: will treat the instances as up)

              • move_allocators array[object]
                Hide move_allocators attributes Show move_allocators attributes object
                • from string Required

                  The allocator id off which all instances in the cluster should be moved

                • to array[string]

                  An optional list of allocator ids to which the instance(s) should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)

                • 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)

              • If true (default: false) does not allow re-using any existing instances currently in the cluster, ie even unchanged instances will be re-created

              • List of allocators on which instances are placed if possible (if not possible/not specified then any available allocator with space is used)

              • Map containing allocators tags in form of key value pairs, increasing the likelihood during move requests for allocators with matching tags, to be selected as target allocators

                Hide preferred_allocator_tags attribute Show preferred_allocator_tags attribute object
                • * string Additional properties
              • 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

              • Set to 'forced' to force a reboot as part of the upgrade plan

                Value is forced.

              • If false (the default), the plan fails if it determines that the request can result in unsafe operations. Setting this flag overrides some of these check restraints.

        • settings object

          The settings for building this Integrations Server cluster

          Additional properties are allowed.

          Hide settings attribute Show settings attribute object
          • metadata object

            The top-level configuration settings for the Elasticsearch cluster.

            Additional properties are allowed.

            Hide metadata attributes Show metadata attributes object
            • name string

              The display name of the cluster

            • owner_id string

              The user id (referencing whatever user database is in use) of the cluster owner

            • Subscription level of the cluster

            • Indicates if a cluster is system owned (restricts the set of operations that can be performed on it)

            • Contact email for the cluster

            • The top-level configuration settings for the Elasticsearch cluster resources.

              Additional properties are allowed.

              Hide resources attribute Show resources attribute object
              • cpu object

                Specifies the CPU resource settings for the Elasticsearch cluster.

                Additional properties are allowed.

                Hide cpu attributes Show cpu attributes object
                • boost boolean

                  Indicates if the CPU boost flag is enabled or not.

                • hard_limit boolean

                  Indicates if the CPU hard limit flag is enabled or not. When set to true (default), allocates CPU timeshare based on the total CPU time multiplied by the relative RAM capacity of the instance on a given host. When set to false, delegates CPU allocation to the operating system to schedule CPU timeshares.

    • settings object

      Additional configuration for this Deployment

      Additional properties are allowed.

      Hide settings attributes Show settings attributes object
      • The rulesets to apply to all resources in this cluster. When specified, the set of rulesets is updated and the same rulesets will be applied to Kibana and APM clusters as well. If not specified, the rulesets remain as they were set previously.

        Additional properties are allowed.

        Hide traffic_filter_settings attribute Show traffic_filter_settings attribute object
        • rulesets array[string] Required

          IDs of the traffic filter rulesets

      • Observability settings for this deployment

        Additional properties are allowed.

        Hide observability attributes Show observability attributes object
        • logging object

          The logging settings for the deployment

          Additional properties are allowed.

          Hide logging attribute Show logging attribute object
          • destination object Required

            The destination deployment that this deployment's logs will be sent to

            Additional properties are allowed.

            Hide destination attributes Show destination attributes object
            • deployment_id string Required

              The deployment to send logs and/or metrics to. Contains either the deployment's ID or 'self'.

            • ref_id string

              RefId of the Elasticsearch cluster to send logs and/or metrics to. If not specified, refId is resolved automatically as long as the destination deployment contains a single Elasticsearch resource.

        • metrics object

          The metrics settings for the deployment

          Additional properties are allowed.

          Hide metrics attributes Show metrics attributes object
          • destination object Required

            The destination deployment that this deployment's logs will be sent to

            Additional properties are allowed.

            Hide destination attributes Show destination attributes object
            • deployment_id string Required

              The deployment to send logs and/or metrics to. Contains either the deployment's ID or 'self'.

            • ref_id string

              RefId of the Elasticsearch cluster to send logs and/or metrics to. If not specified, refId is resolved automatically as long as the destination deployment contains a single Elasticsearch resource.

          • Set to true to force the deployment to use legacy monitoring instead of Metricbeat-based monitoring.

      • Enable autoscaling for this deployment.

    • metadata object

      Additional information about this deployment

      Additional properties are allowed.

      Hide metadata attributes Show metadata attributes object
      • Indicates if a deployment is system owned (restricts the set of operations that can be performed on it)

      • tags array[object]

        Arbitrary user-defined metadata associated with this deployment

        Hide tags attributes Show tags attributes object
        • key string Required

          The metadata field name

        • value string Required

          The metadata value

    • alias string

      A user-defined alias to use in place of Cluster IDs for user-friendly URLs

    • region string

      Identifier of the region to be used as the default for all the resources of the deployment

    • version string

      The version for all the resources of the deployment (must be one of the supported versions). Defaults to the latest version if not specified.

  • Whether or not if this is system owned template.

  • metadata array[object]

    Optional arbitrary metadata to associate with this template.

    Hide metadata attributes Show metadata attributes object
    • key string Required

      The metadata field name

    • value string Required

      The metadata value

  • order integer(int32)

    Determines the order in which this template should be returned when listed. Templates are returned in ascending order. If not specified, then the template willbe appended to the end of the list.

  • hidden boolean

    Whether or not the deployment template is hidden by default.

  • Minimum stack version required by this template, if any.

  • Provider and version agnostic template identifier used for grouping related template types.

Responses

  • The request was valid (used when validate_only is true).

    Hide response attribute Show response attribute object
    • id string Required

      The ID

  • The deployment definition was valid and the template has been created.

    Hide response attribute Show response attribute object
    • id string Required

      The ID

  • The requested region is not supported. (code: templates.region_not_found)

    Hide headers attribute Show headers attribute
    • The error codes associated with the response

      Value is templates.region_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

  • The user is not authorized to access requested region. (code: templates.region_not_allowed)

    Hide headers attribute Show headers attribute
    • The error codes associated with the response

      Value is templates.region_not_allowed.

    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/templates
curl \
 -X POST https://{{hostname}}/api/v1/deployments/templates?region=string \
 -d '{"name":"string","description":"string","deployment_template":{"name":"string","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"],"memory_per_node":42,"node_count_per_zone":42,"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,"move_instances":[{"from":"string","to":["string"],"instance_down":true}],"move_allocators":[{"from":"string","to":["string"],"allocator_down":true}],"move_only":true,"reallocate_instances":true,"preferred_allocators":["string"],"preferred_allocator_tags":{"additionalProperty1":"string","additionalProperty2":"string"},"skip_snapshot":true,"max_snapshot_attempts":42,"max_snapshot_age":42,"extended_maintenance":true,"cluster_reboot":"forced","override_failsafe":true,"skip_data_migration":true,"skip_upgrade_checker":true,"skip_post_upgrade_steps":true,"skip_snapshot_post_major_upgrade":true},"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}]},"cluster_settings_json":{}},"autoscaling_enabled":true},"settings":{"snapshot":{"repository":{"static":{"repository_type":"string","settings":{}},"reference":{"repository_name":"string"},"default":{}},"interval":"string","pending_interval":"string","wait_time_after_snapshotting":"string","enabled":true,"suspended":["string"],"retention":{"snapshots":42,"max_age":"string"},"cron_expression":"string"},"monitoring":{"target_cluster_id":"string"},"metadata":{"name":"string","owner_id":"string","subscription_level":"string","system_owned":true,"contact_email":"string","resources":{"cpu":{"boost":true,"hard_limit":true}}},"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"}]}]},"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":[{"memory_per_node":42,"node_count_per_zone":42,"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_url":"string","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_url":"string","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,"move_instances":[{"from":"string","to":["string"],"instance_down":true}],"move_allocators":[{"from":"string","to":["string"],"allocator_down":true}],"reallocate_instances":true,"preferred_allocators":["string"],"preferred_allocator_tags":{"additionalProperty1":"string","additionalProperty2":"string"},"extended_maintenance":true,"cluster_reboot":"forced","override_failsafe":true}}},"settings":{"metadata":{"name":"string","owner_id":"string","subscription_level":"string","system_owned":true,"contact_email":"string","resources":{"cpu":{"boost":true,"hard_limit":true}}}}}],"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_url":"string","kibana_url":"string","elasticsearch_username":"string","elasticsearch_password":"string","secret_token":"string","debug_enabled":true},"user_settings_json":{},"user_settings_yaml":"string","user_settings_override_json":{},"user_settings_override_yaml":"string"}}],"apm":{"version":"string","docker_image":"string","system_settings":{"elasticsearch_url":"string","kibana_url":"string","elasticsearch_username":"string","elasticsearch_password":"string","secret_token":"string","debug_enabled":true},"user_settings_json":{},"user_settings_yaml":"string","user_settings_override_json":{},"user_settings_override_yaml":"string"},"transient":{"strategy":{"rolling":{"group_by":"string","allow_inline_resize":true,"skip_synced_flush":true,"shard_init_wait_time":42},"grow_and_shrink":{},"rolling_grow_and_shrink":{},"autodetect":{}},"plan_configuration":{"timeout":42,"calm_wait_time":42,"move_instances":[{"from":"string","to":["string"],"instance_down":true}],"move_allocators":[{"from":"string","to":["string"],"allocator_down":true}],"reallocate_instances":true,"preferred_allocators":["string"],"preferred_allocator_tags":{"additionalProperty1":"string","additionalProperty2":"string"},"extended_maintenance":true,"cluster_reboot":"forced","override_failsafe":true}}},"settings":{"metadata":{"name":"string","owner_id":"string","subscription_level":"string","system_owned":true,"contact_email":"string","resources":{"cpu":{"boost":true,"hard_limit":true}}}}}],"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"],"preferred_allocator_tags":{"additionalProperty1":"string","additionalProperty2":"string"},"extended_maintenance":true,"cluster_reboot":"forced","override_failsafe":true}}},"settings":{"metadata":{"name":"string","owner_id":"string","subscription_level":"string","system_owned":true,"contact_email":"string","resources":{"cpu":{"boost":true,"hard_limit":true}}}}}],"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_url":"string","elasticsearch_username":"string","elasticsearch_password":"string","secret_session_key":"string"},"user_settings_json":{},"user_settings_yaml":"string","user_settings_override_json":{},"user_settings_override_yaml":"string"},"allocator_filter":{},"node_configuration":"string","memory_per_node":{},"node_count_per_zone":{}}],"enterprise_search":{"version":"string","docker_image":"string","system_settings":{"elasticsearch_url":"string","elasticsearch_username":"string","elasticsearch_password":"string","secret_session_key":"string"},"user_settings_json":{},"user_settings_yaml":"string","user_settings_override_json":{},"user_settings_override_yaml":"string"},"transient":{"strategy":{"rolling":{"group_by":"string","allow_inline_resize":true,"skip_synced_flush":true,"shard_init_wait_time":42},"grow_and_shrink":{},"rolling_grow_and_shrink":{},"autodetect":{}},"plan_configuration":{"timeout":42,"calm_wait_time":42,"move_instances":[{"from":"string","to":["string"],"instance_down":true}],"move_allocators":[{"from":"string","to":["string"],"allocator_down":true}],"reallocate_instances":true,"preferred_allocators":["string"],"preferred_allocator_tags":{"additionalProperty1":"string","additionalProperty2":"string"},"extended_maintenance":true,"cluster_reboot":"forced","override_failsafe":true}}},"settings":{"metadata":{"name":"string","owner_id":"string","subscription_level":"string","system_owned":true,"contact_email":"string","resources":{"cpu":{"boost":true,"hard_limit":true}}}}}],"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_url":"string","kibana_url":"string","elasticsearch_username":"string","elasticsearch_password":"string","secret_token":"string","debug_enabled":true},"user_settings_json":{},"user_settings_yaml":"string","user_settings_override_json":{},"user_settings_override_yaml":"string","mode":"standalone"}}],"integrations_server":{"version":"string","docker_image":"string","system_settings":{"elasticsearch_url":"string","kibana_url":"string","elasticsearch_username":"string","elasticsearch_password":"string","secret_token":"string","debug_enabled":true},"user_settings_json":{},"user_settings_yaml":"string","user_settings_override_json":{},"user_settings_override_yaml":"string","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,"move_instances":[{"from":"string","to":["string"],"instance_down":true}],"move_allocators":[{"from":"string","to":["string"],"allocator_down":true}],"reallocate_instances":true,"preferred_allocators":["string"],"preferred_allocator_tags":{"additionalProperty1":"string","additionalProperty2":"string"},"extended_maintenance":true,"cluster_reboot":"forced","override_failsafe":true}}},"settings":{"metadata":{"name":"string","owner_id":"string","subscription_level":"string","system_owned":true,"contact_email":"string","resources":{"cpu":{"boost":true,"hard_limit":true}}}}}]},"settings":{"traffic_filter_settings":{"rulesets":["string"]},"observability":{"logging":{"destination":{"deployment_id":"string","ref_id":"string"}},"metrics":{"destination":{"deployment_id":"string","ref_id":"string"},"force_legacy_monitoring":true}},"autoscaling_enabled":true},"metadata":{"system_owned":true,"tags":[{"key":"string","value":"string"}]},"alias":"string","region":"string","version":"string"},"system_owned":true,"metadata":[{"key":"string","value":"string"}],"order":42,"hidden":true,"min_version":"string","template_category_id":"string","kibana_deeplink":[{"semver":"string","uri":"string"}]}'
Request examples
{
  "name": "string",
  "description": "string",
  "deployment_template": {
    "name": "string",
    "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"
                ],
                "memory_per_node": 42,
                "node_count_per_zone": 42,
                "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,
                "move_instances": [
                  {
                    "from": "string",
                    "to": [
                      "string"
                    ],
                    "instance_down": true
                  }
                ],
                "move_allocators": [
                  {
                    "from": "string",
                    "to": [
                      "string"
                    ],
                    "allocator_down": true
                  }
                ],
                "move_only": true,
                "reallocate_instances": true,
                "preferred_allocators": [
                  "string"
                ],
                "preferred_allocator_tags": {
                  "additionalProperty1": "string",
                  "additionalProperty2": "string"
                },
                "skip_snapshot": true,
                "max_snapshot_attempts": 42,
                "max_snapshot_age": 42,
                "extended_maintenance": true,
                "cluster_reboot": "forced",
                "override_failsafe": true,
                "skip_data_migration": true,
                "skip_upgrade_checker": true,
                "skip_post_upgrade_steps": true,
                "skip_snapshot_post_major_upgrade": true
              },
              "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
                  }
                ]
              },
              "cluster_settings_json": {}
            },
            "autoscaling_enabled": true
          },
          "settings": {
            "snapshot": {
              "repository": {
                "static": {
                  "repository_type": "string",
                  "settings": {}
                },
                "reference": {
                  "repository_name": "string"
                },
                "default": {}
              },
              "interval": "string",
              "pending_interval": "string",
              "wait_time_after_snapshotting": "string",
              "enabled": true,
              "suspended": [
                "string"
              ],
              "retention": {
                "snapshots": 42,
                "max_age": "string"
              },
              "cron_expression": "string"
            },
            "monitoring": {
              "target_cluster_id": "string"
            },
            "metadata": {
              "name": "string",
              "owner_id": "string",
              "subscription_level": "string",
              "system_owned": true,
              "contact_email": "string",
              "resources": {
                "cpu": {
                  "boost": true,
                  "hard_limit": true
                }
              }
            },
            "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"
                    }
                  ]
                }
              ]
            },
            "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": [
              {
                "memory_per_node": 42,
                "node_count_per_zone": 42,
                "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_url": "string",
                    "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_url": "string",
                "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,
                "move_instances": [
                  {
                    "from": "string",
                    "to": [
                      "string"
                    ],
                    "instance_down": true
                  }
                ],
                "move_allocators": [
                  {
                    "from": "string",
                    "to": [
                      "string"
                    ],
                    "allocator_down": true
                  }
                ],
                "reallocate_instances": true,
                "preferred_allocators": [
                  "string"
                ],
                "preferred_allocator_tags": {
                  "additionalProperty1": "string",
                  "additionalProperty2": "string"
                },
                "extended_maintenance": true,
                "cluster_reboot": "forced",
                "override_failsafe": true
              }
            }
          },
          "settings": {
            "metadata": {
              "name": "string",
              "owner_id": "string",
              "subscription_level": "string",
              "system_owned": true,
              "contact_email": "string",
              "resources": {
                "cpu": {
                  "boost": true,
                  "hard_limit": true
                }
              }
            }
          }
        }
      ],
      "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_url": "string",
                    "kibana_url": "string",
                    "elasticsearch_username": "string",
                    "elasticsearch_password": "string",
                    "secret_token": "string",
                    "debug_enabled": true
                  },
                  "user_settings_json": {},
                  "user_settings_yaml": "string",
                  "user_settings_override_json": {},
                  "user_settings_override_yaml": "string"
                }
              }
            ],
            "apm": {
              "version": "string",
              "docker_image": "string",
              "system_settings": {
                "elasticsearch_url": "string",
                "kibana_url": "string",
                "elasticsearch_username": "string",
                "elasticsearch_password": "string",
                "secret_token": "string",
                "debug_enabled": true
              },
              "user_settings_json": {},
              "user_settings_yaml": "string",
              "user_settings_override_json": {},
              "user_settings_override_yaml": "string"
            },
            "transient": {
              "strategy": {
                "rolling": {
                  "group_by": "string",
                  "allow_inline_resize": true,
                  "skip_synced_flush": true,
                  "shard_init_wait_time": 42
                },
                "grow_and_shrink": {},
                "rolling_grow_and_shrink": {},
                "autodetect": {}
              },
              "plan_configuration": {
                "timeout": 42,
                "calm_wait_time": 42,
                "move_instances": [
                  {
                    "from": "string",
                    "to": [
                      "string"
                    ],
                    "instance_down": true
                  }
                ],
                "move_allocators": [
                  {
                    "from": "string",
                    "to": [
                      "string"
                    ],
                    "allocator_down": true
                  }
                ],
                "reallocate_instances": true,
                "preferred_allocators": [
                  "string"
                ],
                "preferred_allocator_tags": {
                  "additionalProperty1": "string",
                  "additionalProperty2": "string"
                },
                "extended_maintenance": true,
                "cluster_reboot": "forced",
                "override_failsafe": true
              }
            }
          },
          "settings": {
            "metadata": {
              "name": "string",
              "owner_id": "string",
              "subscription_level": "string",
              "system_owned": true,
              "contact_email": "string",
              "resources": {
                "cpu": {
                  "boost": true,
                  "hard_limit": true
                }
              }
            }
          }
        }
      ],
      "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"
                ],
                "preferred_allocator_tags": {
                  "additionalProperty1": "string",
                  "additionalProperty2": "string"
                },
                "extended_maintenance": true,
                "cluster_reboot": "forced",
                "override_failsafe": true
              }
            }
          },
          "settings": {
            "metadata": {
              "name": "string",
              "owner_id": "string",
              "subscription_level": "string",
              "system_owned": true,
              "contact_email": "string",
              "resources": {
                "cpu": {
                  "boost": true,
                  "hard_limit": true
                }
              }
            }
          }
        }
      ],
      "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_url": "string",
                    "elasticsearch_username": "string",
                    "elasticsearch_password": "string",
                    "secret_session_key": "string"
                  },
                  "user_settings_json": {},
                  "user_settings_yaml": "string",
                  "user_settings_override_json": {},
                  "user_settings_override_yaml": "string"
                },
                "allocator_filter": {},
                "node_configuration": "string",
                "memory_per_node": {},
                "node_count_per_zone": {}
              }
            ],
            "enterprise_search": {
              "version": "string",
              "docker_image": "string",
              "system_settings": {
                "elasticsearch_url": "string",
                "elasticsearch_username": "string",
                "elasticsearch_password": "string",
                "secret_session_key": "string"
              },
              "user_settings_json": {},
              "user_settings_yaml": "string",
              "user_settings_override_json": {},
              "user_settings_override_yaml": "string"
            },
            "transient": {
              "strategy": {
                "rolling": {
                  "group_by": "string",
                  "allow_inline_resize": true,
                  "skip_synced_flush": true,
                  "shard_init_wait_time": 42
                },
                "grow_and_shrink": {},
                "rolling_grow_and_shrink": {},
                "autodetect": {}
              },
              "plan_configuration": {
                "timeout": 42,
                "calm_wait_time": 42,
                "move_instances": [
                  {
                    "from": "string",
                    "to": [
                      "string"
                    ],
                    "instance_down": true
                  }
                ],
                "move_allocators": [
                  {
                    "from": "string",
                    "to": [
                      "string"
                    ],
                    "allocator_down": true
                  }
                ],
                "reallocate_instances": true,
                "preferred_allocators": [
                  "string"
                ],
                "preferred_allocator_tags": {
                  "additionalProperty1": "string",
                  "additionalProperty2": "string"
                },
                "extended_maintenance": true,
                "cluster_reboot": "forced",
                "override_failsafe": true
              }
            }
          },
          "settings": {
            "metadata": {
              "name": "string",
              "owner_id": "string",
              "subscription_level": "string",
              "system_owned": true,
              "contact_email": "string",
              "resources": {
                "cpu": {
                  "boost": true,
                  "hard_limit": true
                }
              }
            }
          }
        }
      ],
      "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_url": "string",
                    "kibana_url": "string",
                    "elasticsearch_username": "string",
                    "elasticsearch_password": "string",
                    "secret_token": "string",
                    "debug_enabled": true
                  },
                  "user_settings_json": {},
                  "user_settings_yaml": "string",
                  "user_settings_override_json": {},
                  "user_settings_override_yaml": "string",
                  "mode": "standalone"
                }
              }
            ],
            "integrations_server": {
              "version": "string",
              "docker_image": "string",
              "system_settings": {
                "elasticsearch_url": "string",
                "kibana_url": "string",
                "elasticsearch_username": "string",
                "elasticsearch_password": "string",
                "secret_token": "string",
                "debug_enabled": true
              },
              "user_settings_json": {},
              "user_settings_yaml": "string",
              "user_settings_override_json": {},
              "user_settings_override_yaml": "string",
              "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,
                "move_instances": [
                  {
                    "from": "string",
                    "to": [
                      "string"
                    ],
                    "instance_down": true
                  }
                ],
                "move_allocators": [
                  {
                    "from": "string",
                    "to": [
                      "string"
                    ],
                    "allocator_down": true
                  }
                ],
                "reallocate_instances": true,
                "preferred_allocators": [
                  "string"
                ],
                "preferred_allocator_tags": {
                  "additionalProperty1": "string",
                  "additionalProperty2": "string"
                },
                "extended_maintenance": true,
                "cluster_reboot": "forced",
                "override_failsafe": true
              }
            }
          },
          "settings": {
            "metadata": {
              "name": "string",
              "owner_id": "string",
              "subscription_level": "string",
              "system_owned": true,
              "contact_email": "string",
              "resources": {
                "cpu": {
                  "boost": true,
                  "hard_limit": true
                }
              }
            }
          }
        }
      ]
    },
    "settings": {
      "traffic_filter_settings": {
        "rulesets": [
          "string"
        ]
      },
      "observability": {
        "logging": {
          "destination": {
            "deployment_id": "string",
            "ref_id": "string"
          }
        },
        "metrics": {
          "destination": {
            "deployment_id": "string",
            "ref_id": "string"
          },
          "force_legacy_monitoring": true
        }
      },
      "autoscaling_enabled": true
    },
    "metadata": {
      "system_owned": true,
      "tags": [
        {
          "key": "string",
          "value": "string"
        }
      ]
    },
    "alias": "string",
    "region": "string",
    "version": "string"
  },
  "system_owned": true,
  "metadata": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "order": 42,
  "hidden": true,
  "min_version": "string",
  "template_category_id": "string",
  "kibana_deeplink": [
    {
      "semver": "string",
      "uri": "string"
    }
  ]
}
Response examples (200)
{
  "id": "string"
}
Response examples (201)
{
  "id": "string"
}
Response examples (400)
# Headers
x-cloud-error-codes: templates.region_not_found

# Payload
{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}
Response examples (401)
# Headers
x-cloud-error-codes: templates.region_not_allowed

# Payload
{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}

Get deployment template

GET /deployments/templates/{template_id}

Retrieves a deployment template by id.

Path parameters

  • template_id string Required

    The identifier for the deployment template.

Query parameters

  • If true, will return details for each instance configuration referenced by the template.

    Default value is true.

  • If true, will populate the max_zones field in the instance configurations. Only relevant if show_instance_configurations=true.

    Default value is false.

  • If present, it will cause the returned deployment template to be adapted to return only the elements allowed in that version.

  • region string Required

    Region of the deployment template

Responses

  • The deployment template was found and returned successfully.

    Hide response attributes Show response attributes object
    • id string Required

      The unique identifier for the template.

    • name string Required

      A human readable name for the template.

    • An optional description for the template.

    • deployment_template object Required

      A request for creating a new Deployment consisting of multiple clusters

      Additional properties are allowed.

      Hide deployment_template attributes Show deployment_template attributes object
      • name string

        A name for the deployment; otherwise this will be the generated deployment id

      • The Resources that will belong to this Deployment

        Additional properties are allowed.

        Hide resources attributes Show resources attributes object
        • elasticsearch array[object]

          A list of payloads for Elasticsearch cluster creation.

          Hide elasticsearch attributes Show elasticsearch attributes object
          • ref_id string Required

            A locally-unique user-specified id for this Elasticsearch cluster

          • 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 building this Elasticsearch cluster

            Additional properties are allowed.

            Hide plan attributes Show plan attributes object
            • cluster_topology array[object] Required
              Hide cluster_topology attributes Show cluster_topology attributes object
              • id string

                Unique identifier of this topology element

              • Controls the combinations of Elasticsearch node types. TIP: By default, the Elasticsearch node is master eligible, can hold data, and run ingest pipelines. WARNING: Do not set for tiebreaker topologies.

                Additional properties are allowed.

                Hide node_type attributes Show node_type attributes object
                • master boolean

                  Defines whether this node can be elected master (default: false)

                • data boolean

                  Defines whether this node can hold data (default: false)

                • ingest boolean

                  Defines whether this node can run an ingest pipeline (default: false)

                • ml boolean

                  Defines whether this node can run ml jobs, valid only for versions 5.4.0 or greater (default: false)

              • node_roles array[string]

                The list of node roles for this topology element (ES version >= 7.10). Allowable values are: master, ingest, ml, data_hot, data_content, data_warm, data_cold, data_frozen, remote_cluster_client, transform

                Values are master, ingest, ml, data_hot, data_content, data_warm, data_cold, data_frozen, remote_cluster_client, or transform.

              • memory_per_node integer(int32)

                The memory capacity in MB for each node of this type built in each zone.

              • node_count_per_zone integer(int32)

                The number of nodes of this type that are allocated within each zone. (i.e. total capacity per zone = node_count_per_zone * memory_per_node in MB). Cannot be set for tiebreaker topologies. For dedicated master nodes, must be 1 if an entry exists.

              • zone_count integer(int32)

                The default number of zones in which data nodes will be placed

              • The Elasticsearch cluster settings. When specified at the top level, provides a field-by-field default. When specified at the topology level, provides the override settings.

                Additional properties are allowed.

                Hide elasticsearch attributes Show elasticsearch attributes object
                • version string

                  The version of the Elasticsearch cluster (must be one of the ECE supported versions). Currently cannot be different across the topology (and is generally specified in the globals). Defaults to the latest version if not specified.

                • A docker URI that allows overriding of the default docker image specified for this version

                • A subset of Elasticsearch settings. TIP: To define the complete set of Elasticsearch settings, use ElasticsearchSystemSettings with user_settings_override* and user_settings*.

                  Additional properties are allowed.

                  Hide system_settings attributes Show system_settings attributes object
                  • Controls the languages supported by the Elasticsearch cluster, such as Painless, Mustache, and Expressions. Controls how the languages are used, such as file, index, and inline. TIP: For complex configurations, leave these blank and configure these settings in the user YAML or JSON.

                    Additional properties are allowed.

                    Hide scripting attributes Show scripting attributes object
                    • (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]')

                    • (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]')

                    • (5.x+ only) If enabled (the default) then the expressions scripting engine is allowed as a sandboxed language. Sandboxed languages are the only ones allowed if 'sandbox_mode' is set to true. NOTES: (Corresponds to the parameters 'script.engine.expression.[file|stored|inline]')

                    • stored object

                      Enables scripting for the specified type and controls other parameters. Store scripts in indexes (stored), upload in file bundles (file), or use in API requests (inline).

                      Additional properties are allowed.

                      Hide stored attributes Show stored attributes object
                      • enabled boolean

                        If enabled (default: true) then scripts are enabled, either for sandboxing languages (by default), or for all installed languages if 'sandbox_mode' is disabled (or for 6.x). NOTES: (Corresponds to the parameter 'script.file|stored/indexed|inline')

                      • If enabled (default: true) and this script type is enabled, then only the sandbox languages are allowed. By default the sandbox languages are painless, expressions and mustache, but this can be restricted via the 'painless_enabled', 'mustache_enabled' 'expression_enabled' settings.NOTES: Not supported in 6.x. (Corresponds to the parameters 'script.engine.[painless|mustache|expressions].[file|stored|inline]')

                    • file object

                      Enables scripting for the specified type and controls other parameters. Store scripts in indexes (stored), upload in file bundles (file), or use in API requests (inline).

                      Additional properties are allowed.

                      Hide file attributes Show file attributes object
                      • enabled boolean

                        If enabled (default: true) then scripts are enabled, either for sandboxing languages (by default), or for all installed languages if 'sandbox_mode' is disabled (or for 6.x). NOTES: (Corresponds to the parameter 'script.file|stored/indexed|inline')

                      • If enabled (default: true) and this script type is enabled, then only the sandbox languages are allowed. By default the sandbox languages are painless, expressions and mustache, but this can be restricted via the 'painless_enabled', 'mustache_enabled' 'expression_enabled' settings.NOTES: Not supported in 6.x. (Corresponds to the parameters 'script.engine.[painless|mustache|expressions].[file|stored|inline]')

                    • inline object

                      Enables scripting for the specified type and controls other parameters. Store scripts in indexes (stored), upload in file bundles (file), or use in API requests (inline).

                      Additional properties are allowed.

                      Hide inline attributes Show inline attributes object
                      • enabled boolean

                        If enabled (default: true) then scripts are enabled, either for sandboxing languages (by default), or for all installed languages if 'sandbox_mode' is disabled (or for 6.x). NOTES: (Corresponds to the parameter 'script.file|stored/indexed|inline')

                      • 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

                  • 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')

                  • 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')

                  • 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')

                  • 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.)

                  • (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)

                  • 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)

                  • 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')

                • An arbitrary JSON object allowing cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters arey are on the allowlist and not on the denylist. NOTES: (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Elasticsearch settings)

                  Additional properties are allowed.

                • 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)

                • An arbitrary JSON object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), ie in addition to the documented 'system_settings'. NOTES: (This field together with 'system_settings' and 'user_settings*' defines the total set of Elasticsearch settings)

                  Additional properties are allowed.

                • 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)

                • A list of plugin names from the Elastic-supported subset that are bundled with the version images. NOTES: (Users should consult the Elastic stack objects to see what plugins are available, this is currently only available from the UI)

                • user_plugins array[object]

                  A list of admin-uploaded plugin objects that are available for this user.

                  Hide user_plugins attributes Show user_plugins attributes object
                  • name string Required

                    The name of the plugin

                  • url string Required

                    The URL of the plugin (must be accessible from the ECE infrastructure)

                  • elasticsearch_version string Required

                    The supported Elasticsearch version (must match the version in the plan)

                • user_bundles array[object]

                  A list of admin-uploaded bundle objects (eg scripts, synonym files) that are available for this user.

                  Hide user_bundles attributes Show user_bundles attributes object
                  • name string Required

                    The name of the bundle

                  • url string Required

                    The URL of the bundle, which must be accessible from the ECE infrastructure. This URL could be cached by platform, make sure to change it when updating the bundle

                  • elasticsearch_version string Required

                    The supported Elasticsearch version (must match the version in the plan)

                • curation object

                  Defines the index curation routing for the cluster

                  Additional properties are allowed.

                  Hide curation attributes Show curation attributes object
                • Defines the Elasticsearch node attributes for the instances in the topology

                  Hide node_attributes attribute Show node_attributes attribute object
                  • * string Additional properties
              • 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.

              • The version of the Instance Configuration Id. If it is unset, the meaning depends on read vs writes. For deployment reads, it is equivalent to version 0 (or the IC is unversioned); for deployment creates and deployment template use, it is equivalent to 'the latest version'; and for deployment updates, it is equivalent to 'retain the current version'.

              • size object

                Measured by the amount of a resource. The final cluster size is calculated using multipliers from the topology instance configuration.

                Additional properties are allowed.

                Hide size attributes Show size attributes object
                • value integer(int32) Required

                  Amount of resource

                • resource string Required

                  Type of resource

                  Values are memory or storage.

              • Measured by the amount of a resource. The final cluster size is calculated using multipliers from the topology instance configuration.

                Additional properties are allowed.

                Hide autoscaling_min attributes Show autoscaling_min attributes object
                • value integer(int32) Required

                  Amount of resource

                • resource string Required

                  Type of resource

                  Values are memory or storage.

              • Measured by the amount of a resource. The final cluster size is calculated using multipliers from the topology instance configuration.

                Additional properties are allowed.

                Hide autoscaling_max attributes Show autoscaling_max attributes object
                • value integer(int32) Required

                  Amount of resource

                • resource string Required

                  Type of resource

                  Values are memory or storage.

              • An arbitrary JSON object overriding the default autoscaling policy. Don't set unless you really know what you are doing.

                Additional properties are allowed.

              • Controls for the topology element. Only used as part of the deployment template. Ignored if included as part of a deployment.

                Additional properties are allowed.

                Hide topology_element_control attribute Show topology_element_control attribute object
                • min object Required

                  Measured by the amount of a resource. The final cluster size is calculated using multipliers from the topology instance configuration.

                  Additional properties are allowed.

                  Hide min attributes Show min attributes object
                  • value integer(int32) Required

                    Amount of resource

                  • resource string Required

                    Type of resource

                    Values are memory or storage.

              • Set to true to enable autoscaling for this topology element, even if the cluster-level 'autoscaling_enabled' field is false. Note that 'autoscaling_tier_override' cannot be set to false if cluster-level 'autoscaling_enabled' is true. Currently only supported for the 'ml' tier

            • elasticsearch object Required

              The Elasticsearch cluster settings. When specified at the top level, provides a field-by-field default. When specified at the topology level, provides the override settings.

              Additional properties are allowed.

              Hide elasticsearch attributes Show elasticsearch attributes object
              • version string

                The version of the Elasticsearch cluster (must be one of the ECE supported versions). Currently cannot be different across the topology (and is generally specified in the globals). Defaults to the latest version if not specified.

              • A docker URI that allows overriding of the default docker image specified for this version

              • A subset of Elasticsearch settings. TIP: To define the complete set of Elasticsearch settings, use ElasticsearchSystemSettings with user_settings_override* and user_settings*.

                Additional properties are allowed.

                Hide system_settings attributes Show system_settings attributes object
                • Controls the languages supported by the Elasticsearch cluster, such as Painless, Mustache, and Expressions. Controls how the languages are used, such as file, index, and inline. TIP: For complex configurations, leave these blank and configure these settings in the user YAML or JSON.

                  Additional properties are allowed.

                  Hide scripting attributes Show scripting attributes object
                  • (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]')

                  • (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]')

                  • (5.x+ only) If enabled (the default) then the expressions scripting engine is allowed as a sandboxed language. Sandboxed languages are the only ones allowed if 'sandbox_mode' is set to true. NOTES: (Corresponds to the parameters 'script.engine.expression.[file|stored|inline]')

                  • stored object

                    Enables scripting for the specified type and controls other parameters. Store scripts in indexes (stored), upload in file bundles (file), or use in API requests (inline).

                    Additional properties are allowed.

                    Hide stored attributes Show stored attributes object
                    • enabled boolean

                      If enabled (default: true) then scripts are enabled, either for sandboxing languages (by default), or for all installed languages if 'sandbox_mode' is disabled (or for 6.x). NOTES: (Corresponds to the parameter 'script.file|stored/indexed|inline')

                    • If enabled (default: true) and this script type is enabled, then only the sandbox languages are allowed. By default the sandbox languages are painless, expressions and mustache, but this can be restricted via the 'painless_enabled', 'mustache_enabled' 'expression_enabled' settings.NOTES: Not supported in 6.x. (Corresponds to the parameters 'script.engine.[painless|mustache|expressions].[file|stored|inline]')

                  • file object

                    Enables scripting for the specified type and controls other parameters. Store scripts in indexes (stored), upload in file bundles (file), or use in API requests (inline).

                    Additional properties are allowed.

                    Hide file attributes Show file attributes object
                    • enabled boolean

                      If enabled (default: true) then scripts are enabled, either for sandboxing languages (by default), or for all installed languages if 'sandbox_mode' is disabled (or for 6.x). NOTES: (Corresponds to the parameter 'script.file|stored/indexed|inline')

                    • If enabled (default: true) and this script type is enabled, then only the sandbox languages are allowed. By default the sandbox languages are painless, expressions and mustache, but this can be restricted via the 'painless_enabled', 'mustache_enabled' 'expression_enabled' settings.NOTES: Not supported in 6.x. (Corresponds to the parameters 'script.engine.[painless|mustache|expressions].[file|stored|inline]')

                  • inline object

                    Enables scripting for the specified type and controls other parameters. Store scripts in indexes (stored), upload in file bundles (file), or use in API requests (inline).

                    Additional properties are allowed.

                    Hide inline attributes Show inline attributes object
                    • enabled boolean

                      If enabled (default: true) then scripts are enabled, either for sandboxing languages (by default), or for all installed languages if 'sandbox_mode' is disabled (or for 6.x). NOTES: (Corresponds to the parameter 'script.file|stored/indexed|inline')

                    • 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

                • 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')

                • 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')

                • 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')

                • 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.)

                • (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)

                • 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)

                • 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')

              • An arbitrary JSON object allowing cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters arey are on the allowlist and not on the denylist. NOTES: (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Elasticsearch settings)

                Additional properties are allowed.

              • 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)

              • An arbitrary JSON object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), ie in addition to the documented 'system_settings'. NOTES: (This field together with 'system_settings' and 'user_settings*' defines the total set of Elasticsearch settings)

                Additional properties are allowed.

              • 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)

              • A list of plugin names from the Elastic-supported subset that are bundled with the version images. NOTES: (Users should consult the Elastic stack objects to see what plugins are available, this is currently only available from the UI)

              • user_plugins array[object]

                A list of admin-uploaded plugin objects that are available for this user.

                Hide user_plugins attributes Show user_plugins attributes object
                • name string Required

                  The name of the plugin

                • url string Required

                  The URL of the plugin (must be accessible from the ECE infrastructure)

                • elasticsearch_version string Required

                  The supported Elasticsearch version (must match the version in the plan)

              • user_bundles array[object]

                A list of admin-uploaded bundle objects (eg scripts, synonym files) that are available for this user.

                Hide user_bundles attributes Show user_bundles attributes object
                • name string Required

                  The name of the bundle

                • url string Required

                  The URL of the bundle, which must be accessible from the ECE infrastructure. This URL could be cached by platform, make sure to change it when updating the bundle

                • elasticsearch_version string Required

                  The supported Elasticsearch version (must match the version in the plan)

              • curation object

                Defines the index curation routing for the cluster

                Additional properties are allowed.

                Hide curation attributes Show curation attributes object
              • Defines the Elasticsearch node attributes for the instances in the topology

                Hide node_attributes attribute Show node_attributes attribute object
                • * string Additional properties
            • Documents which deployment template was used in the creation of this plan

              Additional properties are allowed.

              Hide deployment_template attributes Show deployment_template attributes object
              • id string Required

                The unique identifier of the deployment template

              • version string

                A version identifier to disambiguate multiple revisions of the same template

            • Defines the configuration parameters that control how the plan is applied. For example, the Elasticsearch cluster topology and Elasticsearch settings.

              Additional properties are allowed.

              Hide transient attributes Show transient attributes object
              • strategy object

                The options for performing a plan change. Specify only one property each time. The default is grow_and_shrink.

                Additional properties are allowed.

                Hide strategy attributes Show strategy attributes object
                • rolling object

                  Performs inline, rolling configuration changes that mutate existing containers. TIP: This is the fastest way to update a plan, but can fail for complex plan changes, such as topology changes. Also, this is less safe for configuration changes that leave a cluster in a non running state. NOTE: When you perform a major version upgrade, and 'group_by' is set to 'pass:macros[all]';, rolling is required.

                  Additional properties are allowed.

                  Hide rolling attributes Show rolling attributes object
                  • group_by string

                    Specifies the grouping attribute to use when rolling several instances. Instances that share the same value for the provided attribute key are rolled together as a unit. Examples that make sense to use are '__all__' (roll all instances as a single unit), 'logical_zone_name' (roll instances by zone), '__name__' (roll one instance at a time, the default if not specified). Note that '__all__' is required when performing a major version upgrade

                  • 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

                  • 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)

                • A strategy that creates instances with the new plan, migrates data from the old instances, then shuts down the old instances. GrowShrinkStrategyConfig is safer than 'rolling' and ensures single node availability during a plan change, but can be a lot slower on larger clusters.

                  Additional properties are allowed.

                • A strategy that creates new Elasticsearch instances, Kibana instances, and APM Servers with the new plan, then migrates the node data to minimize the amount of spare capacity.

                  Additional properties are allowed.

                • A strategy that lets constructor choose the most optimal way to execute the plan.

                  Additional properties are allowed.

              • The configuration settings for the timeout and fallback parameters.

                Additional properties are allowed.

                Hide plan_configuration attributes Show plan_configuration attributes object
                • timeout integer(int64)

                  The total timeout in seconds after which the plan is cancelled even if it is not complete. Defaults to 4x the max memory capacity per node (in MB). NOTES: A 3 zone cluster with 2 nodes of 2048 each would have a timeout of 4*2048=8192 seconds. Timeout does not include time required to run rollback actions.

                • calm_wait_time integer(int64)

                  This timeout determines how long to give a cluster after it responds to API calls before performing actual operations on it. It defaults to 5s

                • move_instances array[object]
                  Hide move_instances attributes Show move_instances attributes object
                  • from string Required

                    The instance id that is going to be moved

                  • to array[string]

                    An optional list of allocator ids to which the instance should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)

                  • Tells the infrastructure that the instance should be considered as permanently down when deciding how to migrate data to new nodes. If left blank then the system will automatically decide (currently: will treat the instances as up)

                • move_allocators array[object]
                  Hide move_allocators attributes Show move_allocators attributes object
                  • from string Required

                    The allocator id off which all instances in the cluster should be moved

                  • to array[string]

                    An optional list of allocator ids to which the instance(s) should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)

                  • 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)

                • move_only boolean

                  If true (default: false) only move_instances and move_allocators instructions will be executed, all other changes will be ignored

                • If true (default: false) does not allow re-using any existing instances currently in the cluster, ie even unchanged instances will be re-created

                • List of allocators on which instances are placed if possible (if not possible/not specified then any available allocator with space is used)

                • Map containing allocators tags in form of key value pairs, increasing the likelihood during move requests for allocators with matching tags, to be selected as target allocators

                  Hide preferred_allocator_tags attribute Show preferred_allocator_tags attribute object
                  • * string Additional properties
                • If true (default: false), does not take (or require) a successful snapshot to be taken before performing any potentially destructive changes to this cluster

                • 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

                • 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

                • 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.

                • If false (the default) then the plan will fail out if it believes the requested sequence of operations can result in data loss - this flag will override some of these restraints

                • If true (default: false) then the plan will not wait for data to be migrated from old instances to new instances before continuing the plan (potentially deleting the old instances and losing data)

                • If false, the cluster is checked for issues that should be resolved before migration (eg contains old Lucene segments), if true this is bypassed

                • If false (the default), the cluster will run (currently) 2.x->5.x operations for any plan change ending with a 5.x cluster (eg apply a cluster license, ensure Monitoring is configured)

                • If false (the default), the cluster will perform a snapshot after a major version upgrade takes place

              • Restores a snapshot from a local or remote repository.

                Additional properties are allowed.

                Hide restore_snapshot attributes Show restore_snapshot attributes object
                • 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

                • Raw remote snapshot restore settings. Do not send this if you are sending source_cluster_id

                  Additional properties are allowed.

                  Hide repository_config attribute Show repository_config attribute object
                  • The remote snapshot settings raw JSON - see the Elasticsearch '_snapshot' documentation for more details on supported formats

                    Additional properties are allowed.

                • The configuration for the restore command, such as which indices you want to restore.

                  Additional properties are allowed.

                  Hide restore_payload attributes Show restore_payload attributes object
                  • indices array[string]

                    The list of indices to restore (supports +ve and -ve selection and wildcarding - see the default Elasticsearch index format documentation)

                  • This JSON object (merged with the 'indices' field (if present) is passed untouched into the restore command - see the Elasticsearch '_snapshot' documentation for more details on supported formats

                    Additional properties are allowed.

                • strategy string

                  The restore strategy to use. Defaults to a full restore. Partial restore will attempt to restore unavailable indices only

                  Values are partial, full, or recovery.

                • If specified, contains the name of the source cluster id. Do not send this if you are sending repository_config

              • The list of resources that will be configured as remote clusters

                Additional properties are allowed.

                Hide remote_clusters attribute Show remote_clusters attribute object
                • resources array[object] Required

                  The remote resources

                  Hide resources attributes Show resources attributes object
                  • deployment_id string Required

                    The id of the deployment

                  • elasticsearch_ref_id string Required

                    The locally-unique user-specified id of an Elasticsearch Resource

                  • alias string Required

                    The alias for this remote cluster. Aliases must only contain letters, digits, dashes and underscores

                  • If true, skip this cluster during search if it is disconnected. Default: false

                  • info object

                    Information about a Remote Cluster.

                    Additional properties are allowed.

                    Hide info attributes Show info attributes object
                    • healthy boolean Required

                      Whether or not the remote cluster is healthy

                    • connected boolean Required

                      Whether or not there is at least one connection to the remote cluster.

                    • compatible boolean Required

                      Whether or not the remote cluster version is compatible with this cluster version.

                    • trusted boolean Required

                      Whether or not the remote cluster is trusted by this cluster.

                    • trusted_back boolean Required

                      Whether or not the remote cluster trusts this cluster back.

              • If specified, contains transient settings to be applied to an Elasticsearch cluster during changes,default values shown below applied. These can be overridden by specifying them in the map (or null to unset). Additional settings can also be set. Settings will be cleared after the plan has finished. If not specified, no settings will be applied. NOTE: These settings are only explicitly cleared for 5.x+ clusters, they must be hand-reset to their defaults in 2.x- (or a cluster reboot will clear them).

                • indices.store.throttle.max_bytes_per_sec: 120Mb
                • indices.recovery.max_bytes_per_sec: 120Mb
                • cluster.routing.allocation.cluster_concurrent_rebalance: 5
                • cluster.routing.allocation.node_initial_primaries_recoveries: 5
                • cluster.routing.allocation.node_concurrent_incoming_recoveries: 5 For version 8.1 and later no defaults are provided through this mechanism, but instead hardware dependent settings are provided to each instance.

                Additional properties are allowed.

            • Enable autoscaling for this Elasticsearch cluster.

          • settings object

            The settings for building this Elasticsearch cluster

            Additional properties are allowed.

            Hide settings attributes Show settings attributes object
            • snapshot object

              The snapshot settings for this deployment. When provided, snapshot settings are changed as specified. A null value reverts the field to the default value. Otherwise, all snapshot settings remain as they were set previously.

              Additional properties are allowed.

              Hide snapshot attributes Show snapshot attributes object
              • Snapshot repository configuration

                Additional properties are allowed.

                Hide repository attributes Show repository attributes object
                • static object

                  Cluster snapshot static repository settings, containing repository type and settings

                  Additional properties are allowed.

                  Hide static attributes Show static attributes object
                  • Type of snapshot repository, ie: S3

                  • settings object

                    Settings associated with snapshot repository

                    Additional properties are allowed.

                • Cluster snapshot reference repository settings, containing the repository name in ECE fashion

                  Additional properties are allowed.

                  Hide reference attribute Show reference attribute object
                  • ECE snapshot repository name, from the '/platform/configuration/snapshots/repositories' endpoint

                • default object

                  Cluster snapshot default repository settings

                  Additional properties are allowed.

              • 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

              • Interval between snapshot progress checks, with the format 'length unit' (space is optional), where unit can be one of: d (day), h (hour), min (minute). Default is 1 minute

              • The time to wait between snapshot phases (snapshot, purge), with the format 'length unit' (space is optional), where unit can be one of: d (day), h (hour), min (minute). Default is 10 minutes

              • enabled boolean

                Indicates if Snapshotting is enabled

              • suspended array[string]

                List of temporary snapshot suspensions

              • Cluster snapshot retention information

                Additional properties are allowed.

                Hide retention attributes Show retention attributes object
                • snapshots integer(int32)

                  Number of snapshots to retain

                • max_age string

                  Total retention period for all snapshots, with the format 'length unit' (space is optional), where unit can be one of: d (day), h (hour), min (minute)

              • slm boolean

                When set to true, the deployment will have SLM enabled. Default value is true.

              • Cron expression indicating when should snapshots be taken. This can be enabled only if SLM is enabled for the deployment and 'interval' is not present

            • The monitoring settings for this deployment. When provided, monitoring settings are changed as specified. A null value reverts the field to the default value. Otherwise, all monitoring settings remain as they were set previously.

              Additional properties are allowed.

              Hide monitoring attribute Show monitoring attribute object
              • target_cluster_id string Required

                The Id of the target cluster to which to send monitoring information

            • metadata object

              The top-level configuration settings for the Elasticsearch cluster.

              Additional properties are allowed.

              Hide metadata attributes Show metadata attributes object
              • name string

                The display name of the cluster

              • owner_id string

                The user id (referencing whatever user database is in use) of the cluster owner

              • The organization that owns the deployment

              • Subscription level of the cluster

              • Indicates if a cluster is system owned (restricts the set of operations that can be performed on it)

              • Contact email for the cluster

              • hidden boolean

                Whether or not this cluster is hidden from the normal clusters list

              • The top-level configuration settings for the Elasticsearch cluster resources.

                Additional properties are allowed.

                Hide resources attribute Show resources attribute object
                • cpu object

                  Specifies the CPU resource settings for the Elasticsearch cluster.

                  Additional properties are allowed.

                  Hide cpu attributes Show cpu attributes object
                  • boost boolean

                    Indicates if the CPU boost flag is enabled or not.

                  • hard_limit boolean

                    Indicates if the CPU hard limit flag is enabled or not. When set to true (default), allocates CPU timeshare based on the total CPU time multiplied by the relative RAM capacity of the instance on a given host. When set to false, delegates CPU allocation to the operating system to schedule CPU timeshares.

            • curation object

              The curation settings for this deployment. When provided, curation settings are changed as specified. A null value reverts the field to the default value. Otherwise, all curation settings remain as they were set previously.

              Additional properties are allowed.

              Hide curation attribute Show curation attribute object
              • specs array[object] Required

                Specifications for curation

                Hide specs attributes Show specs attributes object
            • 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.

            • The rulesets to apply to all resources in this cluster. When specified, the set of rulesets is updated and the same rulesets will be applied to Kibana and APM clusters as well. If not specified, the rulesets remain as they were set previously.

              Additional properties are allowed.

              Hide traffic_filter attribute Show traffic_filter attribute object
              • rulesets array[string] Required

                IDs of the traffic filter rulesets

            • trust object

              Configuration of trust with other clusters. When provided, trust settings are changed as specified. A null value reverts the field to the default value. Otherwise, all trust settings remain as they were set previously.

              Additional properties are allowed.

              Hide trust attributes Show trust attributes object
              • accounts array[object]

                The list of trust relationships with different accounts

                Hide accounts attributes Show accounts attributes object
                • account_id string Required

                  the ID of the Account

                • name string

                  A human readable name of the trust relationship

                • trust_all boolean Required

                  If true, all clusters in this account will by default be trusted and the trust_allowlist is ignored.

                • trust_allowlist array[string]

                  The list of clusters to trust. Only used when trust_all is false.

              • external array[object]

                The list of trust relationships with external entities

                Hide external attributes Show external attributes object
                • trust_relationship_id string Required

                  The ID of the external trust relationship

                • name string

                  The name of the external trust relationship. Retrieved from the TrustRelationship and ignored on write.

                • trust_all boolean Required

                  If true, all clusters in this external entity will be trusted and the trust_allowlist is ignored.

                • trust_allowlist array[string]

                  The list of clusters to trust. Only used when trust_all is false.

              • direct array[object]

                The list of trust relationships where the certificate is bundled with the trust setting. Allows configuring trust for clusters running outside of an Elastic Cloud managed environment or in an Elastic Cloud environment without an environment level trust established.

                Hide direct attributes Show direct attributes object
                • uid string

                  Auto generated identifier for this trust, allows distinguishing between update vs remove and add.

                • name string Required

                  a human readable name of the trust relationship

                • type string

                  The type can either be ESS, ECE, generic or proxy. If none is specified, then generic is assumed. If proxy is specified, trust_all should be false and trust_allowlist, scope_id and additional_node_names should be omitted.

                  Values are ECE, ESS, generic, or proxy.

                • trust_all boolean Required

                  If true, scope_id is required and the trust_allowlist is ignored and all clusters matching the scope id will be trusted.

                • trust_allowlist array[string]

                  The list of clusters with matching scope to trust. Only used when trust_all is false. Providing one or more clusters makes scope_id mandatory.

                • scope_id string

                  A lowercase alphanumerical string of max 32 characters. Usually an organization id or an environment id, but could really be any suitable suffix for clusters using the CA certificate of this trust. Required unless trust_all is false and trust_allowlist is empty.

                • A list of node names trusted in addition to those deducible from trust_allowlist and scope id. Allows trusting nodes that don't have a scoped name at the cost of maintaining the list. Mandatory if scope id is not defined. Wildcards are not allowed.

                • certificates array[object] Required

                  The public ca certificate(s) to trust. Only one is required, but it is possible to specify multiple certificates in order to facilitate key rotation.

                  Hide certificates attributes Show certificates attributes object
                  • pem string Required

                    The public ca certificate as string in PEM format.

                  • metadata object

                    Metadata about the certificate, including fingerprint and expiry date. Generated by the Cloud service and ignored on write.

                    Additional properties are allowed.

                    Hide metadata attributes Show metadata attributes object
                    • fingerprint string Required

                      The fingerprint of the certificate

                    • valid_to string(date-time) Required

                      The expiry date of the certificate in UTC

                    • valid_from string(date-time) Required

                      The valid from date of the certificate in UTC

                    • also_trusted_by array[string]

                      Other deployments also trusting this certificate

            • The contents of the Elasticsearch keystore. It's a write only field.

              Additional properties are allowed.

              Hide keystore_contents attribute Show keystore_contents attribute object
              • secrets object Required

                List of secrets

                Hide secrets attribute Show secrets attribute object
                • * object Additional properties

                  The value that you configure for the Elasticsearch keystore secret.

                  Additional properties are allowed.

                  Hide * attributes Show * attributes object
                  • value object

                    Value of this setting. This can either be a string or a JSON object that is stored as a JSON string in the keystore. NOTE: When the keystore secret is unspecified, it is removed.

                    Additional properties are allowed.

                  • as_file boolean

                    Stores the keystore secret as a file. The default is false, which stores the keystore secret as string when value is a plain string, or true when value is an object.

        • kibana array[object]

          A list of payloads for Kibana creation.

          Hide kibana attributes Show kibana attributes object
          • ref_id string Required

            A locally-unique user-specified id for Kibana

          • Alias to the Elasticsearch Cluster to attach Kibana to

          • 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.

            Additional properties are allowed.

            Hide plan attributes Show plan attributes object
            • cluster_topology array[object]
              Hide cluster_topology attributes Show cluster_topology attributes object
              • memory_per_node integer(int32)

                The memory capacity in MB for each node of this type built in each zone.

              • node_count_per_zone integer(int32)

                The number of nodes of this type that are allocated within each zone (i.e. total capacity per zone = node_count_per_zone * memory_per_node in MB).

              • 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.

              • The version of the Instance Configuration Id. If it is unset, the meaning depends on read vs writes. For deployment reads, it is equivalent to version 0 (or the IC is unversioned); for deployment creates and deployment template use, it is equivalent to 'the latest version'; and for deployment updates, it is equivalent to 'retain the current version'.

              • size object

                Measured by the amount of a resource. The final cluster size is calculated using multipliers from the topology instance configuration.

                Additional properties are allowed.

                Hide size attributes Show size attributes object
                • value integer(int32) Required

                  Amount of resource

                • resource string Required

                  Type of resource

                  Values are memory or storage.

              • zone_count integer(int32)

                number of zones in which nodes will be placed

              • kibana object

                The Kibana instance settings. When specified at the top level, provides a field-by-field default. When specified at the topology level, provides the override settings.

                Additional properties are allowed.

                Hide kibana attributes Show kibana attributes object
                • version string

                  The version of the Kibana cluster (must be one of the ECE supported versions, and won't work unless it matches the Elasticsearch version. Leave blank to auto-detect version.)

                • A docker URI that allows overriding of the default docker image specified for this version

                • A subset of Kibana settings. TIP: To define the complete set of Elasticsearch settings, use KibanaSystemSettings with user_settings_override_ and user_settings_.

                  Additional properties are allowed.

                  Hide system_settings attributes Show system_settings attributes object
                  • DEPRECATED: Scheduled for removal in a future version of the API.

                    Optionally override the URL to which to send data (for advanced users only, if unspecified the system selects an internal URL)

                  • 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.

                  • 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.

                • An arbitrary JSON object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters are on the allowlist and not on the denylist. (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Kibana settings)

                  Additional properties are allowed.

                • 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)

                • An arbitrary JSON object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Kibana settings)

                  Additional properties are allowed.

                • An arbitrary YAML object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_json' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Kibana settings)

            • kibana object Required

              The Kibana instance settings. When specified at the top level, provides a field-by-field default. When specified at the topology level, provides the override settings.

              Additional properties are allowed.

              Hide kibana attributes Show kibana attributes object
              • version string

                The version of the Kibana cluster (must be one of the ECE supported versions, and won't work unless it matches the Elasticsearch version. Leave blank to auto-detect version.)

              • A docker URI that allows overriding of the default docker image specified for this version

              • A subset of Kibana settings. TIP: To define the complete set of Elasticsearch settings, use KibanaSystemSettings with user_settings_override_ and user_settings_.

                Additional properties are allowed.

                Hide system_settings attributes Show system_settings attributes object
                • DEPRECATED: Scheduled for removal in a future version of the API.

                  Optionally override the URL to which to send data (for advanced users only, if unspecified the system selects an internal URL)

                • 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.

                • 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.

              • An arbitrary JSON object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters are on the allowlist and not on the denylist. (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Kibana settings)

                Additional properties are allowed.

              • 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)

              • An arbitrary JSON object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Kibana settings)

                Additional properties are allowed.

              • 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)

            • Defines the configuration parameters that control how the plan is applied. For example, the Elasticsearch cluster topology and Kibana instance settings.

              Additional properties are allowed.

              Hide transient attributes Show transient attributes object
              • strategy object

                The options for performing a plan change. Specify only one property each time. The default is grow_and_shrink.

                Additional properties are allowed.

                Hide strategy attributes Show strategy attributes object
                • rolling object

                  Performs inline, rolling configuration changes that mutate existing containers. TIP: This is the fastest way to update a plan, but can fail for complex plan changes, such as topology changes. Also, this is less safe for configuration changes that leave a cluster in a non running state. NOTE: When you perform a major version upgrade, and 'group_by' is set to 'pass:macros[all]';, rolling is required.

                  Additional properties are allowed.

                  Hide rolling attributes Show rolling attributes object
                  • group_by string

                    Specifies the grouping attribute to use when rolling several instances. Instances that share the same value for the provided attribute key are rolled together as a unit. Examples that make sense to use are '__all__' (roll all instances as a single unit), 'logical_zone_name' (roll instances by zone), '__name__' (roll one instance at a time, the default if not specified). Note that '__all__' is required when performing a major version upgrade

                  • 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

                  • 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)

                • A strategy that creates instances with the new plan, migrates data from the old instances, then shuts down the old instances. GrowShrinkStrategyConfig is safer than 'rolling' and ensures single node availability during a plan change, but can be a lot slower on larger clusters.

                  Additional properties are allowed.

                • A strategy that creates new Elasticsearch instances, Kibana instances, and APM Servers with the new plan, then migrates the node data to minimize the amount of spare capacity.

                  Additional properties are allowed.

                • A strategy that lets constructor choose the most optimal way to execute the plan.

                  Additional properties are allowed.

              • The configuration settings for the timeout and fallback parameters.

                Additional properties are allowed.

                Hide plan_configuration attributes Show plan_configuration attributes object
                • timeout integer(int64)

                  The total timeout in seconds after which the plan is cancelled even if it is not complete. Defaults to 4x the max memory capacity per node (in MB)

                • calm_wait_time integer(int64)

                  This timeout determines how long to give a cluster after it responds to API calls before performing actual operations on it. It defaults to 5s

                • move_instances array[object]
                  Hide move_instances attributes Show move_instances attributes object
                  • from string Required

                    The instance id that is going to be moved

                  • to array[string]

                    An optional list of allocator ids to which the instance should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)

                  • Tells the infrastructure that the instance should be considered as permanently down when deciding how to migrate data to new nodes. If left blank then the system will automatically decide (currently: will treat the instances as up)

                • move_allocators array[object]
                  Hide move_allocators attributes Show move_allocators attributes object
                  • from string Required

                    The allocator id off which all instances in the cluster should be moved

                  • to array[string]

                    An optional list of allocator ids to which the instance(s) should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)

                  • 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)

                • If true (default: false) does not allow re-using any existing instances currently in the cluster, ie even unchanged instances will be re-created

                • List of allocators on which instances are placed if possible (if not possible/not specified then any available allocator with space is used)

                • Map containing allocators tags in form of key value pairs, increasing the likelihood during move requests for allocators with matching tags, to be selected as target allocators

                  Hide preferred_allocator_tags attribute Show preferred_allocator_tags attribute object
                  • * string Additional properties
                • 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

                • Set to 'forced' to force a reboot as part of the upgrade plan

                  Value is forced.

                • If false (the default), the plan fails if it determines that the request can result in unsafe operations. Setting this flag overrides some of these check restraints.

          • settings object

            The settings for building this Kibana cluster

            Additional properties are allowed.

            Hide settings attribute Show settings attribute object
            • metadata object

              The top-level configuration settings for the Elasticsearch cluster.

              Additional properties are allowed.

              Hide metadata attributes Show metadata attributes object
              • name string

                The display name of the cluster

              • owner_id string

                The user id (referencing whatever user database is in use) of the cluster owner

              • The organization that owns the deployment

              • Subscription level of the cluster

              • Indicates if a cluster is system owned (restricts the set of operations that can be performed on it)

              • Contact email for the cluster

              • hidden boolean

                Whether or not this cluster is hidden from the normal clusters list

              • The top-level configuration settings for the Elasticsearch cluster resources.

                Additional properties are allowed.

                Hide resources attribute Show resources attribute object
                • cpu object

                  Specifies the CPU resource settings for the Elasticsearch cluster.

                  Additional properties are allowed.

                  Hide cpu attributes Show cpu attributes object
                  • boost boolean

                    Indicates if the CPU boost flag is enabled or not.

                  • hard_limit boolean

                    Indicates if the CPU hard limit flag is enabled or not. When set to true (default), allocates CPU timeshare based on the total CPU time multiplied by the relative RAM capacity of the instance on a given host. When set to false, delegates CPU allocation to the operating system to schedule CPU timeshares.

        • apm array[object]

          A list of payloads for APM creation. WARNING: For stack versions 8.0.0 and higher the integrations_server payload should be used instead, as this field becomes deprecated.

          Hide apm attributes Show apm attributes object
          • ref_id string Required

            A locally-unique user-specified id for APM

          • Alias to the Elasticsearch Cluster to attach APM to

          • 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.

            Additional properties are allowed.

            Hide plan attributes Show plan attributes object
            • cluster_topology array[object]
              Hide cluster_topology attributes Show cluster_topology attributes object
              • 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.

              • The version of the Instance Configuration Id. If it is unset, the meaning depends on read vs writes. For deployment reads, it is equivalent to version 0 (or the IC is unversioned); for deployment creates and deployment template use, it is equivalent to 'the latest version'; and for deployment updates, it is equivalent to 'retain the current version'.

              • size object

                Measured by the amount of a resource. The final cluster size is calculated using multipliers from the topology instance configuration.

                Additional properties are allowed.

                Hide size attributes Show size attributes object
                • value integer(int32) Required

                  Amount of resource

                • resource string Required

                  Type of resource

                  Values are memory or storage.

              • zone_count integer(int32)

                number of zones in which nodes will be placed

              • apm object

                The configuration options for the APM Server.

                Additional properties are allowed.

                Hide apm attributes Show apm attributes object
                • version string

                  The version of the Apm cluster (must be one of the ECE supported versions, and won't work unless it matches the APM version. Leave blank to auto-detect version.)

                • A docker URI that allows overriding of the default docker image specified for this version

                • A structure that defines a curated subset of the APM Server settings. TIP: To define the complete set of APM Server setting, use ApmSystemSettings with user_settings_override_ and user_settings_.

                  Additional properties are allowed.

                  Hide system_settings attributes Show system_settings attributes object
                  • DEPRECATED: Scheduled for removal in a future version of the API.

                    Optionally override the URL to which to send data (for advanced users only, if unspecified the system selects an internal URL)

                  • DEPRECATED: Scheduled for removal in a future version of the API.

                    Optionally override the URL to which to send data (for advanced users only, if unspecified the system selects an internal URL)

                  • 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.

                  • 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.

                  • Optionally override the secret token within APM - defaults to the previously existing secretToken

                  • Optionally enable debug mode for APM servers - defaults false

                • An arbitrary JSON object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters are on the allowlist and not on the denylist. (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Apm settings)

                  Additional properties are allowed.

                • 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)

                • An arbitrary JSON object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Apm settings)

                  Additional properties are allowed.

                • An arbitrary YAML object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_json' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Apm settings)

            • apm object Required

              The configuration options for the APM Server.

              Additional properties are allowed.

              Hide apm attributes Show apm attributes object
              • version string

                The version of the Apm cluster (must be one of the ECE supported versions, and won't work unless it matches the APM version. Leave blank to auto-detect version.)

              • A docker URI that allows overriding of the default docker image specified for this version

              • A structure that defines a curated subset of the APM Server settings. TIP: To define the complete set of APM Server setting, use ApmSystemSettings with user_settings_override_ and user_settings_.

                Additional properties are allowed.

                Hide system_settings attributes Show system_settings attributes object
                • DEPRECATED: Scheduled for removal in a future version of the API.

                  Optionally override the URL to which to send data (for advanced users only, if unspecified the system selects an internal URL)

                • DEPRECATED: Scheduled for removal in a future version of the API.

                  Optionally override the URL to which to send data (for advanced users only, if unspecified the system selects an internal URL)

                • 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.

                • 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.

                • Optionally override the secret token within APM - defaults to the previously existing secretToken

                • Optionally enable debug mode for APM servers - defaults false

              • An arbitrary JSON object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters are on the allowlist and not on the denylist. (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Apm settings)

                Additional properties are allowed.

              • 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)

              • An arbitrary JSON object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Apm settings)

                Additional properties are allowed.

              • 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)

            • Defines the configuration parameters that control how the plan is applied. For example, the Elasticsearch cluster topology and APM Server settings.

              Additional properties are allowed.

              Hide transient attributes Show transient attributes object
              • strategy object

                The options for performing a plan change. Specify only one property each time. The default is grow_and_shrink.

                Additional properties are allowed.

                Hide strategy attributes Show strategy attributes object
                • rolling object

                  Performs inline, rolling configuration changes that mutate existing containers. TIP: This is the fastest way to update a plan, but can fail for complex plan changes, such as topology changes. Also, this is less safe for configuration changes that leave a cluster in a non running state. NOTE: When you perform a major version upgrade, and 'group_by' is set to 'pass:macros[all]';, rolling is required.

                  Additional properties are allowed.

                  Hide rolling attributes Show rolling attributes object
                  • group_by string

                    Specifies the grouping attribute to use when rolling several instances. Instances that share the same value for the provided attribute key are rolled together as a unit. Examples that make sense to use are '__all__' (roll all instances as a single unit), 'logical_zone_name' (roll instances by zone), '__name__' (roll one instance at a time, the default if not specified). Note that '__all__' is required when performing a major version upgrade

                  • 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

                  • 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)

                • A strategy that creates instances with the new plan, migrates data from the old instances, then shuts down the old instances. GrowShrinkStrategyConfig is safer than 'rolling' and ensures single node availability during a plan change, but can be a lot slower on larger clusters.

                  Additional properties are allowed.

                • A strategy that creates new Elasticsearch instances, Kibana instances, and APM Servers with the new plan, then migrates the node data to minimize the amount of spare capacity.

                  Additional properties are allowed.

                • A strategy that lets constructor choose the most optimal way to execute the plan.

                  Additional properties are allowed.

              • The plan control configuration options for the APM Server.

                Additional properties are allowed.

                Hide plan_configuration attributes Show plan_configuration attributes object
                • timeout integer(int64)

                  The total timeout in seconds after which the plan is cancelled even if it is not complete. Defaults to 4x the max memory capacity per node (in MB)

                • calm_wait_time integer(int64)

                  This timeout determines how long to give a cluster after it responds to API calls before performing actual operations on it. It defaults to 5s

                • move_instances array[object]
                  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)

                  • Tells the infrastructure that the instance should be considered as permanently down when deciding how to migrate data to new nodes. If left blank then the system will automatically decide (currently: will treat the instances as up)

                • move_allocators array[object]
                  Hide move_allocators attributes Show move_allocators attributes object
                  • from string Required

                    The allocator id off which all instances in the cluster should be moved

                  • to array[string]

                    An optional list of allocator ids to which the instance(s) should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)

                  • 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)

                • If true (default: false) does not allow re-using any existing instances currently in the cluster, ie even unchanged instances will be re-created

                • List of allocators on which instances are placed if possible (if not possible/not specified then any available allocator with space is used)

                • Map containing allocators tags in form of key value pairs, increasing the likelihood during move requests for allocators with matching tags, to be selected as target allocators

                  Hide preferred_allocator_tags attribute Show preferred_allocator_tags attribute object
                  • * string Additional properties
                • 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

                • Set to 'forced' to force a reboot as part of the upgrade plan

                  Value is forced.

                • If false (the default), the plan fails if it determines that the request can result in unsafe operations. Setting this flag overrides some of these check restraints.

          • settings object

            The settings for building this APM cluster

            Additional properties are allowed.

            Hide settings attribute Show settings attribute object
            • metadata object

              The top-level configuration settings for the Elasticsearch cluster.

              Additional properties are allowed.

              Hide metadata attributes Show metadata attributes object
              • name string

                The display name of the cluster

              • owner_id string

                The user id (referencing whatever user database is in use) of the cluster owner

              • The organization that owns the deployment

              • Subscription level of the cluster

              • Indicates if a cluster is system owned (restricts the set of operations that can be performed on it)

              • Contact email for the cluster

              • hidden boolean

                Whether or not this cluster is hidden from the normal clusters list

              • The top-level configuration settings for the Elasticsearch cluster resources.

                Additional properties are allowed.

                Hide resources attribute Show resources attribute object
                • cpu object

                  Specifies the CPU resource settings for the Elasticsearch cluster.

                  Additional properties are allowed.

                  Hide cpu attributes Show cpu attributes object
                  • boost boolean

                    Indicates if the CPU boost flag is enabled or not.

                  • hard_limit boolean

                    Indicates if the CPU hard limit flag is enabled or not. When set to true (default), allocates CPU timeshare based on the total CPU time multiplied by the relative RAM capacity of the instance on a given host. When set to false, delegates CPU allocation to the operating system to schedule CPU timeshares.

        • 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.

          Hide appsearch attributes Show appsearch attributes object
          • ref_id string Required

            A locally-unique user-specified id for AppSearch

          • Alias to the Elasticsearch Cluster to attach AppSearch to

          • 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.

            Additional properties are allowed.

            Hide plan attributes Show plan attributes object
            • cluster_topology array[object]
              Hide cluster_topology attributes Show cluster_topology attributes object
              • Defines the AppSearch node type

                Additional properties are allowed.

                Hide node_type attributes Show node_type attributes object
                • appserver boolean Required

                  Defines whether this instance should run as Application/API server

                • worker boolean Required

                  Defines whether this instance should run as background worker

              • 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.

              • The version of the Instance Configuration Id. If it is unset, the meaning depends on read vs writes. For deployment reads, it is equivalent to version 0 (or the IC is unversioned); for deployment creates and deployment template use, it is equivalent to 'the latest version'; and for deployment updates, it is equivalent to 'retain the current version'.

              • size object

                Measured by the amount of a resource. The final cluster size is calculated using multipliers from the topology instance configuration.

                Additional properties are allowed.

                Hide size attributes Show size attributes object
                • value integer(int32) Required

                  Amount of resource

                • resource string Required

                  Type of resource

                  Values are memory or storage.

              • zone_count integer(int32)

                number of zones in which nodes will be placed

              • Additional properties are allowed.

                Hide appsearch attributes Show appsearch attributes object
                • version string

                  The version of the AppSearch cluster (must be one of the ECE supported versions, and won't work unless it matches the Elasticsearch version. Leave blank to auto-detect version.)

                • A docker URI that allows overriding of the default docker image specified for this version

                • This structure defines a curated subset of the AppSearch settings. (This field together with 'user_settings_override*' and 'user_settings*' defines the total set of AppSearch settings)

                  Additional properties are allowed.

                  Hide system_settings attributes Show system_settings attributes object
                  • Optionally override the URL to which to send data (for advanced users only, if unspecified the system selects an internal URL)

                  • 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.

                  • 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.

                  • 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.

                • An arbitrary JSON object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters are on the allowlist and not on the denylist. (This field together with 'user_settings_override*' and 'system_settings' defines the total set of AppSearch settings)

                  Additional properties are allowed.

                • 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)

                • An arbitrary JSON object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of AppSearch settings)

                  Additional properties are allowed.

                • An arbitrary YAML object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_json' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of AppSearch settings)

            • appsearch object Required

              Additional properties are allowed.

              Hide appsearch attributes Show appsearch attributes object
              • version string

                The version of the AppSearch cluster (must be one of the ECE supported versions, and won't work unless it matches the Elasticsearch version. Leave blank to auto-detect version.)

              • A docker URI that allows overriding of the default docker image specified for this version

              • This structure defines a curated subset of the AppSearch settings. (This field together with 'user_settings_override*' and 'user_settings*' defines the total set of AppSearch settings)

                Additional properties are allowed.

                Hide system_settings attributes Show system_settings attributes object
                • Optionally override the URL to which to send data (for advanced users only, if unspecified the system selects an internal URL)

                • 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.

                • 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.

                • 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.

              • An arbitrary JSON object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters are on the allowlist and not on the denylist. (This field together with 'user_settings_override*' and 'system_settings' defines the total set of AppSearch settings)

                Additional properties are allowed.

              • 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)

              • An arbitrary JSON object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of AppSearch settings)

                Additional properties are allowed.

              • 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)

            • Defines configuration parameters that control how the plan (ie consisting of the cluster topology and AppSearch settings) is applied

              Additional properties are allowed.

              Hide transient attributes Show transient attributes object
              • strategy object

                The options for performing a plan change. Specify only one property each time. The default is grow_and_shrink.

                Additional properties are allowed.

                Hide strategy attributes Show strategy attributes object
                • rolling object

                  Performs inline, rolling configuration changes that mutate existing containers. TIP: This is the fastest way to update a plan, but can fail for complex plan changes, such as topology changes. Also, this is less safe for configuration changes that leave a cluster in a non running state. NOTE: When you perform a major version upgrade, and 'group_by' is set to 'pass:macros[all]';, rolling is required.

                  Additional properties are allowed.

                  Hide rolling attributes Show rolling attributes object
                  • group_by string

                    Specifies the grouping attribute to use when rolling several instances. Instances that share the same value for the provided attribute key are rolled together as a unit. Examples that make sense to use are '__all__' (roll all instances as a single unit), 'logical_zone_name' (roll instances by zone), '__name__' (roll one instance at a time, the default if not specified). Note that '__all__' is required when performing a major version upgrade

                  • 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

                  • 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)

                • A strategy that creates instances with the new plan, migrates data from the old instances, then shuts down the old instances. GrowShrinkStrategyConfig is safer than 'rolling' and ensures single node availability during a plan change, but can be a lot slower on larger clusters.

                  Additional properties are allowed.

                • A strategy that creates new Elasticsearch instances, Kibana instances, and APM Servers with the new plan, then migrates the node data to minimize the amount of spare capacity.

                  Additional properties are allowed.

                • A strategy that lets constructor choose the most optimal way to execute the plan.

                  Additional properties are allowed.

              • Additional properties are allowed.

                Hide plan_configuration attributes Show plan_configuration attributes object
                • timeout integer(int64)

                  The total timeout in seconds after which the plan is cancelled even if it is not complete. Defaults to 4x the max memory capacity per node (in MB)

                • calm_wait_time integer(int64)

                  This timeout determines how long to give a cluster after it responds to API calls before performing actual operations on it. It defaults to 5s

                • move_instances array[object]
                  Hide move_instances attributes Show move_instances attributes object
                  • from string Required

                    The instance id that is going to be moved

                  • to array[string]

                    An optional list of allocator ids to which the instance should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)

                  • Tells the infrastructure that the instance should be considered as permanently down when deciding how to migrate data to new nodes. If left blank then the system will automatically decide (currently: will treat the instances as up)

                • move_allocators array[object]
                  Hide move_allocators attributes Show move_allocators attributes object
                  • from string Required

                    The allocator id off which all instances in the cluster should be moved

                  • to array[string]

                    An optional list of allocator ids to which the instance(s) should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)

                  • 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)

                • If true (default: false) does not allow re-using any existing instances currently in the cluster, ie even unchanged instances will be re-created

                • List of allocators on which instances are placed if possible (if not possible/not specified then any available allocator with space is used)

                • Map containing allocators tags in form of key value pairs, increasing the likelihood during move requests for allocators with matching tags, to be selected as target allocators

                  Hide preferred_allocator_tags attribute Show preferred_allocator_tags attribute object
                  • * string Additional properties
                • 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

                • Set to 'forced' to force a reboot as part of the upgrade plan

                  Value is forced.

                • If false (the default), the plan fails if it determines that the request can result in unsafe operations. Setting this flag overrides some of these check restraints.

          • settings object

            The settings for building this AppSearch cluster

            Additional properties are allowed.

            Hide settings attribute Show settings attribute object
            • metadata object

              The top-level configuration settings for the Elasticsearch cluster.

              Additional properties are allowed.

              Hide metadata attributes Show metadata attributes object
              • name string

                The display name of the cluster

              • owner_id string

                The user id (referencing whatever user database is in use) of the cluster owner

              • The organization that owns the deployment

              • Subscription level of the cluster

              • Indicates if a cluster is system owned (restricts the set of operations that can be performed on it)

              • Contact email for the cluster

              • hidden boolean

                Whether or not this cluster is hidden from the normal clusters list

              • The top-level configuration settings for the Elasticsearch cluster resources.

                Additional properties are allowed.

                Hide resources attribute Show resources attribute object
                • cpu object

                  Specifies the CPU resource settings for the Elasticsearch cluster.

                  Additional properties are allowed.

                  Hide cpu attributes Show cpu attributes object
                  • boost boolean

                    Indicates if the CPU boost flag is enabled or not.

                  • hard_limit boolean

                    Indicates if the CPU hard limit flag is enabled or not. When set to true (default), allocates CPU timeshare based on the total CPU time multiplied by the relative RAM capacity of the instance on a given host. When set to false, delegates CPU allocation to the operating system to schedule CPU timeshares.

        • integrations_server array[object]

          A list of payloads for Integrations Server creation.

          Hide integrations_server attributes Show integrations_server attributes object
          • ref_id string Required

            A locally-unique user-specified id for the Integrations Server

          • Alias to the Elasticsearch Cluster to attach the Integrations Server to

          • 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.

            Additional properties are allowed.

            Hide plan attributes Show plan attributes object
            • cluster_topology array[object]
              Hide cluster_topology attributes Show cluster_topology attributes object
              • 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.

              • The version of the Instance Configuration Id. If it is unset, the meaning depends on read vs writes. For deployment reads, it is equivalent to version 0 (or the IC is unversioned); for deployment creates and deployment template use, it is equivalent to 'the latest version'; and for deployment updates, it is equivalent to 'retain the current version'.

              • size object

                Measured by the amount of a resource. The final cluster size is calculated using multipliers from the topology instance configuration.

                Additional properties are allowed.

                Hide size attributes Show size attributes object
                • value integer(int32) Required

                  Amount of resource

                • resource string Required

                  Type of resource

                  Values are memory or storage.

              • zone_count integer(int32)

                number of zones in which nodes will be placed

              • The configuration options for the Integrations Server.

                Additional properties are allowed.

                Hide integrations_server attributes Show integrations_server attributes object
                • version string

                  The version of the Integrations Server cluster (must be one of the ECE supported versions, and won't work unless it matches the Integrations Server version. Leave blank to auto-detect version.)

                • A docker URI that allows overriding of the default docker image specified for this version

                • A structure that defines a curated subset of the Integrations Server settings. TIP: To define the complete set of Integrations Server setting, use IntegrationsSystemSettings with user_settings_override_ and user_settings_.

                  Additional properties are allowed.

                  Hide system_settings attributes Show system_settings attributes object
                  • DEPRECATED: Scheduled for removal in a future version of the API.

                    Optionally override the URL to which to send data (for advanced users only, if unspecified the system selects an internal URL)

                  • DEPRECATED: Scheduled for removal in a future version of the API.

                    Optionally override the URL to which to send data (for advanced users only, if unspecified the system selects an internal URL)

                  • 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.

                  • 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.

                  • Optionally override the secret token within Integrations Server - defaults to the previously existing secretToken

                  • Optionally enable debug mode for Integrations Server - defaults false

                • An arbitrary JSON object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters are on the allowlist and not on the denylist. (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Integrations Server settings)

                  Additional properties are allowed.

                • 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)

                • An arbitrary JSON object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Integrations Server settings)

                  Additional properties are allowed.

                • An arbitrary YAML object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_json' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Integrations Server settings)

                • mode string

                  The mode the Integrations Server is operating in.

                  Values are standalone or managed.

            • integrations_server object Required

              The configuration options for the Integrations Server.

              Additional properties are allowed.

              Hide integrations_server attributes Show integrations_server attributes object
              • version string

                The version of the Integrations Server cluster (must be one of the ECE supported versions, and won't work unless it matches the Integrations Server version. Leave blank to auto-detect version.)

              • A docker URI that allows overriding of the default docker image specified for this version

              • A structure that defines a curated subset of the Integrations Server settings. TIP: To define the complete set of Integrations Server setting, use IntegrationsSystemSettings with user_settings_override_ and user_settings_.

                Additional properties are allowed.

                Hide system_settings attributes Show system_settings attributes object
                • DEPRECATED: Scheduled for removal in a future version of the API.

                  Optionally override the URL to which to send data (for advanced users only, if unspecified the system selects an internal URL)

                • DEPRECATED: Scheduled for removal in a future version of the API.

                  Optionally override the URL to which to send data (for advanced users only, if unspecified the system selects an internal URL)

                • 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.

                • 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.

                • Optionally override the secret token within Integrations Server - defaults to the previously existing secretToken

                • Optionally enable debug mode for Integrations Server - defaults false

              • An arbitrary JSON object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters are on the allowlist and not on the denylist. (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Integrations Server settings)

                Additional properties are allowed.

              • 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)

              • An arbitrary JSON object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Integrations Server settings)

                Additional properties are allowed.

              • 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.

            • Defines the configuration parameters that control how the plan is applied. For example, the Elasticsearch cluster topology and Integrations Server settings.

              Additional properties are allowed.

              Hide transient attributes Show transient attributes object
              • strategy object

                The options for performing a plan change. Specify only one property each time. The default is grow_and_shrink.

                Additional properties are allowed.

                Hide strategy attributes Show strategy attributes object
                • rolling object

                  Performs inline, rolling configuration changes that mutate existing containers. TIP: This is the fastest way to update a plan, but can fail for complex plan changes, such as topology changes. Also, this is less safe for configuration changes that leave a cluster in a non running state. NOTE: When you perform a major version upgrade, and 'group_by' is set to 'pass:macros[all]';, rolling is required.

                  Additional properties are allowed.

                  Hide rolling attributes Show rolling attributes object
                  • group_by string

                    Specifies the grouping attribute to use when rolling several instances. Instances that share the same value for the provided attribute key are rolled together as a unit. Examples that make sense to use are '__all__' (roll all instances as a single unit), 'logical_zone_name' (roll instances by zone), '__name__' (roll one instance at a time, the default if not specified). Note that '__all__' is required when performing a major version upgrade

                  • 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

                  • 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)

                • A strategy that creates instances with the new plan, migrates data from the old instances, then shuts down the old instances. GrowShrinkStrategyConfig is safer than 'rolling' and ensures single node availability during a plan change, but can be a lot slower on larger clusters.

                  Additional properties are allowed.

                • A strategy that creates new Elasticsearch instances, Kibana instances, and APM Servers with the new plan, then migrates the node data to minimize the amount of spare capacity.

                  Additional properties are allowed.

                • A strategy that lets constructor choose the most optimal way to execute the plan.

                  Additional properties are allowed.

              • The plan control configuration options for the Integrations Server.

                Additional properties are allowed.

                Hide plan_configuration attributes Show plan_configuration attributes object
                • timeout integer(int64)

                  The total timeout in seconds after which the plan is cancelled even if it is not complete. Defaults to 4x the max memory capacity per node (in MB)

                • calm_wait_time integer(int64)

                  This timeout determines how long to give a cluster after it responds to API calls before performing actual operations on it. It defaults to 5s

                • move_instances array[object]
                  Hide move_instances attributes Show move_instances attributes object
                  • from string Required

                    The instance id that is going to be moved

                  • to array[string]

                    An optional list of allocator ids to which the instance should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)

                  • Tells the infrastructure that the instance should be considered as permanently down when deciding how to migrate data to new nodes. If left blank then the system will automatically decide (currently: will treat the instances as up)

                • move_allocators array[object]
                  Hide move_allocators attributes Show move_allocators attributes object
                  • from string Required

                    The allocator id off which all instances in the cluster should be moved

                  • to array[string]

                    An optional list of allocator ids to which the instance(s) should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)

                  • 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)

                • If true (default: false) does not allow re-using any existing instances currently in the cluster, ie even unchanged instances will be re-created

                • List of allocators on which instances are placed if possible (if not possible/not specified then any available allocator with space is used)

                • Map containing allocators tags in form of key value pairs, increasing the likelihood during move requests for allocators with matching tags, to be selected as target allocators

                  Hide preferred_allocator_tags attribute Show preferred_allocator_tags attribute object
                  • * string Additional properties
                • 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

                • Set to 'forced' to force a reboot as part of the upgrade plan

                  Value is forced.

                • If false (the default), the plan fails if it determines that the request can result in unsafe operations. Setting this flag overrides some of these check restraints.

          • settings object

            The settings for building this Integrations Server cluster

            Additional properties are allowed.

            Hide settings attribute Show settings attribute object
            • metadata object

              The top-level configuration settings for the Elasticsearch cluster.

              Additional properties are allowed.

              Hide metadata attributes Show metadata attributes object
              • name string

                The display name of the cluster

              • owner_id string

                The user id (referencing whatever user database is in use) of the cluster owner

              • The organization that owns the deployment

              • Subscription level of the cluster

              • Indicates if a cluster is system owned (restricts the set of operations that can be performed on it)

              • Contact email for the cluster

              • hidden boolean

                Whether or not this cluster is hidden from the normal clusters list

              • The top-level configuration settings for the Elasticsearch cluster resources.

                Additional properties are allowed.

                Hide resources attribute Show resources attribute object
                • cpu object

                  Specifies the CPU resource settings for the Elasticsearch cluster.

                  Additional properties are allowed.

                  Hide cpu attributes Show cpu attributes object
                  • boost boolean

                    Indicates if the CPU boost flag is enabled or not.

                  • hard_limit boolean

                    Indicates if the CPU hard limit flag is enabled or not. When set to true (default), allocates CPU timeshare based on the total CPU time multiplied by the relative RAM capacity of the instance on a given host. When set to false, delegates CPU allocation to the operating system to schedule CPU timeshares.

      • settings object

        Additional configuration for this Deployment

        Additional properties are allowed.

        Hide settings attributes Show settings attributes object
        • The rulesets to apply to all resources in this cluster. When specified, the set of rulesets is updated and the same rulesets will be applied to Kibana and APM clusters as well. If not specified, the rulesets remain as they were set previously.

          Additional properties are allowed.

          Hide traffic_filter_settings attribute Show traffic_filter_settings attribute object
          • rulesets array[string] Required

            IDs of the traffic filter rulesets

        • Observability settings for this deployment

          Additional properties are allowed.

          Hide observability attributes Show observability attributes object
          • logging object

            The logging settings for the deployment

            Additional properties are allowed.

            Hide logging attribute Show logging attribute object
            • destination object Required

              The destination deployment that this deployment's logs will be sent to

              Additional properties are allowed.

              Hide destination attributes Show destination attributes object
              • deployment_id string Required

                The deployment to send logs and/or metrics to. Contains either the deployment's ID or 'self'.

              • ref_id string

                RefId of the Elasticsearch cluster to send logs and/or metrics to. If not specified, refId is resolved automatically as long as the destination deployment contains a single Elasticsearch resource.

          • metrics object

            The metrics settings for the deployment

            Additional properties are allowed.

            Hide metrics attributes Show metrics attributes object
            • destination object Required

              The destination deployment that this deployment's logs will be sent to

              Additional properties are allowed.

              Hide destination attributes Show destination attributes object
              • deployment_id string Required

                The deployment to send logs and/or metrics to. Contains either the deployment's ID or 'self'.

              • ref_id string

                RefId of the Elasticsearch cluster to send logs and/or metrics to. If not specified, refId is resolved automatically as long as the destination deployment contains a single Elasticsearch resource.

            • Set to true to force the deployment to use legacy monitoring instead of Metricbeat-based monitoring.

        • Enable autoscaling for this deployment.

      • metadata object

        Additional information about this deployment

        Additional properties are allowed.

        Hide metadata attributes Show metadata attributes object
        • Indicates if a deployment is system owned (restricts the set of operations that can be performed on it)

        • tags array[object]

          Arbitrary user-defined metadata associated with this deployment

          Hide tags attributes Show tags attributes object
          • key string Required

            The metadata field name

          • value string Required

            The metadata value

      • alias string

        A user-defined alias to use in place of Cluster IDs for user-friendly URLs

      • region string

        Identifier of the region to be used as the default for all the resources of the deployment

      • version string

        The version for all the resources of the deployment (must be one of the supported versions). Defaults to the latest version if not specified.

    • Whether or not if this is system owned template.

    • source object

      Information describing the source that facilitated the plans current state

      Additional properties are allowed.

      Hide source attributes Show source attributes object
      • facilitator string Required

        The service where the change originated from

      • action string Required

        The type of plan change that was initiated

      • date string(date-time) Required

        The time the change was initiated

      • user_id string

        The user that requested the change

      • admin_id string

        The admin user that requested the change

      • remote_addresses array[string]

        The host addresses of the user that originated the change

    • metadata array[object]

      Optional arbitrary metadata to associate with this template.

      Hide metadata attributes Show metadata attributes object
      • key string Required

        The metadata field name

      • value string Required

        The metadata value

    • instance_configurations array[object] Required

      List of instance configurations used in the cluster template.

      Hide instance_configurations attributes Show instance_configurations attributes object
      • id string

        Unique identifier for the instance configuration

      • name string Required

        Display name for the instance configuration.

      • config_version integer(int32)

        If the IC is configuration controlled, this field is the version either being read back (reads return the latest IC unless specified by the 'config_version' URL param), or the version to update. Cannot be used in creates. For unversioned IC reads it is left empty.

      • Optional description for the instance configuration

      • The type of instance. For instance configurations where the type is specified in the 'id', the default value of 'instance_type' will be automatically inferred.

        Values are elasticsearch, kibana, apm, integrations_server, appsearch, or enterprise_search.

      • node_types array[string]

        Node types (master, data) for the instance. For instance configurations where the type (and tier) is specified in the 'id', the default value of 'node_types' will be automatically inferred.

      • discrete_sizes object Required

        Numerics representing possible instance sizes that the instance configuration supports.

        Additional properties are allowed.

        Hide discrete_sizes attributes Show discrete_sizes attributes object
        • sizes array[integer(int32)] Required

          List of supported sizes

        • default_size integer(int32)

          The default size

        • resource string

          The unit that each size represents. If not specified, it will default to 'memory'.

          Values are memory or storage.

      • storage_multiplier number(double)

        Settings for the instance storage multiplier

      • cpu_multiplier number(double)

        Settings for the instance CPU multiplier

      • metadata object

        Optional arbitrary metadata to associate with this template.

        Additional properties are allowed.

      • max_zones integer(int32)

        The maximum number of availability zones in which this instance configuration has allocators. This field will be missing unless explicitly requested with the show_max_zones parameter.

    • order integer(int32)

      Determines the order in which this template should be returned when listed. Templates are returned in ascending order. If not specified, then the template willbe appended to the end of the list.

    • hidden boolean

      Whether or not the deployment template is hidden by default.

    • Minimum stack version required by this template, if any.

    • Provider and version agnostic template identifier used for grouping related template types.

  • The requested region is not supported. (code: templates.region_not_found)

    Hide headers attribute Show headers attribute
    • The error codes associated with the response

      Value is templates.region_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

  • The user is not authorized to access requested region. (code: templates.region_not_allowed)

    Hide headers attribute Show headers attribute
    • The error codes associated with the response

      Value is templates.region_not_allowed.

    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

  • The deployment template specified by {template_id} cannot be found. (code: templates.template_not_found)

    Hide headers attribute Show headers attribute
    • The error codes associated with the response

      Value is templates.template_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/templates/{template_id}
curl \
 -X GET https://{{hostname}}/api/v1/deployments/templates/{template_id}?region=string
Response examples (200)
{
  "id": "string",
  "name": "string",
  "description": "string",
  "deployment_template": {
    "name": "string",
    "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"
                ],
                "memory_per_node": 42,
                "node_count_per_zone": 42,
                "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,
                "move_instances": [
                  {
                    "from": "string",
                    "to": [
                      "string"
                    ],
                    "instance_down": true
                  }
                ],
                "move_allocators": [
                  {
                    "from": "string",
                    "to": [
                      "string"
                    ],
                    "allocator_down": true
                  }
                ],
                "move_only": true,
                "reallocate_instances": true,
                "preferred_allocators": [
                  "string"
                ],
                "preferred_allocator_tags": {
                  "additionalProperty1": "string",
                  "additionalProperty2": "string"
                },
                "skip_snapshot": true,
                "max_snapshot_attempts": 42,
                "max_snapshot_age": 42,
                "extended_maintenance": true,
                "cluster_reboot": "forced",
                "override_failsafe": true,
                "skip_data_migration": true,
                "skip_upgrade_checker": true,
                "skip_post_upgrade_steps": true,
                "skip_snapshot_post_major_upgrade": true
              },
              "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": {
              "repository": {
                "static": {
                  "repository_type": "string",
                  "settings": {}
                },
                "reference": {
                  "repository_name": "string"
                },
                "default": {}
              },
              "interval": "string",
              "pending_interval": "string",
              "wait_time_after_snapshotting": "string",
              "enabled": true,
              "suspended": [
                "string"
              ],
              "retention": {
                "snapshots": 42,
                "max_age": "string"
              },
              "slm": true,
              "cron_expression": "string"
            },
            "monitoring": {
              "target_cluster_id": "string"
            },
            "metadata": {
              "name": "string",
              "owner_id": "string",
              "organization_id": "string",
              "subscription_level": "string",
              "system_owned": true,
              "contact_email": "string",
              "hidden": true,
              "resources": {
                "cpu": {
                  "boost": true,
                  "hard_limit": true
                }
              }
            },
            "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:00+00:00",
                        "valid_from": "2025-05-04T09:42:00+00:00",
                        "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": [
              {
                "memory_per_node": 42,
                "node_count_per_zone": 42,
                "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_url": "string",
                    "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_url": "string",
                "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,
                "move_instances": [
                  {
                    "from": "string",
                    "to": [
                      "string"
                    ],
                    "instance_down": true
                  }
                ],
                "move_allocators": [
                  {
                    "from": "string",
                    "to": [
                      "string"
                    ],
                    "allocator_down": true
                  }
                ],
                "reallocate_instances": true,
                "preferred_allocators": [
                  "string"
                ],
                "preferred_allocator_tags": {
                  "additionalProperty1": "string",
                  "additionalProperty2": "string"
                },
                "extended_maintenance": true,
                "cluster_reboot": "forced",
                "override_failsafe": true
              }
            }
          },
          "settings": {
            "metadata": {
              "name": "string",
              "owner_id": "string",
              "organization_id": "string",
              "subscription_level": "string",
              "system_owned": true,
              "contact_email": "string",
              "hidden": true,
              "resources": {
                "cpu": {
                  "boost": true,
                  "hard_limit": true
                }
              }
            }
          }
        }
      ],
      "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_url": "string",
                    "kibana_url": "string",
                    "elasticsearch_username": "string",
                    "elasticsearch_password": "string",
                    "secret_token": "string",
                    "debug_enabled": true
                  },
                  "user_settings_json": {},
                  "user_settings_yaml": "string",
                  "user_settings_override_json": {},
                  "user_settings_override_yaml": "string"
                }
              }
            ],
            "apm": {
              "version": "string",
              "docker_image": "string",
              "system_settings": {
                "elasticsearch_url": "string",
                "kibana_url": "string",
                "elasticsearch_username": "string",
                "elasticsearch_password": "string",
                "secret_token": "string",
                "debug_enabled": true
              },
              "user_settings_json": {},
              "user_settings_yaml": "string",
              "user_settings_override_json": {},
              "user_settings_override_yaml": "string"
            },
            "transient": {
              "strategy": {
                "rolling": {
                  "group_by": "string",
                  "allow_inline_resize": true,
                  "skip_synced_flush": true,
                  "shard_init_wait_time": 42
                },
                "grow_and_shrink": {},
                "rolling_grow_and_shrink": {},
                "autodetect": {}
              },
              "plan_configuration": {
                "timeout": 42,
                "calm_wait_time": 42,
                "move_instances": [
                  {
                    "from": "string",
                    "to": [
                      "string"
                    ],
                    "instance_down": true
                  }
                ],
                "move_allocators": [
                  {
                    "from": "string",
                    "to": [
                      "string"
                    ],
                    "allocator_down": true
                  }
                ],
                "reallocate_instances": true,
                "preferred_allocators": [
                  "string"
                ],
                "preferred_allocator_tags": {
                  "additionalProperty1": "string",
                  "additionalProperty2": "string"
                },
                "extended_maintenance": true,
                "cluster_reboot": "forced",
                "override_failsafe": true
              }
            }
          },
          "settings": {
            "metadata": {
              "name": "string",
              "owner_id": "string",
              "organization_id": "string",
              "subscription_level": "string",
              "system_owned": true,
              "contact_email": "string",
              "hidden": true,
              "resources": {
                "cpu": {
                  "boost": true,
                  "hard_limit": true
                }
              }
            }
          }
        }
      ],
      "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"
                ],
                "preferred_allocator_tags": {
                  "additionalProperty1": "string",
                  "additionalProperty2": "string"
                },
                "extended_maintenance": true,
                "cluster_reboot": "forced",
                "override_failsafe": true
              }
            }
          },
          "settings": {
            "metadata": {
              "name": "string",
              "owner_id": "string",
              "organization_id": "string",
              "subscription_level": "string",
              "system_owned": true,
              "contact_email": "string",
              "hidden": true,
              "resources": {
                "cpu": {
                  "boost": true,
                  "hard_limit": true
                }
              }
            }
          }
        }
      ],
      "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_url": "string",
                    "elasticsearch_username": "string",
                    "elasticsearch_password": "string",
                    "secret_session_key": "string"
                  },
                  "user_settings_json": {},
                  "user_settings_yaml": "string",
                  "user_settings_override_json": {},
                  "user_settings_override_yaml": "string"
                },
                "allocator_filter": {},
                "node_configuration": "string",
                "memory_per_node": {},
                "node_count_per_zone": {}
              }
            ],
            "enterprise_search": {
              "version": "string",
              "docker_image": "string",
              "system_settings": {
                "elasticsearch_url": "string",
                "elasticsearch_username": "string",
                "elasticsearch_password": "string",
                "secret_session_key": "string"
              },
              "user_settings_json": {},
              "user_settings_yaml": "string",
              "user_settings_override_json": {},
              "user_settings_override_yaml": "string"
            },
            "transient": {
              "strategy": {
                "rolling": {
                  "group_by": "string",
                  "allow_inline_resize": true,
                  "skip_synced_flush": true,
                  "shard_init_wait_time": 42
                },
                "grow_and_shrink": {},
                "rolling_grow_and_shrink": {},
                "autodetect": {}
              },
              "plan_configuration": {
                "timeout": 42,
                "calm_wait_time": 42,
                "move_instances": [
                  {
                    "from": "string",
                    "to": [
                      "string"
                    ],
                    "instance_down": true
                  }
                ],
                "move_allocators": [
                  {
                    "from": "string",
                    "to": [
                      "string"
                    ],
                    "allocator_down": true
                  }
                ],
                "reallocate_instances": true,
                "preferred_allocators": [
                  "string"
                ],
                "preferred_allocator_tags": {
                  "additionalProperty1": "string",
                  "additionalProperty2": "string"
                },
                "extended_maintenance": true,
                "cluster_reboot": "forced",
                "override_failsafe": true
              }
            }
          },
          "settings": {
            "metadata": {
              "name": "string",
              "owner_id": "string",
              "organization_id": "string",
              "subscription_level": "string",
              "system_owned": true,
              "contact_email": "string",
              "hidden": true,
              "resources": {
                "cpu": {
                  "boost": true,
                  "hard_limit": true
                }
              }
            }
          }
        }
      ],
      "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_url": "string",
                    "kibana_url": "string",
                    "elasticsearch_username": "string",
                    "elasticsearch_password": "string",
                    "secret_token": "string",
                    "debug_enabled": true
                  },
                  "user_settings_json": {},
                  "user_settings_yaml": "string",
                  "user_settings_override_json": {},
                  "user_settings_override_yaml": "string",
                  "mode": "standalone"
                }
              }
            ],
            "integrations_server": {
              "version": "string",
              "docker_image": "string",
              "system_settings": {
                "elasticsearch_url": "string",
                "kibana_url": "string",
                "elasticsearch_username": "string",
                "elasticsearch_password": "string",
                "secret_token": "string",
                "debug_enabled": true
              },
              "user_settings_json": {},
              "user_settings_yaml": "string",
              "user_settings_override_json": {},
              "user_settings_override_yaml": "string",
              "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,
                "move_instances": [
                  {
                    "from": "string",
                    "to": [
                      "string"
                    ],
                    "instance_down": true
                  }
                ],
                "move_allocators": [
                  {
                    "from": "string",
                    "to": [
                      "string"
                    ],
                    "allocator_down": true
                  }
                ],
                "reallocate_instances": true,
                "preferred_allocators": [
                  "string"
                ],
                "preferred_allocator_tags": {
                  "additionalProperty1": "string",
                  "additionalProperty2": "string"
                },
                "extended_maintenance": true,
                "cluster_reboot": "forced",
                "override_failsafe": true
              }
            }
          },
          "settings": {
            "metadata": {
              "name": "string",
              "owner_id": "string",
              "organization_id": "string",
              "subscription_level": "string",
              "system_owned": true,
              "contact_email": "string",
              "hidden": true,
              "resources": {
                "cpu": {
                  "boost": true,
                  "hard_limit": true
                }
              }
            }
          }
        }
      ]
    },
    "settings": {
      "traffic_filter_settings": {
        "rulesets": [
          "string"
        ]
      },
      "observability": {
        "logging": {
          "destination": {
            "deployment_id": "string",
            "ref_id": "string"
          }
        },
        "metrics": {
          "destination": {
            "deployment_id": "string",
            "ref_id": "string"
          },
          "force_legacy_monitoring": true
        }
      },
      "autoscaling_enabled": true
    },
    "metadata": {
      "system_owned": true,
      "tags": [
        {
          "key": "string",
          "value": "string"
        }
      ]
    },
    "alias": "string",
    "region": "string",
    "version": "string"
  },
  "system_owned": true,
  "source": {
    "facilitator": "string",
    "action": "string",
    "date": "2025-05-04T09:42:00+00:00",
    "user_id": "string",
    "admin_id": "string",
    "remote_addresses": [
      "string"
    ]
  },
  "metadata": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "instance_configurations": [
    {
      "id": "string",
      "name": "string",
      "config_version": 42,
      "description": "string",
      "instance_type": "elasticsearch",
      "node_types": [
        "string"
      ],
      "discrete_sizes": {
        "sizes": [
          42
        ],
        "default_size": 42,
        "resource": "memory"
      },
      "storage_multiplier": 42.0,
      "cpu_multiplier": 42.0,
      "metadata": {},
      "max_zones": 42
    }
  ],
  "order": 42,
  "hidden": true,
  "min_version": "string",
  "template_category_id": "string",
  "kibana_deeplink": [
    {
      "semver": "string",
      "uri": "string"
    }
  ]
}
Response examples (400)
# Headers
x-cloud-error-codes: templates.region_not_found

# Payload
{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}
Response examples (401)
# Headers
x-cloud-error-codes: templates.region_not_allowed

# Payload
{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}
Response examples (404)
# Headers
x-cloud-error-codes: templates.template_not_found

# Payload
{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}













List traffic filter claimed link id

GET /deployments/traffic-filter/link-ids

List all of the traffic filter claimed link id.

GET /deployments/traffic-filter/link-ids
curl \
 -X GET https://{{hostname}}/api/v1/deployments/traffic-filter/link-ids
Response examples (200)
{
  "claimed_link_ids": [
    {
      "link_id": "string",
      "azure_endpoint_name": "string",
      "azure_endpoint_guid": "string",
      "region": "string"
    }
  ]
}
Response examples (500)
# Headers
x-cloud-error-codes: traffic_filter_claimed_link_id.request_execution_failed

# Payload
{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}
























Delete a ruleset

DELETE /deployments/traffic-filter/rulesets/{ruleset_id}

Deletes the ruleset by ID.

Path parameters

Query parameters

  • When true, ignores the associations and deletes the ruleset. When false, recognizes the associations, which prevents the deletion of the rule set.

    Default value is false.

Responses

  • The traffic filter ruleset was successfully deleted.

    Additional properties are allowed.

  • The traffic filter ruleset specified by {ruleset_id} cannot be found. (code: traffic_filter.not_found)

    Hide headers attribute Show headers attribute
    • The error codes associated with the response

      Value is traffic_filter.not_found.

    Hide response attribute Show response attribute object
    • errors array[object] Required

      A list of errors that occurred in the failing request

      Hide errors attributes Show errors attributes object
      • code string Required

        A structured code representing the error type that occurred

      • message string Required

        A human readable message describing the error that occurred

      • fields array[string]

        If the error can be tied to a specific field or fields in the user request, this lists those fields

  • Error deleting the traffic filter ruleset. (code: traffic_filter.request_execution_failed)

    Hide headers attribute Show headers attribute
    • The error codes associated with the response

      Value is traffic_filter.request_execution_failed.

    Hide response attribute Show response attribute object
    • errors array[object] Required

      A list of errors that occurred in the failing request

      Hide errors attributes Show errors attributes object
      • code string Required

        A structured code representing the error type that occurred

      • message string Required

        A human readable message describing the error that occurred

      • fields array[string]

        If the error can be tied to a specific field or fields in the user request, this lists those fields

DELETE /deployments/traffic-filter/rulesets/{ruleset_id}
curl \
 -X DELETE https://{{hostname}}/api/v1/deployments/traffic-filter/rulesets/{ruleset_id}
Response examples (200)
{}
Response examples (404)
# Headers
x-cloud-error-codes: traffic_filter.not_found

# Payload
{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}
Response examples (500)
# Headers
x-cloud-error-codes: traffic_filter.request_execution_failed

# Payload
{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}








Delete ruleset association

DELETE /deployments/traffic-filter/rulesets/{ruleset_id}/associations/{association_type}/{associated_entity_id}

Deletes the traffic rules in the ruleset from the deployment.

Path parameters

Responses

  • Delete association request was valid and the association has been deleted

    Additional properties are allowed.

  • The traffic filter ruleset association cannot be found. (code: traffic_filter.not_found)

    Hide headers attribute Show headers attribute
    • The error codes associated with the response

      Value is traffic_filter.not_found.

    Hide response attribute Show response attribute object
    • errors array[object] Required

      A list of errors that occurred in the failing request

      Hide errors attributes Show errors attributes object
      • code string Required

        A structured code representing the error type that occurred

      • message string Required

        A human readable message describing the error that occurred

      • fields array[string]

        If the error can be tied to a specific field or fields in the user request, this lists those fields

  • Deletion failed. (code: traffic_filter.request_execution_failed)

    Hide headers attribute Show headers attribute
    • The error codes associated with the response

      Value is traffic_filter.request_execution_failed.

    Hide response attribute Show response attribute object
    • errors array[object] Required

      A list of errors that occurred in the failing request

      Hide errors attributes Show errors attributes object
      • code string Required

        A structured code representing the error type that occurred

      • message string Required

        A human readable message describing the error that occurred

      • fields array[string]

        If the error can be tied to a specific field or fields in the user request, this lists those fields

DELETE /deployments/traffic-filter/rulesets/{ruleset_id}/associations/{association_type}/{associated_entity_id}
curl \
 -X DELETE https://{{hostname}}/api/v1/deployments/traffic-filter/rulesets/{ruleset_id}/associations/{association_type}/{associated_entity_id}
Response examples (200)
{}
Response examples (404)
# Headers
x-cloud-error-codes: traffic_filter.not_found

# Payload
{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}
Response examples (500)
# Headers
x-cloud-error-codes: traffic_filter.request_execution_failed

# Payload
{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}













Set Deployment Domain Name for a resource kind.

PUT /platform/configuration/networking/deployment_domain_name/{resource_kind}

Saves the Deployment Domain Name configuration value for a resource kind.

Path parameters

  • resource_kind string Required

    The kind of resource you want to manage a Deployment Domain Name for.

    Values are elasticsearch, kibana, apm, appsearch, enterprise_search, or integrations_server.

Query parameters

  • 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). If not specified, will unconditionally upsert.

  • Whether or not to skip cascading operations, such as re-provisioning the Security Deployment.

    Default value is false.

Body Required

Data containing the Deployment Domain Name to set

  • value string Required

    The domain name for all deployments. The hostname of an application in a deployment is constructed from the application ID and the domain name (for example, 1234567890.example.com).

Responses

  • The Deployment Domain Name was successfully saved.

    Hide headers attributes Show headers attributes
    Hide response attribute Show response attribute object
    • value string Required

      The domain name for all deployments. The hostname of an application in a deployment is constructed from the application ID and the domain name (for example, 1234567890.example.com).

  • The optimistic locking version format was wrong. (code: networking.cname.bad_version_format)

    Hide headers attribute Show headers attribute
    • The error codes associated with the response

      Value is networking.cname.bad_version_format.

    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

  • There is no configured Deployment Domain Name but optimistic locking was sent. (code: networking.cname.not_found)

    Hide headers attribute Show headers attribute
    • The error codes associated with the response

      Value is networking.cname.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

  • There was an optimistic locking version conflict. (code: networking.cname.version_conflict)

    Hide headers attribute Show headers attribute
    • The error codes associated with the response

      Value is networking.cname.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

  • skip_cascading_operations was false but the Security Deployment already had a pending plan. (code: security_deployment.cluster_pending_plan_exists)

    Hide headers attribute Show headers attribute
    • The error codes associated with the response

      Value is security_deployment.cluster_pending_plan_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 /platform/configuration/networking/deployment_domain_name/{resource_kind}
curl \
 -X PUT https://{{hostname}}/api/v1/platform/configuration/networking/deployment_domain_name/{resource_kind} \
 -d '{"value":"string"}'
Request examples
{
  "value": "string"
}
Response examples (200)
# Headers
x-cloud-resource-version: string
x-cloud-resource-created: string
x-cloud-resource-last-modified: string

# Payload
{
  "value": "string"
}
Response examples (400)
# Headers
x-cloud-error-codes: networking.cname.bad_version_format

# Payload
{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}
Response examples (404)
# Headers
x-cloud-error-codes: networking.cname.not_found

# Payload
{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}
Response examples (409)
# Headers
x-cloud-error-codes: networking.cname.version_conflict

# Payload
{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}
Response examples (412)
# Headers
x-cloud-error-codes: security_deployment.cluster_pending_plan_exists

# Payload
{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}





Get organization invitation

GET /organizations/invitations/{invitation_token}

Gets a single invitation to an organization by token. Currently unavailable in self-hosted ECE.

Path parameters

Responses

  • Organization invitation fetched successfully

    Hide response attributes Show response 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

      Additional properties are allowed.

      Hide organization attributes Show organization attributes object
  • Invitation not found. (code: organization.invitation_not_found)

    Hide headers attribute Show headers attribute
    • The error codes associated with the response

      Value is organization.invitation_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/invitations/{invitation_token}
curl \
 -X GET https://{{hostname}}/api/v1/organizations/invitations/{invitation_token}
Response examples (200)
{
  "token": "string",
  "email": "string",
  "created_at": "2025-05-04T09:42:00+00:00",
  "expires_at": "2025-05-04T09:42:00+00:00",
  "expired": true,
  "accepted_at": "2025-05-04T09:42:00+00:00",
  "organization": {
    "id": "string",
    "name": "string",
    "default_disk_usage_alerts_enabled": true,
    "notifications_allowed_email_domains": [
      "string"
    ],
    "billing_contacts": [
      "string"
    ],
    "operational_contacts": [
      "string"
    ]
  }
}
Response examples (404)
# Headers
x-cloud-error-codes: organization.invitation_not_found

# Payload
{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}









































Read extra certificate

GET /platform/configuration/security/extra_certs/{cert_id}

Read an extra certificate.

Path parameters

  • cert_id string Required

    The extra certificate Id. For example, star_my_domain_com.

Responses

  • Extra certificate public chain if exists

    Hide response attribute Show response attribute object
    • chain array[string] Required

      The list of PEM encoded X509 certificates that make up the certificate chain

  • The extra certificate cannot be found. (code: cert.not_found)

    Hide headers attribute Show headers attribute
    Hide response attribute Show response attribute object
    • errors array[object] Required

      A list of errors that occurred in the failing request

      Hide errors attributes Show errors attributes object
      • code string Required

        A structured code representing the error type that occurred

      • message string Required

        A human readable message describing the error that occurred

      • fields array[string]

        If the error can be tied to a specific field or fields in the user request, this lists those fields

GET /platform/configuration/security/extra_certs/{cert_id}
curl \
 -X GET https://{{hostname}}/api/v1/platform/configuration/security/extra_certs/{cert_id}
Response examples (200)
{
  "chain": [
    "string"
  ]
}
Response examples (404)
# Headers
x-cloud-error-codes: cert.not_found

# Payload
{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}

Update extra certificate

PUT /platform/configuration/security/extra_certs/{cert_id}

Add or update an extra certificate.

Path parameters

  • cert_id string Required

    The extra certificate Id. For example, star_my_domain_com.

Body Required

Extra certificate bundle

string string

Responses

  • Updates extra certificate under given id

    Additional properties are allowed.

  • Certificate uses unknown cryptographic algorithm. (code: cert.unknown_cert_algorithm)

    Hide headers attribute Show headers attribute
    • The error codes associated with the response

      Value is cert.unknown_cert_algorithm.

    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 /platform/configuration/security/extra_certs/{cert_id}
curl \
 -X PUT https://{{hostname}}/api/v1/platform/configuration/security/extra_certs/{cert_id} \
 -d '"string"'
Request examples
string
Response examples (200)
{}
Response examples (400)
# Headers
x-cloud-error-codes: cert.unknown_cert_algorithm

# Payload
{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}

































Create security deployment

POST /platform/configuration/security/deployment

Creates a new security deployment configuration.

Body Required

The deployment request

  • name string

    The name of the security deployment cluster

  • version string

    The version of the Elasticsearch cluster

  • topology object

    The cluster topology used to create the security deployment cluster

    Additional properties are allowed.

    Hide topology attributes Show topology attributes object
    • size object

      Measured by the amount of a resource. The final cluster size is calculated using multipliers from the topology instance configuration.

      Additional properties are allowed.

      Hide size attributes Show size attributes object
      • value integer(int32) Required

        Amount of resource

      • resource string Required

        Type of resource

        Values are memory or storage.

    • zone_count integer(int32)

      The number of zones in which data nodes will be placed

Responses

  • The security deployment was successfully created

    Hide headers attributes Show headers attributes
    Hide response attribute Show response attribute object
    • id string Required

      The ID

    • There is a version conflict. (code: security_deployment.version_conflict)
    • There is a version conflict. (code: security_deployment.already_exists)
    Hide headers attribute Show headers attribute
    • The error codes associated with the response

      Values are security_deployment.version_conflict or security_deployment.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 /platform/configuration/security/deployment
curl \
 -X POST https://{{hostname}}/api/v1/platform/configuration/security/deployment \
 -d '{"name":"string","version":"string","topology":{"size":{"value":42,"resource":"memory"},"zone_count":42}}'
Request examples
{
  "name": "string",
  "version": "string",
  "topology": {
    "size": {
      "value": 42,
      "resource": "memory"
    },
    "zone_count": 42
  }
}
Response examples (201)
# Headers
x-cloud-resource-version: string
x-cloud-resource-created: string
x-cloud-resource-last-modified: string

# Payload
{
  "id": "string"
}
Response examples (409)
# Headers
x-cloud-error-codes: security_deployment.version_conflict

# Payload
{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}




























Update Active Directory configuration

PUT /platform/configuration/security/realms/active-directory/{realm_id}

Updates an existing Active Directory configuration.

Path parameters

  • realm_id string Required

    The Elasticsearch Security realm identifier.

Query parameters

  • version string

    When specified, checks for conflicts against the version stored in the persistent store (returned in 'x-cloud-resource-version' of the GET request)

Body Required

The Active Directory configuration

  • id string Required

    The identifier for the security realm

  • name string Required

    The friendly name of the security realm

  • urls array[string] Required

    The Active Directory URLs used to authenticate against, in the format ldap[s]://server:port. Note that ldap and ldaps protocols cannot be mixed together.

  • domain_name string Required

    Specifies the domain name of the Active Directory (the forest root domain name).

  • bind_anonymously boolean Required

    When true, bindDb credentials are ignored

  • bind_dn string

    The distinguished name of the user that is used to bind to the Active Directory and perform searches.

  • The user password that is used to bind to the Active Directory server.

  • The Active Directory load balancing behavior

    Additional properties are allowed.

    Hide load_balance attributes Show load_balance attributes object
    • type string

      The behavior to use when there are multiple Active Directory URLs defined

      Values are failover, dns_failover, round_robin, or dns_round_robin.

    • When using dns_failover or dns_round_robin as the load balancing type, this setting controls the amount of time to cache DNS lookups. Defaults to 1h.

  • The SSL trusted CA certificate bundle URL. The bundle should be a zip file containing a single keystore file 'keystore.ks' in the directory '/active_directory/:id/truststore', where :id is the value of the [id] field.

  • The password to the certificate bundle URL truststore

  • The format of the truststore file. Should be jks to use the Java Keystore format or PKCS12 to use PKCS#12 files. The default is jks.

    Values are jks or PKCS12.

  • The role mapping rules associated with the security realm

    Additional properties are allowed.

    Hide role_mappings attributes Show role_mappings attributes object
    • default_roles array[string] Required

      The default roles applied to all users

    • rules array[object] Required

      The role mapping rules to evaluate

      Hide rules attributes Show rules attributes object
      • type string Required

        The type of role mapping rule

        Values are user_dn or group_dn.

      • roles array[string] Required

        The roles that are applied when the mapping rule is successfully evaluated

      • value string Required

        The value to match when evaluating this rule

  • enabled boolean

    When true, enables the security realm

  • order integer(int32)

    The order that the security realm is evaluated

  • Advanced configuration options in YAML format. Any settings defined here will override any configuration set via the API. Note that all keys should omit the 'xpack.security.authc.realms.active_directory.{realm_id}' prefix. For example, when the realm ID is set to 'ad1', the advanced configuration 'xpack.security.authc.realms.active_directory.ad1.ssl.verification_mode: full' should be added as 'ssl.verification_mode: full'.

Responses

  • The Active Directory configuration was successfully updated

    Hide headers attributes Show headers attributes

    Additional properties are allowed.

    • The realm id is already in use. (code: security_realm.id_conflict)
    • The selected id is not valid. (code: security_realm.invalid_id)
    • Order must be greater than zero. (code: security_realm.invalid_order)
    • Invalid Elasticsearch Security realm type. (code: security_realm.invalid_type)
    • The realm order is already in use. (code: security_realm.order_conflict)
    • Advanced YAML format is invalid. (code: security_realm.invalid_yaml)
    • The url format is invalid. (code: security_realm.invalid_url)
    • Invalid Active Directory URL. (code: security_realm.active_directory.invalid_url)
    • Invalid certificate bundle URL. (code: security_realm.invalid_bundle_url)
    Hide headers attribute Show headers attribute
    • The error codes associated with the response

      Values are security_realm.id_conflict, security_realm.invalid_id, security_realm.invalid_order, security_realm.invalid_type, security_realm.order_conflict, security_realm.invalid_yaml, security_realm.invalid_url, security_realm.active_directory.invalid_url, or security_realm.invalid_bundle_url.

    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

  • The realm specified by {realm_id} cannot be found. (code: security_realm.not_found)

    Hide headers attribute Show headers attribute
    • The error codes associated with the response

      Value is security_realm.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

  • There is a version conflict. (code: security_realm.version_conflict)

    Hide headers attribute Show headers attribute
    • The error codes associated with the response

      Value is security_realm.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

PUT /platform/configuration/security/realms/active-directory/{realm_id}
curl \
 -X PUT https://{{hostname}}/api/v1/platform/configuration/security/realms/active-directory/{realm_id} \
 -d '{"id":"string","name":"string","urls":["string"],"domain_name":"string","bind_anonymously":true,"group_search":{"base_dn":"string","scope":"sub_tree"},"user_search":{"base_dn":"string","scope":"sub_tree","filter":"string"},"bind_dn":"string","bind_password":"string","load_balance":{"type":"failover","cache_ttl":"string"},"certificate_url":"string","certificate_url_truststore_password":"string","certificate_url_truststore_type":"jks","role_mappings":{"default_roles":["string"],"rules":[{"type":"user_dn","roles":["string"],"value":"string"}]},"enabled":true,"order":42,"override_yaml":"string"}'
Request examples
{
  "id": "string",
  "name": "string",
  "urls": [
    "string"
  ],
  "domain_name": "string",
  "bind_anonymously": true,
  "group_search": {
    "base_dn": "string",
    "scope": "sub_tree"
  },
  "user_search": {
    "base_dn": "string",
    "scope": "sub_tree",
    "filter": "string"
  },
  "bind_dn": "string",
  "bind_password": "string",
  "load_balance": {
    "type": "failover",
    "cache_ttl": "string"
  },
  "certificate_url": "string",
  "certificate_url_truststore_password": "string",
  "certificate_url_truststore_type": "jks",
  "role_mappings": {
    "default_roles": [
      "string"
    ],
    "rules": [
      {
        "type": "user_dn",
        "roles": [
          "string"
        ],
        "value": "string"
      }
    ]
  },
  "enabled": true,
  "order": 42,
  "override_yaml": "string"
}
Response examples (200)
# Headers
x-cloud-resource-version: string
x-cloud-resource-created: string
x-cloud-resource-last-modified: string

# Payload
{}
Response examples (400)
# Headers
x-cloud-error-codes: security_realm.id_conflict

# Payload
{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}
Response examples (404)
# Headers
x-cloud-error-codes: security_realm.not_found

# Payload
{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}
Response examples (409)
# Headers
x-cloud-error-codes: security_realm.version_conflict

# Payload
{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}




Create LDAP configuration

POST /platform/configuration/security/realms/ldap

Creates a new LDAP configuration.

Body Required

The LDAP configuration

  • id string Required

    The identifier for the security realm

  • name string Required

    The friendly name of the security realm

  • urls array[string] Required

    The LDAP URLs used to authenticate against, in the format ldap[s]://server:port. Note that ldap and ldaps protocols cannot be mixed together.

  • bind_anonymously boolean Required

    When true, bindDb credentials are ignored

  • bind_type string Required

    The type of user binding to apply

    Values are user_search or user_templates.

  • user_dn_templates array[string]

    The distinguished name template that replaces the user name with the string {0}. Only used when bind_type is set to 'user_templates'.

  • bind_dn string

    The distinguished name of the user that is used to bind to the LDAP and perform searches. Only used when bind_type is set to 'user_search'.

  • The user password that is used to bind to the LDAP server. Only used when bind_type is set to 'user_search'.

  • Specifies the attribute to examine on the user for group membership. If any 'group_search' settings are specified, this setting is ignored. Defaults to 'memberOf'.

  • The LDAP load balancing behavior

    Additional properties are allowed.

    Hide load_balance attributes Show load_balance attributes object
    • type string

      The behavior to use when there are multiple LDAP URLs defined

      Values are failover, dns_failover, round_robin, or dns_round_robin.

    • When using dns_failover or dns_round_robin as the load balancing type, this setting controls the amount of time to cache DNS lookups. Defaults to 1h.

  • The SSL trusted CA certificate bundle URL. The bundle should be a zip file containing a single keystore file 'keystore.ks' in the directory '/ldap/:id/truststore', where :id is the value of the [id] field.

  • The password to the certificate bundle URL truststore

  • The format of the truststore file. Should be jks to use the Java Keystore format or PKCS12 to use PKCS#12 files. The default is jks.

    Values are jks or PKCS12.

  • The role mapping rules associated with the security realm

    Additional properties are allowed.

    Hide role_mappings attributes Show role_mappings attributes object
    • default_roles array[string] Required

      The default roles applied to all users

    • rules array[object] Required

      The role mapping rules to evaluate

      Hide rules attributes Show rules attributes object
      • type string Required

        The type of role mapping rule

        Values are user_dn or group_dn.

      • roles array[string] Required

        The roles that are applied when the mapping rule is successfully evaluated

      • value string Required

        The value to match when evaluating this rule

  • enabled boolean

    When true, enables the security realm

  • order integer(int32)

    The order that the security realm is evaluated

  • Advanced configuration options in YAML format. Any settings defined here will override any configuration set via the API. Note that all keys should omit the 'xpack.security.authc.realms.ldap.{realm_id}' prefix. For example, when the realm ID is set to 'ldap1', the advanced configuration 'xpack.security.authc.realms.ldap.ldap1.ssl.verification_mode: full' should be added as 'ssl.verification_mode: full'.

Responses

  • The LDAP configuration was successfully created

    Hide headers attributes Show headers attributes

    Additional properties are allowed.

    • The realm id is already in use. (code: security_realm.id_conflict)
    • The selected id is not valid. (code: security_realm.invalid_id)
    • Order must be greater than zero. (code: security_realm.invalid_order)
    • Invalid Elasticsearch Security realm type. (code: security_realm.invalid_type)
    • The realm order is already in use. (code: security_realm.order_conflict)
    • Advanced YAML format is invalid. (code: security_realm.invalid_yaml)
    • The url format is invalid. (code: security_realm.invalid_url)
    • Invalid LDAP URL. (code: security_realm.ldap.invalid_url)
    • Invalid certificate bundle URL. (code: security_realm.invalid_bundle_url)
    Hide headers attribute Show headers attribute
    • The error codes associated with the response

      Values are security_realm.id_conflict, security_realm.invalid_id, security_realm.invalid_order, security_realm.invalid_type, security_realm.order_conflict, security_realm.invalid_yaml, security_realm.invalid_url, security_realm.ldap.invalid_url, or security_realm.invalid_bundle_url.

    Hide response attribute Show response attribute object
    • errors array[object] Required

      A list of errors that occurred in the failing request

      Hide errors attributes Show errors attributes object
      • code string Required

        A structured code representing the error type that occurred

      • message string Required

        A human readable message describing the error that occurred

      • fields array[string]

        If the error can be tied to a specific field or fields in the user request, this lists those fields

POST /platform/configuration/security/realms/ldap
curl \
 -X POST https://{{hostname}}/api/v1/platform/configuration/security/realms/ldap \
 -d '{"id":"string","name":"string","urls":["string"],"bind_anonymously":true,"bind_type":"user_search","group_search":{"base_dn":"string","scope":"sub_tree","filter":"string","user_attribute":"string"},"user_search":{"base_dn":"string","scope":"sub_tree","filter":"string"},"user_dn_templates":["string"],"bind_dn":"string","bind_password":"string","user_group_attribute":"string","load_balance":{"type":"failover","cache_ttl":"string"},"certificate_url":"string","certificate_url_truststore_password":"string","certificate_url_truststore_type":"jks","role_mappings":{"default_roles":["string"],"rules":[{"type":"user_dn","roles":["string"],"value":"string"}]},"enabled":true,"order":42,"override_yaml":"string"}'
Request examples
{
  "id": "string",
  "name": "string",
  "urls": [
    "string"
  ],
  "bind_anonymously": true,
  "bind_type": "user_search",
  "group_search": {
    "base_dn": "string",
    "scope": "sub_tree",
    "filter": "string",
    "user_attribute": "string"
  },
  "user_search": {
    "base_dn": "string",
    "scope": "sub_tree",
    "filter": "string"
  },
  "user_dn_templates": [
    "string"
  ],
  "bind_dn": "string",
  "bind_password": "string",
  "user_group_attribute": "string",
  "load_balance": {
    "type": "failover",
    "cache_ttl": "string"
  },
  "certificate_url": "string",
  "certificate_url_truststore_password": "string",
  "certificate_url_truststore_type": "jks",
  "role_mappings": {
    "default_roles": [
      "string"
    ],
    "rules": [
      {
        "type": "user_dn",
        "roles": [
          "string"
        ],
        "value": "string"
      }
    ]
  },
  "enabled": true,
  "order": 42,
  "override_yaml": "string"
}
Response examples (201)
# Headers
x-cloud-resource-version: string
x-cloud-resource-created: string
x-cloud-resource-last-modified: string

# Payload
{}
Response examples (400)
# Headers
x-cloud-error-codes: security_realm.id_conflict

# Payload
{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}
















































Update trust relationship

PUT /platform/configuration/trust-relationships/{trust_relationship_id}

Updates a trust relationship.

Path parameters

Body Required

The trust relationship definition

  • name string

    A name for the trust relationship

  • If this relationship is trusted by default by all deployments in the current environment.

  • account_ids array[string]

    The ID of the accounts to trust by this relationship.

  • The public CA certificate of the environment to trust

  • The installation ID of the environment to trust

Responses

  • The request was valid and the trust relationship was updated.

    Hide headers attributes Show headers attributes
    Hide response attributes Show response attributes object
    • id string Required

      The id of the trust relationship

    • name string Required

      The name of the trust relationship

    • trust_by_default boolean Required

      If this relationship is trusted by default by all deployments in the current environment.

    • account_ids array[string]

      The ID of the accounts trusted by this relationship.

    • local boolean Required

      If this is the trust relationship for the local environment

    • The installation ID of the environment to trust

  • The trust relationship 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

  • 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

  • The trust relationship specified by {trust_relationship_id} cannot be found. (code: trust_relationships.not_found)

    Hide headers attribute Show headers attribute
    • The error codes associated with the response

      Value is trust_relationships.not_found.

    Hide response attribute Show response attribute object
    • errors array[object] Required

      A list of errors that occurred in the failing request

      Hide errors attributes Show errors attributes object
      • code string Required

        A structured code representing the error type that occurred

      • message string Required

        A human readable message describing the error that occurred

      • fields array[string]

        If the error can be tied to a specific field or fields in the user request, this lists those fields

PUT /platform/configuration/trust-relationships/{trust_relationship_id}
curl \
 -X PUT https://{{hostname}}/api/v1/platform/configuration/trust-relationships/{trust_relationship_id} \
 -d '{"name":"string","trust_by_default":true,"account_ids":["string"],"public_ca_cert":"string","installation_id":"string"}'
Request examples
{
  "name": "string",
  "trust_by_default": true,
  "account_ids": [
    "string"
  ],
  "public_ca_cert": "string",
  "installation_id": "string"
}
Response examples (200)
# Headers
x-cloud-resource-version: string
x-cloud-resource-created: string
x-cloud-resource-last-modified: string

# Payload
{
  "id": "string",
  "name": "string",
  "trust_by_default": true,
  "account_ids": [
    "string"
  ],
  "local": true,
  "installation_id": "string"
}
Response examples (400)
{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}
Response examples (401)
{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}
Response examples (404)
# Headers
x-cloud-error-codes: trust_relationships.not_found

# Payload
{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}









Set API base Url

PUT /platform/configuration/api_base_url

Saves the API base Url configuration value.

Query parameters

  • 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). If not specified, will unconditionally upsert.

  • Whether or not to skip cascading operations, such as re-provisioning the Security Deployment.

    Default value is false.

Body Required

Data containing the base Url to set

  • value string Required

    The configured base Url

Responses

  • The API base Url was successfully saved.

    Hide headers attributes Show headers attributes
    Hide response attribute Show response attribute object
    • value string Required

      The configured base Url

  • The optimistic locking version format was wrong. (code: adminconsole.base_url.bad_version_format)

    Hide headers attribute Show headers attribute
    • The error codes associated with the response

      Value is adminconsole.base_url.bad_version_format.

    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

  • There is no configured API base value but optimistic locking was sent. (code: adminconsole.base_url.not_found)

    Hide headers attribute Show headers attribute
    • The error codes associated with the response

      Value is adminconsole.base_url.not_found.

    Hide response attribute Show response attribute object
    • errors array[object] Required

      A list of errors that occurred in the failing request

      Hide errors attributes Show errors attributes object
      • code string Required

        A structured code representing the error type that occurred

      • message string Required

        A human readable message describing the error that occurred

      • fields array[string]

        If the error can be tied to a specific field or fields in the user request, this lists those fields

  • There was an optimistic locking version conflict. (code: adminconsole.base_url.version_conflict)

    Hide headers attribute Show headers attribute
    • The error codes associated with the response

      Value is adminconsole.base_url.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

  • skip_cascading_operations was false but the Security Deployment already had a pending plan. (code: security_deployment.cluster_pending_plan_exists)

    Hide headers attribute Show headers attribute
    • The error codes associated with the response

      Value is security_deployment.cluster_pending_plan_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 /platform/configuration/api_base_url
curl \
 -X PUT https://{{hostname}}/api/v1/platform/configuration/api_base_url \
 -d '{"value":"string"}'
Request examples
{
  "value": "string"
}
Response examples (200)
# Headers
x-cloud-resource-version: string
x-cloud-resource-created: string
x-cloud-resource-last-modified: string

# Payload
{
  "value": "string"
}
Response examples (400)
# Headers
x-cloud-error-codes: adminconsole.base_url.bad_version_format

# Payload
{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}
Response examples (404)
# Headers
x-cloud-error-codes: adminconsole.base_url.not_found

# Payload
{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}
Response examples (409)
# Headers
x-cloud-error-codes: adminconsole.base_url.version_conflict

# Payload
{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}
Response examples (412)
# Headers
x-cloud-error-codes: security_deployment.cluster_pending_plan_exists

# Payload
{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}
























Reindex region indices

POST /platform/infrastructure/adminconsoles/_reindex

Start reindex of all regional indices.

Responses

  • Started reindexing of regional indices.

    Additional properties are allowed.

POST /platform/infrastructure/adminconsoles/_reindex
curl \
 -X POST https://{{hostname}}/api/v1/platform/infrastructure/adminconsoles/_reindex
Response examples (202)
{}




























Get allocator

GET /platform/infrastructure/allocators/{allocator_id}

Retrieves the allocator by the ID.

Path parameters

Responses

  • The information for the allocator specified by {allocator_id}

    Hide response attributes Show response attributes object
    • status object Required

      The health status of the allocator.

      Additional properties are allowed.

      Hide status attributes Show status attributes object
      • connected boolean Required

        Whether the allocator is connected

      • healthy boolean Required

        Whether the allocator is healthy, meaning it is either connected or has no instances

      • Checks used to determine if an allocator is healthy or not

        Additional properties are allowed.

        Hide health_checks attributes Show health_checks attributes object
      • maintenance_mode boolean Required

        Whether the allocator is in maintenance mode (meaning that new workload won't be assigned to it)

      • Timestamp when allocator last entered or exited maintenance mode

    • allocator_id string Required

      Identifier for this allocator

    • zone_id string Required

      Identifier of the zone

    • host_ip string Required

      Host IP of this allocator

    • public_hostname string Required

      Public hostname of this allocator

    • capacity object Required

      The total and used capacity of the allocator.

      Additional properties are allowed.

      Hide capacity attributes Show capacity attributes object
      • memory object Required

        The available and used memory of the allocator.

        Additional properties are allowed.

        Hide memory attributes Show memory attributes object
        • total integer(int32) Required

          Total memory in MB capacity installed on this allocator

        • used integer(int32) Required

          Used memory in MB used by instances assigned to this allocator

      • storage object Required

        The storage capacity of the allocator.

        Additional properties are allowed.

        Hide storage attribute Show storage attribute object
        • total integer(int64) Required

          Total storage in MiB capacity installed on this allocator

      • available_cpus integer(int32)

        Total number of CPUs available on this allocator

      • Additional bonus CPU shares available to Elasticsearch master instances

    • settings object Required

      The settings for the allocator.

      Additional properties are allowed.

      Hide settings attribute Show settings attribute object
      • capacity integer(int32)

        A memory capacity (in MB) that overrides the capacity defined during installation - requires separate restart of Allocator services on each host to take full effect.

    • instances array[object] Required
      Hide instances attributes Show instances attributes object
      • cluster_type string Required

        Type of instance that is running

        Values are elasticsearch, kibana, apm, integrations_server, appsearch, or enterprise_search.

      • cluster_id string Required

        Identifier for the cluster this instance belongs

      • Name of cluster this instance belongs, if available

      • instance_name string Required

        Instance ID of the instance

      • node_memory integer(int32) Required

        Memory assigned to this instance

      • healthy boolean

        Indicates whether the instance is healthy

      • Indicates whether the cluster the instance belongs to is healthy

      • The instance configuration id of this instance

      • moving boolean

        Indicates whether the instance is vacating away from this allocator. Note that this is currently not populated when returned from the search endpoint.

      • The plans associated with the current instance. Note that this is currently not populated when returned from the search endpoint.

        Additional properties are allowed.

        Hide plans_info attributes Show plans_info attributes object
        • pending boolean Required

          Whether or not there is a pending plan.

        • version string

          The version of the current plan, falling back to that of the pending plan if it exists.

        • zone_count integer(int32)

          The number of zones in the current plan, falling back to that of the pending plan if it exists.

      • The id of the deployment this cluster belongs to.

    • metadata array[object] Required

      Arbitrary metadata associated with this allocator

      Hide metadata attributes Show metadata attributes object
      • key string Required

        The metadata field name

      • value string Required

        The metadata value

    • Build Info of the artifact

      Additional properties are allowed.

      Hide build_info attributes Show build_info attributes object
    • features array[string] Required

      List of features associated with this allocator. Note this is only present for backwards compatibility purposes and is scheduled for removal in the next major version release.

    • region string

      The region that this allocator belongs to. Only populated in SaaS or federated ECE.

  • The allocator specified by {allocator_id} cannot be found. (code: allocators.allocator_not_found)

    Hide headers attribute Show headers attribute
    • The error codes associated with the response

      Value is allocators.allocator_not_found.

    Hide response attribute Show response attribute object
    • errors array[object] Required

      A list of errors that occurred in the failing request

      Hide errors attributes Show errors attributes object
      • code string Required

        A structured code representing the error type that occurred

      • message string Required

        A human readable message describing the error that occurred

      • fields array[string]

        If the error can be tied to a specific field or fields in the user request, this lists those fields

GET /platform/infrastructure/allocators/{allocator_id}
curl \
 -X GET https://{{hostname}}/api/v1/platform/infrastructure/allocators/{allocator_id}
Response examples (200)
{
  "status": {
    "connected": true,
    "healthy": true,
    "health_checks": {
      "is_docker_healthy": true,
      "is_connected_to_zk": true,
      "has_instances": true
    },
    "maintenance_mode": true,
    "maintenance_mode_timestamp": "2025-05-04T09:42:00+00:00"
  },
  "allocator_id": "string",
  "zone_id": "string",
  "host_ip": "string",
  "public_hostname": "string",
  "capacity": {
    "memory": {
      "total": 42,
      "used": 42
    },
    "storage": {
      "total": 42
    },
    "available_cpus": 42,
    "additional_master_bonus": 42.0
  },
  "settings": {
    "capacity": 42
  },
  "instances": [
    {
      "cluster_type": "elasticsearch",
      "cluster_id": "string",
      "cluster_name": "string",
      "instance_name": "string",
      "node_memory": 42,
      "healthy": true,
      "cluster_healthy": true,
      "instance_configuration_id": "string",
      "moving": true,
      "plans_info": {
        "pending": true,
        "version": "string",
        "zone_count": 42
      },
      "deployment_id": "string"
    }
  ],
  "metadata": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "build_info": {
    "commit_hash": "string",
    "version": "string"
  },
  "features": [
    "string"
  ],
  "external_links": [
    {
      "id": "string",
      "label": "string",
      "uri": "string"
    }
  ],
  "region": "string"
}
Response examples (404)
# Headers
x-cloud-error-codes: allocators.allocator_not_found

# Payload
{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}








Move clusters

POST /platform/infrastructure/allocators/{allocator_id}/clusters/_move

Moves the clusters to a different allocator.

Path parameters

Query parameters

  • When true, cancels and overwrites the pending plans, or treats the instance as an error.

    Default value is false.

  • move_only boolean

    When true, moves the specified instances and ignores the changes for the cluster state.

    Default value is true.

  • force_move boolean

    When true, execute a primitive vacate by moving data at file-system level, and recreating instances on the target allocator(s).

    Default value is false.

  • When true, considers all instances on the allocator as permanently shut down when deciding how to migrate data to new nodes.When left blank, the system automatically decides. NOTE: The default treats the allocator as up.

  • When true, validates the plan overrides, then returns the plan without performing the move.

    Default value is false.

Body

Overrides defaults for the move of each cluster

  • Optional list of Elasticsearch clusters to move off the allocator.

    Hide elasticsearch_clusters attributes Show elasticsearch_clusters attributes object
    • cluster_ids array[string] Required

      Identifiers for the Elasticsearch clusters.

    • Defines the configuration parameters that control how the plan is applied. For example, the Elasticsearch cluster topology and Elasticsearch settings.

      Additional properties are allowed.

      Hide plan_override attributes Show plan_override attributes object
      • strategy object

        The options for performing a plan change. Specify only one property each time. The default is grow_and_shrink.

        Additional properties are allowed.

        Hide strategy attributes Show strategy attributes object
        • rolling object

          Performs inline, rolling configuration changes that mutate existing containers. TIP: This is the fastest way to update a plan, but can fail for complex plan changes, such as topology changes. Also, this is less safe for configuration changes that leave a cluster in a non running state. NOTE: When you perform a major version upgrade, and 'group_by' is set to 'pass:macros[all]';, rolling is required.

          Additional properties are allowed.

          Hide rolling attributes Show rolling attributes object
          • group_by string

            Specifies the grouping attribute to use when rolling several instances. Instances that share the same value for the provided attribute key are rolled together as a unit. Examples that make sense to use are '__all__' (roll all instances as a single unit), 'logical_zone_name' (roll instances by zone), '__name__' (roll one instance at a time, the default if not specified). Note that '__all__' is required when performing a major version upgrade

          • 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

          • 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)

        • A strategy that creates instances with the new plan, migrates data from the old instances, then shuts down the old instances. GrowShrinkStrategyConfig is safer than 'rolling' and ensures single node availability during a plan change, but can be a lot slower on larger clusters.

          Additional properties are allowed.

        • A strategy that creates new Elasticsearch instances, Kibana instances, and APM Servers with the new plan, then migrates the node data to minimize the amount of spare capacity.

          Additional properties are allowed.

        • A strategy that lets constructor choose the most optimal way to execute the plan.

          Additional properties are allowed.

      • The configuration settings for the timeout and fallback parameters.

        Additional properties are allowed.

        Hide plan_configuration attributes Show plan_configuration attributes object
        • timeout integer(int64)

          The total timeout in seconds after which the plan is cancelled even if it is not complete. Defaults to 4x the max memory capacity per node (in MB). NOTES: A 3 zone cluster with 2 nodes of 2048 each would have a timeout of 4*2048=8192 seconds. Timeout does not include time required to run rollback actions.

        • calm_wait_time integer(int64)

          This timeout determines how long to give a cluster after it responds to API calls before performing actual operations on it. It defaults to 5s

        • move_instances array[object]
          Hide move_instances attributes Show move_instances attributes object
          • from string Required

            The instance id that is going to be moved

          • to array[string]

            An optional list of allocator ids to which the instance should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)

          • Tells the infrastructure that the instance should be considered as permanently down when deciding how to migrate data to new nodes. If left blank then the system will automatically decide (currently: will treat the instances as up)

        • move_allocators array[object]
          Hide move_allocators attributes Show move_allocators attributes object
          • from string Required

            The allocator id off which all instances in the cluster should be moved

          • to array[string]

            An optional list of allocator ids to which the instance(s) should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)

          • 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)

        • move_only boolean

          If true (default: false) only move_instances and move_allocators instructions will be executed, all other changes will be ignored

        • If true (default: false) does not allow re-using any existing instances currently in the cluster, ie even unchanged instances will be re-created

        • List of allocators on which instances are placed if possible (if not possible/not specified then any available allocator with space is used)

        • Map containing allocators tags in form of key value pairs, increasing the likelihood during move requests for allocators with matching tags, to be selected as target allocators

          Hide preferred_allocator_tags attribute Show preferred_allocator_tags attribute object
          • * string Additional properties
        • If true (default: false), does not take (or require) a successful snapshot to be taken before performing any potentially destructive changes to this cluster

        • 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

        • 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

        • 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.

        • If false (the default) then the plan will fail out if it believes the requested sequence of operations can result in data loss - this flag will override some of these restraints

        • If true (default: false) then the plan will not wait for data to be migrated from old instances to new instances before continuing the plan (potentially deleting the old instances and losing data)

        • If false, the cluster is checked for issues that should be resolved before migration (eg contains old Lucene segments), if true this is bypassed

        • If false (the default), the cluster will run (currently) 2.x->5.x operations for any plan change ending with a 5.x cluster (eg apply a cluster license, ensure Monitoring is configured)

        • If false (the default), the cluster will perform a snapshot after a major version upgrade takes place

      • Restores a snapshot from a local or remote repository.

        Additional properties are allowed.

        Hide restore_snapshot attributes Show restore_snapshot attributes object
        • 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

        • Raw remote snapshot restore settings. Do not send this if you are sending source_cluster_id

          Additional properties are allowed.

          Hide repository_config attribute Show repository_config attribute object
          • The remote snapshot settings raw JSON - see the Elasticsearch '_snapshot' documentation for more details on supported formats

            Additional properties are allowed.

        • The configuration for the restore command, such as which indices you want to restore.

          Additional properties are allowed.

          Hide restore_payload attributes Show restore_payload attributes object
          • indices array[string]

            The list of indices to restore (supports +ve and -ve selection and wildcarding - see the default Elasticsearch index format documentation)

          • This JSON object (merged with the 'indices' field (if present) is passed untouched into the restore command - see the Elasticsearch '_snapshot' documentation for more details on supported formats

            Additional properties are allowed.

        • strategy string

          The restore strategy to use. Defaults to a full restore. Partial restore will attempt to restore unavailable indices only

          Values are partial, full, or recovery.

        • If specified, contains the name of the source cluster id. Do not send this if you are sending repository_config

      • The list of resources that will be configured as remote clusters

        Additional properties are allowed.

        Hide remote_clusters attribute Show remote_clusters attribute object
        • resources array[object] Required

          The remote resources

          Hide resources attributes Show resources attributes object
          • deployment_id string Required

            The id of the deployment

          • elasticsearch_ref_id string Required

            The locally-unique user-specified id of an Elasticsearch Resource

          • alias string Required

            The alias for this remote cluster. Aliases must only contain letters, digits, dashes and underscores

          • If true, skip this cluster during search if it is disconnected. Default: false

      • If specified, contains transient settings to be applied to an Elasticsearch cluster during changes,default values shown below applied. These can be overridden by specifying them in the map (or null to unset). Additional settings can also be set. Settings will be cleared after the plan has finished. If not specified, no settings will be applied. NOTE: These settings are only explicitly cleared for 5.x+ clusters, they must be hand-reset to their defaults in 2.x- (or a cluster reboot will clear them).

        • indices.store.throttle.max_bytes_per_sec: 120Mb
        • indices.recovery.max_bytes_per_sec: 120Mb
        • cluster.routing.allocation.cluster_concurrent_rebalance: 5
        • cluster.routing.allocation.node_initial_primaries_recoveries: 5
        • cluster.routing.allocation.node_concurrent_incoming_recoveries: 5 For version 8.1 and later no defaults are provided through this mechanism, but instead hardware dependent settings are provided to each instance.

        Additional properties are allowed.

  • kibana_clusters array[object]

    Optional list of Kibana clusters to move off the allocator.

    Hide kibana_clusters attributes Show kibana_clusters attributes object
    • cluster_ids array[string] Required

      Identifiers for the Kibana clusters.

    • Defines the configuration parameters that control how the plan is applied. For example, the Elasticsearch cluster topology and Kibana instance settings.

      Additional properties are allowed.

      Hide plan_override attributes Show plan_override attributes object
      • strategy object

        The options for performing a plan change. Specify only one property each time. The default is grow_and_shrink.

        Additional properties are allowed.

        Hide strategy attributes Show strategy attributes object
        • rolling object

          Performs inline, rolling configuration changes that mutate existing containers. TIP: This is the fastest way to update a plan, but can fail for complex plan changes, such as topology changes. Also, this is less safe for configuration changes that leave a cluster in a non running state. NOTE: When you perform a major version upgrade, and 'group_by' is set to 'pass:macros[all]';, rolling is required.

          Additional properties are allowed.

          Hide rolling attributes Show rolling attributes object
          • group_by string

            Specifies the grouping attribute to use when rolling several instances. Instances that share the same value for the provided attribute key are rolled together as a unit. Examples that make sense to use are '__all__' (roll all instances as a single unit), 'logical_zone_name' (roll instances by zone), '__name__' (roll one instance at a time, the default if not specified). Note that '__all__' is required when performing a major version upgrade

          • 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

          • 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)

        • A strategy that creates instances with the new plan, migrates data from the old instances, then shuts down the old instances. GrowShrinkStrategyConfig is safer than 'rolling' and ensures single node availability during a plan change, but can be a lot slower on larger clusters.

          Additional properties are allowed.

        • A strategy that creates new Elasticsearch instances, Kibana instances, and APM Servers with the new plan, then migrates the node data to minimize the amount of spare capacity.

          Additional properties are allowed.

        • A strategy that lets constructor choose the most optimal way to execute the plan.

          Additional properties are allowed.

      • The configuration settings for the timeout and fallback parameters.

        Additional properties are allowed.

        Hide plan_configuration attributes Show plan_configuration attributes object
        • timeout integer(int64)

          The total timeout in seconds after which the plan is cancelled even if it is not complete. Defaults to 4x the max memory capacity per node (in MB)

        • calm_wait_time integer(int64)

          This timeout determines how long to give a cluster after it responds to API calls before performing actual operations on it. It defaults to 5s

        • move_instances array[object]
          Hide move_instances attributes Show move_instances attributes object
          • from string Required

            The instance id that is going to be moved

          • to array[string]

            An optional list of allocator ids to which the instance should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)

          • Tells the infrastructure that the instance should be considered as permanently down when deciding how to migrate data to new nodes. If left blank then the system will automatically decide (currently: will treat the instances as up)

        • move_allocators array[object]
          Hide move_allocators attributes Show move_allocators attributes object
          • from string Required

            The allocator id off which all instances in the cluster should be moved

          • to array[string]

            An optional list of allocator ids to which the instance(s) should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)

          • 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)

        • If true (default: false) does not allow re-using any existing instances currently in the cluster, ie even unchanged instances will be re-created

        • List of allocators on which instances are placed if possible (if not possible/not specified then any available allocator with space is used)

        • Map containing allocators tags in form of key value pairs, increasing the likelihood during move requests for allocators with matching tags, to be selected as target allocators

          Hide preferred_allocator_tags attribute Show preferred_allocator_tags attribute object
          • * string Additional properties
        • 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

        • Set to 'forced' to force a reboot as part of the upgrade plan

          Value is forced.

        • If false (the default), the plan fails if it determines that the request can result in unsafe operations. Setting this flag overrides some of these check restraints.

  • apm_clusters array[object]

    Optional list of Apm clusters to move off the allocator.

    Hide apm_clusters attributes Show apm_clusters attributes object
    • cluster_ids array[string] Required

      Identifiers for the Apm clusters.

    • Defines the configuration parameters that control how the plan is applied. For example, the Elasticsearch cluster topology and APM Server settings.

      Additional properties are allowed.

      Hide plan_override attributes Show plan_override attributes object
      • strategy object

        The options for performing a plan change. Specify only one property each time. The default is grow_and_shrink.

        Additional properties are allowed.

        Hide strategy attributes Show strategy attributes object
        • rolling object

          Performs inline, rolling configuration changes that mutate existing containers. TIP: This is the fastest way to update a plan, but can fail for complex plan changes, such as topology changes. Also, this is less safe for configuration changes that leave a cluster in a non running state. NOTE: When you perform a major version upgrade, and 'group_by' is set to 'pass:macros[all]';, rolling is required.

          Additional properties are allowed.

          Hide rolling attributes Show rolling attributes object
          • group_by string

            Specifies the grouping attribute to use when rolling several instances. Instances that share the same value for the provided attribute key are rolled together as a unit. Examples that make sense to use are '__all__' (roll all instances as a single unit), 'logical_zone_name' (roll instances by zone), '__name__' (roll one instance at a time, the default if not specified). Note that '__all__' is required when performing a major version upgrade

          • 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

          • 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)

        • A strategy that creates instances with the new plan, migrates data from the old instances, then shuts down the old instances. GrowShrinkStrategyConfig is safer than 'rolling' and ensures single node availability during a plan change, but can be a lot slower on larger clusters.

          Additional properties are allowed.

        • A strategy that creates new Elasticsearch instances, Kibana instances, and APM Servers with the new plan, then migrates the node data to minimize the amount of spare capacity.

          Additional properties are allowed.

        • A strategy that lets constructor choose the most optimal way to execute the plan.

          Additional properties are allowed.

      • The plan control configuration options for the APM Server.

        Additional properties are allowed.

        Hide plan_configuration attributes Show plan_configuration attributes object
        • timeout integer(int64)

          The total timeout in seconds after which the plan is cancelled even if it is not complete. Defaults to 4x the max memory capacity per node (in MB)

        • calm_wait_time integer(int64)

          This timeout determines how long to give a cluster after it responds to API calls before performing actual operations on it. It defaults to 5s

        • move_instances array[object]
          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)

          • Tells the infrastructure that the instance should be considered as permanently down when deciding how to migrate data to new nodes. If left blank then the system will automatically decide (currently: will treat the instances as up)

        • move_allocators array[object]
          Hide move_allocators attributes Show move_allocators attributes object
          • from string Required

            The allocator id off which all instances in the cluster should be moved

          • to array[string]

            An optional list of allocator ids to which the instance(s) should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)

          • 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)

        • If true (default: false) does not allow re-using any existing instances currently in the cluster, ie even unchanged instances will be re-created

        • List of allocators on which instances are placed if possible (if not possible/not specified then any available allocator with space is used)

        • Map containing allocators tags in form of key value pairs, increasing the likelihood during move requests for allocators with matching tags, to be selected as target allocators

          Hide preferred_allocator_tags attribute Show preferred_allocator_tags attribute object
          • * string Additional properties
        • 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

        • Set to 'forced' to force a reboot as part of the upgrade plan

          Value is forced.

        • If false (the default), the plan fails if it determines that the request can result in unsafe operations. Setting this flag overrides some of these check restraints.

  • appsearch_clusters array[object]

    Optional list of App Search clusters to move off the allocator.

    Hide appsearch_clusters attributes Show appsearch_clusters attributes object
    • cluster_ids array[string] Required

      Identifiers for the App Searches.

    • Defines configuration parameters that control how the plan (ie consisting of the cluster topology and AppSearch settings) is applied

      Additional properties are allowed.

      Hide plan_override attributes Show plan_override attributes object
      • strategy object

        The options for performing a plan change. Specify only one property each time. The default is grow_and_shrink.

        Additional properties are allowed.

        Hide strategy attributes Show strategy attributes object
        • rolling object

          Performs inline, rolling configuration changes that mutate existing containers. TIP: This is the fastest way to update a plan, but can fail for complex plan changes, such as topology changes. Also, this is less safe for configuration changes that leave a cluster in a non running state. NOTE: When you perform a major version upgrade, and 'group_by' is set to 'pass:macros[all]';, rolling is required.

          Additional properties are allowed.

          Hide rolling attributes Show rolling attributes object
          • group_by string

            Specifies the grouping attribute to use when rolling several instances. Instances that share the same value for the provided attribute key are rolled together as a unit. Examples that make sense to use are '__all__' (roll all instances as a single unit), 'logical_zone_name' (roll instances by zone), '__name__' (roll one instance at a time, the default if not specified). Note that '__all__' is required when performing a major version upgrade

          • 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

          • 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)

        • A strategy that creates instances with the new plan, migrates data from the old instances, then shuts down the old instances. GrowShrinkStrategyConfig is safer than 'rolling' and ensures single node availability during a plan change, but can be a lot slower on larger clusters.

          Additional properties are allowed.

        • A strategy that creates new Elasticsearch instances, Kibana instances, and APM Servers with the new plan, then migrates the node data to minimize the amount of spare capacity.

          Additional properties are allowed.

        • A strategy that lets constructor choose the most optimal way to execute the plan.

          Additional properties are allowed.

      • Additional properties are allowed.

        Hide plan_configuration attributes Show plan_configuration attributes object
        • timeout integer(int64)

          The total timeout in seconds after which the plan is cancelled even if it is not complete. Defaults to 4x the max memory capacity per node (in MB)

        • calm_wait_time integer(int64)

          This timeout determines how long to give a cluster after it responds to API calls before performing actual operations on it. It defaults to 5s

        • move_instances array[object]
          Hide move_instances attributes Show move_instances attributes object
          • from string Required

            The instance id that is going to be moved

          • to array[string]

            An optional list of allocator ids to which the instance should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)

          • Tells the infrastructure that the instance should be considered as permanently down when deciding how to migrate data to new nodes. If left blank then the system will automatically decide (currently: will treat the instances as up)

        • move_allocators array[object]
          Hide move_allocators attributes Show move_allocators attributes object
          • from string Required

            The allocator id off which all instances in the cluster should be moved

          • to array[string]

            An optional list of allocator ids to which the instance(s) should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)

          • 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)

        • If true (default: false) does not allow re-using any existing instances currently in the cluster, ie even unchanged instances will be re-created

        • List of allocators on which instances are placed if possible (if not possible/not specified then any available allocator with space is used)

        • Map containing allocators tags in form of key value pairs, increasing the likelihood during move requests for allocators with matching tags, to be selected as target allocators

          Hide preferred_allocator_tags attribute Show preferred_allocator_tags attribute object
          • * string Additional properties
        • 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

        • Set to 'forced' to force a reboot as part of the upgrade plan

          Value is forced.

        • If false (the default), the plan fails if it determines that the request can result in unsafe operations. Setting this flag overrides some of these check restraints.

  • Optional list of Elastic Enterprise Search clusters to move off the allocator.

    Hide enterprise_search_clusters attributes Show enterprise_search_clusters attributes object
    • cluster_ids array[string] Required

      Identifiers for the Elastic Enterprise Search clusters.

    • Defines configuration parameters that control how the plan (i.e. consisting of the cluster topology and Enterprise Search settings) is applied

      Additional properties are allowed.

      Hide plan_override attributes Show plan_override attributes object
      • strategy object

        The options for performing a plan change. Specify only one property each time. The default is grow_and_shrink.

        Additional properties are allowed.

        Hide strategy attributes Show strategy attributes object
        • rolling object

          Performs inline, rolling configuration changes that mutate existing containers. TIP: This is the fastest way to update a plan, but can fail for complex plan changes, such as topology changes. Also, this is less safe for configuration changes that leave a cluster in a non running state. NOTE: When you perform a major version upgrade, and 'group_by' is set to 'pass:macros[all]';, rolling is required.

          Additional properties are allowed.

          Hide rolling attributes Show rolling attributes object
          • group_by string

            Specifies the grouping attribute to use when rolling several instances. Instances that share the same value for the provided attribute key are rolled together as a unit. Examples that make sense to use are '__all__' (roll all instances as a single unit), 'logical_zone_name' (roll instances by zone), '__name__' (roll one instance at a time, the default if not specified). Note that '__all__' is required when performing a major version upgrade

          • 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

          • 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)

        • A strategy that creates instances with the new plan, migrates data from the old instances, then shuts down the old instances. GrowShrinkStrategyConfig is safer than 'rolling' and ensures single node availability during a plan change, but can be a lot slower on larger clusters.

          Additional properties are allowed.

        • A strategy that creates new Elasticsearch instances, Kibana instances, and APM Servers with the new plan, then migrates the node data to minimize the amount of spare capacity.

          Additional properties are allowed.

        • A strategy that lets constructor choose the most optimal way to execute the plan.

          Additional properties are allowed.

      • Additional properties are allowed.

        Hide plan_configuration attributes Show plan_configuration attributes object
        • timeout integer(int64)

          The total timeout in seconds after which the plan is cancelled even if it is not complete. Defaults to 4x the max memory capacity per node (in MB)

        • calm_wait_time integer(int64)

          This timeout determines how long to give a cluster after it responds to API calls before performing actual operations on it. It defaults to 5s

        • move_instances array[object]
          Hide move_instances attributes Show move_instances attributes object
          • from string Required

            The instance id that is going to be moved

          • to array[string]

            An optional list of allocator ids to which the instance should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)

          • Tells the infrastructure that the instance should be considered as permanently down when deciding how to migrate data to new nodes. If left blank then the system will automatically decide (currently: will treat the instances as up)

        • move_allocators array[object]
          Hide move_allocators attributes Show move_allocators attributes object
          • from string Required

            The allocator id off which all instances in the cluster should be moved

          • to array[string]

            An optional list of allocator ids to which the instance(s) should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)

          • 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)

        • 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

        • List of allocators on which instances are placed if possible (if not possible/not specified then any available allocator with space is used)

        • Map containing allocators tags in form of key value pairs, increasing the likelihood during move requests for allocators with matching tags, to be selected as target allocators

          Hide preferred_allocator_tags attribute Show preferred_allocator_tags attribute object
          • * string Additional properties
        • 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

        • Set to 'forced' to force a reboot as part of the upgrade plan

          Value is forced.

        • If false (the default), the plan fails if it determines that the request can result in unsafe operations. Setting this flag overrides some of these check restraints.

Responses

  • The move command was issued successfully, use the "GET" command on each /{cluster_id} resource to monitor progress

    Hide response attributes Show response attributes object
    • failures object Required

      Detailed information about the clusters that failed to move.

      Additional properties are allowed.

      Hide failures attributes Show failures attributes object
      • elasticsearch_clusters array[object] Required

        Detailed information about the Elasticsearch clusters being moved.

        Hide elasticsearch_clusters attributes Show elasticsearch_clusters attributes object
        • cluster_id string Required

          Identifier for the Elasticsearch cluster.

        • Defines the configuration parameters that control how the plan is applied. For example, the Elasticsearch cluster topology and Elasticsearch settings.

          Additional properties are allowed.

          Hide calculated_plan attributes Show calculated_plan attributes object
          • strategy object

            The options for performing a plan change. Specify only one property each time. The default is grow_and_shrink.

            Additional properties are allowed.

            Hide strategy attributes Show strategy attributes object
            • rolling object

              Performs inline, rolling configuration changes that mutate existing containers. TIP: This is the fastest way to update a plan, but can fail for complex plan changes, such as topology changes. Also, this is less safe for configuration changes that leave a cluster in a non running state. NOTE: When you perform a major version upgrade, and 'group_by' is set to 'pass:macros[all]';, rolling is required.

              Additional properties are allowed.

              Hide rolling attributes Show rolling attributes object
              • group_by string

                Specifies the grouping attribute to use when rolling several instances. Instances that share the same value for the provided attribute key are rolled together as a unit. Examples that make sense to use are '__all__' (roll all instances as a single unit), 'logical_zone_name' (roll instances by zone), '__name__' (roll one instance at a time, the default if not specified). Note that '__all__' is required when performing a major version upgrade

              • 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

              • 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)

            • A strategy that creates instances with the new plan, migrates data from the old instances, then shuts down the old instances. GrowShrinkStrategyConfig is safer than 'rolling' and ensures single node availability during a plan change, but can be a lot slower on larger clusters.

              Additional properties are allowed.

            • A strategy that creates new Elasticsearch instances, Kibana instances, and APM Servers with the new plan, then migrates the node data to minimize the amount of spare capacity.

              Additional properties are allowed.

            • A strategy that lets constructor choose the most optimal way to execute the plan.

              Additional properties are allowed.

          • The configuration settings for the timeout and fallback parameters.

            Additional properties are allowed.

            Hide plan_configuration attributes Show plan_configuration attributes object
            • timeout integer(int64)

              The total timeout in seconds after which the plan is cancelled even if it is not complete. Defaults to 4x the max memory capacity per node (in MB). NOTES: A 3 zone cluster with 2 nodes of 2048 each would have a timeout of 4*2048=8192 seconds. Timeout does not include time required to run rollback actions.

            • calm_wait_time integer(int64)

              This timeout determines how long to give a cluster after it responds to API calls before performing actual operations on it. It defaults to 5s

            • move_instances array[object]
              Hide move_instances attributes Show move_instances attributes object
              • from string Required

                The instance id that is going to be moved

              • to array[string]

                An optional list of allocator ids to which the instance should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)

              • Tells the infrastructure that the instance should be considered as permanently down when deciding how to migrate data to new nodes. If left blank then the system will automatically decide (currently: will treat the instances as up)

            • move_allocators array[object]
              Hide move_allocators attributes Show move_allocators attributes object
              • from string Required

                The allocator id off which all instances in the cluster should be moved

              • to array[string]

                An optional list of allocator ids to which the instance(s) should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)

              • 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)

            • move_only boolean

              If true (default: false) only move_instances and move_allocators instructions will be executed, all other changes will be ignored

            • If true (default: false) does not allow re-using any existing instances currently in the cluster, ie even unchanged instances will be re-created

            • List of allocators on which instances are placed if possible (if not possible/not specified then any available allocator with space is used)

            • Map containing allocators tags in form of key value pairs, increasing the likelihood during move requests for allocators with matching tags, to be selected as target allocators

              Hide preferred_allocator_tags attribute Show preferred_allocator_tags attribute object
              • * string Additional properties
            • If true (default: false), does not take (or require) a successful snapshot to be taken before performing any potentially destructive changes to this cluster

            • 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

            • 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

            • 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.

            • If false (the default) then the plan will fail out if it believes the requested sequence of operations can result in data loss - this flag will override some of these restraints

            • If true (default: false) then the plan will not wait for data to be migrated from old instances to new instances before continuing the plan (potentially deleting the old instances and losing data)

            • If false, the cluster is checked for issues that should be resolved before migration (eg contains old Lucene segments), if true this is bypassed

            • If false (the default), the cluster will run (currently) 2.x->5.x operations for any plan change ending with a 5.x cluster (eg apply a cluster license, ensure Monitoring is configured)

            • If false (the default), the cluster will perform a snapshot after a major version upgrade takes place

          • Restores a snapshot from a local or remote repository.

            Additional properties are allowed.

            Hide restore_snapshot attributes Show restore_snapshot attributes object
            • 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

            • Raw remote snapshot restore settings. Do not send this if you are sending source_cluster_id

              Additional properties are allowed.

              Hide repository_config attribute Show repository_config attribute object
              • The remote snapshot settings raw JSON - see the Elasticsearch '_snapshot' documentation for more details on supported formats

                Additional properties are allowed.

            • The configuration for the restore command, such as which indices you want to restore.

              Additional properties are allowed.

              Hide restore_payload attributes Show restore_payload attributes object
              • indices array[string]

                The list of indices to restore (supports +ve and -ve selection and wildcarding - see the default Elasticsearch index format documentation)

              • This JSON object (merged with the 'indices' field (if present) is passed untouched into the restore command - see the Elasticsearch '_snapshot' documentation for more details on supported formats

                Additional properties are allowed.

            • strategy string

              The restore strategy to use. Defaults to a full restore. Partial restore will attempt to restore unavailable indices only

              Values are partial, full, or recovery.

            • If specified, contains the name of the source cluster id. Do not send this if you are sending repository_config

          • The list of resources that will be configured as remote clusters

            Additional properties are allowed.

            Hide remote_clusters attribute Show remote_clusters attribute object
            • resources array[object] Required

              The remote resources

              Hide resources attributes Show resources attributes object
              • deployment_id string Required

                The id of the deployment

              • elasticsearch_ref_id string Required

                The locally-unique user-specified id of an Elasticsearch Resource

              • alias string Required

                The alias for this remote cluster. Aliases must only contain letters, digits, dashes and underscores

              • If true, skip this cluster during search if it is disconnected. Default: false

              • info object

                Information about a Remote Cluster.

                Additional properties are allowed.

                Hide info attributes Show info attributes object
                • healthy boolean Required

                  Whether or not the remote cluster is healthy

                • connected boolean Required

                  Whether or not there is at least one connection to the remote cluster.

                • compatible boolean Required

                  Whether or not the remote cluster version is compatible with this cluster version.

                • trusted boolean Required

                  Whether or not the remote cluster is trusted by this cluster.

                • trusted_back boolean Required

                  Whether or not the remote cluster trusts this cluster back.

          • If specified, contains transient settings to be applied to an Elasticsearch cluster during changes,default values shown below applied. These can be overridden by specifying them in the map (or null to unset). Additional settings can also be set. Settings will be cleared after the plan has finished. If not specified, no settings will be applied. NOTE: These settings are only explicitly cleared for 5.x+ clusters, they must be hand-reset to their defaults in 2.x- (or a cluster reboot will clear them).

            • indices.store.throttle.max_bytes_per_sec: 120Mb
            • indices.recovery.max_bytes_per_sec: 120Mb
            • cluster.routing.allocation.cluster_concurrent_rebalance: 5
            • cluster.routing.allocation.node_initial_primaries_recoveries: 5
            • cluster.routing.allocation.node_concurrent_incoming_recoveries: 5 For version 8.1 and later no defaults are provided through this mechanism, but instead hardware dependent settings are provided to each instance.

            Additional properties are allowed.

        • errors array[object]

          A list of errors that occurred if the attempt to move the cluster failed.

          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

      • kibana_clusters array[object] Required

        Detailed information about the Kibana clusters being moved.

        Hide kibana_clusters attributes Show kibana_clusters attributes object
        • cluster_id string Required

          Identifier for the Kibana cluster.

        • Defines the configuration parameters that control how the plan is applied. For example, the Elasticsearch cluster topology and Kibana instance settings.

          Additional properties are allowed.

          Hide calculated_plan attributes Show calculated_plan attributes object
          • strategy object

            The options for performing a plan change. Specify only one property each time. The default is grow_and_shrink.

            Additional properties are allowed.

            Hide strategy attributes Show strategy attributes object
            • rolling object

              Performs inline, rolling configuration changes that mutate existing containers. TIP: This is the fastest way to update a plan, but can fail for complex plan changes, such as topology changes. Also, this is less safe for configuration changes that leave a cluster in a non running state. NOTE: When you perform a major version upgrade, and 'group_by' is set to 'pass:macros[all]';, rolling is required.

              Additional properties are allowed.

              Hide rolling attributes Show rolling attributes object
              • group_by string

                Specifies the grouping attribute to use when rolling several instances. Instances that share the same value for the provided attribute key are rolled together as a unit. Examples that make sense to use are '__all__' (roll all instances as a single unit), 'logical_zone_name' (roll instances by zone), '__name__' (roll one instance at a time, the default if not specified). Note that '__all__' is required when performing a major version upgrade

              • 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

              • 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)

            • A strategy that creates instances with the new plan, migrates data from the old instances, then shuts down the old instances. GrowShrinkStrategyConfig is safer than 'rolling' and ensures single node availability during a plan change, but can be a lot slower on larger clusters.

              Additional properties are allowed.

            • A strategy that creates new Elasticsearch instances, Kibana instances, and APM Servers with the new plan, then migrates the node data to minimize the amount of spare capacity.

              Additional properties are allowed.

            • A strategy that lets constructor choose the most optimal way to execute the plan.

              Additional properties are allowed.

          • The configuration settings for the timeout and fallback parameters.

            Additional properties are allowed.

            Hide plan_configuration attributes Show plan_configuration attributes object
            • timeout integer(int64)

              The total timeout in seconds after which the plan is cancelled even if it is not complete. Defaults to 4x the max memory capacity per node (in MB)

            • calm_wait_time integer(int64)

              This timeout determines how long to give a cluster after it responds to API calls before performing actual operations on it. It defaults to 5s

            • move_instances array[object]
              Hide move_instances attributes Show move_instances attributes object
              • from string Required

                The instance id that is going to be moved

              • to array[string]

                An optional list of allocator ids to which the instance should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)

              • Tells the infrastructure that the instance should be considered as permanently down when deciding how to migrate data to new nodes. If left blank then the system will automatically decide (currently: will treat the instances as up)

            • move_allocators array[object]
              Hide move_allocators attributes Show move_allocators attributes object
              • from string Required

                The allocator id off which all instances in the cluster should be moved

              • to array[string]

                An optional list of allocator ids to which the instance(s) should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)

              • 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)

            • If true (default: false) does not allow re-using any existing instances currently in the cluster, ie even unchanged instances will be re-created

            • List of allocators on which instances are placed if possible (if not possible/not specified then any available allocator with space is used)

            • Map containing allocators tags in form of key value pairs, increasing the likelihood during move requests for allocators with matching tags, to be selected as target allocators

              Hide preferred_allocator_tags attribute Show preferred_allocator_tags attribute object
              • * string Additional properties
            • 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

            • Set to 'forced' to force a reboot as part of the upgrade plan

              Value is forced.

            • If false (the default), the plan fails if it determines that the request can result in unsafe operations. Setting this flag overrides some of these check restraints.

        • errors array[object]

          A list of errors that occurred if the attempt to move the cluster failed.

          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

      • apm_clusters array[object] Required

        Detailed information about the Apm clusters being moved.

        Hide apm_clusters attributes Show apm_clusters attributes object
        • cluster_id string Required

          Identifier for the Apm cluster.

        • Defines the configuration parameters that control how the plan is applied. For example, the Elasticsearch cluster topology and APM Server settings.

          Additional properties are allowed.

          Hide calculated_plan attributes Show calculated_plan attributes object
          • strategy object

            The options for performing a plan change. Specify only one property each time. The default is grow_and_shrink.

            Additional properties are allowed.

            Hide strategy attributes Show strategy attributes object
            • rolling object

              Performs inline, rolling configuration changes that mutate existing containers. TIP: This is the fastest way to update a plan, but can fail for complex plan changes, such as topology changes. Also, this is less safe for configuration changes that leave a cluster in a non running state. NOTE: When you perform a major version upgrade, and 'group_by' is set to 'pass:macros[all]';, rolling is required.

              Additional properties are allowed.

              Hide rolling attributes Show rolling attributes object
              • group_by string

                Specifies the grouping attribute to use when rolling several instances. Instances that share the same value for the provided attribute key are rolled together as a unit. Examples that make sense to use are '__all__' (roll all instances as a single unit), 'logical_zone_name' (roll instances by zone), '__name__' (roll one instance at a time, the default if not specified). Note that '__all__' is required when performing a major version upgrade

              • 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

              • 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)

            • A strategy that creates instances with the new plan, migrates data from the old instances, then shuts down the old instances. GrowShrinkStrategyConfig is safer than 'rolling' and ensures single node availability during a plan change, but can be a lot slower on larger clusters.

              Additional properties are allowed.

            • A strategy that creates new Elasticsearch instances, Kibana instances, and APM Servers with the new plan, then migrates the node data to minimize the amount of spare capacity.

              Additional properties are allowed.

            • A strategy that lets constructor choose the most optimal way to execute the plan.

              Additional properties are allowed.

          • The plan control configuration options for the APM Server.

            Additional properties are allowed.

            Hide plan_configuration attributes Show plan_configuration attributes object
            • timeout integer(int64)

              The total timeout in seconds after which the plan is cancelled even if it is not complete. Defaults to 4x the max memory capacity per node (in MB)

            • calm_wait_time integer(int64)

              This timeout determines how long to give a cluster after it responds to API calls before performing actual operations on it. It defaults to 5s

            • move_instances array[object]
              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)

              • Tells the infrastructure that the instance should be considered as permanently down when deciding how to migrate data to new nodes. If left blank then the system will automatically decide (currently: will treat the instances as up)

            • move_allocators array[object]
              Hide move_allocators attributes Show move_allocators attributes object
              • from string Required

                The allocator id off which all instances in the cluster should be moved

              • to array[string]

                An optional list of allocator ids to which the instance(s) should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)

              • 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)

            • If true (default: false) does not allow re-using any existing instances currently in the cluster, ie even unchanged instances will be re-created

            • List of allocators on which instances are placed if possible (if not possible/not specified then any available allocator with space is used)

            • Map containing allocators tags in form of key value pairs, increasing the likelihood during move requests for allocators with matching tags, to be selected as target allocators

              Hide preferred_allocator_tags attribute Show preferred_allocator_tags attribute object
              • * string Additional properties
            • 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

            • Set to 'forced' to force a reboot as part of the upgrade plan

              Value is forced.

            • If false (the default), the plan fails if it determines that the request can result in unsafe operations. Setting this flag overrides some of these check restraints.

        • errors array[object]

          A list of errors that occurred if the attempt to move the cluster failed.

          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

      • appsearch_clusters array[object] Required

        Detailed information about the App Search clusters being moved.

        Hide appsearch_clusters attributes Show appsearch_clusters attributes object
        • cluster_id string Required

          Identifier for the App Search.

        • Defines configuration parameters that control how the plan (ie consisting of the cluster topology and AppSearch settings) is applied

          Additional properties are allowed.

          Hide calculated_plan attributes Show calculated_plan attributes object
          • strategy object

            The options for performing a plan change. Specify only one property each time. The default is grow_and_shrink.

            Additional properties are allowed.

            Hide strategy attributes Show strategy attributes object
            • rolling object

              Performs inline, rolling configuration changes that mutate existing containers. TIP: This is the fastest way to update a plan, but can fail for complex plan changes, such as topology changes. Also, this is less safe for configuration changes that leave a cluster in a non running state. NOTE: When you perform a major version upgrade, and 'group_by' is set to 'pass:macros[all]';, rolling is required.

              Additional properties are allowed.

              Hide rolling attributes Show rolling attributes object
              • group_by string

                Specifies the grouping attribute to use when rolling several instances. Instances that share the same value for the provided attribute key are rolled together as a unit. Examples that make sense to use are '__all__' (roll all instances as a single unit), 'logical_zone_name' (roll instances by zone), '__name__' (roll one instance at a time, the default if not specified). Note that '__all__' is required when performing a major version upgrade

              • 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

              • 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)

            • A strategy that creates instances with the new plan, migrates data from the old instances, then shuts down the old instances. GrowShrinkStrategyConfig is safer than 'rolling' and ensures single node availability during a plan change, but can be a lot slower on larger clusters.

              Additional properties are allowed.

            • A strategy that creates new Elasticsearch instances, Kibana instances, and APM Servers with the new plan, then migrates the node data to minimize the amount of spare capacity.

              Additional properties are allowed.

            • A strategy that lets constructor choose the most optimal way to execute the plan.

              Additional properties are allowed.

          • Additional properties are allowed.

            Hide plan_configuration attributes Show plan_configuration attributes object
            • timeout integer(int64)

              The total timeout in seconds after which the plan is cancelled even if it is not complete. Defaults to 4x the max memory capacity per node (in MB)

            • calm_wait_time integer(int64)

              This timeout determines how long to give a cluster after it responds to API calls before performing actual operations on it. It defaults to 5s

            • move_instances array[object]
              Hide move_instances attributes Show move_instances attributes object
              • from string Required

                The instance id that is going to be moved

              • to array[string]

                An optional list of allocator ids to which the instance should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)

              • Tells the infrastructure that the instance should be considered as permanently down when deciding how to migrate data to new nodes. If left blank then the system will automatically decide (currently: will treat the instances as up)

            • move_allocators array[object]
              Hide move_allocators attributes Show move_allocators attributes object
              • from string Required

                The allocator id off which all instances in the cluster should be moved

              • to array[string]

                An optional list of allocator ids to which the instance(s) should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)

              • 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)

            • If true (default: false) does not allow re-using any existing instances currently in the cluster, ie even unchanged instances will be re-created

            • List of allocators on which instances are placed if possible (if not possible/not specified then any available allocator with space is used)

            • Map containing allocators tags in form of key value pairs, increasing the likelihood during move requests for allocators with matching tags, to be selected as target allocators

              Hide preferred_allocator_tags attribute Show preferred_allocator_tags attribute object
              • * string Additional properties
            • 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

            • Set to 'forced' to force a reboot as part of the upgrade plan

              Value is forced.

            • If false (the default), the plan fails if it determines that the request can result in unsafe operations. Setting this flag overrides some of these check restraints.

        • errors array[object]

          A list of errors that occurred if the attempt to move the cluster failed.

          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

      • enterprise_search_clusters array[object] Required

        Detailed information about the Elastic Enterprise Search clusters being moved.

        Hide enterprise_search_clusters attributes Show enterprise_search_clusters attributes object
        • cluster_id string Required

          Identifier for the Elastic Enterprise Search.

        • Defines configuration parameters that control how the plan (i.e. consisting of the cluster topology and Enterprise Search settings) is applied

          Additional properties are allowed.

          Hide calculated_plan attributes Show calculated_plan attributes object
          • strategy object

            The options for performing a plan change. Specify only one property each time. The default is grow_and_shrink.

            Additional properties are allowed.

            Hide strategy attributes Show strategy attributes object
            • rolling object

              Performs inline, rolling configuration changes that mutate existing containers. TIP: This is the fastest way to update a plan, but can fail for complex plan changes, such as topology changes. Also, this is less safe for configuration changes that leave a cluster in a non running state. NOTE: When you perform a major version upgrade, and 'group_by' is set to 'pass:macros[all]';, rolling is required.

              Additional properties are allowed.

              Hide rolling attributes Show rolling attributes object
              • group_by string

                Specifies the grouping attribute to use when rolling several instances. Instances that share the same value for the provided attribute key are rolled together as a unit. Examples that make sense to use are '__all__' (roll all instances as a single unit), 'logical_zone_name' (roll instances by zone), '__name__' (roll one instance at a time, the default if not specified). Note that '__all__' is required when performing a major version upgrade

              • 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

              • 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)

            • A strategy that creates instances with the new plan, migrates data from the old instances, then shuts down the old instances. GrowShrinkStrategyConfig is safer than 'rolling' and ensures single node availability during a plan change, but can be a lot slower on larger clusters.

              Additional properties are allowed.

            • A strategy that creates new Elasticsearch instances, Kibana instances, and APM Servers with the new plan, then migrates the node data to minimize the amount of spare capacity.

              Additional properties are allowed.

            • A strategy that lets constructor choose the most optimal way to execute the plan.

              Additional properties are allowed.

          • Additional properties are allowed.

            Hide plan_configuration attributes Show plan_configuration attributes object
            • timeout integer(int64)

              The total timeout in seconds after which the plan is cancelled even if it is not complete. Defaults to 4x the max memory capacity per node (in MB)

            • calm_wait_time integer(int64)

              This timeout determines how long to give a cluster after it responds to API calls before performing actual operations on it. It defaults to 5s

            • move_instances array[object]
              Hide move_instances attributes Show move_instances attributes object
              • from string Required

                The instance id that is going to be moved

              • to array[string]

                An optional list of allocator ids to which the instance should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)

              • Tells the infrastructure that the instance should be considered as permanently down when deciding how to migrate data to new nodes. If left blank then the system will automatically decide (currently: will treat the instances as up)

            • move_allocators array[object]
              Hide move_allocators attributes Show move_allocators attributes object
              • from string Required

                The allocator id off which all instances in the cluster should be moved

              • to array[string]

                An optional list of allocator ids to which the instance(s) should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)

              • 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)

            • 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

            • List of allocators on which instances are placed if possible (if not possible/not specified then any available allocator with space is used)

            • Map containing allocators tags in form of key value pairs, increasing the likelihood during move requests for allocators with matching tags, to be selected as target allocators

              Hide preferred_allocator_tags attribute Show preferred_allocator_tags attribute object
              • * string Additional properties
            • 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

            • Set to 'forced' to force a reboot as part of the upgrade plan

              Value is forced.

            • If false (the default), the plan fails if it determines that the request can result in unsafe operations. Setting this flag overrides some of these check restraints.

        • errors array[object]

          A list of errors that occurred if the attempt to move the cluster failed.

          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

    • moves object Required

      Detailed information about the clusters that failed to move.

      Additional properties are allowed.

      Hide moves attributes Show moves attributes object
      • elasticsearch_clusters array[object] Required

        Detailed information about the Elasticsearch clusters being moved.

        Hide elasticsearch_clusters attributes Show elasticsearch_clusters attributes object
        • cluster_id string Required

          Identifier for the Elasticsearch cluster.

        • Defines the configuration parameters that control how the plan is applied. For example, the Elasticsearch cluster topology and Elasticsearch settings.

          Additional properties are allowed.

          Hide calculated_plan attributes Show calculated_plan attributes object
          • strategy object

            The options for performing a plan change. Specify only one property each time. The default is grow_and_shrink.

            Additional properties are allowed.

            Hide strategy attributes Show strategy attributes object
            • rolling object

              Performs inline, rolling configuration changes that mutate existing containers. TIP: This is the fastest way to update a plan, but can fail for complex plan changes, such as topology changes. Also, this is less safe for configuration changes that leave a cluster in a non running state. NOTE: When you perform a major version upgrade, and 'group_by' is set to 'pass:macros[all]';, rolling is required.

              Additional properties are allowed.

              Hide rolling attributes Show rolling attributes object
              • group_by string

                Specifies the grouping attribute to use when rolling several instances. Instances that share the same value for the provided attribute key are rolled together as a unit. Examples that make sense to use are '__all__' (roll all instances as a single unit), 'logical_zone_name' (roll instances by zone), '__name__' (roll one instance at a time, the default if not specified). Note that '__all__' is required when performing a major version upgrade

              • 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

              • 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)

            • A strategy that creates instances with the new plan, migrates data from the old instances, then shuts down the old instances. GrowShrinkStrategyConfig is safer than 'rolling' and ensures single node availability during a plan change, but can be a lot slower on larger clusters.

              Additional properties are allowed.

            • A strategy that creates new Elasticsearch instances, Kibana instances, and APM Servers with the new plan, then migrates the node data to minimize the amount of spare capacity.

              Additional properties are allowed.

            • A strategy that lets constructor choose the most optimal way to execute the plan.

              Additional properties are allowed.

          • The configuration settings for the timeout and fallback parameters.

            Additional properties are allowed.

            Hide plan_configuration attributes Show plan_configuration attributes object
            • timeout integer(int64)

              The total timeout in seconds after which the plan is cancelled even if it is not complete. Defaults to 4x the max memory capacity per node (in MB). NOTES: A 3 zone cluster with 2 nodes of 2048 each would have a timeout of 4*2048=8192 seconds. Timeout does not include time required to run rollback actions.

            • calm_wait_time integer(int64)

              This timeout determines how long to give a cluster after it responds to API calls before performing actual operations on it. It defaults to 5s

            • move_instances array[object]
              Hide move_instances attributes Show move_instances attributes object
              • from string Required

                The instance id that is going to be moved

              • to array[string]

                An optional list of allocator ids to which the instance should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)

              • Tells the infrastructure that the instance should be considered as permanently down when deciding how to migrate data to new nodes. If left blank then the system will automatically decide (currently: will treat the instances as up)

            • move_allocators array[object]
              Hide move_allocators attributes Show move_allocators attributes object
              • from string Required

                The allocator id off which all instances in the cluster should be moved

              • to array[string]

                An optional list of allocator ids to which the instance(s) should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)

              • 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)

            • move_only boolean

              If true (default: false) only move_instances and move_allocators instructions will be executed, all other changes will be ignored

            • If true (default: false) does not allow re-using any existing instances currently in the cluster, ie even unchanged instances will be re-created

            • List of allocators on which instances are placed if possible (if not possible/not specified then any available allocator with space is used)

            • Map containing allocators tags in form of key value pairs, increasing the likelihood during move requests for allocators with matching tags, to be selected as target allocators

              Hide preferred_allocator_tags attribute Show preferred_allocator_tags attribute object
              • * string Additional properties
            • If true (default: false), does not take (or require) a successful snapshot to be taken before performing any potentially destructive changes to this cluster

            • 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

            • 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

            • 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.

            • If false (the default) then the plan will fail out if it believes the requested sequence of operations can result in data loss - this flag will override some of these restraints

            • If true (default: false) then the plan will not wait for data to be migrated from old instances to new instances before continuing the plan (potentially deleting the old instances and losing data)

            • If false, the cluster is checked for issues that should be resolved before migration (eg contains old Lucene segments), if true this is bypassed

            • If false (the default), the cluster will run (currently) 2.x->5.x operations for any plan change ending with a 5.x cluster (eg apply a cluster license, ensure Monitoring is configured)

            • If false (the default), the cluster will perform a snapshot after a major version upgrade takes place

          • Restores a snapshot from a local or remote repository.

            Additional properties are allowed.

            Hide restore_snapshot attributes Show restore_snapshot attributes object
            • 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

            • Raw remote snapshot restore settings. Do not send this if you are sending source_cluster_id

              Additional properties are allowed.

              Hide repository_config attribute Show repository_config attribute object
              • The remote snapshot settings raw JSON - see the Elasticsearch '_snapshot' documentation for more details on supported formats

                Additional properties are allowed.

            • The configuration for the restore command, such as which indices you want to restore.

              Additional properties are allowed.

              Hide restore_payload attributes Show restore_payload attributes object
              • indices array[string]

                The list of indices to restore (supports +ve and -ve selection and wildcarding - see the default Elasticsearch index format documentation)

              • This JSON object (merged with the 'indices' field (if present) is passed untouched into the restore command - see the Elasticsearch '_snapshot' documentation for more details on supported formats

                Additional properties are allowed.

            • strategy string

              The restore strategy to use. Defaults to a full restore. Partial restore will attempt to restore unavailable indices only

              Values are partial, full, or recovery.

            • If specified, contains the name of the source cluster id. Do not send this if you are sending repository_config

          • The list of resources that will be configured as remote clusters

            Additional properties are allowed.

            Hide remote_clusters attribute Show remote_clusters attribute object
            • resources array[object] Required

              The remote resources

              Hide resources attributes Show resources attributes object
              • deployment_id string Required

                The id of the deployment

              • elasticsearch_ref_id string Required

                The locally-unique user-specified id of an Elasticsearch Resource

              • alias string Required

                The alias for this remote cluster. Aliases must only contain letters, digits, dashes and underscores

              • If true, skip this cluster during search if it is disconnected. Default: false

              • info object

                Information about a Remote Cluster.

                Additional properties are allowed.

                Hide info attributes Show info attributes object
                • healthy boolean Required

                  Whether or not the remote cluster is healthy

                • connected boolean Required

                  Whether or not there is at least one connection to the remote cluster.

                • compatible boolean Required

                  Whether or not the remote cluster version is compatible with this cluster version.

                • trusted boolean Required

                  Whether or not the remote cluster is trusted by this cluster.

                • trusted_back boolean Required

                  Whether or not the remote cluster trusts this cluster back.

          • If specified, contains transient settings to be applied to an Elasticsearch cluster during changes,default values shown below applied. These can be overridden by specifying them in the map (or null to unset). Additional settings can also be set. Settings will be cleared after the plan has finished. If not specified, no settings will be applied. NOTE: These settings are only explicitly cleared for 5.x+ clusters, they must be hand-reset to their defaults in 2.x- (or a cluster reboot will clear them).

            • indices.store.throttle.max_bytes_per_sec: 120Mb
            • indices.recovery.max_bytes_per_sec: 120Mb
            • cluster.routing.allocation.cluster_concurrent_rebalance: 5
            • cluster.routing.allocation.node_initial_primaries_recoveries: 5
            • cluster.routing.allocation.node_concurrent_incoming_recoveries: 5 For version 8.1 and later no defaults are provided through this mechanism, but instead hardware dependent settings are provided to each instance.

            Additional properties are allowed.

        • errors array[object]

          A list of errors that occurred if the attempt to move the cluster failed.

          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

      • kibana_clusters array[object] Required

        Detailed information about the Kibana clusters being moved.

        Hide kibana_clusters attributes Show kibana_clusters attributes object
        • cluster_id string Required

          Identifier for the Kibana cluster.

        • Defines the configuration parameters that control how the plan is applied. For example, the Elasticsearch cluster topology and Kibana instance settings.

          Additional properties are allowed.

          Hide calculated_plan attributes Show calculated_plan attributes object
          • strategy object

            The options for performing a plan change. Specify only one property each time. The default is grow_and_shrink.

            Additional properties are allowed.

            Hide strategy attributes Show strategy attributes object
            • rolling object

              Performs inline, rolling configuration changes that mutate existing containers. TIP: This is the fastest way to update a plan, but can fail for complex plan changes, such as topology changes. Also, this is less safe for configuration changes that leave a cluster in a non running state. NOTE: When you perform a major version upgrade, and 'group_by' is set to 'pass:macros[all]';, rolling is required.

              Additional properties are allowed.

              Hide rolling attributes Show rolling attributes object
              • group_by string

                Specifies the grouping attribute to use when rolling several instances. Instances that share the same value for the provided attribute key are rolled together as a unit. Examples that make sense to use are '__all__' (roll all instances as a single unit), 'logical_zone_name' (roll instances by zone), '__name__' (roll one instance at a time, the default if not specified). Note that '__all__' is required when performing a major version upgrade

              • 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

              • 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)

            • A strategy that creates instances with the new plan, migrates data from the old instances, then shuts down the old instances. GrowShrinkStrategyConfig is safer than 'rolling' and ensures single node availability during a plan change, but can be a lot slower on larger clusters.

              Additional properties are allowed.

            • A strategy that creates new Elasticsearch instances, Kibana instances, and APM Servers with the new plan, then migrates the node data to minimize the amount of spare capacity.

              Additional properties are allowed.

            • A strategy that lets constructor choose the most optimal way to execute the plan.

              Additional properties are allowed.

          • The configuration settings for the timeout and fallback parameters.

            Additional properties are allowed.

            Hide plan_configuration attributes Show plan_configuration attributes object
            • timeout integer(int64)

              The total timeout in seconds after which the plan is cancelled even if it is not complete. Defaults to 4x the max memory capacity per node (in MB)

            • calm_wait_time integer(int64)

              This timeout determines how long to give a cluster after it responds to API calls before performing actual operations on it. It defaults to 5s

            • move_instances array[object]
              Hide move_instances attributes Show move_instances attributes object
              • from string Required

                The instance id that is going to be moved

              • to array[string]

                An optional list of allocator ids to which the instance should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)

              • Tells the infrastructure that the instance should be considered as permanently down when deciding how to migrate data to new nodes. If left blank then the system will automatically decide (currently: will treat the instances as up)

            • move_allocators array[object]
              Hide move_allocators attributes Show move_allocators attributes object
              • from string Required

                The allocator id off which all instances in the cluster should be moved

              • to array[string]

                An optional list of allocator ids to which the instance(s) should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)

              • 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)

            • If true (default: false) does not allow re-using any existing instances currently in the cluster, ie even unchanged instances will be re-created

            • List of allocators on which instances are placed if possible (if not possible/not specified then any available allocator with space is used)

            • Map containing allocators tags in form of key value pairs, increasing the likelihood during move requests for allocators with matching tags, to be selected as target allocators

              Hide preferred_allocator_tags attribute Show preferred_allocator_tags attribute object
              • * string Additional properties
            • 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

            • Set to 'forced' to force a reboot as part of the upgrade plan

              Value is forced.

            • If false (the default), the plan fails if it determines that the request can result in unsafe operations. Setting this flag overrides some of these check restraints.

        • errors array[object]

          A list of errors that occurred if the attempt to move the cluster failed.

          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

      • apm_clusters array[object] Required

        Detailed information about the Apm clusters being moved.

        Hide apm_clusters attributes Show apm_clusters attributes object
        • cluster_id string Required

          Identifier for the Apm cluster.

        • Defines the configuration parameters that control how the plan is applied. For example, the Elasticsearch cluster topology and APM Server settings.

          Additional properties are allowed.

          Hide calculated_plan attributes Show calculated_plan attributes object
          • strategy object

            The options for performing a plan change. Specify only one property each time. The default is grow_and_shrink.

            Additional properties are allowed.

            Hide strategy attributes Show strategy attributes object
            • rolling object

              Performs inline, rolling configuration changes that mutate existing containers. TIP: This is the fastest way to update a plan, but can fail for complex plan changes, such as topology changes. Also, this is less safe for configuration changes that leave a cluster in a non running state. NOTE: When you perform a major version upgrade, and 'group_by' is set to 'pass:macros[all]';, rolling is required.

              Additional properties are allowed.

              Hide rolling attributes Show rolling attributes object
              • group_by string

                Specifies the grouping attribute to use when rolling several instances. Instances that share the same value for the provided attribute key are rolled together as a unit. Examples that make sense to use are '__all__' (roll all instances as a single unit), 'logical_zone_name' (roll instances by zone), '__name__' (roll one instance at a time, the default if not specified). Note that '__all__' is required when performing a major version upgrade

              • 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

              • 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)

            • A strategy that creates instances with the new plan, migrates data from the old instances, then shuts down the old instances. GrowShrinkStrategyConfig is safer than 'rolling' and ensures single node availability during a plan change, but can be a lot slower on larger clusters.

              Additional properties are allowed.

            • A strategy that creates new Elasticsearch instances, Kibana instances, and APM Servers with the new plan, then migrates the node data to minimize the amount of spare capacity.

              Additional properties are allowed.

            • A strategy that lets constructor choose the most optimal way to execute the plan.

              Additional properties are allowed.

          • The plan control configuration options for the APM Server.

            Additional properties are allowed.

            Hide plan_configuration attributes Show plan_configuration attributes object
            • timeout integer(int64)

              The total timeout in seconds after which the plan is cancelled even if it is not complete. Defaults to 4x the max memory capacity per node (in MB)

            • calm_wait_time integer(int64)

              This timeout determines how long to give a cluster after it responds to API calls before performing actual operations on it. It defaults to 5s

            • move_instances array[object]
              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)

              • Tells the infrastructure that the instance should be considered as permanently down when deciding how to migrate data to new nodes. If left blank then the system will automatically decide (currently: will treat the instances as up)

            • move_allocators array[object]
              Hide move_allocators attributes Show move_allocators attributes object
              • from string Required

                The allocator id off which all instances in the cluster should be moved

              • to array[string]

                An optional list of allocator ids to which the instance(s) should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)

              • 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)

            • If true (default: false) does not allow re-using any existing instances currently in the cluster, ie even unchanged instances will be re-created

            • List of allocators on which instances are placed if possible (if not possible/not specified then any available allocator with space is used)

            • Map containing allocators tags in form of key value pairs, increasing the likelihood during move requests for allocators with matching tags, to be selected as target allocators

              Hide preferred_allocator_tags attribute Show preferred_allocator_tags attribute object
              • * string Additional properties
            • 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

            • Set to 'forced' to force a reboot as part of the upgrade plan

              Value is forced.

            • If false (the default), the plan fails if it determines that the request can result in unsafe operations. Setting this flag overrides some of these check restraints.

        • errors array[object]

          A list of errors that occurred if the attempt to move the cluster failed.

          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

      • appsearch_clusters array[object] Required

        Detailed information about the App Search clusters being moved.

        Hide appsearch_clusters attributes Show appsearch_clusters attributes object
        • cluster_id string Required

          Identifier for the App Search.

        • Defines configuration parameters that control how the plan (ie consisting of the cluster topology and AppSearch settings) is applied

          Additional properties are allowed.

          Hide calculated_plan attributes Show calculated_plan attributes object
          • strategy object

            The options for performing a plan change. Specify only one property each time. The default is grow_and_shrink.

            Additional properties are allowed.

            Hide strategy attributes Show strategy attributes object
            • rolling object

              Performs inline, rolling configuration changes that mutate existing containers. TIP: This is the fastest way to update a plan, but can fail for complex plan changes, such as topology changes. Also, this is less safe for configuration changes that leave a cluster in a non running state. NOTE: When you perform a major version upgrade, and 'group_by' is set to 'pass:macros[all]';, rolling is required.

              Additional properties are allowed.

              Hide rolling attributes Show rolling attributes object
              • group_by string

                Specifies the grouping attribute to use when rolling several instances. Instances that share the same value for the provided attribute key are rolled together as a unit. Examples that make sense to use are '__all__' (roll all instances as a single unit), 'logical_zone_name' (roll instances by zone), '__name__' (roll one instance at a time, the default if not specified). Note that '__all__' is required when performing a major version upgrade

              • 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

              • 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)

            • A strategy that creates instances with the new plan, migrates data from the old instances, then shuts down the old instances. GrowShrinkStrategyConfig is safer than 'rolling' and ensures single node availability during a plan change, but can be a lot slower on larger clusters.

              Additional properties are allowed.

            • A strategy that creates new Elasticsearch instances, Kibana instances, and APM Servers with the new plan, then migrates the node data to minimize the amount of spare capacity.

              Additional properties are allowed.

            • A strategy that lets constructor choose the most optimal way to execute the plan.

              Additional properties are allowed.

          • Additional properties are allowed.

            Hide plan_configuration attributes Show plan_configuration attributes object
            • timeout integer(int64)

              The total timeout in seconds after which the plan is cancelled even if it is not complete. Defaults to 4x the max memory capacity per node (in MB)

            • calm_wait_time integer(int64)

              This timeout determines how long to give a cluster after it responds to API calls before performing actual operations on it. It defaults to 5s

            • move_instances array[object]
              Hide move_instances attributes Show move_instances attributes object
              • from string Required

                The instance id that is going to be moved

              • to array[string]

                An optional list of allocator ids to which the instance should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)

              • Tells the infrastructure that the instance should be considered as permanently down when deciding how to migrate data to new nodes. If left blank then the system will automatically decide (currently: will treat the instances as up)

            • move_allocators array[object]
              Hide move_allocators attributes Show move_allocators attributes object
              • from string Required

                The allocator id off which all instances in the cluster should be moved

              • to array[string]

                An optional list of allocator ids to which the instance(s) should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)

              • 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)

            • If true (default: false) does not allow re-using any existing instances currently in the cluster, ie even unchanged instances will be re-created

            • List of allocators on which instances are placed if possible (if not possible/not specified then any available allocator with space is used)

            • Map containing allocators tags in form of key value pairs, increasing the likelihood during move requests for allocators with matching tags, to be selected as target allocators

              Hide preferred_allocator_tags attribute Show preferred_allocator_tags attribute object
              • * string Additional properties
            • 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

            • Set to 'forced' to force a reboot as part of the upgrade plan

              Value is forced.

            • If false (the default), the plan fails if it determines that the request can result in unsafe operations. Setting this flag overrides some of these check restraints.

        • errors array[object]

          A list of errors that occurred if the attempt to move the cluster failed.

          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

      • enterprise_search_clusters array[object] Required

        Detailed information about the Elastic Enterprise Search clusters being moved.

        Hide enterprise_search_clusters attributes Show enterprise_search_clusters attributes object
        • cluster_id string Required

          Identifier for the Elastic Enterprise Search.

        • Defines configuration parameters that control how the plan (i.e. consisting of the cluster topology and Enterprise Search settings) is applied

          Additional properties are allowed.

          Hide calculated_plan attributes Show calculated_plan attributes object
          • strategy object

            The options for performing a plan change. Specify only one property each time. The default is grow_and_shrink.

            Additional properties are allowed.

            Hide strategy attributes Show strategy attributes object
            • rolling object

              Performs inline, rolling configuration changes that mutate existing containers. TIP: This is the fastest way to update a plan, but can fail for complex plan changes, such as topology changes. Also, this is less safe for configuration changes that leave a cluster in a non running state. NOTE: When you perform a major version upgrade, and 'group_by' is set to 'pass:macros[all]';, rolling is required.

              Additional properties are allowed.

              Hide rolling attributes Show rolling attributes object
              • group_by string

                Specifies the grouping attribute to use when rolling several instances. Instances that share the same value for the provided attribute key are rolled together as a unit. Examples that make sense to use are '__all__' (roll all instances as a single unit), 'logical_zone_name' (roll instances by zone), '__name__' (roll one instance at a time, the default if not specified). Note that '__all__' is required when performing a major version upgrade

              • 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

              • 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)

            • A strategy that creates instances with the new plan, migrates data from the old instances, then shuts down the old instances. GrowShrinkStrategyConfig is safer than 'rolling' and ensures single node availability during a plan change, but can be a lot slower on larger clusters.

              Additional properties are allowed.

            • A strategy that creates new Elasticsearch instances, Kibana instances, and APM Servers with the new plan, then migrates the node data to minimize the amount of spare capacity.

              Additional properties are allowed.

            • A strategy that lets constructor choose the most optimal way to execute the plan.

              Additional properties are allowed.

          • Additional properties are allowed.

            Hide plan_configuration attributes Show plan_configuration attributes object
            • timeout integer(int64)

              The total timeout in seconds after which the plan is cancelled even if it is not complete. Defaults to 4x the max memory capacity per node (in MB)

            • calm_wait_time integer(int64)

              This timeout determines how long to give a cluster after it responds to API calls before performing actual operations on it. It defaults to 5s

            • move_instances array[object]
              Hide move_instances attributes Show move_instances attributes object
              • from string Required

                The instance id that is going to be moved

              • to array[string]

                An optional list of allocator ids to which the instance should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)

              • Tells the infrastructure that the instance should be considered as permanently down when deciding how to migrate data to new nodes. If left blank then the system will automatically decide (currently: will treat the instances as up)

            • move_allocators array[object]
              Hide move_allocators attributes Show move_allocators attributes object
              • from string Required

                The allocator id off which all instances in the cluster should be moved

              • to array[string]

                An optional list of allocator ids to which the instance(s) should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)

              • 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)

            • 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

            • List of allocators on which instances are placed if possible (if not possible/not specified then any available allocator with space is used)

            • Map containing allocators tags in form of key value pairs, increasing the likelihood during move requests for allocators with matching tags, to be selected as target allocators

              Hide preferred_allocator_tags attribute Show preferred_allocator_tags attribute object
              • * string Additional properties
            • 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

            • Set to 'forced' to force a reboot as part of the upgrade plan

              Value is forced.

            • If false (the default), the plan fails if it determines that the request can result in unsafe operations. Setting this flag overrides some of these check restraints.

        • errors array[object]

          A list of errors that occurred if the attempt to move the cluster failed.

          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

    • The cluster definition contained errors. (code: clusters.cluster_invalid_plan)
    • The cluster definition contained errors. (code: clusters.plan_feature_not_implemented)
    Hide headers attribute Show headers attribute
    • The error codes associated with the response

      Values are clusters.cluster_invalid_plan or clusters.plan_feature_not_implemented.

    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

  • The move command was prohibited for the given cluster. (code: clusters.command_prohibited)

    Hide headers attribute Show headers attribute
    • The error codes associated with the response

      Value is clusters.command_prohibited.

    Hide response attribute Show response attribute object
    • errors array[object] Required

      A list of errors that occurred in the failing request

      Hide errors attributes Show errors attributes object
      • code string Required

        A structured code representing the error type that occurred

      • message string Required

        A human readable message describing the error that occurred

      • fields array[string]

        If the error can be tied to a specific field or fields in the user request, this lists those fields

POST /platform/infrastructure/allocators/{allocator_id}/clusters/_move
curl \
 -X POST https://{{hostname}}/api/v1/platform/infrastructure/allocators/{allocator_id}/clusters/_move \
 -d '{"elasticsearch_clusters":[{"cluster_ids":["string"],"plan_override":{"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}],"move_only":true,"reallocate_instances":true,"preferred_allocators":["string"],"preferred_allocator_tags":{"additionalProperty1":"string","additionalProperty2":"string"},"skip_snapshot":true,"max_snapshot_attempts":42,"max_snapshot_age":42,"extended_maintenance":true,"cluster_reboot":"forced","override_failsafe":true,"skip_data_migration":true,"skip_upgrade_checker":true,"skip_post_upgrade_steps":true,"skip_snapshot_post_major_upgrade":true},"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}]},"cluster_settings_json":{}}}],"kibana_clusters":[{"cluster_ids":["string"],"plan_override":{"strategy":{"rolling":{"group_by":"string","allow_inline_resize":true,"skip_synced_flush":true,"shard_init_wait_time":42},"grow_and_shrink":{},"rolling_grow_and_shrink":{},"autodetect":{}},"plan_configuration":{"timeout":42,"calm_wait_time":42,"move_instances":[{"from":"string","to":["string"],"instance_down":true}],"move_allocators":[{"from":"string","to":["string"],"allocator_down":true}],"reallocate_instances":true,"preferred_allocators":["string"],"preferred_allocator_tags":{"additionalProperty1":"string","additionalProperty2":"string"},"extended_maintenance":true,"cluster_reboot":"forced","override_failsafe":true}}}],"apm_clusters":[{"cluster_ids":["string"],"plan_override":{"strategy":{"rolling":{"group_by":"string","allow_inline_resize":true,"skip_synced_flush":true,"shard_init_wait_time":42},"grow_and_shrink":{},"rolling_grow_and_shrink":{},"autodetect":{}},"plan_configuration":{"timeout":42,"calm_wait_time":42,"move_instances":[{"from":"string","to":["string"],"instance_down":true}],"move_allocators":[{"from":"string","to":["string"],"allocator_down":true}],"reallocate_instances":true,"preferred_allocators":["string"],"preferred_allocator_tags":{"additionalProperty1":"string","additionalProperty2":"string"},"extended_maintenance":true,"cluster_reboot":"forced","override_failsafe":true}}}],"appsearch_clusters":[{"cluster_ids":["string"],"plan_override":{"strategy":{"rolling":{"group_by":"string","allow_inline_resize":true,"skip_synced_flush":true,"shard_init_wait_time":42},"grow_and_shrink":{},"rolling_grow_and_shrink":{},"autodetect":{}},"plan_configuration":{"timeout":42,"calm_wait_time":42,"move_instances":[{"from":"string","to":["string"],"instance_down":true}],"move_allocators":[{"from":"string","to":["string"],"allocator_down":true}],"reallocate_instances":true,"preferred_allocators":["string"],"preferred_allocator_tags":{"additionalProperty1":"string","additionalProperty2":"string"},"extended_maintenance":true,"cluster_reboot":"forced","override_failsafe":true}}}],"enterprise_search_clusters":[{"cluster_ids":["string"],"plan_override":{"strategy":{"rolling":{"group_by":"string","allow_inline_resize":true,"skip_synced_flush":true,"shard_init_wait_time":42},"grow_and_shrink":{},"rolling_grow_and_shrink":{},"autodetect":{}},"plan_configuration":{"timeout":42,"calm_wait_time":42,"move_instances":[{"from":"string","to":["string"],"instance_down":true}],"move_allocators":[{"from":"string","to":["string"],"allocator_down":true}],"reallocate_instances":true,"preferred_allocators":["string"],"preferred_allocator_tags":{"additionalProperty1":"string","additionalProperty2":"string"},"extended_maintenance":true,"cluster_reboot":"forced","override_failsafe":true}}}]}'
Request examples
{
  "elasticsearch_clusters": [
    {
      "cluster_ids": [
        "string"
      ],
      "plan_override": {
        "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
            }
          ],
          "move_only": true,
          "reallocate_instances": true,
          "preferred_allocators": [
            "string"
          ],
          "preferred_allocator_tags": {
            "additionalProperty1": "string",
            "additionalProperty2": "string"
          },
          "skip_snapshot": true,
          "max_snapshot_attempts": 42,
          "max_snapshot_age": 42,
          "extended_maintenance": true,
          "cluster_reboot": "forced",
          "override_failsafe": true,
          "skip_data_migration": true,
          "skip_upgrade_checker": true,
          "skip_post_upgrade_steps": true,
          "skip_snapshot_post_major_upgrade": true
        },
        "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
            }
          ]
        },
        "cluster_settings_json": {}
      }
    }
  ],
  "kibana_clusters": [
    {
      "cluster_ids": [
        "string"
      ],
      "plan_override": {
        "strategy": {
          "rolling": {
            "group_by": "string",
            "allow_inline_resize": true,
            "skip_synced_flush": true,
            "shard_init_wait_time": 42
          },
          "grow_and_shrink": {},
          "rolling_grow_and_shrink": {},
          "autodetect": {}
        },
        "plan_configuration": {
          "timeout": 42,
          "calm_wait_time": 42,
          "move_instances": [
            {
              "from": "string",
              "to": [
                "string"
              ],
              "instance_down": true
            }
          ],
          "move_allocators": [
            {
              "from": "string",
              "to": [
                "string"
              ],
              "allocator_down": true
            }
          ],
          "reallocate_instances": true,
          "preferred_allocators": [
            "string"
          ],
          "preferred_allocator_tags": {
            "additionalProperty1": "string",
            "additionalProperty2": "string"
          },
          "extended_maintenance": true,
          "cluster_reboot": "forced",
          "override_failsafe": true
        }
      }
    }
  ],
  "apm_clusters": [
    {
      "cluster_ids": [
        "string"
      ],
      "plan_override": {
        "strategy": {
          "rolling": {
            "group_by": "string",
            "allow_inline_resize": true,
            "skip_synced_flush": true,
            "shard_init_wait_time": 42
          },
          "grow_and_shrink": {},
          "rolling_grow_and_shrink": {},
          "autodetect": {}
        },
        "plan_configuration": {
          "timeout": 42,
          "calm_wait_time": 42,
          "move_instances": [
            {
              "from": "string",
              "to": [
                "string"
              ],
              "instance_down": true
            }
          ],
          "move_allocators": [
            {
              "from": "string",
              "to": [
                "string"
              ],
              "allocator_down": true
            }
          ],
          "reallocate_instances": true,
          "preferred_allocators": [
            "string"
          ],
          "preferred_allocator_tags": {
            "additionalProperty1": "string",
            "additionalProperty2": "string"
          },
          "extended_maintenance": true,
          "cluster_reboot": "forced",
          "override_failsafe": true
        }
      }
    }
  ],
  "appsearch_clusters": [
    {
      "cluster_ids": [
        "string"
      ],
      "plan_override": {
        "strategy": {
          "rolling": {
            "group_by": "string",
            "allow_inline_resize": true,
            "skip_synced_flush": true,
            "shard_init_wait_time": 42
          },
          "grow_and_shrink": {},
          "rolling_grow_and_shrink": {},
          "autodetect": {}
        },
        "plan_configuration": {
          "timeout": 42,
          "calm_wait_time": 42,
          "move_instances": [
            {
              "from": "string",
              "to": [
                "string"
              ],
              "instance_down": true
            }
          ],
          "move_allocators": [
            {
              "from": "string",
              "to": [
                "string"
              ],
              "allocator_down": true
            }
          ],
          "reallocate_instances": true,
          "preferred_allocators": [
            "string"
          ],
          "preferred_allocator_tags": {
            "additionalProperty1": "string",
            "additionalProperty2": "string"
          },
          "extended_maintenance": true,
          "cluster_reboot": "forced",
          "override_failsafe": true
        }
      }
    }
  ],
  "enterprise_search_clusters": [
    {
      "cluster_ids": [
        "string"
      ],
      "plan_override": {
        "strategy": {
          "rolling": {
            "group_by": "string",
            "allow_inline_resize": true,
            "skip_synced_flush": true,
            "shard_init_wait_time": 42
          },
          "grow_and_shrink": {},
          "rolling_grow_and_shrink": {},
          "autodetect": {}
        },
        "plan_configuration": {
          "timeout": 42,
          "calm_wait_time": 42,
          "move_instances": [
            {
              "from": "string",
              "to": [
                "string"
              ],
              "instance_down": true
            }
          ],
          "move_allocators": [
            {
              "from": "string",
              "to": [
                "string"
              ],
              "allocator_down": true
            }
          ],
          "reallocate_instances": true,
          "preferred_allocators": [
            "string"
          ],
          "preferred_allocator_tags": {
            "additionalProperty1": "string",
            "additionalProperty2": "string"
          },
          "extended_maintenance": true,
          "cluster_reboot": "forced",
          "override_failsafe": true
        }
      }
    }
  ]
}
Response examples (202)
{
  "failures": {
    "elasticsearch_clusters": [
      {
        "cluster_id": "string",
        "calculated_plan": {
          "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
              }
            ],
            "move_only": true,
            "reallocate_instances": true,
            "preferred_allocators": [
              "string"
            ],
            "preferred_allocator_tags": {
              "additionalProperty1": "string",
              "additionalProperty2": "string"
            },
            "skip_snapshot": true,
            "max_snapshot_attempts": 42,
            "max_snapshot_age": 42,
            "extended_maintenance": true,
            "cluster_reboot": "forced",
            "override_failsafe": true,
            "skip_data_migration": true,
            "skip_upgrade_checker": true,
            "skip_post_upgrade_steps": true,
            "skip_snapshot_post_major_upgrade": true
          },
          "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": {}
        },
        "errors": [
          {
            "code": "string",
            "message": "string",
            "fields": [
              "string"
            ]
          }
        ]
      }
    ],
    "kibana_clusters": [
      {
        "cluster_id": "string",
        "calculated_plan": {
          "strategy": {
            "rolling": {
              "group_by": "string",
              "allow_inline_resize": true,
              "skip_synced_flush": true,
              "shard_init_wait_time": 42
            },
            "grow_and_shrink": {},
            "rolling_grow_and_shrink": {},
            "autodetect": {}
          },
          "plan_configuration": {
            "timeout": 42,
            "calm_wait_time": 42,
            "move_instances": [
              {
                "from": "string",
                "to": [
                  "string"
                ],
                "instance_down": true
              }
            ],
            "move_allocators": [
              {
                "from": "string",
                "to": [
                  "string"
                ],
                "allocator_down": true
              }
            ],
            "reallocate_instances": true,
            "preferred_allocators": [
              "string"
            ],
            "preferred_allocator_tags": {
              "additionalProperty1": "string",
              "additionalProperty2": "string"
            },
            "extended_maintenance": true,
            "cluster_reboot": "forced",
            "override_failsafe": true
          }
        },
        "errors": [
          {
            "code": "string",
            "message": "string",
            "fields": [
              "string"
            ]
          }
        ]
      }
    ],
    "apm_clusters": [
      {
        "cluster_id": "string",
        "calculated_plan": {
          "strategy": {
            "rolling": {
              "group_by": "string",
              "allow_inline_resize": true,
              "skip_synced_flush": true,
              "shard_init_wait_time": 42
            },
            "grow_and_shrink": {},
            "rolling_grow_and_shrink": {},
            "autodetect": {}
          },
          "plan_configuration": {
            "timeout": 42,
            "calm_wait_time": 42,
            "move_instances": [
              {
                "from": "string",
                "to": [
                  "string"
                ],
                "instance_down": true
              }
            ],
            "move_allocators": [
              {
                "from": "string",
                "to": [
                  "string"
                ],
                "allocator_down": true
              }
            ],
            "reallocate_instances": true,
            "preferred_allocators": [
              "string"
            ],
            "preferred_allocator_tags": {
              "additionalProperty1": "string",
              "additionalProperty2": "string"
            },
            "extended_maintenance": true,
            "cluster_reboot": "forced",
            "override_failsafe": true
          }
        },
        "errors": [
          {
            "code": "string",
            "message": "string",
            "fields": [
              "string"
            ]
          }
        ]
      }
    ],
    "appsearch_clusters": [
      {
        "cluster_id": "string",
        "calculated_plan": {
          "strategy": {
            "rolling": {
              "group_by": "string",
              "allow_inline_resize": true,
              "skip_synced_flush": true,
              "shard_init_wait_time": 42
            },
            "grow_and_shrink": {},
            "rolling_grow_and_shrink": {},
            "autodetect": {}
          },
          "plan_configuration": {
            "timeout": 42,
            "calm_wait_time": 42,
            "move_instances": [
              {
                "from": "string",
                "to": [
                  "string"
                ],
                "instance_down": true
              }
            ],
            "move_allocators": [
              {
                "from": "string",
                "to": [
                  "string"
                ],
                "allocator_down": true
              }
            ],
            "reallocate_instances": true,
            "preferred_allocators": [
              "string"
            ],
            "preferred_allocator_tags": {
              "additionalProperty1": "string",
              "additionalProperty2": "string"
            },
            "extended_maintenance": true,
            "cluster_reboot": "forced",
            "override_failsafe": true
          }
        },
        "errors": [
          {
            "code": "string",
            "message": "string",
            "fields": [
              "string"
            ]
          }
        ]
      }
    ],
    "enterprise_search_clusters": [
      {
        "cluster_id": "string",
        "calculated_plan": {
          "strategy": {
            "rolling": {
              "group_by": "string",
              "allow_inline_resize": true,
              "skip_synced_flush": true,
              "shard_init_wait_time": 42
            },
            "grow_and_shrink": {},
            "rolling_grow_and_shrink": {},
            "autodetect": {}
          },
          "plan_configuration": {
            "timeout": 42,
            "calm_wait_time": 42,
            "move_instances": [
              {
                "from": "string",
                "to": [
                  "string"
                ],
                "instance_down": true
              }
            ],
            "move_allocators": [
              {
                "from": "string",
                "to": [
                  "string"
                ],
                "allocator_down": true
              }
            ],
            "reallocate_instances": true,
            "preferred_allocators": [
              "string"
            ],
            "preferred_allocator_tags": {
              "additionalProperty1": "string",
              "additionalProperty2": "string"
            },
            "extended_maintenance": true,
            "cluster_reboot": "forced",
            "override_failsafe": true
          }
        },
        "errors": [
          {
            "code": "string",
            "message": "string",
            "fields": [
              "string"
            ]
          }
        ]
      }
    ]
  },
  "moves": {
    "elasticsearch_clusters": [
      {
        "cluster_id": "string",
        "calculated_plan": {
          "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
              }
            ],
            "move_only": true,
            "reallocate_instances": true,
            "preferred_allocators": [
              "string"
            ],
            "preferred_allocator_tags": {
              "additionalProperty1": "string",
              "additionalProperty2": "string"
            },
            "skip_snapshot": true,
            "max_snapshot_attempts": 42,
            "max_snapshot_age": 42,
            "extended_maintenance": true,
            "cluster_reboot": "forced",
            "override_failsafe": true,
            "skip_data_migration": true,
            "skip_upgrade_checker": true,
            "skip_post_upgrade_steps": true,
            "skip_snapshot_post_major_upgrade": true
          },
          "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": {}
        },
        "errors": [
          {
            "code": "string",
            "message": "string",
            "fields": [
              "string"
            ]
          }
        ]
      }
    ],
    "kibana_clusters": [
      {
        "cluster_id": "string",
        "calculated_plan": {
          "strategy": {
            "rolling": {
              "group_by": "string",
              "allow_inline_resize": true,
              "skip_synced_flush": true,
              "shard_init_wait_time": 42
            },
            "grow_and_shrink": {},
            "rolling_grow_and_shrink": {},
            "autodetect": {}
          },
          "plan_configuration": {
            "timeout": 42,
            "calm_wait_time": 42,
            "move_instances": [
              {
                "from": "string",
                "to": [
                  "string"
                ],
                "instance_down": true
              }
            ],
            "move_allocators": [
              {
                "from": "string",
                "to": [
                  "string"
                ],
                "allocator_down": true
              }
            ],
            "reallocate_instances": true,
            "preferred_allocators": [
              "string"
            ],
            "preferred_allocator_tags": {
              "additionalProperty1": "string",
              "additionalProperty2": "string"
            },
            "extended_maintenance": true,
            "cluster_reboot": "forced",
            "override_failsafe": true
          }
        },
        "errors": [
          {
            "code": "string",
            "message": "string",
            "fields": [
              "string"
            ]
          }
        ]
      }
    ],
    "apm_clusters": [
      {
        "cluster_id": "string",
        "calculated_plan": {
          "strategy": {
            "rolling": {
              "group_by": "string",
              "allow_inline_resize": true,
              "skip_synced_flush": true,
              "shard_init_wait_time": 42
            },
            "grow_and_shrink": {},
            "rolling_grow_and_shrink": {},
            "autodetect": {}
          },
          "plan_configuration": {
            "timeout": 42,
            "calm_wait_time": 42,
            "move_instances": [
              {
                "from": "string",
                "to": [
                  "string"
                ],
                "instance_down": true
              }
            ],
            "move_allocators": [
              {
                "from": "string",
                "to": [
                  "string"
                ],
                "allocator_down": true
              }
            ],
            "reallocate_instances": true,
            "preferred_allocators": [
              "string"
            ],
            "preferred_allocator_tags": {
              "additionalProperty1": "string",
              "additionalProperty2": "string"
            },
            "extended_maintenance": true,
            "cluster_reboot": "forced",
            "override_failsafe": true
          }
        },
        "errors": [
          {
            "code": "string",
            "message": "string",
            "fields": [
              "string"
            ]
          }
        ]
      }
    ],
    "appsearch_clusters": [
      {
        "cluster_id": "string",
        "calculated_plan": {
          "strategy": {
            "rolling": {
              "group_by": "string",
              "allow_inline_resize": true,
              "skip_synced_flush": true,
              "shard_init_wait_time": 42
            },
            "grow_and_shrink": {},
            "rolling_grow_and_shrink": {},
            "autodetect": {}
          },
          "plan_configuration": {
            "timeout": 42,
            "calm_wait_time": 42,
            "move_instances": [
              {
                "from": "string",
                "to": [
                  "string"
                ],
                "instance_down": true
              }
            ],
            "move_allocators": [
              {
                "from": "string",
                "to": [
                  "string"
                ],
                "allocator_down": true
              }
            ],
            "reallocate_instances": true,
            "preferred_allocators": [
              "string"
            ],
            "preferred_allocator_tags": {
              "additionalProperty1": "string",
              "additionalProperty2": "string"
            },
            "extended_maintenance": true,
            "cluster_reboot": "forced",
            "override_failsafe": true
          }
        },
        "errors": [
          {
            "code": "string",
            "message": "string",
            "fields": [
              "string"
            ]
          }
        ]
      }
    ],
    "enterprise_search_clusters": [
      {
        "cluster_id": "string",
        "calculated_plan": {
          "strategy": {
            "rolling": {
              "group_by": "string",
              "allow_inline_resize": true,
              "skip_synced_flush": true,
              "shard_init_wait_time": 42
            },
            "grow_and_shrink": {},
            "rolling_grow_and_shrink": {},
            "autodetect": {}
          },
          "plan_configuration": {
            "timeout": 42,
            "calm_wait_time": 42,
            "move_instances": [
              {
                "from": "string",
                "to": [
                  "string"
                ],
                "instance_down": true
              }
            ],
            "move_allocators": [
              {
                "from": "string",
                "to": [
                  "string"
                ],
                "allocator_down": true
              }
            ],
            "reallocate_instances": true,
            "preferred_allocators": [
              "string"
            ],
            "preferred_allocator_tags": {
              "additionalProperty1": "string",
              "additionalProperty2": "string"
            },
            "extended_maintenance": true,
            "cluster_reboot": "forced",
            "override_failsafe": true
          }
        },
        "errors": [
          {
            "code": "string",
            "message": "string",
            "fields": [
              "string"
            ]
          }
        ]
      }
    ]
  }
}
Response examples (400)
# Headers
x-cloud-error-codes: clusters.cluster_invalid_plan

# Payload
{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}
Response examples (403)
# Headers
x-cloud-error-codes: clusters.command_prohibited

# Payload
{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}
































Set allocator metadata

PUT /platform/infrastructure/allocators/{allocator_id}/metadata

Sets the allocator metadata.

Path parameters

Query parameters

  • version string

    Checks for conflicts against the metadata version, then returns the value in the x-cloud-resource-version header.

Body Required

The metadata to update the allocator with

  • items array[object] Required

    A collection of arbitrary metadata items associated with a resource.

    Hide items attributes Show items attributes object
    • key string Required

      The metadata field name

    • value string Required

      The metadata value

Responses

  • The allocator metadata was successfully changed (the updated JSON is returned)

    Hide response attributes Show response attributes object
    • key string Required

      The metadata field name

    • value string Required

      The metadata value

  • The value specified is empty for at least one of the metadata tags. (code: allocators.invalid_empty_metadata_items)

    Hide headers attribute Show headers attribute
    • The error codes associated with the response

      Value is allocators.invalid_empty_metadata_items.

    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

  • The allocator specified by {allocator_id} cannot be found. (code: allocators.allocator_not_found)

    Hide headers attribute Show headers attribute
    • The error codes associated with the response

      Value is allocators.allocator_not_found.

    Hide response attribute Show response attribute object
    • errors array[object] Required

      A list of errors that occurred in the failing request

      Hide errors attributes Show errors attributes object
      • code string Required

        A structured code representing the error type that occurred

      • message string Required

        A human readable message describing the error that occurred

      • fields array[string]

        If the error can be tied to a specific field or fields in the user request, this lists those fields

PUT /platform/infrastructure/allocators/{allocator_id}/metadata
curl \
 -X PUT https://{{hostname}}/api/v1/platform/infrastructure/allocators/{allocator_id}/metadata \
 -d '{"items":[{"key":"string","value":"string"}]}'
Request examples
{
  "items": [
    {
      "key": "string",
      "value": "string"
    }
  ]
}
Response examples (200)
[
  {
    "key": "string",
    "value": "string"
  }
]
Response examples (400)
# Headers
x-cloud-error-codes: allocators.invalid_empty_metadata_items

# Payload
{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}
Response examples (404)
# Headers
x-cloud-error-codes: allocators.allocator_not_found

# Payload
{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}




































Delete role

DELETE /platform/infrastructure/blueprinter/roles/{blueprinter_role_id}

Delete a role.

Path parameters

Query parameters

  • When sent as true, ignores validation errors.

    Default value is false.

  • version integer

    When specified, checks for conflicts against the version stored in the persistent store (returned in 'x-cloud-resource-version' of the GET request)

Responses

  • The role was successfully deleted.

    Additional properties are allowed.

  • The role is currently running container sets. (code: roles.in_use)

    Hide headers attribute Show headers attribute
    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

  • The role can't be found. (code: roles.not_found)

    Hide headers attribute Show headers attribute
    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

  • Your request failed because the specified version does not match the persisted version. (code: roles.version_conflict)

    Hide headers attribute Show headers attribute
    • The error codes associated with the response

      Value is roles.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

DELETE /platform/infrastructure/blueprinter/roles/{blueprinter_role_id}
curl \
 -X DELETE https://{{hostname}}/api/v1/platform/infrastructure/blueprinter/roles/{blueprinter_role_id}
Response examples (200)
{}
Response examples (400)
# Headers
x-cloud-error-codes: roles.in_use

# Payload
{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}
Response examples (404)
# Headers
x-cloud-error-codes: roles.not_found

# Payload
{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}
Response examples (409)
# Headers
x-cloud-error-codes: roles.version_conflict

# Payload
{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}








Get constructors

GET /platform/infrastructure/constructors

Retrieves an overview of all constructors in an ECE installation.

Responses

  • An overview of all constructors.

    Hide response attribute Show response attribute object
    • constructors array[object] Required
      Hide constructors attributes Show constructors attributes object
      • status object Required

        The health status of the constructor.

        Additional properties are allowed.

        Hide status attributes Show status attributes object
        • connected boolean Required

          Whether the constructor is connected

        • maintenance_mode boolean Required

          Whether the constructor is in maintenance mode

      • constructor_id string Required

        Identifier for this constructor

GET /platform/infrastructure/constructors
curl \
 -X GET https://{{hostname}}/api/v1/platform/infrastructure/constructors
Response examples (200)
{
  "constructors": [
    {
      "status": {
        "connected": true,
        "maintenance_mode": true
      },
      "constructor_id": "string"
    }
  ]
}
















Set constructor logging settings

PUT /platform/infrastructure/constructors/{constructor_id}/logging_settings

Set the logging settings for this constructor instance.

Path parameters

Body Required

The new logging settings for the constructor instance

  • logging_levels object Required

    Overridden logging levels. Keys are logging levels. Allowable values are OFF, ERROR, WARN, INFO, DEBUG, TRACE, ALL

    Hide logging_levels attribute Show logging_levels attribute object
    • * string Additional properties

Responses

  • The updated logging settings for the constructor instance

    Hide headers attributes Show headers attributes
    Hide response attribute Show response attribute object
    • logging_levels object Required

      Overridden logging levels. Keys are logging levels. Allowable values are OFF, ERROR, WARN, INFO, DEBUG, TRACE, ALL

      Hide logging_levels attribute Show logging_levels attribute object
      • * string Additional properties
  • The logging settings for this constructor were not found. (code: constructors.logging_settings.not_found)

    Hide headers attribute Show headers attribute
    • The error codes associated with the response

      Value is constructors.logging_settings.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 /platform/infrastructure/constructors/{constructor_id}/logging_settings
curl \
 -X PUT https://{{hostname}}/api/v1/platform/infrastructure/constructors/{constructor_id}/logging_settings \
 -d '{"logging_levels":{"additionalProperty1":"string","additionalProperty2":"string"}}'
Request examples
{
  "logging_levels": {
    "additionalProperty1": "string",
    "additionalProperty2": "string"
  }
}
Response examples (200)
# Headers
x-cloud-resource-version: string
x-cloud-resource-created: string
x-cloud-resource-last-modified: string

# Payload
{
  "logging_levels": {
    "additionalProperty1": "string",
    "additionalProperty2": "string"
  }
}
Response examples (404)
# Headers
x-cloud-error-codes: constructors.logging_settings.not_found

# Payload
{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}

Delete constructor logging settings

DELETE /platform/infrastructure/constructors/{constructor_id}/logging_settings

Reset the default logging settings for this constructor instance.

Path parameters

Responses

  • The updated logging settings for the constructor instance

    Hide headers attributes Show headers attributes
    Hide response attribute Show response attribute object
    • logging_levels object Required

      Overridden logging levels. Keys are logging levels. Allowable values are OFF, ERROR, WARN, INFO, DEBUG, TRACE, ALL

      Hide logging_levels attribute Show logging_levels attribute object
      • * string Additional properties
  • The logging settings for this constructor were not found. (code: constructors.logging_settings.not_found)

    Hide headers attribute Show headers attribute
    • The error codes associated with the response

      Value is constructors.logging_settings.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 /platform/infrastructure/constructors/{constructor_id}/logging_settings
curl \
 -X DELETE https://{{hostname}}/api/v1/platform/infrastructure/constructors/{constructor_id}/logging_settings
Response examples (200)
# Headers
x-cloud-resource-version: string
x-cloud-resource-created: string
x-cloud-resource-last-modified: string

# Payload
{
  "logging_levels": {
    "additionalProperty1": "string",
    "additionalProperty2": "string"
  }
}
Response examples (404)
# Headers
x-cloud-error-codes: constructors.logging_settings.not_found

# Payload
{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}




































































Get proxies settings

GET /platform/infrastructure/proxies/settings

WARNING This endpoint is deprecated and scheduled to be removed in the next major version.

Retrieves the settings for all proxies.

Responses

GET /platform/infrastructure/proxies/settings
curl \
 -X GET https://{{hostname}}/api/v1/platform/infrastructure/proxies/settings
Response examples (200)
{
  "expected_proxies_count": 42,
  "signature_secret": "string",
  "signature_valid_for_millis": 42,
  "http_settings": {
    "disconnected_cutoff": 42,
    "minimum_proxy_services": 42,
    "sso_settings": {
      "max_age": 42,
      "sso_secret": "string",
      "cookie_name": "string",
      "dont_log_requests": true,
      "default_redirect_path": "string",
      "maintenance_bypass_cookie_name": "string"
    },
    "dashboards_base_url": "string",
    "cookie_secret": "string",
    "user_cookie_key": "string"
  }
}








Get proxy

GET /platform/infrastructure/proxies/{proxy_id}

Retrieves a single proxy by ID.

Path parameters

  • proxy_id string Required

    The identifier for the proxy

Responses

  • The information for the proxy specified by {proxy_id}.

    Hide response attributes Show response attributes object
    • proxy_id string Required

      The proxy identifier

    • Identifier of the runner for the proxy

    • host_ip string Required

      IP of the host the proxy runs on

    • public_hostname string Required

      Public hostname of the host the proxy runs on

    • metadata object Required

      Arbitrary metadata associated with the proxy

      Additional properties are allowed.

    • healthy boolean Required

      Specifies if the proxy is healthy

    • zone string

      The zone.

    • allocations array[object] Required

      Allocation information by type.

      Hide allocations attributes Show allocations attributes object
      • allocations_type string Required

        The type of proxy allocations

        Values are elasticsearch, kibana, apm, integrations_server, appsearch, or enterprise_search.

      • counts object Required

        Proxy allocation counts.

        Additional properties are allowed.

        Hide counts attributes Show counts attributes object
  • Unable to find the {proxy_id} specified proxy. Edit your request, then try again. (code: proxies.proxy_not_found)

    Hide headers attribute Show headers attribute
    • The error codes associated with the response

      Value is proxies.proxy_not_found.

    Hide response attribute Show response attribute object
    • errors array[object] Required

      A list of errors that occurred in the failing request

      Hide errors attributes Show errors attributes object
      • code string Required

        A structured code representing the error type that occurred

      • message string Required

        A human readable message describing the error that occurred

      • fields array[string]

        If the error can be tied to a specific field or fields in the user request, this lists those fields

GET /platform/infrastructure/proxies/{proxy_id}
curl \
 -X GET https://{{hostname}}/api/v1/platform/infrastructure/proxies/{proxy_id}
Response examples (200)
{
  "proxy_id": "string",
  "runner_id": "string",
  "host_ip": "string",
  "public_hostname": "string",
  "metadata": {},
  "healthy": true,
  "zone": "string",
  "allocations": [
    {
      "allocations_type": "elasticsearch",
      "counts": {
        "allocations": 42,
        "connectors": 42
      }
    }
  ]
}
Response examples (404)
# Headers
x-cloud-error-codes: proxies.proxy_not_found

# Payload
{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}