FAQ & API Docs

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

​Get index info, 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

Optimize an 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

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 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. core_name - the name of the core you want to create
    4. core_type - the type of the core to be created
      1. At the moment, core_type may be one of the following:
        1. drupal6
        2. magento
        3. drupal7
        4. wordpress
        5. ezpublish
        6. typo3
        7. joomla
        8. web
        9. generic
    5. server_country - the country, or geographical region (aka: 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):
        • FRANKFURT_GERMANY
        • AWS_EC2_SOLR_6_1
        • DIGITAL_OCEAN_US_NY_SOLR_5_1
        • AWS_EC2_CA_LA_USA_SOLR_5_1
        • HETZNER_5_1
        • GERMANY_SOLR_4_10
        • AWS_EC2_VIRGINIA_SOLR_4_10
        • AWS_EC2_VA_USA_1
        • UK
        • STUTTGART_GERMANY
        • AWS_EC2_CA_USA_SOLR_4_0
        • NETHERLANDS
  3. Example: https://opensolr.com/solr_manager/api/create_core?email=&
    api_key=Please log in&core_name=my_solr_core&server_country=USA_LOS_ANGELES&core_type=wordpress

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