Backup API 🟡 BETA

The Backup API provides endpoints for creating, managing, and restoring backups of bot data and configurations.

Status: Roadmap

This API is on the development roadmap. The endpoints documented below represent the planned interface design.

Base URL

http://localhost:9000/api/v1/backup

Authentication

Uses the standard botserver authentication mechanism with administrator-level permissions required.

Endpoints

Backup Operations

Restore Operations

Scheduling

Request Examples

Create Backup

backup_options = NEW OBJECT
backup_options.type = "full"
backup_options.include_files = true
backup_options.include_database = true

result = POST "/api/v1/backup/create", backup_options
TALK "Backup created: " + result.backup_id

List Backups

backups = GET "/api/v1/backup/list"
FOR EACH backup IN backups
    TALK backup.id + " - " + backup.created_at + " (" + backup.size + ")"
NEXT

Restore from Backup

restore_options = NEW OBJECT
restore_options.target = "staging"

result = POST "/api/v1/backup/restore/backup-123", restore_options
TALK "Restore job started: " + result.job_id

Schedule Automated Backup

schedule = NEW OBJECT
schedule.cron = "0 2 * * *"
schedule.type = "incremental"
schedule.retention_days = 30

POST "/api/v1/backup/schedule", schedule
TALK "Backup schedule created"

Backup Types

Response Codes

Required Permissions