Documentation > Index Management

API - Ping Solr Environment

Index Management
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

ParameterStatusDescription
emailrequiredYour Opensolr registration email address
api_keyrequiredYour Opensolr API key
hostnamerequiredThe 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']}")

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