Minion API

Control the built-in Minion Job Queue.

Get the basic status of a Minion Job

GET http://lrr.tvc-16.science/api/minion/:jobid

For a given Minion job ID, check whether it succeeded or failed. Minion jobs are ran for various occasions like thumbnails, cache warmup and handling incoming files. For some jobs, you can check the notes field for progress information. Look at https://docs.mojolicious.org/Minion/Guide#Job-progress for more information.

Path Parameters

Name	Type	Description
id*	string	ID of the Job.

200 You get job data.

{
  "state": "finished",
  "task": "handle_upload",
  "notes": {
    "example_note": "This note could contain the name of the upload, for example."
  },
  "error": null
}

{
  "state": "failed",
  "task": "thumbnail_task",
  "error": "oh no"
}

🔑Get the full status of a Minion Job

GET http://lrr.tvc-16.science/api/minion/:jobid/detail

Get the status of a Minion Job. This API is there for internal usage mostly, but you can use it to get detailed status for jobs like plugin runs or URL downloads.

Path Parameters

Name	Type	Description
id*	string	ID of the Job.

200 You get detailed job data.

{
  "args": ["\/tmp\/QF3UCnKdMr\/myfile.zip"],
  "attempts": 1,
  "children": [],
  "created": "1601145004",
  "delayed": "1601145004",
  "expires": null,
  "finished": "1601145004",
  "id": 7,
  "lax": 0,
  "notes": {},
  "parents": [],
  "priority": 0,
  "queue": "default",
  "result": {
    "id": "75d18ce470dc99f83dc355bdad66319d1f33c82b",
    "message": "This file already exists in the Library.",
    "success": 0
  },
  "retried": null,
  "retries": 0,
  "started": "1601145004",
  "state": "finished",
  "task": "handle_upload",
  "time": "1601145005",
  "worker": 1
}