Miscellaneous other API
Other APIs that don't fit a dedicated theme.
Get Server Information
GET http://lrr.tvc-16.science/api/info
Returns some basic information about the LRR instance this server is running.
{
"archives_per_page": 100,
"cache_last_cleared": 1728852701,
"debug_mode": true,
"has_password": false,
"motd": "aye lads time to read some manga",
"name": "LANraragi",
"nofun_mode": false,
"server_resizes_images": false,
"server_tracks_progress": true,
"total_archives": 104,
"total_pages_read": 252,
"version": "0.9.30",
"version_desc": "I'm under Japanese influence and my honor's at stake!",
"version_name": "Law (Earthlings On Fire)"
}Get the OPDS Catalog
GET http://lrr.tvc-16.science/api/opds
Get the Archive Index as an OPDS 1.2 Catalog with PSE 1.1 compatibility.
Path Parameters
id
string
ID of an archive. Passing this will show only one <entry\> for the given ID in the result, instead of all the archives.
Query Parameters
category
string
Category ID. If passed, the OPDS catalog will be filtered to only show archives from this category.
🔑Get available plugins
GET http://lrr.tvc-16.science/api/plugins/:type
Get a list of the available plugins on the server, filtered by type.
Path Parameters
type*
string
Type of plugins you want to list.
You can either use download, login, metadata, script, or all to get all previous types at once.
🔑Use a Plugin
POST http://lrr.tvc-16.science/api/plugins/use
Uses a Plugin and returns the result. If using a metadata plugin, the matching archive will not be modified in the database. See more info on Plugins in the matching section of the Docs.
Query Parameters
plugin*
string
Namespace of the plugin to use.
id
string
ID of the archive to use the Plugin on. This is only mandatory for metadata plugins.
arg
string
Optional One-Shot argument to use when executing this Plugin.
🔑Use a Plugin Asynchronously
POST http://lrr.tvc-16.science/api/plugins/queue
Uses a Plugin and returns a Minion Job ID matching the Plugin run. This endpoint is useful if you want to run longer-lived plugins which might timeout if ran with the standard endpoint.
Query Parameters
plugin*
string
Namespace of the plugin to use.
id
string
ID of the archive to use the Plugin on. This is only mandatory for metadata plugins.
arg
string
Optional One-Shot argument to use when executing this Plugin.
🔑Clean the Temporary Folder
DELETE http://lrr.tvc-16.science/api/tempfolder
Cleans the server's temporary folder.
🔑Queue a URL download
POST http://lrr.tvc-16.science/api/download_url
Add a URL to be downloaded by the server and added to its library.
Query Parameters
url*
string
URL to download
catid
string
Category ID to add the downloaded URL to.
🔑Regenerate Thumbnails
POST http://lrr.tvc-16.science/api/regen_thumbs
Queue a Minion job to regenerate missing/all thumbnails on the server.
Query Parameters
force
boolean
Whether to generate all thumbnails, or only the missing ones.
Last updated
Was this helpful?