API - Pause the Web Crawler

Stops the running crawl of your Opensolr Index now, and keeps its schedule: the next scheduled run carries on from where it stopped.

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

03 · Answer

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

Resume it yourself at any time with start_crawl and clean=no.

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

Stop and remove the schedule: stop_crawl.

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