Skip to main content

CodexDocs API

Introduction
health
- Health check endpoint - checks database connectivity
auth
libraries
series
genres
tags
ratings
User Preferences
books
pages
Reading Progress
users
api-keys
Metrics
Scans
Task Queue
Thumbnails
filesystem
settings
System Integrations
Admin
events
opds
opds2
Duplicates
setup
User Integrations
Schemas

health

health

Health check endpoints

📄️ Health check endpoint - checks database connectivity

Returns 'OK' with 200 status if database is healthy,

Health check endpoint - checks database connectivity

Documentation

Introduction
Getting Started
API Reference

Project

GitHub
Issues

Copyright © 2026 Codex. Built with Docusaurus.