System Administration > Lifecycle Management > Backup Restore Management > Backup

Associated URIs:

API Description API Path

Request one-time inventory summary.


Request one-time inventory summary. The backup will be uploaded using the
same server configuration as for an automatic backup.
POST /api/v1/cluster?action=summarize_inventory_to_remote

Request one-time backup


Request one-time backup. The backup will be uploaded using the
same server configuration as for automatic backup.
POST /api/v1/cluster?action=backup_to_remote

Get ssh fingerprint of remote(backup) server


Get SHA256 fingerprint of ECDSA key of remote server. The caller should
independently verify that the key is trusted.
POST /api/v1/cluster/backups?action=retrieve_ssh_fingerprint

Get backup configuration


Get a configuration of a file server and timers for automated backup.
Fields that contain secrets (password, passphrase) are not returned.
GET /api/v1/cluster/backups/config

Configure backup


Configure file server and timers for automated backup.
If secret fields are omitted (password, passphrase)
then use the previously set value.
PUT /api/v1/cluster/backups/config

Get backup history


Get history of previous backup operations
GET /api/v1/cluster/backups/history

Get all backup related information for a site


Get a configuration of a file server, timers for automated backup,
latest backup status, backups list for a site.
Fields that contain secrets (password, passphrase) are not returned.
GET /api/v1/cluster/backups/overview

Get backup status


Get status of active backup operations
GET /api/v1/cluster/backups/status