- 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
- 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
- Work with Snapshots
- Access the Elasticsearch API
- Upgrade Versions
- Editing Your User Settings
- Configure Beats and Logstash with Cloud ID
- Keep Your Clusters Healthy
- Secure Your Clusters
- Manage Your Kibana Instance
- Enable Monitoring (formerly Marvel)
- Enable Graph (Versions before 5.0)
- Connect to Your Cluster
- Troubleshooting
- RESTful API
- Using the API
- API examples
- A first API call: What deployments are there?
- Create a first deployment: Just an Elasticsearch cluster
- 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
- API reference
- Authentication
- Clusters - Elasticsearch - CRUD
- Clusters - Elasticsearch - CRUD - Configuration
- Get cluster curation settings
- Update cluster curation settings
- Set settings overrides (all instances)
- Set settings overrides
- 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
- 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
- Immediately create a new cluster 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 - 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
- Deployments - Notes
- Platform
- Platform - Allocators
- Get 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 - TLS
- Platform - Constructors
- Platform - License
- Platform - Repository - CRUD
- Platform - Runners
- Stack - Instance Types - CRUD
- Stack - Versions - CRUD
- Templates - Deployments
- Definitions
AllocatedInstanceStatusAllocatorCapacityAllocatorCapacityMemoryAllocatorHealthStatusAllocatorInfoAllocatorMoveRequestAllocatorOverviewAllocatorSettingsAllocatorZoneInfoApmPlanControlConfigurationBasicFailedReplyBasicFailedReplyElementBoolQueryCapacityConstraintsResourceChangeSourceInfoClusterCommandResponseClusterCredentialsClusterCrudResponseClusterCurationSettingsClusterCurationSpecClusterInstanceConfigurationInfoClusterInstanceDiskInfoClusterInstanceInfoClusterInstanceMemoryInfoClusterLicenseInfoClusterMetadataCpuResourcesSettingsClusterMetadataInfoClusterMetadataResourcesSettingsClusterMetadataSettingsClusterPlanStepInfoClusterPlanStepLogMessageInfoClusterSnapshotRepositoryDefaultClusterSnapshotRepositoryInfoClusterSnapshotRepositoryReferenceClusterSnapshotRepositoryStaticClusterSnapshotRequestClusterSnapshotResponseClusterSnapshotSettingsClusterSystemAlertClusterTopologyInfoClusterUpgradeInfoCompatibleNodeTypesResourceCompatibleVersionResourceConstructorHealthStatusConstructorInfoConstructorOverviewCreateElasticsearchClusterRequestCreateKibanaInCreateElasticsearchRequestCreateKibanaRequestDeploymentTemplateInfoDeploymentTemplateReferenceDiscreteSizesElasticsearchClusterBlockingIssueElementElasticsearchClusterBlockingIssuesElasticsearchClusterInfoElasticsearchClusterInstanceSettingsOverridesElasticsearchClusterPlanElasticsearchClusterPlanInfoElasticsearchClusterPlansInfoElasticsearchClusterRoleElasticsearchClusterSecurityInfoElasticsearchClusterSettingsElasticsearchClusterTopologyElementElasticsearchClusterUserElasticsearchClustersInfoElasticsearchConfigurationElasticsearchCurationElasticsearchInfoElasticsearchMasterElementElasticsearchMasterInfoElasticsearchMonitoringInfoElasticsearchNodeTypeElasticsearchPlanControlConfigurationElasticsearchReplicaElementElasticsearchScriptTypeSettingsElasticsearchScriptingUserSettingsElasticsearchShardElementElasticsearchShardsInfoElasticsearchSystemSettingsElasticsearchUserBundleElasticsearchUserPluginElevatePermissionsRequestEmptyResponseEnrollmentTokenRequestExistsQueryExternalHyperlinkGrowShrinkStrategyConfigHyperlinkIdResponseInstanceConfigurationInstanceMoveRequestInstanceTypeResourceKibanaClusterInfoKibanaClusterPlanKibanaClusterPlanInfoKibanaClusterPlansInfoKibanaClusterTopologyElementKibanaClustersInfoKibanaConfigurationKibanaPlanControlConfigurationKibanaSubClusterInfoKibanaSystemSettingsLegacySecuritySettingsLicenseInfoLicenseObjectListEnrollmentTokenElementListEnrollmentTokenReplyLoginRequestLoginStateManagedMonitoringSettingsMatchQueryMetadataItemMetadataItemValueMetadataItemsMoveApmClusterConfigurationMoveApmClusterDetailsMoveClustersCommandResponseMoveClustersDetailsMoveClustersRequestMoveElasticsearchClusterConfigurationMoveElasticsearchClusterDetailsMoveKibanaClusterConfigurationMoveKibanaClusterDetailsNestedQueryNodeTypeResourceNoteNotesPlanStrategyPlatformInfoPlatformServiceImageInfoPlatformServiceInfoPrefixQueryQueryContainerQueryStringQueryRangeQueryRepositoryConfigRepositoryConfigsRequestEnrollmentTokenReplyRestoreSnapshotApiConfigurationRestoreSnapshotConfigurationRestoreSnapshotRepoConfigurationRollingGrowShrinkStrategyConfigRollingStrategyConfigRunnerContainerInfoRunnerInfoRunnerOverviewRunnerRoleInfoRunnerRolesInfoSearchRequestSnapshotRepositoryConfigurationSnapshotStatusInfoStackVersionApmConfigStackVersionArchiveProcessingErrorStackVersionArchiveProcessingResultStackVersionConfigStackVersionConfigPostStackVersionConfigsStackVersionElasticsearchConfigStackVersionInstanceCapacityConstraintStackVersionKibanaConfigStackVersionMetadataStackVersionNodeTypeStackVersionTemplateFileHashStackVersionTemplateInfoTargetElasticsearchClusterTermQueryTiebreakerTopologyElementTlsPublicCertChainTokenResponseTopologySizeTransientApmPlanConfigurationTransientElasticsearchPlanConfigurationTransientKibanaPlanConfiguration
- Script Reference
- Release notes
- 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
- 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.
Work with Snapshots
editWork with Snapshots
editSnapshots provide backups of your Elasticsearch indices. You can use snapshots to recover from a failure when not enough availability zones are used to provide high availability or to recover from accidental deletion.
Before You Begin
editTo enable snapshots for your Elasticsearch clusters and to work with them, you must have configured a repository. After you have configured a snapshot repository, a snapshot is taken every 30 minutes or at the interval you specify through your user settings.
ECE keeps the latest 100 successful snapshots. Once your cluster has reached 100 snapshots, ECE removes old snapshots as new ones are taken. IMPORTANT: Snapshots back up all open indices. If you close an index, it is not included in snapshots and you will not be able to restore the data.
List Available Snapshots
editTo list all available snapshots:
- Log into the Cloud UI.
-
On the Deployments page, select your deployment.
Narrow the list of the deployments by name, ID, or choose from several other filters. Use a combination of them to further define the list.
- From the Elasticsearch menu, click Snapshots.
The list of available snapshots is shown, newest first. The listing shows when each snapshot was completed, how long it took, and whether the snapshot succeeded. Click on a specific snapshot to see additional details.
Restore a Snapshot
editTo restore a snapshot:
- Log into the Cloud UI.
-
On the Deployments page, select your deployment.
Narrow the list of the deployments by name, ID, or choose from several other filters. Use a combination of them to further define the list.
- From the Elasticsearch menu, click Snapshots.
- Click on a specific snapshot to see additional details and see the restore options.
-
Optional: In the Restore Snapshot section, specify how you want to restore the snapshot. If you do not specify any options, all the open indices of the snapshot are restored on the cluster where the snapshot was taken.
- In the Specify Indices field, you can limit which indices get restored by specifying only those indices that you want.
- If the index already exists, use the Rename Indices section and the Match pattern and Replace with fields when you restore indices. You cannot restore to an existing index.
- Click Restore snapshot.
Was this helpful?
Thank you for your feedback.