API - Check Crawl Schedule Status

Web Crawler

Tells you whether the crawl of your Opensolr Index is on a schedule, whether or not it runs at this moment.

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

03 · Answer

{
    "status": true,
    "active": true
}

active is true from start_crawl with a schedule until stop_crawl. A pause keeps it true.

04 · Errors

ERROR_MISSING_CORE_NAMEHTTP 200

No index name.

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

Whether a crawl runs right now: crawler_active.

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