FAQ & API Docs

Select a category on the left, to get your answers quickly

Upload a new file for crawling and indexing

  1. ​POST https://opensolr.com/solr_manager/api/index_crawler_file
  2. Parameters:
    1. ​email your opensolr registration email address
    2. api_key - your opensolr api_key
    3. core_name - the name of the core you wish to upload the document for
    4. url - optionally, you can add an URL to crawl and index, alongside the uploaded document. They will both be indexed as separate documents in your opensolr index.
    5. userfile - your local document file to POST and upload to the server (pdf, doc, html, xls, mp3, mp4, etc.)
  3. Example here: https://opensolr.com/solr_manager/index_crawler_file

Delete index configuration file from the server

  1. GET https://opensolr.com/solr_manager/api/delete_config_file
  2. Parameters:
    1. ​email - your opensolr registration email address
    2. api_key - your opensolr api_key
    3. core_name - the name of the core
    4. file_name - the name of the config file you wish to remove from your solr core, without the file extension
    5. file_extension - the extension of the config file you wish to remove from your solr core, without the period.
  3. Example: https://opensolr.com/solr_manager/api/delete_config_file?email=&
    api_key=Please log in&core_name=my_solr_core&file_name=schema&file_extension=xml

Get all the configuration files list from the server

  1. ​GET https://opensolr.com/solr_manager/api/get_all_config_files
  2. Parameters:
    1. ​email your opensolr registration email address
    2. api_key - your opensolr api_key
    3. core_name - the name of the core you wish to upload the schema.xml for
  3. Example: https://opensolr.com/solr_manager/api/get_all_config_files?email=&
    api_key=Please log in&core_name=my_solr_core

Upload zip archive containing your solr configuration files

  1. ​POST https://opensolr.com/solr_manager/api/upload_zip_config_files
  2. Note that if uploading a zip archive containing multiple files, you will use the upload_zip_config_files API endpoint 
  3. Parameters:
    1. ​email your opensolr registration email address
    2. api_key - your opensolr api_key
    3. core_name - the name of the core you wish to upload the schema.xml for
    4. userfile - your local config.zip file to POST and upload to the server
  4. Example: https://opensolr.com/solr_manager/upload_config_files_form

Upload or Update your custom configuration file for a SOLR core

Allows to automate the upload of a single solr config file. 

  1. ​POST https://opensolr.com/solr_manager/api/upload_config_file
  2. Parameters:
    1. ​email your opensolr registration email address
    2. api_key - your opensolr api_key
    3. core_name - the name of the core you wish to upload the schema.xml for
    4. userfile - your local schema.xml file to POST and upload to the server
  3. Example here: https://opensolr.com/solr_manager/upload_config_files_form