API - Get index full status

Index Management

Gives you what Solr reports about your Opensolr Index: when it started, how many documents and segments it holds, its size on disk.

Endpointhttps://opensolr.com/solr_manager/api/get_core_status
MethodGET
Authemail and api_key of your account, as GET or POST parameters: Authentication.

01 · Parameters

core_nameRequired

The name of your index.

02 · Example

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

03 · Answer

status is true and msg is the answer of Solr's core STATUS call, as a string: decode it as JSON. Under status.my_index.index you find numDocs, maxDoc, deletedDocs, segmentCount and sizeInBytes.

04 · Errors

ERROR_NOT_CORE_OWNERHTTP 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

Sizes, limits and the connection URL in one answer: get_core_info.

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