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=PLEASE_LOG_IN&
    api_key=PLEASE_LOG_IN

Get list of Solr 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=PLEASE_LOG_IN&
    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=PLEASE_LOG_IN&
    api_key=PLEASE_LOG_IN&core_name=my_solr_core

Reload Solr Index

  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=PLEASE_LOG_IN&
    api_key=PLEASE_LOG_IN&core_name=my_solr_core

Available Solr Regions

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/regions
  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=PLEASE_LOG_IN&
    api_key=PLEASE_LOG_IN

Optimize 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=PLEASE_LOG_IN&
    api_key=PLEASE_LOG_IN&core_name=my_solr_core

Commit data for 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=PLEASE_LOG_IN&
    api_key=PLEASE_LOG_IN&core_name=my_solr_core

Ping Solr Env.

  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=PLEASE_LOG_IN&
    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=PLEASE_LOG_IN&
    api_key=PLEASE_LOG_IN&core_name=my_solr_core

Create a new Solr 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. index_name - the name of the index you want to create
    4. region- the server region identifier, in which you want your new solr core to be created
      1. At the moment, region may be one of the following (including your own private servers):
        • US-EAST-SOLR-9-4
        • DE-SOLR-9
        • US-EAST-SOLR-9
        • US-EAST-SOLR-8-10
        • US-WEST-SOLR-8ii
        • 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-3
        • AUS-SOLR-6-0
        • DE-SOLR-7-0
        • SW-SOLR-7-0
        • US-WEST-SOLR-7-0
        • DE-SOLR-5-1
        • SAGE-UK-SOLR-4-10
        • UK-SOLR-7-0
        • DE-SOLR-6-1
        • US-EAST-SOLR-6-1
        • US-EAST-SOLR-5-1
        • US-WEST-SOLR-5-1
        • DE-SOLR-4-10
        • US-EAST-SOLR-4-10
        • US-EAST-SOLR-4-0-2
        • UK-SOLR-4-0
        • US-WEST-SOLR-4-0-1
  3. Example: https://opensolr.com/solr_manager/api/create_core?email=PLEASE_LOG_IN&
    api_key=PLEASE_LOG_IN&index_name=my_solr_core&region=US-EAST-SOLR-8-0

Delete Solr 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=PLEASE_LOG_IN&
    api_key=PLEASE_LOG_IN&core_name=my_solr_core

Replicate 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. ​index_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=PLEASE_LOG_IN&
    api_key=PLEASE_LOG_IN&index_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=PLEASE_LOG_IN&
    api_key=PLEASE_LOG_IN&core_name=my_opensolr_index_name