Documentation > Data Ingestion

API - List the Data Ingestion queue (ingest_queue)

Data Ingestion

Lists your latest 100 Data Ingestion jobs, newest first, each with its state, counts and the documents it carries.

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

01 · Parameters

core_nameOptional

Only the jobs of this index. Without it: every index of your account.

02 · Example

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

03 · Answer

status is true and jobs lists the jobs with the same fields as ingest_status, plus payload, the documents of the job as a JSON string.

With many jobs, the lighter calls are better: ingest_queue_list_jobs pages through the jobs of an index without their documents, ingest_queue_core_progress gives the progress alone.

Jobs that are not running are removed 30 days after they were queued.

04 · 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.

05 · Related

Act on a job: ingest_queue_action. Your indexes with jobs: ingest_queue_list_cores.

Start the waiting jobs now: ingest_run_now. Retry the failed ones: ingest_queue_retry_failed.

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