API - Pause the Web Crawler

Web Crawler
Web Crawler API

Pause the Web Crawler

Temporarily halt crawler processes while keeping the cron schedule intact. The crawler will automatically resume on the next scheduled cron tick.

Endpoint

GET https://opensolr.com/solr_manager/api/pause_crawl

Parameters

ParameterStatusDescription
emailRequiredYour Opensolr registration email address
api_keyRequiredYour Opensolr API key
core_nameRequiredThe name of the index to pause the crawler for
Unlike Stop, Pause does not remove the cron schedule. The crawler will restart automatically on the next scheduled cron tick. Use this when you want to temporarily halt crawling without losing your schedule.

Code Examples

cURL

curl -s "https://opensolr.com/solr_manager/api/pause_crawl?email=YOUR_EMAIL&api_key=YOUR_API_KEY&core_name=my_solr_core"

PHP

$params = http_build_query([
    'email'     => 'YOUR_EMAIL',
    'api_key'   => 'YOUR_API_KEY',
    'core_name' => 'my_solr_core',
]);
$response = file_get_contents("https://opensolr.com/solr_manager/api/pause_crawl?{$params}");
$result = json_decode($response, true);
print_r($result);

Python

import requests

response = requests.get("https://opensolr.com/solr_manager/api/pause_crawl", params={
    "email": "YOUR_EMAIL",
    "api_key": "YOUR_API_KEY",
    "core_name": "my_solr_core",
})
print(response.json())

Related Documentation

Need help with the Opensolr Web Crawler? We are here to help.

Contact Support