Documentation > Data Ingestion

API - Indexes with ingestion jobs (ingest_queue_list_cores)

Data Ingestion

Lists your indexes that have Data Ingestion jobs, with how many jobs each one has in every state.

Endpointhttps://api.opensolr.com/solr_manager/api/ingest_queue_list_cores
MethodGET or POST
Authemail and api_key of your account, as GET or POST parameters: Authentication. Never rate limited.

01 · Example

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

02 · Answer

{
    "status": true,
    "cores": [
        {
            "core_name": "my_index",
            "total": 42,
            "pending": 3,
            "processing": 1,
            "completed": 36,
            "failed": 2,
            "paused": 0,
            "stopped": 0,
            "retryable": 4,
            "retryable_failed": 2,
            "retryable_partial": 2
        }
    ]
}

retryable_failed counts the jobs that failed whole, retryable_partial the finished jobs with some failed documents. A scoped key sees only the indexes it was given.

03 · Errors

ERROR_QUEUE_UNAVAILABLE_TRY_AGAINHTTP 200

The queue did not answer. Ask 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.

04 · Related

The jobs of one index: ingest_queue_list_jobs.

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