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.

Contents:

• Installation
  • Prerequisites
  • Debian/Ubuntu Installation
  • RHEL/CentOS/Rocky/Fedora Installation
  • What Gets Installed
  • Post-Installation Setup
  • Verify Installation
  • Next Steps
• Configuration
  • Database Credentials
  • SSL Certificates
  • API Configuration
  • Backup Storage
  • Security
  • Troubleshooting
• API Reference
  • Base URL
  • Authentication
  • API Endpoints
• Developer Guide
  • Development vs Production
  • Development Setup
  • Project Structure
  • Architecture
  • Development Commands
  • Code Style Guidelines
  • Contributing

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 Installation.

For configuration options, see Configuration.

For API documentation, see API Reference.

For development setup, see Developer Guide.