API Documentation
=================

Welcome to DBCalm, a comprehensive database backup and management tool for MariaDB/MySQL databases.

DBCalm provides a secure, automated solution for database backups with scheduling capabilities,
restore functionality, and a user-friendly API for managing your database infrastructure.

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   installation
   configuration
   api-specification
   developer-guide

Features
--------

* **Automated Backups**: Schedule regular backups of your MariaDB/MySQL databases
* **Secure API**: OAuth2-based authentication with JWT tokens
* **Restore Management**: Easy restoration of backups to any point in time
* **API Client Management**: Support for multiple API clients to securely access the backup system
* **Process Monitoring**: Track backup and restore operations in real-time
* **Privilege Separation**: Secure command execution with dedicated service accounts

Quick Start
-----------

For installation instructions, see :doc:`installation`.

For configuration options, see :doc:`configuration`.

For API documentation, see :doc:`api-specification`.

For development setup, see :doc:`developer-guide`.