Forge provides hosted storage capabilities that let you persistently store data in your app installation. Each installation of your app is subject to the quotas and limits of Forge's hosted storage capabilities. See Storage quotas and Storage limits for more details.

Hosted storage capabilities

Use this for long-term storage until you need to delete or overwrite the data. Forge provides the following persistent storage capabilities:

Key-Value Store

Store user preferences and app configuration with simple and persistent storage.

Go to reference →

Custom Entity Store

Save and query structured data using custom entities for flexible and persistent storage.

Go to reference →

SQL

Manage complex data models and relationships with a fully managed relational datastore.

Go to reference →

Object Store (EAP)

Store unstructured or binary data (like files and media) with scalable and persistent storage.

Go to reference →

These capabilities will:

Encrypt and store data on disk, optimising them for durability and persistence at the expense of performance.
Automatically scope data per installation to ensure tenant safety.

For the Key-Value Store and Custom Entity Store, we recommend using the @forge/kvs package. The legacy storage module from @forge/api is still supported but no longer receives feature updates (as of March 17, 2025). If you're still using the legacy module, see Migrating to @forge/kvs from legacy storage for migration guidance.

Data recovery for apps with hosted storage

Forge hosted storage retains data for 28 days after uninstallation. However, when a customer reinstalls an app that uses Forge hosted storage, data from the previous installation is not automatically restored.

To recover this data for a customer, app developers must:

Get customer consent to restore data.
Submit a recovery request within 21 days of uninstallation. This is to ensure the request is processed before the 28-day retention ends.

To submit a recovery request:

Raise a bug ticket on Developer and Marketplace Support.
Write Re-link data to reinstalled app in the summary.
Add the following customer details to the Description:
- Site ID: of the site where the app is currently installed
- Installation ID: the current app installation where the existing data should be re-linked

We will then re-link the data from their previous installation (also identified by Installation ID) to the current installation.

If the customer uninstalled and reinstalled their app multiple times, you may need to specify which installation's data we should re-link. In this case, you can ask the customer to identify this installation by the date it was uninstalled.

See Data lifecycle for Forge-hosted storage for related details.