FAQ & API Docs

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

Update HTTP Auth for your opensolr Index

  1. GET https://opensolr.com/solr_manager/api/update_http_auth
  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 add or update HTTP Auth. protection for
    4. username - the username you want to use for the core you wish to protect using HTTP Auth.
    5. password - the password you want to use for the core you wish to protect using HTTP Auth.
  3. Example: https://opensolr.com/solr_manager/api/update_http_auth?email=&
    api_key=Please log in&core_name=my_solr_core&username=index_auth_username&password=index_auth_password

​Remove HTTP Auth

  1. GET https://opensolr.com/solr_manager/api/remove_http_auth
  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 stop the web crawler process for
  3. Example: https://opensolr.com/solr_manager/api/remove_http_auth?email=&
    api_key=Please log in&core_name=my_solr_core

Add IP access rule for a SOLR core

  1. GET https://opensolr.com/solr_manager/api/add_ip
  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 add an IP rule to
    4. ip - the IP address you wish to grant access
    5. handler - the SOLR URI handler that the restriction will be applied to
  3. Example: https://opensolr.com/solr_manager/api/add_ip?email=&
    api_key=Please log in&core_name=my_solr_core&ip=15.24.53.123&handler=/update

Get IP list for a SOLR core

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

Remove IP access rule for a SOLR core

  1. GET https://opensolr.com/solr_manager/api/delete_ip
  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 an IP rule from
    4. ip - the IP address you wish to remove from your core_name
    5. handler - the SOLR URI handler that the restriction has been applied to
  3. Example: https://opensolr.com/solr_manager/api/delete_ip?email=&
    api_key=Please log in&core_name=my_solr_core&ip=15.24.53.123&handler=/update