CAFORADocs
Developer

Backup Client API

Updated steps and current-interface reference for backup client api.

Current routes

Use a Panel Client API key and a server identifier you are authorized to access. Routes below are relative to https://panel.caforahost.com:

Method and pathPurpose
GET /api/client/servers/{identifier}/backupsList backups
POST /api/client/servers/{identifier}/backupsCreate with optional name, ignored, is_locked
GET /api/client/servers/{identifier}/backups/{uuid}Inspect a backup
GET /api/client/servers/{identifier}/backups/{uuid}/downloadObtain download details
POST /api/client/servers/{identifier}/backups/{uuid}/restoreRestore; review truncate carefully
DELETE /api/client/servers/{identifier}/backups/{uuid}Delete a backup

Creation acceptance is not completion. Check attributes.completed_at and attributes.is_successful. Limits, permissions, state and locking rules still apply; do not assume creation universally requires an online server based on the old guide.

Restoration and deletion affect data. truncate corresponds to deleting all files before restore. Preserve a current copy and verify backup contents first. See manual backups and restore.

On this page