API - Upload solr configuration via zip archive

Config Files

Uploads a ZIP of configuration files to your Opensolr Index in one call, for example a configuration exported from another Solr server. The index reloads at the end.

Endpointhttps://opensolr.com/solr_manager/api/upload_zip_config_files
MethodPOST, multipart/form-data
Authemail and api_key of your account, as GET or POST parameters: Authentication.
In the panelUpload a ZIP

01 · Parameters

core_nameRequired

The name of your index.

userfileRequired

The .zip file.

02 · What goes in the ZIP

Your configuration files, at most 560. Files in folders inside the ZIP are saved under their own name.

Files without an extension, .properties files and names that start with a dot or an underscore are skipped.

03 · Example

curl -s -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=my_index" \
  -F "userfile=@my_config.zip"

04 · Answer

{
    "status": true,
    "msg": {
        "Files upload": "OK"
    }
}

When the index cannot load the new files, status is false and msg.ERROR holds the error of Solr. On a cluster master, msg also lists every replica the files went to.

05 · Errors

ERROR_NOT_CORE_OWNERHTTP 200

In msg.ERROR: the index is not yours.

ERROR_PLEASE_UPLOAD_MAX_560_FILESHTTP 200

The ZIP holds more than 560 files.

ERROR_ZIP_EXTRACTION_FAILEDHTTP 200

The file is not a ZIP that can be opened.

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.

06 · Related

One file at a time: upload_config_file.

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