FAQ & API Documentation

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

Get list of available environments and servers

Get list of available environments

GET https://opensolr.com/solr_manager/api/get_env
Parameters:
1. email - your opensolr registration email address
2. api_key - your opensolr api_key

Example: https://opensolr.com/solr_manager/api/get_env?email=&
api_key=Please log in

Delete Environment

Delete Opensolr Cloud Environment

GET https://opensolr.com/solr_manager/api/provision_environment
Parameters:
1. email - your opensolr registration email address
2. api_key - your opensolr api_key
3. env_name - the unique name identifier for your environment, used when creating the environment.

Example: https://opensolr.com/solr_manager/api/provision_environment?email=&api_key=Please log in&env_name=ENVIRONMENT_NAME

Provision Opensolr Cloud Environment

Automate provisioning of either one of our three major types of Solr Cloud Environments:

GET https://opensolr.com/solr_manager/api/provision_environment
Parameters:
1. email - your opensolr registration email address
2. api_key - your opensolr api_key
3. failover - [1 OR 0] - either you want to setup a Multi-Region Failover system.
  1. If you select 1 (yes), you will have to enter EXACTLY TWO regions on the regions parameter, in order to create an Opensolr Multi-Region Failover Resilient Cluster. Any other extra regions will be disregarded.
  2. If you select 0 (no), you will have to enter EXACTLY ONE region on the regions parameter. This will create an Opensolr Simple Dedicated Instance. The second region will be disregarded.
  3. If you select 1 (yes) and only select ONE region, the system will create a classic Opensolr Resilient Cluster, without Multi-Region Failover
  4. Defaults to 0 (no).
4. regions - the AWS region identifier. May be either one of the following:
  1. ap-south-1, eu-west-2, eu-west-1, ap-northeast-2, ap-northeast-1, sa-east-1, ca-central-1, ap-southeast-1, ap-southeast-2, eu-central-1, us-east-1, us-east-2, us-west-1, us-west-2
  2. If you selected 1 at failover, you should enter TWO REGIONS separated by the keyword AND exactly as follows: us-east-1ANDeu-west-1
5. max_replicas - the number of replicas you want to create in each Load Balancer for the Resilient Cluster, or the Multi-Region Failover Resilient Cluster. Defaults to 2
6. size - the size of each of your created instances. May be one of (in capital letters): SMALL, MEDIUM, LARGE, XLARGE, 2XLARGE
  1. NANO - 1 vCPU / 500 Mb RAM
  2. MICRO - 1 vCPU / 1 Gb RAM
  3. SMALL - 1 vCPU / 2 GB RAM
  4. MEDIUM - 2 vCPU / 4 GB RAM
  5. LARGE - 2 vCPU / 8 GB RAM
  6. XLARGE - 4 vCPU / 16 GB RAM
  7. 2XLARGE - 8 vCPU / 32 GB RAM
7. solr_version - the version of solr that will be installed on your provisioned environment. example format: 4.10
  1. Currently only supports SOLR 4.10 however, please email help@opensolr.com to request other SOLR versions. Be sure to include the region(s) where you would like to have the other version available.
  2. Defaults to 4.10
8. disk - how much disk space to allocate each replica in your environment. defaults to 10 Gb. Minimum is 10 Gb. Maximum is 1000 Gb.
9. env_name - (OPTIONAL) the unique name identified for your environment. the name must be at least 6 characters long, ONLY alpha-numeric, and should be unique throughout the opensolr ecosystem. If not provided, a unique hash ID will be automatically assigned.

Example: https://opensolr.com/solr_manager/api/provision_environment?email=&api_key=Please log in

Ping an opensolr server

GET https://opensolr.com/solr_manager/api/ping
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

Example: https://opensolr.com/solr_manager/api/ping_server?email=&
api_key=Please log in&hostname=us.opensolr.com