Backup Management

Backup files are downloaded over HTTPS, not through an API endpoint. Sign in with the username and password of the index, the ones in its Security tab.

01 · Find the file name

Call get_backup_files_list, or open the folder of the index in a browser: it lists every backup file.

02 · Example

curl -u "INDEX_USERNAME:INDEX_PASSWORD" -o my_index_10_11_2026-02.00.09.tar \
  "https://backup.opensolr.com/my_index/my_index_10_11_2026-02.00.09.tar"

A new index starts with the username opensolr and your master API key as its password. If you changed them, use the new ones.

03 · Related

Lists the backup files of your Opensolr Index. You need a file name from this list to restore a backup or to download it.

01 · Parameters

02 · Example

curl -s "https://opensolr.com/solr_manager/api/get_backup_files_list?email=YOUR_EMAIL&api_key=YOUR_API_KEY&core_name=my_index"

03 · Answer

{
    "status": true,
    "msg": [
        "my_index_10_10_2026-02.00.11.tar",
        "my_index_10_11_2026-02.00.09.tar"
    ]
}

The names carry the date and time the backup was made (month, day, year, then hour, minute, second). An index with no backup answers an empty list.

04 · Errors

05 · Related

Makes a backup of your Opensolr Index, its data and its configuration files, the same as Create New Backup in the Control Panel.

01 · Parameters

02 · Example

curl -s "https://opensolr.com/solr_manager/api/create_backup?email=YOUR_EMAIL&api_key=YOUR_API_KEY&core_name=my_index"

03 · Answer

{
    "status": true,
    "msg": "Your backup file will be created momentarily."
}

The backup is queued and made in the background. When it is ready, its file is in get_backup_files_list, named after the index and the time it was made, for example my_index_10_11_2026-14.05.33.tar.

04 · Errors

05 · Related