API - Create backup

Backup Management

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

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

01 · Parameters

core_nameRequired

The name of your index.

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

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

Restore a backup: restore_backup. Download one: Download backup files.

A backup every day without calling the API: Daily backup schedule.

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