Sign in
Admin

List Admin Jobs

Changed on

List all ingestion jobs with optional status/user/search/sort filters (admin only).

sort and order are closed enums, so an unrecognised value is refused with a 422 and never reaches the query.

get/admin/jobs/

Request

  • The document declares no server URL.
  • Auth: one of:
    • OAuth 2 (password, token URL /api/auth/login)
    • API key in header X-Api-Key
    • API key in query parameter api_key

Query parameters

statusstring nullable

Job status to match. 'failed' leaves out replacements held for review, which 'awaiting_review' lists while their run still needs a decision.

user_idstring uuid nullable
searchstring nullable
skipinteger
limitinteger
sort'created_at' | 'source_filename' | 'status' | 'username' | 'duration'

Column to order by. Duration orders by the completed_at - started_at interval, so unfinished jobs sort last either way.

order'asc' | 'desc'

Sort direction.

Response

Successful Response

totalinteger required

Total number of jobs matching the query.

Changes

  • 832fb7e64056Revision changes
    • info

      added the optional property // to the response with the status

  • 5dad40cb0184Revision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status