Index Management

Opensolr Index Management — find answers to your questions

API - Get a list of your Opensolr Indexes

API Endpoint

Get a List of Your Opensolr Indexes

Retrieve a list of all Solr indexes associated with your Opensolr account. Returns index names, hostnames, server regions, and status information.

Endpoint

GET https://opensolr.com/solr_manager/api/get_index_list

Parameters

ParameterStatusDescription
emailrequiredYour Opensolr registration email address
api_keyrequiredYour Opensolr API key

Code Examples

$_ cURL

curl -s "https://opensolr.com/solr_manager/api/get_index_list?email=YOUR_EMAIL&api_key=YOUR_API_KEY"

PHP PHP

$params = http_build_query([
    'email'   => 'YOUR_EMAIL',
    'api_key' => 'YOUR_API_KEY',
]);
$response = json_decode(file_get_contents(
    'https://opensolr.com/solr_manager/api/get_index_list?' . $params
), true);
print_r($response);

Py Python

import requests

response = requests.get(
    "https://opensolr.com/solr_manager/api/get_index_list",
    params={
        "email": "YOUR_EMAIL",
        "api_key": "YOUR_API_KEY",
    }
)
data = response.json()
for index in data.get("msg", []):
    print(index)

Related Documentation

Create Index

Create a new Solr index via the API.

List Indexes

Get a list of all your Opensolr indexes.

Index Info & Stats

Get detailed information and statistics for an index.

Platform Guide

Complete guide to the Opensolr platform and control panel.

Need help managing your Solr indexes? We are here to help.

Contact Support
Read Full Answer

API - Get list of available environments and servers

API Endpoint

Get List of Available Environments and Servers

Retrieve a list of all Solr environments (servers) available in your Opensolr account. Use this to discover which servers and regions you can create indexes on.

Endpoint

GET https://opensolr.com/solr_manager/api/get_env

Parameters

ParameterStatusDescription
emailrequiredYour Opensolr registration email address
api_keyrequiredYour Opensolr API key

Code Examples

$_ cURL

curl -s "https://opensolr.com/solr_manager/api/get_env?email=YOUR_EMAIL&api_key=YOUR_API_KEY"

PHP PHP

$params = http_build_query([
    'email'   => 'YOUR_EMAIL',
    'api_key' => 'YOUR_API_KEY',
]);
$response = json_decode(file_get_contents(
    'https://opensolr.com/solr_manager/api/get_env?' . $params
), true);
print_r($response);

Py Python

import requests

response = requests.get(
    "https://opensolr.com/solr_manager/api/get_env",
    params={
        "email": "YOUR_EMAIL",
        "api_key": "YOUR_API_KEY",
    }
)
data = response.json()
print(data)

Related Documentation

Create Index

Create a new Solr index via the API.

List Indexes

Get a list of all your Opensolr indexes.

Index Info & Stats

Get detailed information and statistics for an index.

Platform Guide

Complete guide to the Opensolr platform and control panel.

Need help managing your Solr indexes? We are here to help.

Contact Support
Read Full Answer

API - Get Index Details, Info and Stats

API Endpoint

Get Index Details, Info and Stats

Get detailed information, configuration details, and usage statistics for a specific Opensolr index. This method also returns the statistics usage for all your indexes.

Endpoint

GET https://opensolr.com/solr_manager/api/get_core_info

Parameters

ParameterStatusDescription
emailrequiredYour Opensolr registration email address
api_keyrequiredYour Opensolr API key
core_namerequiredThe name of the index you wish to get info for

Code Examples

$_ cURL

curl -s "https://opensolr.com/solr_manager/api/get_core_info?email=YOUR_EMAIL&api_key=YOUR_API_KEY&core_name=YOUR_INDEX"

PHP PHP

$params = http_build_query([
    'email'     => 'YOUR_EMAIL',
    'api_key'   => 'YOUR_API_KEY',
    'core_name' => 'YOUR_INDEX',
]);
$response = json_decode(file_get_contents(
    'https://opensolr.com/solr_manager/api/get_core_info?' . $params
), true);
print_r($response);

Py Python

import requests

response = requests.get(
    "https://opensolr.com/solr_manager/api/get_core_info",
    params={
        "email": "YOUR_EMAIL",
        "api_key": "YOUR_API_KEY",
        "core_name": "YOUR_INDEX",
    }
)
data = response.json()
print(data)

Related Documentation

Create Index

Create a new Solr index via the API.

List Indexes

Get a list of all your Opensolr indexes.

Index Info & Stats

Get detailed information and statistics for an index.

Platform Guide

Complete guide to the Opensolr platform and control panel.

Need help managing your Solr indexes? We are here to help.

Contact Support
Read Full Answer

Loading more articles...