Minion API

Minion Job Queue APIs.

Get the basic status of a Minion Job

get

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
jobidintegerRequired

ID of the Job to query status for.

Responses
200

Job status data

application/json
get
/minion/{jobid}
200

Job status data

πŸ”‘ Get the full status of a Minion Job

get

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.

Authorizations
AuthorizationstringRequired

Use Authorization: Bearer <base64(api_key)>

Path parameters
jobidintegerRequired
Responses
200

Job detail

application/json
ResponseobjectExample: {"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}
get
/minion/{jobid}/detail
200

Job detail

πŸ”‘ Queue a Minion job

post

Queue a Job with the specified type and parameters. See LANraragi::Utils::Minion for all the available types of jobs and the parameters they require.

There's no API contract in place for whether a Job type exists on a given server version, so I wouldn't recommend using this unless you have a good reason to.

Authorizations
AuthorizationstringRequired

Use Authorization: Bearer <base64(api_key)>

Path parameters
jobnamestring Β· enumRequired

Type of the job to instantiate.

Possible values:
Query parameters
argsstringRequired

Arguments as a JSON array string

priorityintegerOptional

Priority of the Minion job. The higher the number, the more important the job is.

Responses
200

Enqueued job

application/json
post
/minion/{jobname}/queue
200

Enqueued job

Last updated