FAQ & API Documentation

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

Get a list of your Opensolr Indexes

  1. GET https://opensolr.com/solr_manager/api/get_index_list
  2. Parameters:
    1. ​email - your opensolr registration email address
    2. api_key - your opensolr api_key
  3. Example: https://opensolr.com/solr_manager/api/get_index_list?email=&
    api_key=Please log in

Get list of available environments

  1. GET https://opensolr.com/solr_manager/api/get_env
  2. Parameters:
    1. ​email - your opensolr registration email address
    2. api_key - your opensolr api_key
  3. Example: https://opensolr.com/solr_manager/api/get_env?email=&
    api_key=Please log in

​Get index info, details, and statistics

This method, also returns the statistics usage for all your indexes as well.

  1. GET https://opensolr.com/solr_manager/api/get_core_info
  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 get the info for
  3. Example: https://opensolr.com/solr_manager/api/get_core_info?email=support@opensolr.com&
    api_key=3091929c9bf802f85d65189385073afe&core_name=my_solr_core

Reload a index - also used for troubleshooting

  1. GET https://opensolr.com/solr_manager/api/reload_core
  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 remove
  3. Example: https://opensolr.com/solr_manager/api/reload_core?email=&
    api_key=Please log in&core_name=my_solr_core

Get Server Country Options

Allows to get a list of all the Servers that you can create your Opensolr indexes into.

  1. GET https://opensolr.com/solr_manager/api/server_country
  2. Parameters:
    1. ​email - your opensolr registration email address
    2. api_key - your opensolr api_key
  3. Example: https://opensolr.com/solr_manager/api/server_country?email=&
    api_key=Please log in

Optimize a SOLR index

  1. GET https://opensolr.com/solr_manager/api/optimize
  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 optimize
  3. Example: https://opensolr.com/solr_manager/api/optimize?email=&
    api_key=Please log in&core_name=my_solr_core

Commit data for a SOLR index

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

Ping an opensolr server

  1. GET https://opensolr.com/solr_manager/api/ping
  2. Parameters:
    1. ​email - your opensolr registration email address
    2. api_key - your opensolr api_key
    3. ​hostname - the hostname of the server you wish to ping
  3. Example: https://opensolr.com/solr_manager/api/ping_server?email=&
    api_key=Please log in&hostname=us.opensolr.com

Get full status of a SOLR index

  1. GET https://opensolr.com/solr_manager/api/get_core_status
  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 get status for
  3. Example: https://opensolr.com/solr_manager/api/get_core_status?email=&
    api_key=Please log in&core_name=my_solr_core

Create a new OpenSolr index

  1. GET https://opensolr.com/solr_manager/api/create_core
  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 want to create
    4. mode
      1. Must be: standalone
    5. core_type- the type of the core to be created
      1. Core_type may be one of the following:
        1. generic
    6. server_country- the server identifier, in which you want your new solr core to be created
      1. At the moment, server_country may be one of the following (including your own private servers):
        • US-EAST-R2-SOLR-8
        • US-EAST-R1-SOLR-8
        • US-EAST-M-SOLR-8
        • UK-SOLR-8-6
        • US-EAST-SOLR-7-0
        • DE-SOLR-8-0
        • FR-SOLR-8-0
        • US-WEST-SOLR-8-0
        • SW-SOLR-8-0
        • US-EAST-SOLR-8-0
        • UK-SOLR-6-1
        • US-EAST-SOLR-6-1-2
        • RO-SOLR-6-1
        • AUS-SOLR-6-0
        • DE-SOLR-7-0
        • SW-SOLR-7-0
        • US-WEST-SOLR-7-0
        • DE-SOLR-5-1
        • DE-SOLR-6-1
        • UK-SOLR-7-0
        • DE-SOLR-6-1
        • US-EAST-SOLR-6-1
        • US-EAST-SOLR-5-1
        • US-WEST-SOLR-4-10
        • DE-SOLR-4-10
        • US-EAST-SOLR-4-10
        • US-WEST-SOLR-4-0
        • UK-SOLR-4-0
        • DE-SOLR-4-0
        • US-WEST-SOLR-4-0
        • NL-SOLR-4-0
  3. Example: https://opensolr.com/solr_manager/api/create_core?email=&
    api_key=Please log in&core_name=my_solr_core&server_country=US-EAST-SOLR-8-0&core_type=generic

Delete OpenSolr index

  1. GET https://opensolr.com/solr_manager/api/delete_core
  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 delete
  3. Example: https://opensolr.com/solr_manager/api/delete_core?email=&
    api_key=Please log in&core_name=my_solr_core

Replicate a SOLR index

  1. GET https://opensolr.com/solr_manager/api/replicate_index
  2. Parameters:
    1. ​email - your opensolr registration email address
    2. api_key - your opensolr api_key
    3. ​core_name - the name of the master index. this index has to be created first.
    4. target_index - the name of the target replica indes. this index has to be created first.
  3. Example: https://opensolr.com/solr_manager/api/replicate_index?email=&
    api_key=Please log in&core_name=master_index&target_index=replica_index

Get Request Handlers

Allows to get a list of all the Request Handlers being defined in any one of your Opensolr Indexes, in your solrconfig.xml file.

  1. GET https://opensolr.com/solr_manager/api/request_handlers
  2. Parameters:
    1. ​email - your opensolr registration email address
    2. api_key - your opensolr api_key
    3. core_name - your opensolr index (core) name
  3. Example: https://opensolr.com/solr_manager/api/request_handlers?email=&
    api_key=Please log in&core_name=my_opensolr_index_name