API - Get Index Details, Info and Stats

Index Management

Gives you the details of your Opensolr Index in one answer: how to connect to it, how much disk and traffic it uses, and its limits.

Endpointhttps://opensolr.com/solr_manager/api/get_core_info
MethodGET
Authemail and api_key of your account, as GET or POST parameters: Authentication.
In the panelIndex dashboard

01 · Parameters

core_nameRequired

The name of your index.

02 · Example

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

03 · Answer

info

connection_url, port, type, solr_version, environment_identifier (the region), auth_username, auth_password.

core_data

This index: core_size_mb, core_badnwidth_mb (traffic this month), max_core_size_mb, max_badnwdith_mb. The two misspelled keys are spelled like this in the answer.

all_cores

Your indexes together: total_number_of_cores, total_cores_disk_mb, total_cores_bandwidth_mb and their averages.

A scoped key limited to some indexes counts only those in all_cores.

04 · Errors

NOT_OWNER_ERRORHTTP 200

The index is not yours.

ERROR_AUTHENTICATION_FAILEDHTTP 403

The email and API key do not match.

ERROR_RATE_LIMIT_PER_MINUTEHTTP 429

Too many calls. Wait for the Retry-After seconds: Rate limits.

05 · Related

Plan, usage and AI allowance of an index: get_account_summary.

Every error code and HTTP status of the API: API errors. Calls per minute and per hour: Rate limits.