Backups

Encrypted full database backups (scheduled or on demand, download, and restore), and export or import of the administrator-configured settings only. A restore is prepared while GeoPulse keeps running; activating it replaces all data and stops the backend so it can be restarted. See Backup and Restore.

📄️ Update backup settings

Updates the backup settings and reschedules automatic backups. A new password applies to new backups only.

📄️ Get backup settings

Returns the backup settings: whether a password is configured (the password itself is never returned), scheduled backup and cron expression, backup folder, retention count, operation timeout, and backup health alerts.

📄️ Create and download a backup

Creates an encrypted full database backup, saves it in the backup folder, and streams it as the response. Requires a backup password to be configured. Fails with `409` while another backup or restore is running.

📄️ List backup files

Returns the backup files in the configured backup folder with their sizes and modification times.

📄️ Download a backup file

Downloads an existing encrypted backup file from the backup folder.

📄️ Delete a backup file

Deletes a backup file from the backup folder. Not allowed while a backup or restore is running.

📄️ Discard a prepared restore

Deletes a prepared restore that was not activated and returns to normal operation on the current data.

📄️ Restore a backup file

Starts restoring a backup file that is already in the backup folder, with the password used to create it. Works like restoring an uploaded backup: all current data is replaced and the backend restarts. See [Backup and Restore](https://geopulse.cc/docs/system-administration/maintenance/backup-restore).

📄️ Retry restore activation

Retries switching to a prepared restore after activation could not complete, for example after an interrupted cutover that PostgreSQL rolled back. See [Backup and Restore](https://geopulse.cc/docs/system-administration/maintenance/backup-restore).

📄️ Restore an uploaded backup

Starts restoring an uploaded backup file (multipart fields `file` and `password`). GeoPulse prepares the restore in a separate database while the application keeps running, then switches to it and the backend process exits so it can be restarted on the restored data. All current data is replaced. Poll `GET /api/v1/admin/backups/status` for progress. See [Backup and Restore](https://geopulse.cc/docs/system-administration/maintenance/backup-restore).

📄️ Create a backup

Creates an encrypted full database backup in the backup folder and returns its file name and size. Requires a backup password to be configured.

📄️ Export admin settings

Downloads the administrator-configured settings as JSON: system settings saved in the database, OIDC providers, and custom geocoding providers. User data and the backup password are not included. The file can contain provider credentials in plain text.

📄️ Import admin settings

Imports a settings file created by the export endpoint (multipart field `file`). Replaces the saved system settings and provider configuration, and reports what was imported, removed, or not supported.

📄️ Get backup and restore status

Returns the state of the current or last backup or restore operation, including restore preparation and activation progress and errors.