LANraragi
GithubDemoDocker HubDiscord Server
Nightly Release
Nightly Release
  • LANraragi Documentation
  • Installing LANraragi
    • ❓Which installation method is best for me?
    • 🪟LRR for Windows (Win10)
    • 🍎Homebrew (macOS)
    • 🐳Docker (All platforms)
    • 🛠️Source Code (Linux/macOS)
    • 🐧Community (Linux)
    • 👿Jail (FreeBSD)
  • Basic Operations
    • 🚀Getting Started
    • 📚Reading Archives
    • ✒️Adding Metadata
    • 🔎Searching the Archive Index
    • 📈Statistics and Logs
    • 🖌️Themes
  • Advanced Usage
    • 🦇Batch Operations
    • 📂Categories
    • ⬇️Downloading Archives
    • 💾Backup and Restore
    • 📱Using External Readers
    • 🌐Network Interface Setup
    • 🕵️Proxy Setup
    • 📏Tag Rules
  • Developer Guide
    • 🏗️Setup a Development Environment
    • 🏛️Architecture & Style
    • 🈁Translating LANraragi to other languages
  • API Documentation
    • 🔑Getting started
    • Search API
    • Archive API
    • Database API
    • Category API
    • Tankoubon API
    • Shinobu API
    • Minion API
    • Miscellaneous other API
  • Writing Plugins
    • 🧩Getting started
    • Login Plugins
    • Metadata Plugins
    • Downloader Plugins
    • Generic Plugins ("Scripts")
    • Code Examples
Powered by GitBook
On this page
  • Get the basic status of a Minion Job
  • 🔑Get the full status of a Minion Job

Was this helpful?

  1. API Documentation

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.

{
  "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.

{
  "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
}
PreviousShinobu APINextMiscellaneous other API

Last updated 1 year ago

Was this helpful?