API - Check if Web Crawler is Running

Tells you whether a crawl of your Opensolr Index is running at this moment.

Endpointhttps://opensolr.com/solr_manager/api/crawler_active

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/crawler_active?email=YOUR_EMAIL&api_key=YOUR_API_KEY&core_name=my_index"

03 · Answer

CRAWLER IS READY

Nothing runs: you can start a crawl.

Crawler is already running

A crawl is in progress.

msg is a short text with HTML tags around it: match on the words, not on the whole string.

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

Whether a schedule exists, running or not: crawl_schedule_status.

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