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.
- Elastic Cloud Enterprise - Elastic Cloud on your Infrastructure: other versions:
- What is Elastic Cloud Enterprise?
- Getting started
- Planning your installation
- Preparing your environment
- Installing Elastic Cloud Enterprise
- Configuring your installation
- Securing your installation
- Monitoring your installation
- Administering your installation
- Getting started with deployments
- Administering deployments
- Change your deployment configuration
- Stop routing requests or pause nodes
- Stop a deployment
- Restart a deployment
- Delete a deployment
- Access the Elasticsearch API
- Work with snapshots
- Upgrade versions
- Editing your user settings
- Configure Beats and Logstash with Cloud ID
- Keep your clusters healthy
- Secure your clusters
- Reset the password for the
elasticuser - Manage users and roles in X-Pack
- Manage users and roles in Shield
- Configure the Java Transport client
- Filter IP traffic
- Secure your settings
- Secure your 7.x clusters with LDAP
- Secure your 7.x clusters with Active Directory
- Secure your 5.x and 6.x clusters with LDAP
- Secure your 5.x and 6.x clusters with Active Directory
- Secure your clusters with SAML
- Secure your clusters with OpenID Connect
- Reset the password for the
- Manage your Kibana instance
- Manage your APM Server
- Enable Monitoring (formerly Marvel)
- Enable Graph (versions before 5.0)
- Connect to your cluster
- Enable cross-cluster search
- Troubleshooting
- RESTful API
- Using the API
- API examples
- A first API call: What deployments are there?
- Create a first deployment: Just an Elasticsearch cluster
- Create a Deployment: Elasticsearch Cluster and Kibana instance
- Applying a new plan: Resize and add high availability
- Applying a new plan: Checking on progress
- Applying a new deployment configuration: Upgrade
- Enable more stack features: Add Kibana to a deployment
- Dipping a toe into platform automation: Generate a roles token
- Customize your deployment
- Remove unwanted deployment templates and instance configurations
- Secure your settings
- API reference
- Authentication
- Disable elevated permissions
- Enable elevated permissions
- Login to ECE
- Refresh authentication token
- Delete API keys
- Get all API keys
- Create API key
- Delete API keys of multiple users
- Get all API keys for all users
- Delete API key
- Get API key
- Available authentication methods
- Re-authenticate to generate a token
- SAML callback
- Initiate SAML protocol
- Delete API keys for a user
- Get all API keys for a user
- Delete an API key for a user
- Get a user API key
- Clusters - Apm - CRUD
- Clusters - Apm - CRUD - Configuration
- Clusters - Apm - Commands
- Search clusters
- Restart cluster
- Resynchronize cluster
- Shut down cluster
- Upgrade cluster
- Move instances (advanced)
- Start all instances
- Stop all instances
- Start maintenance mode all instances
- Stop maintenance mode all instances
- Move instances
- Start instances
- Stop instances
- Start maintenance mode
- Stop maintenance mode
- Clusters - Elasticsearch - CRUD
- Clusters - Elasticsearch - CRUD - Configuration
- Get cross-cluster search clusters
- Get remote clusters for cross-cluster search
- Set remote clusters for cross-cluster search
- Get cluster curation settings
- Update cluster curation settings
- Set settings overrides (all instances)
- Set settings overrides
- Get settings from this cluster’s keystore
- Add or remove settings from the cluster keystore
- Set cluster name
- Get cluster metadata
- Set cluster metadata
- Get cluster metadata settings
- Update cluster metadata settings
- Cancel monitoring
- Set monitoring
- Get plan
- Update plan
- Migrate plan
- Get plan activity
- Cancel pending plan
- Get pending plan
- Set legacy security settings
- Get cluster snapshot settings
- Update cluster snapshot settings
- Clusters - Elasticsearch - Commands
- Search clusters
- Restart cluster
- Resynchronize cluster
- Shut down cluster
- Take snapshot
- Move instances (advanced)
- Start all instances
- Stop all instances
- Start maintenance mode all instances
- Stop maintenance mode all instances
- Move instances
- Start instances
- Stop instances
- Start maintenance mode
- Stop maintenance mode
- Clusters - Elasticsearch - Proxy
- Clusters - Elasticsearch - Support
- Clusters - Kibana - CRUD
- Clusters - Kibana - CRUD - Configuration
- Clusters - Kibana - Commands
- Search clusters
- Restart cluster
- Resynchronize cluster
- Shut down cluster
- Upgrade cluster
- Move instances (advanced)
- Start all instances
- Stop all instances
- Start maintenance mode all instances
- Stop maintenance mode all instances
- Move instances
- Start instances
- Stop instances
- Start maintenance mode
- Stop maintenance mode
- Clusters - Kibana - Proxy
- Clusters - Search
- Comments
- Deployments - Extensions
- Deployments - IP Filtering - CRUD
- Deployments - Notes
- Platform
- Platform - Allocators
- Get allocators
- Resynchronize allocators
- Search allocators
- Delete allocator
- Get allocator
- Resynchronize allocator
- Move clusters
- Move clusters by type
- Start maintenance mode
- Stop maintenance mode
- Get allocator metadata
- Set allocator metadata
- Delete allocator metadata item
- Set allocator metadata item
- Get allocator settings
- Update allocator settings
- Set allocator settings
- Platform - Configuration - Instances - CRUD
- Platform - Configuration - Security
- Platform - Configuration - Security Deployment
- Platform - Configuration - Security Realms
- List security realm configurations
- Reorder security realms
- Create Active Directory configuration
- Delete Active Directory configuration
- Get Active Directory configuration
- Update Active Directory configuration
- Create LDAP configuration
- Delete LDAP configuration
- Get LDAP configuration
- Update LDAP configuration
- Create SAML configuration
- Delete SAML configuration
- Get SAML configuration
- Update SAML configuration
- Platform - Configuration - TLS
- Platform - Constructors
- Platform - License
- Platform - Repository - CRUD
- Platform - Runners
- Platform - configuration - Store
- Platform - proxies
- Roles
- Stack - Instance Types - CRUD
- Stack - Versions - CRUD
- Templates - Deployments
- Users
- Definitions
ActiveDirectoryGroupSearchActiveDirectorySecurityRealmLoadBalanceActiveDirectorySecurityRealmRoleMappingRuleActiveDirectorySecurityRealmRoleMappingRulesActiveDirectorySettingsActiveDirectoryUserSearchAllocatedInstancePlansInfoAllocatedInstanceStatusAllocatorBuildInfoAllocatorCapacityAllocatorCapacityMemoryAllocatorHealthStatusAllocatorInfoAllocatorMoveRequestAllocatorOverviewAllocatorSettingsAllocatorZoneInfoApiKeyResponseApiKeysResponseApmConfigurationApmCrudResponseApmInfoApmPlanApmPlanControlConfigurationApmPlanInfoApmPlansInfoApmSettingsApmSubInfoApmSystemSettingsApmTopologyElementApmsInfoAvailableAuthenticationMethodsBasicFailedReplyBasicFailedReplyElementBlessingBlessingsBlessingsWithMetaBoolQueryCapacityConstraintsResourceChangeSourceInfoClusterCommandResponseClusterCredentialsClusterCrudResponseClusterCurationSettingsClusterCurationSpecClusterInfoClusterInstanceConfigurationInfoClusterInstanceDiskInfoClusterInstanceInfoClusterInstanceMemoryInfoClusterLicenseInfoClusterMetadataCpuResourcesSettingsClusterMetadataInfoClusterMetadataPortInfoClusterMetadataResourcesSettingsClusterMetadataSettingsClusterPlanMigrationResponseClusterPlanStepInfoClusterPlanStepLogMessageInfoClusterSnapshotRepositoryDefaultClusterSnapshotRepositoryInfoClusterSnapshotRepositoryReferenceClusterSnapshotRepositoryStaticClusterSnapshotRequestClusterSnapshotResponseClusterSnapshotRetentionClusterSnapshotSettingsClusterSystemAlertClusterTopologyInfoClusterUpgradeInfoClustersInfoCommentCommentCreateRequestCommentUpdateRequestCommentWithMetaCommentsWithMetasCompatibleNodeTypesResourceCompatibleVersionResourceConfigStoreOptionConfigStoreOptionDataConfigStoreOptionListConstructorHealthStatusConstructorInfoConstructorOverviewContainerConfigHostConfigContainersEntryContainersEntryOptionsContainersEntryOptionsACLContainersEntryOptionsAuthContainersEntryOptionsContainerConfigContainersEntryOptionsOverridesCreateApiKeyRequestCreateApmInCreateElasticsearchRequestCreateApmRequestCreateElasticsearchClusterRequestCreateExtensionRequestCreateKibanaInCreateElasticsearchRequestCreateKibanaRequestCrossClusterSearchClustersCrossClusterSearchInfoCrossClusterSearchSettingsDeleteApiKeysRequestDeleteUsersApiKeysRequestDeploymentTemplateInfoDeploymentTemplateReferenceDiscreteSizesElasticsearchClusterBlockingIssueElementElasticsearchClusterBlockingIssuesElasticsearchClusterInfoElasticsearchClusterInstanceSettingsOverridesElasticsearchClusterPlanElasticsearchClusterPlanInfoElasticsearchClusterPlansInfoElasticsearchClusterRoleElasticsearchClusterSecurityInfoElasticsearchClusterSettingsElasticsearchClusterTopologyElementElasticsearchClusterUserElasticsearchClustersInfoElasticsearchConfigurationElasticsearchCurationElasticsearchInfoElasticsearchMasterElementElasticsearchMasterInfoElasticsearchMonitoringInfoElasticsearchNodeTypeElasticsearchPlanControlConfigurationElasticsearchReplicaElementElasticsearchScriptTypeSettingsElasticsearchScriptingUserSettingsElasticsearchShardElementElasticsearchShardsInfoElasticsearchSystemSettingsElasticsearchUserBundleElasticsearchUserPluginElevatePermissionsRequestElevatedPermissionsEmptyResponseEnrollmentTokenRequestExistsQueryExtensionExtensionsExternalHyperlinkFilterAssociationGrowShrinkStrategyConfigHyperlinkIdResponseIndexSynchronizationResultsInstanceConfigurationInstanceMoveRequestInstanceTypeResourceIpFilterRuleIpFilterRulesetIpFilterRulesetsIpFilteringSettingsKeystoreContentsKeystoreSecretKibanaClusterInfoKibanaClusterPlanKibanaClusterPlanInfoKibanaClusterPlansInfoKibanaClusterSettingsKibanaClusterTopologyElementKibanaClustersInfoKibanaConfigurationKibanaPlanControlConfigurationKibanaSubClusterInfoKibanaSystemSettingsLdapGroupSearchLdapSecurityRealmLoadBalanceLdapSecurityRealmRoleMappingRuleLdapSecurityRealmRoleMappingRulesLdapSettingsLdapUserSearchLegacySecuritySettingsLicenseInfoLicenseObjectListEnrollmentTokenElementListEnrollmentTokenReplyLoginRequestLoginStateManagedMonitoringSettingsMatchAllQueryMatchNoneQueryMatchQueryMetadataMetadataItemMetadataItemValueMetadataItemsModelVersionIndexSynchronizationResultsMoveApmClusterConfigurationMoveApmClusterDetailsMoveClustersCommandResponseMoveClustersDetailsMoveClustersRequestMoveElasticsearchClusterConfigurationMoveElasticsearchClusterDetailsMoveKibanaClusterConfigurationMoveKibanaClusterDetailsNestedQueryNodeTypeResourceNoteNotesOptionObjectPendingStatePendingStatesPendingStatesWithMetaPlanStrategyPlatformInfoPlatformServiceImageInfoPlatformServiceInfoPortBindingPrefixQueryProxiesAllocationsInfoProxiesFilterProxiesFilteredGroupProxiesFilteredGroupHealthProxiesHealthProxiesHttpSettingsProxiesSSOSettingsProxiesSettingsProxyAllocationCountsProxyAllocationInfoProxyInfoProxyOverviewQueryContainerQueryStringQueryRangeQueryReAuthenticationRequestReAuthenticationResponseRemoteClusterInfoRemoteClusterRefRepositoryConfigRepositoryConfigsRequestEnrollmentTokenReplyRestartPolicyRestoreSnapshotApiConfigurationRestoreSnapshotConfigurationRestoreSnapshotRepoConfigurationRoleRoleAggregateRoleAggregateCreateDataRoleAggregatesRoleWithMetaRollingGrowShrinkStrategyConfigRollingStrategyConfigRuleSetResponseRulesetAssociationsRunnerBuildInfoRunnerContainerInfoRunnerInfoRunnerOverviewRunnerRoleInfoRunnerRolesInfoSamlAttributeSettingsSamlIdpSettingsSamlSecurityRealmRoleMappingRuleSamlSecurityRealmRoleMappingRulesSamlSettingsSamlSpSettingsSearchRequestSecurityDeploymentSecurityDeploymentCreateRequestSecurityDeploymentTopologySecurityRealmInfoSecurityRealmInfoListSecurityRealmsReorderRequestSnapshotRepositoryConfigurationSnapshotStatusInfoStackVersionApmConfigStackVersionAppSearchConfigStackVersionArchiveProcessingErrorStackVersionArchiveProcessingResultStackVersionConfigStackVersionConfigPostStackVersionConfigsStackVersionElasticsearchConfigStackVersionEnterpriseSearchConfigStackVersionInstanceCapacityConstraintStackVersionKibanaConfigStackVersionMetadataStackVersionNodeTypeStackVersionSiteSearchConfigStackVersionTemplateFileHashStackVersionTemplateInfoTargetElasticsearchClusterTermQueryTiebreakerTopologyElementTlsPublicCertChainTokenResponseTopologySizeTransientApmPlanConfigurationTransientElasticsearchPlanConfigurationTransientKibanaPlanConfigurationUpdateExtensionRequestUsageStatsUserUserApiKeyUserListUserMetadataUserSecurityUserSecurityRealm
- Authentication
- Script reference
- Release notes
- Elastic Cloud Enterprise 2.3.2
- Elastic Cloud Enterprise 2.3.1
- Elastic Cloud Enterprise 2.3.0
- Elastic Cloud Enterprise 2.2.3
- Elastic Cloud Enterprise 2.2.2
- Elastic Cloud Enterprise 2.2.1
- Elastic Cloud Enterprise 2.2.0
- Elastic Cloud Enterprise 2.1.1
- Elastic Cloud Enterprise 2.1.0
- Elastic Cloud Enterprise 2.0.1
- Elastic Cloud Enterprise 2.0.0
- Elastic Cloud Enterprise 1.1.5
- Elastic Cloud Enterprise 1.1.4
- Elastic Cloud Enterprise 1.1.3
- Elastic Cloud Enterprise 1.1.2
- Elastic Cloud Enterprise 1.1.1
- Elastic Cloud Enterprise 1.1.0
- Elastic Cloud Enterprise 1.0.2
- Elastic Cloud Enterprise 1.0.1
- Elastic Cloud Enterprise 1.0.0
- Limitations and known problems
- What’s new with the Elastic Stack
- Elastic Stack 7.5.1 released
- Elastic Stack 7.5.0 released
- Elastic Stack 7.4.2 released
- Elastic Stack 7.4.1 released
- Elastic Stack 7.4.0 released
- Elastic Stack 7.3.2 released
- Elastic Stack 7.3.1 released
- Elastic Stack 7.3.0 released
- Elastic Stack 7.2.1 and 6.8.2 released
- Elastic Stack 7.2.0 released
- Elastic Stack 7.1.1 released
- Elastic Stack 7.1.0 released
- Elastic Stack 7.0.1 released
- Elastic Stack 7.0.0 released
- Elastic Stack 6.8.6 released
- Elastic Stack 6.8.5 released
- Elastic Stack 6.8.4 released
- Elastic Stack 6.8.3 released
- Elastic Stack 6.8.1 released
- Elastic Stack 6.8.0 released
- Elastic Stack 6.7.2 released
- Elastic Stack 6.7.1 released
- Elastic Stack 6.7.0 released
- Elastic Stack 6.6.2 released
- Elastic Stack 6.6.0 released
- Elastic Stack 6.5.4 released
- Elastic Stack 5.6.14 and 6.5.3 released
- Elastic Stack 6.5.2 released
- Elastic Stack 6.5.1 released
- Elastic Stack 6.5.0 released
- Elastic Stack 5.6.13 and 6.4.3 released
- Elastic Stack 5.6.11 and 6.4.0 released
- Elastic Stack 6.3.2 released
- Elastic Stack 6.3.1 released
- Known issue affecting 5.6.10 to 6.3.0 upgrades
- Elastic Stack 5.6.10 and 6.3.0 released
- About this product