API - Retry the failed ingestion jobs of an index (ingest_queue_retry_failed)

Data Ingestion

Puts the failed Data Ingestion jobs of one index back in the queue, whole, the same as the two Retry buttons of the queue page.

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

scopeOptional

failed (default): the jobs that failed whole. partial: finished jobs with some failed documents. all: both.

02 · Example

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

03 · Answer

{
    "status": true,
    "msg": "4 job(s) requeued",
    "requeued": 4
}

With nothing to retry, status is false and msg says No failed jobs to retry for this index. Each job goes back to pending with all its documents.

04 · Errors

ERROR_INVALID_CORE_NAMEHTTP 200

No index name, or one with characters other than letters, digits and underscores.

ERROR_INVALID_SCOPEHTTP 200

scope is not failed, partial or all.

ERROR_CORE_NOT_ALLOWED_FOR_THIS_KEYHTTP 200

A scoped key that was not given this index.

ERROR_QUEUE_UNAVAILABLE_TRY_AGAINHTTP 200

The queue did not answer. Try again.

WRONG_API_HOSTHTTP 404

Called on opensolr.com. The answer carries the right URL.

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

Retry one job: ingest_queue_action with retry.

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