Loading

Read-only URL repository

Note

This repository type is only available if you run Elasticsearch on your own hardware. If you use Elastic Cloud Hosted, see Elastic Cloud Hosted repository types.

You can use a URL repository to give a cluster read-only access to a shared file system. Since 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.

				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.