Type to search.

Read-only URL repository

Stack

The Elastic Stack includes Elastic's core products such as Elasticsearch, Kibana, Logstash, and Beats.

Availability

  • Generally available

    This functionality is generally available and ready for production usage.

Unless stated otherwise on the page, this functionality is available when your Elastic Stack is deployed on Elastic Cloud Hosted, Elastic Cloud Enterprise, Elastic Cloud on Kubernetes, and self-managed environments.

This documentation corresponds to the latest patch available for each minor version. If you're not using the latest patch, check the release notes for changes.

You can use a URL repository to give a cluster read-only access to snapshot data exposed through a URL, including file, http, https, and ftp locations. Because URL repositories are always read-only, they're a safer and more convenient alternative to registering a read-only shared filesystem repository.

Use Kibana or the create snapshot repository API to register a URL repository.

JSON 
PUT _snapshot/my_read_only_url_repository
{
  "type": "url",
  "settings": {
    "url": "file:/mount/backups/my_fs_backup_location"
  }
}

The url repository type supports a number of settings to customize how data is stored, which may be specified when creating the repository.

Repository settings cover the snapshot root URL (including supported protocols), HTTP retries and timeouts for remote URLs, compression, throughput limits, and the maximum number of snapshots. Remote http, https, and ftp URLs must be allowed by the repositories.url.allowed_urls setting. For a complete list of all read-only URL repository settings, refer to Read-only URL repository settings.