API - Check Crawl Schedule Status

Web Crawler API

Check Crawl Schedule Status

Tells you whether a recurring crawl schedule exists for an index. A schedule is created by start_crawl unless you pass schedule=no, and removed when you stop the crawler. The Drupal module and the WordPress plugin poll this to display “Scheduled” vs “Manual” on their crawler tab.

Endpoint

GET or POST https://opensolr.com/solr_manager/api/crawl_schedule_status

Parameters

Parameter	Status	Description
`email`	Required	Your Opensolr registration email address
`api_key`	Required	Your Opensolr API key (master key, or a scoped key that allows this endpoint)
`core_name`	Required	The index to check

How It Works

Opensolr keeps one schedule entry per index on its control server. This endpoint checks for it and returns a boolean — it does not contact the Solr server and does not tell you whether a crawl is running right now; for that use crawler_active. Both together give the full picture: scheduled or not, running or idle.

Response

Key	Type	Description
`status`	bool	`true` when the index is yours
`active`	bool	`true` if a recurring schedule exists for this index

Code Examples

cURL

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

PHP

$q = http_build_query(['email' => 'YOUR_EMAIL', 'api_key' => 'YOUR_API_KEY', 'core_name' => 'my_index']);
$r = json_decode(file_get_contents("https://opensolr.com/solr_manager/api/crawl_schedule_status?{$q}"), true);
echo $r['active'] ? 'Scheduled' : 'Manual only';

Python

import requests

r = requests.get("https://opensolr.com/solr_manager/api/crawl_schedule_status",
                 params={"email": "YOUR_EMAIL", "api_key": "YOUR_API_KEY", "core_name": "my_index"}, timeout=30)
print("scheduled" if r.json()["active"] else "manual only")

Example Response

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

Use Cases

Show the scheduling state in your own dashboard
Decide in a deployment script whether to call start_crawl with or without schedule=no
Audit which of your indexes re-crawl automatically