Documentation > Index Management

API - Get Index Details, Info and Stats

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

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

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