Documentation

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

AI & NLP API-Backup Management API-Cluster Management API-Config Files API-Index Management API-Logs & Analytics API-Security API-Web Crawler Billing CMS-Drupal CMS-Wordpress Data Backup Omeka CMS Security Solr Manager Control Panel Solr Tika Integration Teams Management Web Crawler Wiki

API - Download backup file

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.
The URL: https://backup.opensolr.com/<INDEX_NAME> contains the latest backup of your index, plus daily backup archives from the the last 10 days.

Example: 
curl -s -u "username:password" -o /file/save/path.tar.gz https://backup.opensolr.com/<INDEX_NAME>/<BACKUP_FILE_NAME>

Read All...

API - Get list of backup files

Get List of All Backup Files

GET https://opensolr.com/solr_manager/api/get_backup_files_list
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

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

Read All...

API - Create backup

Create Index Backup

GET https://opensolr.com/solr_manager/api/create_backup
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

Example: https://opensolr.com/solr_manager/api/create_backup?email=PLEASE_LOG_IN&
api_key=PLEASE_LOG_IN&core_name=my_solr_core

Read All...