Documentation > Data Ingestion

API - Page through the ingestion jobs of an index (ingest_queue_list_jobs)

Data Ingestion

Lists the Data Ingestion jobs of one index, a page at a time, without their documents.

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

01 · Parameters

core_nameRequired

The name of your index.

pageOptional

The page, from 0. Default 0.

limitOptional

Jobs per page, 1 to 100. Default 10.

sortOptional

created_at (default), completed_at, total_docs or state.

dirOptional

desc (default) or asc.

filterOptional

failed: only the jobs that failed. partial: only finished jobs with some failed documents.

02 · Example

curl -s "https://api.opensolr.com/solr_manager/api/ingest_queue_list_jobs?email=YOUR_EMAIL&api_key=YOUR_API_KEY&core_name=my_index&limit=20&filter=failed"

03 · Answer

jobs with the fields of ingest_status and inflight_docs, then total, page, limit and pages.

04 · Errors

ERROR_INVALID_PARAMETERSHTTP 200

No core_name.

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

One job with its documents: ingest_queue_job_detail.

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