- Elastic Cloud Enterprise - Elastic Cloud on your Infrastructure: other versions:
- What Is Elastic Cloud Enterprise?
- Getting Started
- Configuring Your Installation
- Securing Your Installation
- Monitoring Your Installation
- Administering Your Installation
- Administering Clusters
- Troubleshooting
- API Reference
- Clusters - Elasticsearch - CRUD
- Clusters - Elasticsearch - CRUD - Configuration
- Set settings overrides (all instances)
- Set settings overrides
- Set cluster name
- Get cluster metadata in raw form
- Set cluster metadata
- Get cluster metadata settings
- Update cluster metadata settings
- Cancel monitoring
- Set monitoring
- Get plan
- Update plan
- Get plan activity
- Cancel pending plan
- Get pending plan
- Clusters - Elasticsearch - Commands
- Clusters - Elasticsearch - Support
- Clusters - Kibana - CRUD
- Clusters - Kibana - CRUD - Configuration
- Clusters - Kibana - Commands
- Platform
- Platform - Allocators
- Platform - Configuration - Security
- Platform - Configuration - TLS
- Platform - Repository - CRUD
- Stack - CRUD
- Definitions
AllocatedInstanceStatus
AllocatorCapacity
AllocatorCapacityMemory
AllocatorHealthStatus
AllocatorInfo
AllocatorMetadataItem
AllocatorMetadataItemValue
AllocatorMetadataItems
AllocatorMoveRequest
AllocatorOverview
AllocatorSettings
AllocatorZoneInfo
BasicFailedReply
BasicFailedReplyElement
BoolQuery
ChangeSourceInfo
ClusterCommandResponse
ClusterCredentials
ClusterCrudResponse
ClusterInstanceDiskInfo
ClusterInstanceInfo
ClusterInstanceMemoryInfo
ClusterMetadataInfo
ClusterMetadataSettings
ClusterPlanStepInfo
ClusterPlanStepLogMessageInfo
ClusterSystemAlert
ClusterTopologyInfo
CreateElasticsearchClusterRequest
CreateKibanaClusterRequest
CreateKibanaInCreateElasticsearchRequest
ElasticsearchClusterBlockingIssueElement
ElasticsearchClusterBlockingIssues
ElasticsearchClusterInfo
ElasticsearchClusterInstanceSettingsOverrides
ElasticsearchClusterPlan
ElasticsearchClusterPlanInfo
ElasticsearchClusterPlansInfo
ElasticsearchClusterRole
ElasticsearchClusterSecurityInfo
ElasticsearchClusterSettings
ElasticsearchClusterTopologyElement
ElasticsearchClusterUser
ElasticsearchClustersInfo
ElasticsearchConfiguration
ElasticsearchHttpUserSettings
ElasticsearchInfo
ElasticsearchMasterElement
ElasticsearchMasterInfo
ElasticsearchMonitoringInfo
ElasticsearchNodeType
ElasticsearchPlanControlConfiguration
ElasticsearchReplicaElement
ElasticsearchScriptTypeSettings
ElasticsearchScriptingUserSettings
ElasticsearchShardElement
ElasticsearchShardsInfo
ElasticsearchSystemSettings
ElasticsearchUserBundle
ElasticsearchUserPlugin
EmptyResponse
EnrollmentTokenRequest
ExternalHyperlink
GrowShrinkStrategyConfig
Hyperlink
InstanceMoveRequest
JSON
KibanaClusterInfo
KibanaClusterPlan
KibanaClusterPlanInfo
KibanaClusterPlansInfo
KibanaClusterTopologyElement
KibanaClustersInfo
KibanaConfiguration
KibanaPlanControlConfiguration
KibanaSubClusterInfo
KibanaSystemSettings
ListEnrollmentTokenElement
ListEnrollmentTokenReply
ManagedMonitoringSettings
ManagedSnapshotSettings
MatchQuery
MoveClustersCommandResponse
MoveClustersDetails
MoveClustersRequest
MoveElasticsearchClusterConfiguration
MoveElasticsearchClusterDetails
MoveKibanaClusterConfiguration
MoveKibanaClusterDetails
NestedQuery
PlanStrategy
PlatformInfo
PlatformServiceImageInfo
PlatformServiceInfo
QueryContainer
QueryStringQuery
RepositoryConfig
RepositoryConfigs
RequestEnrollmentTokenReply
RestoreSnapshotApiConfiguration
RestoreSnapshotConfiguration
RestoreSnapshotRepoConfiguration
RollingGrowShrinkStrategyConfig
RollingStrategyConfig
SearchRequest
SnapshotRepositoryConfiguration
SnapshotStatusInfo
StackVersionArchiveProcessingError
StackVersionArchiveProcessingResult
StackVersionConfig
StackVersionConfigPost
StackVersionConfigs
StackVersionElasticsearchConfig
StackVersionKibanaConfig
StackVersionMetadata
StackVersionTemplateFileHash
StackVersionTemplateInfo
TargetElasticsearchCluster
TermQuery
TiebreakerTopologyElement
TlsPublicCertChain
TransientElasticsearchPlanConfiguration
TransientKibanaPlanConfiguration
- Script Reference
- Release Notes
- Elastic Cloud Enterprise version 1.1.5
- Elastic Cloud Enterprise version 1.1.4
- Elastic Cloud Enterprise version 1.1.3
- Elastic Cloud Enterprise version 1.1.2
- Elastic Cloud Enterprise version 1.1.1
- Elastic Cloud Enterprise version 1.1.0
- Elastic Cloud Enterprise version 1.0.2
- Elastic Cloud Enterprise version 1.0.1
- Elastic Cloud Enterprise version 1.0.0
- About This Product
It is time to say goodbye: This version of Elastic Cloud Enterprise has reached end-of-life (EOL) and is no longer supported.
The documentation for this version is no longer being maintained. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.
Properties
editProperties
edit-
auto_create_index
(boolean
) - If true (the default), then any write operation on an index that does not currently exist will create it. NOTES: (Corresponds to the parameter 'action.auto_create_index')
-
default_shards_per_index
(integer
asint32
) - (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)
-
destructive_requires_name
(boolean
) - If true (default is false) then the index deletion API will not support wildcards or '_all'. NOTES: (Corresponds to the parameter 'action.destructive_requires_name')
-
enable_close_index
(boolean
) - If false (the default), then the API commands to close indices are disabled. This is important because Elasticsearch does not snapshot or migrate close indices, therefore standard Elastic Cloud configuration operations will cause irretrievable loss of indices' data. NOTES: (Corresponds to the parameter 'cluster.indices.close.enable')
-
monitoring_collection_interval
(integer
asint32
) - The default interval at which monitoring information from the cluster if collected, if monitoring is enabled. NOTES: (Corresponds to the parameter 'marvel.agent.interval' in 2.x and 'xpack.monitoring.collection.interval' in 5.x)
-
monitoring_history_duration
(string
) - The duration for which monitoring history is stored (format '(NUMBER)d' eg '3d' for 3 days). NOTES: ('Corresponds to the parameter xpack.monitoring.history.duration' in 5.x, defaults to '7d')
-
reindex_whitelist
(array[
string
)]
- Limits remote Elasticsearch clusters that can be used as the source for '_reindex' API commands
-
scripting
(ElasticsearchScriptingUserSettings
) - Controls the different 'languages' (painless/mustache/expressions) supported by the Elasticsearch cluster, and the different ways they can be used (file, index, inline). More complex configurations need to be handled by leaving these blank and controlling instead in the user YAML or JSON
-
use_disk_threshold
(boolean
) - Whether to factor in the available disk space on a node before deciding whether to allocate new shards to that node or actively relocate shards away from the node (default: true). NOTES: (Corresponds to the parameter 'cluster.routing.allocation.disk.threshold_enabled')
-
watcher_trigger_engine
(string
) - The trigger engine for Watcher, defaults to 'scheduler' - see the xpack documentation for more information. NOTES: (Corresponds to the parameter '(xpack.)watcher.trigger.schedule.engine', depending on version. Ignored from 6.x onwards.)
Was this helpful?
Thank you for your feedback.