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

Was this helpful?

  1. API Documentation

Getting started

The Client API allows you to communicate with a running LANraragi instance from a dedicated client. All the (public)endpoints below can be tested on the demo!

Authenticating with the API

Most of the API endpoints require a form of authentication.

Said authentication is provided by a configurable API Key, which is set by the user in the LRR settings.

This key must be added to your calls as an Authorization: Bearer header, with the key encoded in base64:

DELETE /api/search/cache HTTP/1.1
Accept: application/json
Authorization: Bearer SEVBVEhFTg==

If you fail to meet this requirement, the API endpoint will return error 401 and the following JSON:

{
    "error":"This API is protected and requires login or an API Key."
}

If the user's LRR installation is running under No-Fun Mode, all API methods will be locked behind the key. Empty API Keys will not work, even if there's no key set in Configuration.

Private endpoints will be indicated by a 🔑 symbol next to their name in the following sections.

PreviousTranslating LANraragi to other languagesNextSearch API

Last updated 2 years ago

Was this helpful?

🔑