API - Create backup

API Endpoint

Create Index Backup

Create a backup snapshot of your Opensolr index. The backup is stored on the Opensolr backup servers and can be listed or downloaded later using the backup management API endpoints.

Endpoint

GET https://opensolr.com/solr_manager/api/create_backup

Parameters

Parameter	Status	Description
`email`	required	Your Opensolr registration email address
`api_key`	required	Your Opensolr API key
`core_name`	required	The name of the index you wish to create a backup for

Code Examples

cURL

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

PHP

$params = http_build_query([
    'email'     => 'YOUR_EMAIL',
    'api_key'   => 'YOUR_API_KEY',
    'core_name' => 'YOUR_INDEX',
]);
$response = json_decode(file_get_contents(
    'https://opensolr.com/solr_manager/api/create_backup?' . $params
), true);
print_r($response);

Python

import requests

response = requests.get(
    "https://opensolr.com/solr_manager/api/create_backup",
    params={
        "email": "YOUR_EMAIL",
        "api_key": "YOUR_API_KEY",
        "core_name": "YOUR_INDEX",
    }
)
data = response.json()
print(data)

Find your credentials in the Opensolr Dashboard. Your API key is listed under your account settings.

Create Index Backup

Endpoint

Parameters

Code Examples

cURL

PHP

Python

Related Documentation

List Backup Files

Download Backup

Backup Guide