Forge provides three options for storing app data: Forge-hosted storage, Atlassian app REST APIs (for example, Jira or Confluence), and remote storage that you manage. Use these options to persist and retrieve data securely, at the scale your app needs.
Store your app data with Forge Storage so you can focus on solving customer problems instead of managing infrastructure.
Consider data shape and size limits when selecting the storage option that best fits your use case.
| API | Overview | Ideal for |
|---|---|---|
| Key-Value Store | Simple storage for key/value pairs | User preferences, app configuration, simple data storage |
| Custom entities store | Structured data storage with custom entities and query capabilities | Complex data structures, queryable data, relationships between entities |
| SQL | Fully managed relational database | Complex data models, relationships, transactions, advanced queries |
| Object Store (EAP) | Large file and media storage | Binary data, files, media, large objects |
See platform quotas and limits and storage options for more details.
Explore these code examples to see how to perform common storage operations with each Forge storage option.
1 2import { kvs } from '@forge/kvs'; // Store user preferences export async function saveUserPreferences(userId, preferences) { await kvs.set(`user:${userId}:preferences`, preferences); } // Retrieve user preferences export async function getUserPreferences(userId) { return await kvs.get(`user:${userId}:preferences`); } // Delete user preferences export async function deleteUserPreferences(userId) { await kvs.delete(`user:${userId}:preferences`); }
Explore what's possible by use cases for various Atlassian products using Forge Hosted Storage by:
Forge can also use Atlassian app-specific APIs to store and retrieve data for Atlassian Cloud sites and workspaces. This data is accessible to all apps installed within the site (as well as users). See Atlassian app REST APIs for more details.
Using the capabilities discussed in this section may make your app not eligible for Runs on Atlassian.
Go to this page to know more about the Runs on Atlassian program. To know how to check if your app is eligible for Runs on Atlassian, go to the Forge CLI documentation.
Forge also lets you integrate your app with services hosted on other platforms. This allows Forge apps to store data remotely on self-hosted databases or third-party storage services. For more information about integrating with remote services, see Forge Remote and Accessing Forge storage from a remote via REST API.
Rate this page: