API - Restore a Backup

Backup Management

Puts your Opensolr Index back the way it was when a backup was made: data and configuration, or only the configuration files.

Endpointhttps://opensolr.com/solr_manager/api/restore_backup
MethodGET
Authemail and api_key of your account, as GET or POST parameters: Authentication.
In the panelRestore a backup

01 · Parameters

core_nameRequired

The name of your index.

backup_fileRequired

A file name from get_backup_files_list.

typeOptional

full (the default) restores data and configuration. conf restores the configuration files only and keeps the data.

02 · Example

curl -s "https://opensolr.com/solr_manager/api/restore_backup?email=YOUR_EMAIL&api_key=YOUR_API_KEY&core_name=my_index&backup_file=my_index_10_11_2026-02.00.09.tar&type=full"

03 · Answer

{
    "status": true,
    "msg": "Your backup file will be restored momentarily."
}
A full restore replaces what the index holds now. Documents added after the backup are gone. Make a new backup first if you may need them.

04 · Errors

NOT_ALLOWEDHTTP 200

Your plan has no backups.

ERROR_NOT_CORE_OWNERHTTP 200

The index is not yours.

ERROR_AUTHENTICATION_FAILEDHTTP 403

The email and API key do not match.

ERROR_RATE_LIMIT_PER_MINUTEHTTP 429

Too many calls. Wait for the Retry-After seconds: Rate limits.

05 · Related

Follow the restore in the Control Panel: Restore log.

Every error code and HTTP status of the API: API errors. Calls per minute and per hour: Rate limits.