Backup

Base: /api/backup

Create, list and manage server backups

Handler: BackupHandler

Endpoints

GET /api/backup/list List Backups POST /api/backup/create Create Backup GET /api/backup/status Backup Status DELETE /api/backup/{name} Delete Backup

GET /api/backup/list

List Backups

List of all available backups.

Response Example

[{"name":"backup_2025-01-15_14-30-00.zip","size":"256MB","created_at":"2025-01-15T14:30:00Z"},{"name":"backup_2025-01-15_12-00-00.zip","size":"254MB","created_at":"2025-01-15T12:00:00Z"}]

cURL

curl http://localhost:5550/api/backup/list

POST /api/backup/create

Create Backup

Starts creating a new backup (asynchronous).

Response Example

{"success":true,"message":"Backup started","backup_id":"backup_2025-01-15_14-30-00"}

cURL

curl -X POST http://localhost:5550/api/backup/create

Internal Behavior

Backup runs asynchronously in the background.
World is automatically saved before backup.
Old backups are automatically deleted after max_backups.

GET /api/backup/status

Backup Status

Status of the currently running backup.

Response Example

{"status":"in_progress","progress":67,"started_at":"2025-01-15T14:30:00Z","estimated_remaining":"45s"}

cURL

curl http://localhost:5550/api/backup/status

DELETE /api/backup/{name}

Delete Backup

Deletes a specific backup.

Parameters

Name	Type	Required	Description
`name`	string	Yes	Backup filename

Response Example

{"success":true,"message":"Backup backup_2025-01-15_12-00-00.zip deleted"}

cURL

curl -X DELETE http://localhost:5550/api/backup/backup_2025-01-15_12-00-00.zip