API - Check Optimize Status

Index Management

Tells you whether the optimize you started with optimize is still running, and shows the index as it is now.

Endpointhttps://opensolr.com/solr_manager/api/optimize_status
MethodGET or POST
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/optimize_status?email=YOUR_EMAIL&api_key=YOUR_API_KEY&core_name=my_index"

03 · Answer

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

Ask again every few seconds while running is true. log holds the answer Solr gave to the optimize.

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

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