API - Upload solr configuration via zip archive

API Endpoint

Upload Configuration via Zip Archive

Upload multiple Solr configuration files at once by sending a zip archive. Use this when you need to update several config files together (e.g. schema.xml, solrconfig.xml, and supporting files).

Endpoint

POST https://opensolr.com/solr_manager/api/upload_zip_config_files

Parameters

Parameter	Status	Description
`email`	required	Your Opensolr registration email address
`api_key`	required	Your Opensolr API key
`core_name`	required	The name of your Opensolr index
`userfile`	required	Your `config.zip` file containing the configuration files to upload (sent as multipart form data)

Zip structure: Place your configuration files (e.g. schema.xml, solrconfig.xml, stopwords.txt) at the root of the zip archive — do not nest them in subdirectories.

Code Examples

cURL

curl -X POST https://opensolr.com/solr_manager/api/upload_zip_config_files \
  -F "email=YOUR_EMAIL" \
  -F "api_key=YOUR_API_KEY" \
  -F "core_name=YOUR_INDEX" \
  -F "userfile=@/path/to/config.zip"

PHP

$ch = curl_init('https://opensolr.com/solr_manager/api/upload_zip_config_files');
curl_setopt_array($ch, [
    CURLOPT_POST           => true,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_POSTFIELDS     => [
        'email'     => 'YOUR_EMAIL',
        'api_key'   => 'YOUR_API_KEY',
        'core_name' => 'YOUR_INDEX',
        'userfile'  => new CURLFile('/path/to/config.zip'),
    ],
]);
$response = json_decode(curl_exec($ch), true);
curl_close($ch);
print_r($response);

Python

import requests

with open("/path/to/config.zip", "rb") as f:
    response = requests.post(
        "https://opensolr.com/solr_manager/api/upload_zip_config_files",
        data={
            "email": "YOUR_EMAIL",
            "api_key": "YOUR_API_KEY",
            "core_name": "YOUR_INDEX",
        },
        files={
            "userfile": ("config.zip", f, "application/zip"),
        }
    )
data = response.json()
print(data)

Upload Configuration via Zip Archive

Endpoint

Parameters

Code Examples

cURL

PHP

Python

Related Documentation

Upload Single File

List Config Files

Get Config File

Config File Guide