Index Management

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

Parameter	Status	Description
`email`	required	Your Opensolr registration email address
`api_key`	required	Your 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

$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);

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)

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

Parameter	Status	Description
`email`	required	Your Opensolr registration email address
`api_key`	required	Your 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

$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);

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)

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

Parameter	Status	Description
`email`	required	Your Opensolr registration email address
`api_key`	required	Your Opensolr API key
`core_name`	required	The 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

$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);

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)

Reload Solr Index

Reload a Solr index to apply configuration changes. After uploading new config files (like schema.xml or solrconfig.xml), you must reload the index for the changes to take effect.

Endpoint

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

Parameters

Parameter	Status	Description
`email`	required	Your Opensolr registration email address
`api_key`	required	Your Opensolr API key
`core_name`	required	The name of the index you wish to reload

Tip: Always reload your index after uploading new configuration files via the Upload Config or Upload Zip endpoints.

Code Examples

cURL

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

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/reload_core?' . $params
), true);
print_r($response);

Python

import requests

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

Get Available Regions

Get a list of all server regions where you can create new Opensolr indexes. Use this to find the region identifier needed for the Create Index endpoint.

Endpoint

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

Parameters

Parameter	Status	Description
`email`	required	Your Opensolr registration email address
`api_key`	required	Your Opensolr API key

Code Examples

cURL

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

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/regions?' . $params
), true);
print_r($response);

Python

import requests

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

Optimize Solr Index

Optimization merges all index segments into one, improving search performance and reclaiming disk space from deleted documents. This operation runs asynchronously in the background — the API returns immediately while optimization continues on the server.

Endpoint

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

Parameters

Parameter	Status	Description
`email`	required	Your Opensolr registration email address
`api_key`	required	Your Opensolr API key
`core_name`	required	The name of the index you wish to optimize

Important:

Your index may temporarily double in size on disk during optimization
This can take a long time for large indexes
Avoid writing to the index while optimization is running
The index remains fully searchable during optimization

Response

{"status":true,"msg":"Optimization started. This runs in the background and may take a while for large indexes."}

Use the Check Optimize Status endpoint to monitor progress.

Code Examples

cURL

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

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/optimize?' . $params
), true);
if ($response['status']) {
    echo "Optimization started!\n";
}

Python

import requests

response = requests.get(
    "https://opensolr.com/solr_manager/api/optimize",
    params={
        "email": "YOUR_EMAIL",
        "api_key": "YOUR_API_KEY",
        "core_name": "YOUR_INDEX",
    }
)
data = response.json()
if data["status"]:
    print("Optimization started!")

API - Check Optimize Status

API Endpoint

Check Optimize Status

Check whether an optimization is still running or has completed. Returns current index statistics including segment count, index size, document count, and deleted documents.

Endpoint

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

Parameters

Parameter	Status	Description
`email`	required	Your Opensolr registration email address
`api_key`	required	Your Opensolr API key
`core_name`	required	The name of the index being optimized

Response Fields

Field	Type	Description
`running`	boolean	`true` if optimization is currently in progress
`finished`	boolean	`true` if optimization completed successfully
`segments`	integer	Current number of index segments (1 = fully optimized)
`size_bytes`	integer	Current index size in bytes
`num_docs`	integer	Number of documents in the index
`deleted_docs`	integer	Number of deleted documents not yet reclaimed

Example Response (running)

{"status":true,"msg":{"running":true,"finished":false,"segments":5,"size_bytes":1073741824,"num_docs":50000,"deleted_docs":1200,"log":""}}

Example Response (complete)

{"status":true,"msg":{"running":false,"finished":true,"segments":1,"size_bytes":890000000,"num_docs":50000,"deleted_docs":0,"log":"{...}"}}

Code Examples

cURL

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

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/optimize_status?' . $params
), true);
$info = $response['msg'];
if ($info['running']) {
    echo "Optimization in progress... segments: {$info['segments']}\n";
} elseif ($info['finished']) {
    echo "Optimization complete! Segments: {$info['segments']}, Size: {$info['size_bytes']} bytes\n";
}

Python

import requests

response = requests.get(
    "https://opensolr.com/solr_manager/api/optimize_status",
    params={
        "email": "YOUR_EMAIL",
        "api_key": "YOUR_API_KEY",
        "core_name": "YOUR_INDEX",
    }
)
data = response.json()
info = data["msg"]
if info["running"]:
    print(f"Optimization in progress... segments: {info['segments']}")
elif info["finished"]:
    print(f"Optimization complete! Segments: {info['segments']}, Size: {info['size_bytes']} bytes")

API - Commit data for a Solr Index

API Endpoint

Commit Data for a Solr Index

Issue a commit command to make all pending document additions, updates, and deletions visible in search results. Solr buffers changes until a commit is performed.

Endpoint

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

Parameters

Parameter	Status	Description
`email`	required	Your Opensolr registration email address
`api_key`	required	Your Opensolr API key
`core_name`	required	The name of the index you wish to commit

Code Examples

cURL

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

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/commit?' . $params
), true);
print_r($response);

Python

import requests

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

API - Ping Solr Environment

API Endpoint

Ping Solr Environment

Perform a health check against a specific Opensolr cluster server. Verifies that the Solr environment on the given hostname is up, reachable, and responding to requests.

Endpoint

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

Parameters

Parameter	Status	Description
`email`	required	Your Opensolr registration email address
`api_key`	required	Your Opensolr API key
`hostname`	required	The hostname of the Solr server to ping (e.g. `us.opensolr.com`)

Common Use Cases

Uptime Monitoring

Integrate with Nagios, Zabbix, Datadog, or UptimeRobot to get alerts when your Opensolr environment goes offline.

Load Balancer Health Checks

Configure your load balancer to call the ping endpoint at regular intervals to verify backend health.

Pre-flight Checks

Call the ping endpoint before running large indexing jobs to confirm the environment is ready to receive data.

CI/CD Pipelines

Add a ping check to your deployment pipeline to ensure Solr is available before running integration tests.

Code Examples

cURL

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

PHP

$params = http_build_query([
    'email'    => 'YOUR_EMAIL',
    'api_key'  => 'YOUR_API_KEY',
    'hostname' => 'us.opensolr.com',
]);
$response = json_decode(file_get_contents(
    'https://opensolr.com/solr_manager/api/ping_server?' . $params
), true);
if ($response['status']) {
    echo "Server is healthy!\n";
} else {
    echo "Server is down: " . $response['msg'] . "\n";
}

Python

import requests

response = requests.get(
    "https://opensolr.com/solr_manager/api/ping_server",
    params={
        "email": "YOUR_EMAIL",
        "api_key": "YOUR_API_KEY",
        "hostname": "us.opensolr.com",
    }
)
data = response.json()
if data["status"]:
    print("Server is healthy!")
else:
    print(f"Server is down: {data['msg']}")

API - Get index full status

API Endpoint

Get Index Full Status

Get the full status of a Solr index including detailed Solr core statistics, document counts, index size, and internal status information.

Endpoint

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

Parameters

Parameter	Status	Description
`email`	required	Your Opensolr registration email address
`api_key`	required	Your Opensolr API key
`core_name`	required	The name of the index you wish to get the full status for

Code Examples

cURL

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

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_status?' . $params
), true);
print_r($response);

Python

import requests

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

API - Create New Solr Index

API Endpoint

Create New Solr Index

Create a new Solr index on any available Opensolr server region. Specify the index name and the target region where it should be created.

Endpoint

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

Parameters

Parameter	Status	Description
`email`	required	Your Opensolr registration email address
`api_key`	required	Your Opensolr API key
`index_name`	required	The name for your new index
`region`	required	The server region identifier (e.g. `DE-SOLR-9`). Use the Get Available Regions API to see available options.

Code Examples

cURL

curl -s "https://opensolr.com/solr_manager/api/create_index?email=YOUR_EMAIL&api_key=YOUR_API_KEY&index_name=my_new_index&region=DE-SOLR-9"

PHP

$params = http_build_query([
    'email'      => 'YOUR_EMAIL',
    'api_key'    => 'YOUR_API_KEY',
    'index_name' => 'my_new_index',
    'region'     => 'DE-SOLR-9',
]);
$response = json_decode(file_get_contents(
    'https://opensolr.com/solr_manager/api/create_index?' . $params
), true);
print_r($response);

Python

import requests

response = requests.get(
    "https://opensolr.com/solr_manager/api/create_index",
    params={
        "email": "YOUR_EMAIL",
        "api_key": "YOUR_API_KEY",
        "index_name": "my_new_index",
        "region": "DE-SOLR-9",
    }
)
data = response.json()
print(data)

API - Delete Solr Index

API Endpoint

Delete Solr Index

Permanently delete a Solr index and all its data. This action cannot be undone.

Endpoint

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

Parameters

Parameter	Status	Description
`email`	required	Your Opensolr registration email address
`api_key`	required	Your Opensolr API key
`index_name`	required	The name of the index you wish to delete

Warning: This permanently deletes the index and all its data. Make sure you have a backup before proceeding. This action cannot be undone.

Code Examples

cURL

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

PHP

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

Python

import requests

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

API - Reset Solr Index Data

API Endpoint

Reset Solr Index Data

Delete all data from a Solr index while keeping the index itself and its configuration files intact. Useful when you need to re-index from scratch without recreating the index.

Endpoint

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

Parameters

Parameter	Status	Description
`email`	required	Your Opensolr registration email address
`api_key`	required	Your Opensolr API key
`index_name`	required	The name of the index you wish to reset

Warning: This deletes all documents from the index. The index configuration and schema are preserved, but all data will be permanently removed. Consider creating a backup first.

Code Examples

cURL

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

PHP

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

Python

import requests

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

API - Get Index Request Handlers

API Endpoint

Get Index Request Handlers

Get a list of all request handlers defined in your Opensolr index's solrconfig.xml file. Request handlers define the different query endpoints available on your index (e.g. /select, /update, /suggest).

Endpoint

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

Parameters

Parameter	Status	Description
`email`	required	Your Opensolr registration email address
`api_key`	required	Your Opensolr API key
`core_name`	required	Your Opensolr index name

Code Examples

cURL

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

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/request_handlers?' . $params
), true);
print_r($response);

Python

import requests

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

API - Replicate Solr Index

API Endpoint

Replicate Solr Index

Set up replication from a master index to a target replica index. Both indexes must already exist before you can configure replication between them.

Endpoint

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

Parameters

Parameter	Status	Description
`email`	required	Your Opensolr registration email address
`api_key`	required	Your Opensolr API key
`index_name`	required	The name of the master index (must already exist)
`target_index`	required	The name of the target replica index (must already exist)

Note: Both the master and target indexes must be created first using the Create Index endpoint. The replica will poll the master for updates automatically.

Code Examples

cURL

curl -s "https://opensolr.com/solr_manager/api/replicate_index?email=YOUR_EMAIL&api_key=YOUR_API_KEY&index_name=master_index&target_index=replica_index"

PHP

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

Python

import requests

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

Get a List of Your Opensolr Indexes

Endpoint

Parameters

Code Examples

cURL

PHP

Python

Related Documentation

Get List of Available Environments and Servers

Endpoint

Parameters

Code Examples

cURL

PHP

Python

Related Documentation

Get Index Details, Info and Stats

Endpoint

Parameters

Code Examples

cURL

PHP

Python

Related Documentation

Reload Solr Index

Endpoint

Parameters

Code Examples

cURL

PHP

Python

Related Documentation

Get Available Regions

Endpoint

Parameters

Code Examples

cURL

PHP

Python

Related Documentation

Optimize Solr Index

Endpoint

Parameters

Response

Code Examples

cURL

PHP

Python

Related Documentation

Check Optimize Status

Endpoint

Parameters

Response Fields

Example Response (running)

Example Response (complete)

Code Examples

cURL

PHP

Python

Related Documentation

Commit Data for a Solr Index

Endpoint

Parameters

Code Examples

cURL

PHP

Python

Related Documentation

Ping Solr Environment

Endpoint

Parameters

Common Use Cases

Uptime Monitoring

Load Balancer Health Checks

Pre-flight Checks

CI/CD Pipelines

Code Examples

cURL

PHP