Skip to content

Restore

This path restores the database from a provided backup file. The backup file must be uploaded as part of the request.

Standalone only

Online restore is available in standalone deployments only. Clustered deployments reject this endpoint with 409 Conflict; use the offline restore.bundle disaster-recovery flow instead. See Backup and Restore.

Restore a Backup

Method Path
POST /api/v1/restore

Parameters

  • backup (file): The backup file to restore the database from. It must be a valid backup of the database.

Sample Response

{
    "result": {
        "message": "Database restored successfully"
    }
}

Error Responses

  • 409 Conflict — returned in HA mode. Body:
{
    "error": "Online restore is disabled in HA mode. Stop the cluster and seed a fresh node from the backup archive via the restore.bundle drop-in path; see the backup and restore docs."
}