Documentation

Select a category on the left, to get your answers quickly

Download Index Backup File

  • ​In order to download your index backup file, you will have to make an HTTP GET request to the Index Hostname, found in your Index Control Panel
  • You can get the backup file name using the List Backups API method
  • IMPORTANT: The username and password are the credentials of your Opensolr Index, and NOT those of your Opensolr account.
  • Each Opensolr Index is protected by HTTP Basic Auth over HTTPS.
  • In case you haven't set it to something else, inside your Opensolr Index Control Panel, the default username is opensolr, and the password, is your Secret API KEY found in your Opensolr Control Panel Dashboard.
  • Example: 
    curl -s -u "username:password" -o /file/save/path.tar.gz https://<SERVER_HOSTNAME>/<INDEX_NAME>/<BACKUP_FILE_NAME>

Get List of All Backup Files

  1. GET https://opensolr.com/solr_manager/api/get_backup_files_list
  2. Parameters:
    1. ​email - your opensolr registration email address
    2. api_key - your opensolr api_key
    3. ​core_name - the name of the core you wish to get the backup files list for
  3. Example: https://opensolr.com/solr_manager/api/get_backup_files_list?email=PLEASE_LOG_IN&
    api_key=PLEASE_LOG_IN&core_name=my_solr_core

Create Index Backup

  1. GET https://opensolr.com/solr_manager/api/create_backup
  2. Parameters:
    1. ​email - your opensolr registration email address
    2. api_key - your opensolr api_key
    3. ​core_name - the name of the core you wish to create a backup for
  3. Example: https://opensolr.com/solr_manager/api/create_backup?email=PLEASE_LOG_IN&
    api_key=PLEASE_LOG_IN&core_name=my_solr_core