Manage Snapshot Repositories

Snapshot repositories are managed for your entire Elastic Cloud Enterprise installation and can be specified for an Elasticsearch cluster when you create or manage it. When a repository is specified, a snapshot is taken every 30 minutes or at the interval you specify through the advanced cluster configuration.

Support for the following repositories is available through the Elastic core repository plugins:

You can also configure Google Cloud Storage (GCS) as a snapshot repository, if you are using Elasticsearch 6.0 and Google Default Authentication. To learn more, see Snapshotting to Google Cloud Storage.

If you are installing ECE without internet access (commonly called an offline or air-gapped installation), you will need to use an on-premise storage service. We suggest that you use Minio. For our installation notes, see Snapshotting to Minio On-Premise Storage.

To learn more about how snapshots are used with Elasticsearch, see Snapshot and Restore. To learn more about each of these storage repositories, see their official documentation:

Add Snapshot Repository Configurations

Before any snapshot or restore operation can be performed for Elasticsearch clusters, at least one snapshot repository configuration needs to be added to your Elastic Cloud Enterprise installation.

To add a snapshot repository:

  1. Log into the Cloud UI.
  2. Go to the Platform page and select an Elastic Cloud Enterprise installation.
  3. Click the Repositories tab.
  4. Click Create Repository to add an existing repository.
  5. Provide a name for the repository configuration.
  6. Select one of the supported repository types and specify the necessary settings:

    • Amazon S3 configuration:

      All repository options must be specified, as there are no default values.

      The region where the bucket is located.
      The name of the bucket to be used for snapshots.
      Access key
      The access key to use for authentication.
      Secret key
      The secret key to use for authentication.
    • Advanced configuration:

      Used for Amazon S3 repositories where you need to provide additional configuration parameters not supported by the S3 repository option. Configurations must be specified in a valid JSON format. For example:

      Amazon S3 (see supported settings):

        "type": "s3",
        "settings": {
          "bucket": "my_bucket_name",
          "region": "us-west"
  7. Click Save.

Edit Snapshot Repository Configurations

To edit a snapshot repository configuration from your Elastic Cloud Enterprise installation:

  1. Log into the Cloud UI.
  2. Go to the Platform page and select an Elastic Cloud Enterprise installation.
  3. Click the Repositories tab.
  4. Click Edit to modify a snapshot repository configuration.

    For available options you can change, see Add Snapshot Repository Configurations.

  5. Click Save.

Delete Snapshot Repository Configurations

Deleting a snapshot repository configuration does not remove the snapshot repository itself from S3. Only the configuration that enables Elastic Cloud Enterprise to access the repository is removed. Existing snapshots are also retained and need to be deleted separately if you no longer need them.

To delete a snapshot repository configuration from your Elastic Cloud Enterprise installation:

  1. Go to the Platform page and select an Elastic Cloud Enterprise installation.
  2. Click the Repositories tab, then find the repository name that you want to remove.
  3. Run the following command against the repository name:

    curl -s -DELETE -u "USER:PASSWORD" https://COORDINATOR_HOST:12443/api/v1/platform/configuration/snapshots/repositories/REPOSITORY_NAME

    The root user

    The password for the user

    A host that you installed Elastic Cloud Enterprise on that holds the coordinator role, such as a host where you can log into the Cloud UI

Manage Elasticsearch Cluster Repositories

You might need to update existing Elasticsearch clusters to use a different snapshot repository for one of the following reasons:

  • If you do not want all snapshots for a specific Elasticsearch cluster to go into the same bucket as your other clusters, you can add a new snapshot repository configuration with separate permissions and then change your Elasticsearch cluster to use the new repository.
  • If you created an Elasticsearch cluster with no snapshot repository configured, you can add a repository later on. Elastic Cloud Enterprise will start taking snapshots of the cluster automatically.

To change the snapshot repository for an existing Elasticsearch cluster:

  1. Log into the Cloud UI.
  2. Optional: If you need to use a repository that is not yet listed, add a snapshot repository configuration first.
  3. Select a cluster on the Clusters panel and click Manage.
  4. Under Snapshot repository, select a different repository and click Save repository.

Future snapshots will be sent to the new repository.

Change Snapshot Intervals

When a cluster is configured with a snapshot repository, ECE automatically takes a snapshot of the cluster every 30 minutes. You can change this snapshot interval for individual clusters. For example, if the default snapshot interval negatively affects the performance of a very busy cluster, you can increase the interval to reduce the number of snapshots taken.


Editing the advanced cluster configuration directly can prevent your cluster from operating normally, if done incorrectly. Proceed at your own risk.

To change the snapshot interval:

  1. Select the cluster you want to change from the list of clusters and click Manage.
  2. Click advanced cluster configuration.
  3. Locate the snapshot section in the Data text field.
  4. Specify the interval value between two snapshots, in seconds. For example, to change the snapshot configuration to take a snapshot every two hours, add the following under the snapshot section:

        "interval": 7200

    Other interval formats you can specify include d for days, h for hours, min for minutes, and s for seconds ("interval": "1 d", for example).

  5. Click Save.

The change to the snapshot interval takes effect after the next scheduled snapshot.