API - Stop the Web Crawler

Stops the crawl of your Opensolr Index and removes its schedule, so it does not start again on its own.

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

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

03 · Answer

{
    "status": true,
    "msg": "CRAWLER IS READY / NOT RUNNING."
}

The schedule is removed in the background, a few moments after the answer. Pages already in the index stay.

04 · Errors

ERROR_THIS_CRAWLER_IS_NOW_STARTING_PLEASE_WAITHTTP 200

A start is still on its way. Try again in a moment.

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

Stop until the next scheduled run only: pause_crawl. Start again: start_crawl. Is there a schedule: crawl_schedule_status.

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