• Manual
  • API Documentation
  • Storage
  • Backup

    Show / Hide Table of Contents
    • Introduction
    • Installation
    • Getting Started
    • Demos
    • The Save System API
    • Auto Save
    • Platforms
    • Security
    • Serialization
    • Supported Data Types
    • Migration
    • FAQ
    • Changelog
    • Extend
      • Overview
      • Converter
      • Encryption
      • Storage
    • Guides
      • Overview
      • Configuring Settings
      • Using Auto Save
      • Basic Saving and Loading
      • Saving and Loading Raw Data
      • Deleting the Data
      • Saving and Loading Images
      • Saving and Loading Scene Objects
      • Saving and Loading Assets
      • Saving and Loading Readonly Properties
    • Integrations
      • Overview
      • Google Play Games
      • Xbox Live
      • Bolt
      • Firebase
      • PlayFab
      • PlayMaker
      • Steam Auto-Cloud
      • Steamworks .NET
      • Facepunch Steamworks
      • Text Mesh Pro
    • Storage
      • Overview
      • Backup
      • Catalog
      • Meta Data
      • Built-in Storages
        • File
        • PlayerPrefs
        • Memory
      • Third-party Storages
        • Firebase
          • Realtime Database
          • Cloud Storage
          • Firestore
        • PlayFab
          • Entity Objects
          • Entity Files
          • User Data
        • Steam
          • Steamworks .NET
          • Facepunch Steamworks
        • Google Play
          • Saved Game
        • Xbox Live
          • Connected Storage

    Backup

    The backup feature allows you to take a copy of your existing storage item to restore it at anytime later, it'll be created based on the current date and time, so it'll be unique to the current time and also it adds a new entry to the backups list of storage item meta data, so this feature requires Meta Data API to be enabled.

    Creating a new Backup

    StorageBackup backup = await SaveSystemAPI.CreateBackupAsync("my-identifier");
    

    Restoring a Backup

    // Just using the latest backup as an example
    StorageBackup latestBackup = await SaveSystemAPI.GetLatestBackup("my-identifier");
    
    await SaveSystemAPI.RestoreBackup("my-identifier", latestBackup);
    

    Restoring the latest Backup

    await SaveSystemAPI.RestoreLatestBackupAsync("my-identifier");
    

    Retrieving a list of all Backups

    List<StorageBackup> backups = await SaveSystemAPI.GetBackups("my-identifier");
    

    Delete a Backup

    // Just using the latest backup as an example
    StorageBackup latestBackup = await SaveSystemAPI.GetLatestBackup("my-identifier");
    
    await SaveSystemAPI.DeleteBackup("my-identifier", latestBackup);
    

    Deleting all Backups

    await SaveSystemAPI.DeleteBackups("my-identifier");
    

    Related

    • SaveSystemAPI
    • Improve this Doc
    • 0 Comments
    In This Article
    • Creating a new Backup
    • Restoring a Backup
    • Restoring the latest Backup
    • Retrieving a list of all Backups
    • Delete a Backup
    • Deleting all Backups
    • Related