API - Flush Crawl Buffer to Solr

Web Crawler

Crawled pages reach your index in batches. This sends the pages waiting in the buffer right away, even while the crawl runs.

Endpointhttps://opensolr.com/solr_manager/api/flush_crawl_buffer
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.

max_batchesOptional

Send at most this many batches of 100 pages, then answer with what is left. Without it, the whole buffer is sent.

02 · Example

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

03 · Answer

{
    "status": true,
    "flushed": 500,
    "remaining": 1240,
    "msg": "Flushed 500 documents to Solr. 1,240 left."
}

Call again while remaining is above 0. An empty buffer answers Buffer is empty. Nothing to flush. On an index with meaning vectors, the vectors made during the flush count against the monthly AI allowance of the index owner: API Quota.

04 · Errors

"status": false, A flush is already running

Another flush of this index is in progress. Let it finish.

"status": false, Could not flush any

Nothing could be sent. The pages stay in the buffer and are tried again.

NOT_OWNER_ERROR

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

How many pages are waiting: solr_buffer_docs in get_crawl_stats.

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