• Elastic Cloud Enterprise - Elastic Cloud on your Infrastructure: other versions:
  • What Is Elastic Cloud Enterprise?
    • Architecture
    • Basic Terms
  • Getting Started
    • Quick Start Guide
    • Playbook for Production
      • Example: A Small Baseline Installation
      • Example: A Medium Installation with Separate Management Services
      • Example: A Large Installation with Separate Management Services and Proxies
    • Plan Your Deployment
    • Prerequisites
    • Limitations and Known Problems
    • Prepare Your Environment
      • Your Own Hosts
        • Ubuntu 14.04 LTS (Trusty Tahr)
        • Ubuntu 16.04 LTS (Xenial Xerus)
        • Red Hat Enterprise Linux (RHEL) 7 and CentOS 7
      • Amazon Machine Images (AMIs)
      • Google Cloud Platform (GCP)
      • Microsoft Azure Virtual Machines
        • Set Up Azure Resource Group and Networking
        • Create Your Hosts
    • Install ECE With Internet Access
    • Install ECE Without Internet Access
      • Install ECE Offline Without Your Own Docker Registry
    • Log in and Create Your First Cluster
    • Next Steps
      • Connect to Your Cluster
  • Configuring Your Installation
    • Manage Snapshot Repositories
      • Snapshotting to Google Cloud Storage (GCS) for Elasticsearch 6.x
      • Snapshotting to Azure Storage for Elasticsearch 5.x and 6.x
      • Snapshotting to Minio On-Premise Storage
    • Manage Licenses
    • Change Endpoints URLs
    • Manage Node Configurations
  • Securing Your Installation
    • Security Considerations
    • Generate Roles Tokens
    • Revoke Roles Tokens
    • Manage Security Certificates
    • Retrieve User Passwords
    • Reset User Passwords
  • Monitoring Your Installation
    • Access Logs and Metrics
    • Set the Retention Period for Logging and Metrics Indices
    • Scenario: Knowing When You Need More Proxies
  • Administering Your Installation
    • Scale Out Your Installation
    • Assign Roles to Runners
    • Enable Maintenance Mode
    • Move Nodes From Allocators
    • Delete Runners
    • Perform Host Maintenance
    • Manage Elastic Stack Versions
    • Upgrade Your Installation
  • Administering Clusters
    • Change Your Cluster Configuration
      • Resize Your Cluster
      • Add Plugins
      • Advanced Cluster Configuration
    • Stop Routing Requests or Pause Nodes
    • Stop a Cluster
    • Restart a Cluster
    • Delete a Cluster
    • Work with Snapshots
    • Upgrade Versions
      • Upgrade to Elasticsearch 6.x
      • Upgrade to Elasticsearch 5.x
    • Editing Your User Settings
      • Add Elasticsearch User Settings
      • Add Kibana User Settings
    • Configure Beats and Logstash with Cloud ID
    • Keep Your Clusters Healthy
      • Access the Monitoring Application in Kibana
    • Secure Your Clusters
      • Reset the Password for the elastic User
      • Reset the Password for the admin User
      • Manage Users and Roles in X-Pack
      • Manage Users and Roles in Shield
      • Configure the Java Transport Client
      • Secure Your Clusters with LDAP
        • Before You Begin
  • Troubleshooting
    • Common issues
    • Using the Emergency Roles Token
    • Removing Elastic Cloud Enterprise
    • Getting Help
  • API Reference
    • Clusters - Elasticsearch - CRUD
      • Get clusters
        • Request
        • Query Parameters
        • Responses
      • Create cluster
        • Request
        • Query Parameters
        • Request body
        • Responses
      • Delete cluster
        • Request
        • Path Parameters
        • Responses
      • Get cluster
        • Request
        • Path Parameters
        • Query Parameters
        • Responses
    • Clusters - Elasticsearch - CRUD - Configuration
      • Set settings overrides (all instances)
        • Request
        • Path Parameters
        • Query Parameters
        • Request body
        • Responses
      • Set settings overrides
        • Request
        • Path Parameters
        • Query Parameters
        • Request body
        • Responses
      • Set cluster name
        • Request
        • Path Parameters
        • Responses
      • Get cluster metadata in raw form
        • Request
        • Path Parameters
        • Responses
      • Set cluster metadata
        • Request
        • Path Parameters
        • Query Parameters
        • Request body
        • Responses
      • Get cluster metadata settings
        • Request
        • Path Parameters
        • Responses
      • Update cluster metadata settings
        • Request
        • Path Parameters
        • Query Parameters
        • Request body
        • Responses
      • Cancel monitoring
        • Request
        • Path Parameters
        • Responses
      • Set monitoring
        • Request
        • Path Parameters
        • Responses
      • Get plan
        • Request
        • Path Parameters
        • Query Parameters
        • Responses
      • Update plan
        • Request
        • Path Parameters
        • Query Parameters
        • Request body
        • Responses
      • Get plan activity
        • Request
        • Path Parameters
        • Query Parameters
        • Responses
      • Cancel pending plan
        • Request
        • Path Parameters
        • Query Parameters
        • Responses
      • Get pending plan
        • Request
        • Path Parameters
        • Query Parameters
        • Responses
    • Clusters - Elasticsearch - Commands
      • Restart cluster
        • Request
        • Path Parameters
        • Query Parameters
        • Responses
      • Shut down cluster
        • Request
        • Path Parameters
        • Query Parameters
        • Responses
      • Move instances (advanced)
        • Request
        • Path Parameters
        • Query Parameters
        • Request body
        • Responses
      • Move instances
        • Request
        • Path Parameters
        • Query Parameters
        • Request body
        • Responses
      • Start instances
        • Request
        • Path Parameters
        • Query Parameters
        • Responses
      • Stop instances
        • Request
        • Path Parameters
        • Query Parameters
        • Responses
      • Start maintenance mode
        • Request
        • Path Parameters
        • Query Parameters
        • Responses
      • Stop maintenance mode
        • Request
        • Path Parameters
        • Query Parameters
        • Responses
    • Clusters - Elasticsearch - Support
      • Generate diagnostics
        • Request
        • Path Parameters
        • Responses
      • Generate logs
        • Request
        • Path Parameters
        • Query Parameters
        • Responses
    • Clusters - Kibana - CRUD
      • Get clusters
        • Request
        • Query Parameters
        • Responses
      • Create cluster
        • Request
        • Query Parameters
        • Request body
        • Responses
      • Delete cluster
        • Request
        • Path Parameters
        • Responses
      • Get cluster
        • Request
        • Path Parameters
        • Query Parameters
        • Responses
    • Clusters - Kibana - CRUD - Configuration
      • Set cluster name
        • Request
        • Path Parameters
        • Responses
      • Get cluster metadata
        • Request
        • Path Parameters
        • Responses
      • Set cluster metadata
        • Request
        • Path Parameters
        • Query Parameters
        • Request body
        • Responses
      • Get cluster metadata settings
        • Request
        • Path Parameters
        • Responses
      • Update cluster metadata settings
        • Request
        • Path Parameters
        • Query Parameters
        • Request body
        • Responses
      • Get plan
        • Request
        • Path Parameters
        • Query Parameters
        • Responses
      • Update plan
        • Request
        • Path Parameters
        • Query Parameters
        • Request body
        • Responses
      • Get plan activity
        • Request
        • Path Parameters
        • Query Parameters
        • Responses
      • Cancel pending plan
        • Request
        • Path Parameters
        • Query Parameters
        • Responses
      • Get pending plan
        • Request
        • Path Parameters
        • Query Parameters
        • Responses
    • Clusters - Kibana - Commands
      • Restart cluster
        • Request
        • Path Parameters
        • Query Parameters
        • Responses
      • Shut down cluster
        • Request
        • Path Parameters
        • Query Parameters
        • Responses
      • Move instances (advanced)
        • Request
        • Path Parameters
        • Query Parameters
        • Request body
        • Responses
      • Move instances
        • Request
        • Path Parameters
        • Query Parameters
        • Request body
        • Responses
      • Start instances
        • Request
        • Path Parameters
        • Query Parameters
        • Responses
      • Stop instances
        • Request
        • Path Parameters
        • Query Parameters
        • Responses
      • Start maintenance mode
        • Request
        • Path Parameters
        • Query Parameters
        • Responses
      • Stop maintenance mode
        • Request
        • Path Parameters
        • Query Parameters
        • Responses
    • Platform
      • Get platform
        • Request
        • Responses
    • Platform - Allocators
      • Get allocators
        • Request
        • Query Parameters
        • Responses
      • Search allocators
        • Request
        • Request body
        • Responses
      • Delete allocator
        • Request
        • Path Parameters
        • Query Parameters
        • Responses
      • Get allocator
        • Request
        • Path Parameters
        • Responses
      • Move clusters
        • Request
        • Path Parameters
        • Query Parameters
        • Request body
        • Responses
      • Move clusters by type
        • Request
        • Path Parameters
        • Query Parameters
        • Request body
        • Responses
      • Get allocator metadata
        • Request
        • Path Parameters
        • Responses
      • Set allocator metadata
        • Request
        • Path Parameters
        • Query Parameters
        • Request body
        • Responses
      • Delete allocator metadata item
        • Request
        • Path Parameters
        • Query Parameters
        • Responses
      • Set allocator metadata item
        • Request
        • Path Parameters
        • Query Parameters
        • Request body
        • Responses
      • Get allocator settings
        • Request
        • Path Parameters
        • Responses
      • Update allocator settings
        • Request
        • Path Parameters
        • Query Parameters
        • Request body
        • Responses
      • Set allocator settings
        • Request
        • Path Parameters
        • Query Parameters
        • Request body
        • Responses
    • Platform - Configuration - Security
      • Get enrollment tokens
        • Request
        • Responses
      • Create enrollment token
        • Request
        • Request body
        • Responses
      • Delete enrollment token
        • Request
        • Path Parameters
        • Responses
    • Platform - Configuration - TLS
      • Get TLS certificate
        • Request
        • Path Parameters
        • Responses
      • Set TLS certificate
        • Request
        • Path Parameters
        • Request body
        • Responses
    • Platform - Repository - CRUD
      • Get snapshot repositories
        • Request
        • Responses
      • Delete snapshot repository
        • Request
        • Path Parameters
        • Responses
      • Get snapshot repository
        • Request
        • Path Parameters
        • Responses
      • Set snapshot repository
        • Request
        • Path Parameters
        • Query Parameters
        • Request body
        • Responses
    • Stack - CRUD
      • Get all available Elastic Stack versions
        • Request
        • Query Parameters
        • Responses
      • Submit Elastic Stack packs
        • Request
        • Form Parameters
        • Responses
      • Mark an Elastic Stack version for deletion
        • Request
        • Path Parameters
        • Responses
      • Get an Elastic Stack version
        • Request
        • Path Parameters
        • Responses
      • Update an Elastic Stack version
        • Request
        • Path Parameters
        • Request body
        • Responses
    • Definitions
      • AllocatedInstanceStatus
        • Properties
      • AllocatorCapacity
        • Properties
      • AllocatorCapacityMemory
        • Properties
      • AllocatorHealthStatus
        • Properties
      • AllocatorInfo
        • Properties
      • AllocatorMetadataItem
        • Properties
      • AllocatorMetadataItemValue
        • Properties
      • AllocatorMetadataItems
        • Properties
      • AllocatorMoveRequest
        • Properties
      • AllocatorOverview
        • Properties
      • AllocatorSettings
        • Properties
      • AllocatorZoneInfo
        • Properties
      • BasicFailedReply
        • Properties
      • BasicFailedReplyElement
        • Properties
      • BoolQuery
        • Properties
      • ChangeSourceInfo
        • Properties
      • ClusterCommandResponse
        • Properties
      • ClusterCredentials
        • Properties
      • ClusterCrudResponse
        • Properties
      • ClusterInstanceDiskInfo
        • Properties
      • ClusterInstanceInfo
        • Properties
      • ClusterInstanceMemoryInfo
        • Properties
      • ClusterMetadataInfo
        • Properties
      • ClusterMetadataSettings
        • Properties
      • ClusterPlanStepInfo
        • Properties
      • ClusterPlanStepLogMessageInfo
        • Properties
      • ClusterSystemAlert
        • Properties
      • ClusterTopologyInfo
        • Properties
      • CreateElasticsearchClusterRequest
        • Properties
      • CreateKibanaClusterRequest
        • Properties
      • CreateKibanaInCreateElasticsearchRequest
        • Properties
      • ElasticsearchClusterBlockingIssueElement
        • Properties
      • ElasticsearchClusterBlockingIssues
        • Properties
      • ElasticsearchClusterInfo
        • Properties
      • ElasticsearchClusterInstanceSettingsOverrides
        • Properties
      • ElasticsearchClusterPlan
        • Properties
      • ElasticsearchClusterPlanInfo
        • Properties
      • ElasticsearchClusterPlansInfo
        • Properties
      • ElasticsearchClusterRole
        • Properties
      • ElasticsearchClusterSecurityInfo
        • Properties
      • ElasticsearchClusterSettings
        • Properties
      • ElasticsearchClusterTopologyElement
        • Properties
      • ElasticsearchClusterUser
        • Properties
      • ElasticsearchClustersInfo
        • Properties
      • ElasticsearchConfiguration
        • Properties
      • ElasticsearchHttpUserSettings
        • Properties
      • ElasticsearchInfo
        • Properties
      • ElasticsearchMasterElement
        • Properties
      • ElasticsearchMasterInfo
        • Properties
      • ElasticsearchMonitoringInfo
        • Properties
      • ElasticsearchNodeType
        • Properties
      • ElasticsearchPlanControlConfiguration
        • Properties
      • ElasticsearchReplicaElement
        • Properties
      • ElasticsearchScriptTypeSettings
        • Properties
      • ElasticsearchScriptingUserSettings
        • Properties
      • ElasticsearchShardElement
        • Properties
      • ElasticsearchShardsInfo
        • Properties
      • ElasticsearchSystemSettings
        • Properties
      • ElasticsearchUserBundle
        • Properties
      • ElasticsearchUserPlugin
        • Properties
      • EmptyResponse
      • EnrollmentTokenRequest
        • Properties
      • ExternalHyperlink
        • Properties
      • GrowShrinkStrategyConfig
      • Hyperlink
        • Properties
      • InstanceMoveRequest
        • Properties
      • JSON
      • KibanaClusterInfo
        • Properties
      • KibanaClusterPlan
        • Properties
      • KibanaClusterPlanInfo
        • Properties
      • KibanaClusterPlansInfo
        • Properties
      • KibanaClusterTopologyElement
        • Properties
      • KibanaClustersInfo
        • Properties
      • KibanaConfiguration
        • Properties
      • KibanaPlanControlConfiguration
        • Properties
      • KibanaSubClusterInfo
        • Properties
      • KibanaSystemSettings
        • Properties
      • ListEnrollmentTokenElement
        • Properties
      • ListEnrollmentTokenReply
        • Properties
      • ManagedMonitoringSettings
        • Properties
      • ManagedSnapshotSettings
        • Properties
      • MatchQuery
        • Properties
      • MoveClustersCommandResponse
        • Properties
      • MoveClustersDetails
        • Properties
      • MoveClustersRequest
        • Properties
      • MoveElasticsearchClusterConfiguration
        • Properties
      • MoveElasticsearchClusterDetails
        • Properties
      • MoveKibanaClusterConfiguration
        • Properties
      • MoveKibanaClusterDetails
        • Properties
      • NestedQuery
        • Properties
      • PlanStrategy
        • Properties
      • PlatformInfo
        • Properties
      • PlatformServiceImageInfo
        • Properties
      • PlatformServiceInfo
        • Properties
      • QueryContainer
        • Properties
      • QueryStringQuery
        • Properties
      • RepositoryConfig
        • Properties
      • RepositoryConfigs
        • Properties
      • RequestEnrollmentTokenReply
        • Properties
      • RestoreSnapshotApiConfiguration
        • Properties
      • RestoreSnapshotConfiguration
        • Properties
      • RestoreSnapshotRepoConfiguration
        • Properties
      • RollingGrowShrinkStrategyConfig
      • RollingStrategyConfig
        • Properties
      • SearchRequest
        • Properties
      • SnapshotRepositoryConfiguration
        • Properties
      • SnapshotStatusInfo
        • Properties
      • StackVersionArchiveProcessingError
        • Properties
      • StackVersionArchiveProcessingResult
        • Properties
      • StackVersionConfig
        • Properties
      • StackVersionConfigPost
        • Properties
      • StackVersionConfigs
        • Properties
      • StackVersionElasticsearchConfig
        • Properties
      • StackVersionKibanaConfig
        • Properties
      • StackVersionMetadata
        • Properties
      • StackVersionTemplateFileHash
        • Properties
      • StackVersionTemplateInfo
        • Properties
      • TargetElasticsearchCluster
        • Properties
      • TermQuery
        • Properties
      • TiebreakerTopologyElement
        • Properties
      • TlsPublicCertChain
        • Properties
      • TransientElasticsearchPlanConfiguration
        • Properties
      • TransientKibanaPlanConfiguration
        • Properties
  • Script Reference
    • elastic-cloud-enterprise.sh install
    • elastic-cloud-enterprise.sh upgrade
    • elastic-cloud-enterprise.sh reset-adminconsole-password
    • elastic-cloud-enterprise.sh add-stack-version
    • elastic-cloud-enterprise.sh set-logging-and-metrics-policy
  • 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
    • Statistics collected by Elastic Cloud Enterprise
    • Third-Party Software Dependencies