Forge Object Store is now in Preview, and therefore fully supported. However, it remains under active development and may be subject to shorter deprecation windows. Preview features are suitable for early adopters in production environments.
We release preview features so partners and developers can study, test, and integrate them prior to General Availability (GA). For more details, see Forge EAP, Preview, and GA.
This feature is currently unsupported in Atlassian Government Cloud (AGC) apps. For more information, refer to the AGC feature roadmap.
The Forge Object Store is a hosted storage solution that lets you manage large items such as data objects or media files. It provides a seamless way to efficiently store, retrieve, and manage objects directly from your Forge apps.
The Forge Object Store integrates tightly with the Forge platform, enabling secure and reliable file management.
Example app
We published a sample app to demonstrate the basics of implementing object storage features in a Forge app. This sample app uses the Forge Object Store as its backend and available Forge UI components for its frontend. Refer to the app's README for additional guidance on exploring and testing the code.
The Forge Object Store is subject to following limitations:
Forge Object Store is not supported on Bitbucket apps.
If the following rate limits are exceeded, Forge will return a TOO_MANY_REQUESTS error.
| Parameter | Limit |
|---|---|
| Object Store requests per minute | 5000 |
| Pre-signed URL requests per second | 1000 |
When building interfaces for object download/uploads, you must use the available frontend components.
| Parameter | Limit |
|---|---|
| Maximum object size | 1 GB |
| Maximum request payload size | 1 kB |
| Pre-signed URL validity | 1 hour |
The maximum object size applies to objects uploaded through any frontend component used in conjunction with the Forge Object Store (for example, the useObjectStore
UI Kit hook).
Meanwhile, the maximum request payload size only applies to the actual Forge Object Store request. This request should only contain the object's name and other relevant metadata (not the object itself).
If you add Forge Object Store to an existing app, admins of that app's current installations must review and consent before updating.
As such, adding Forge Object Store to an existing app will require a major version upgrade. This will be triggered through the objectStore
module
(which is required to enable the feature on an app).
All content stored through the Forge Object Store is subject to Atlassian's Acceptable Use Policy. Under this policy, we reserve the right to take swift, appropriate, and decisive action, should any objectionable content be reported or detected. This may include suspending an app's access to Forge Object Store, or outright suspension of the app.
We may also implement additional measures to screen stored content.
Learn more about Forge’s pricing structure, allowances, and billing by visiting Forge platform pricing.
Estimate your app’s monthly costs using the cost estimator, which lets you model usage and see potential charges.
Data in Forge hosted storage is namespaced. The namespace includes all metadata relevant to an app's current installation. As a result:
The Forge Object Store's capabilities are currently available only via Forge methods. See Managing objects for detailed information.
Currently, an experimental Forge Object Store REST API is available, but only accessible via Forge Containers. This REST API will also remain in EAP as long as Forge Containers remains in EAP.
Forge also provides components for building frontends that interact with the Forge Object Store:
objectStore bridge methods: lets you integrate functions with Forge Object Store calls.useObjectStore hook: uses the objectStore bridge method to execute file management operations and track the state of objects.Rate this page: