public Visit Official Website →
    • Installation
    • Docker & Container Deployment
    • Running Behind a Reverse Proxy
    • Hybrid Views & Split Mode
    • Quick Look & Media Previews
    • Download Manager & Batch Archiving
    • Tools & Keyboard Shortcuts
    • Search & Command Palette
    • Real-Time Inotify Sync
    • Public Sharing & Trash Bin
    • Security & Two-Factor Authentication (2FA)
    • Settings & Customization
    • Mobile Experience & Touch Controls
    • Storage Roots & Security Hardening
    • Database, Backups & Maintenance
    • Authentication API
    • User Management API
    • Settings & System API
    • Filesystem & Streaming API
    • Shares & Recycle Bin API
    • WebSocket Stream API
    kv-file v2.0
    public Website
    • Home
    • API Reference
    On this page
    • 🧭 API Sections
    • ⚑ Master Endpoint Reference
    • 🧭 API Sections
    • ⚑ Master Endpoint Reference
    terminal

    API Reference

    Production REST API endpoints catalog and WebSocket event specifications for kv-file

    lock

    Authentication API

    Initial admin setup, login sessions, user verification, and logout

    people

    User Management API

    Creating users, role-based access control, listing active accounts, and user deletion

    settings

    Settings & System API

    Query and update system configuration, theme preferences, and server variables via REST

    folder

    Filesystem & Streaming API

    Listing storage roots, directory trees, file CRUD operations, search, and Range streaming

    share

    Shares & Recycle Bin API

    Public link generation, expiration, password hashing, and Trash recovery endpoints

    cable

    WebSocket Stream API

    Real-time filesystem push notifications over WebSockets with JavaScript and Python client examples


    Β© 2026 kv-file. Built with Lotus Docs.