Rate this page:
We’re excited to kickstart the Forge journey by extending free use of the Forge platform through 2023. We know the value that apps bring to our customers, and want to support our developer ecosystem in getting started with Forge, whether the app is for your organization, your customers, or for the Atlassian Marketplace.
Forge apps can consume resources up to the quotas or limits outlined below. The Function as a Service (FaaS) and storage quotas scale with your apps install base. The larger the install base (number of seats), the higher the FaaS and storage quotas are. Resource update quotas are applied on a per app basis.
If your app consistently exceeds the quotas or limits, we will contact you. You can also contact us if you think your app needs higher quotas or limits. Learn more about exceeding Forge limits and quotas.
These guidelines apply until the end of December 2023.
The FaaS and storage quotas are provided on a per app, per seat basis. For a private app, this is the number of Jira Software and/or Confluence seats that you have licensed. For a free or paid Marketplace app, this is the total number of seats that all your app’s customers have licensed, including evaluations.
As you estimate your app's usage relative to the quotas and limits below, remember that the number of active users at any given point in time will likely be lower than the number of licensed seats for an installation, which would give your app some headroom.
In this example, a paid Marketplace Forge app has 10 500-seat customers, and five 10-seat customers, which is a total of 5,050 seats. The Forge app's weekly quota is shown below.
| FaaS | ||
|---|---|---|
| Invocations (seats) | Runtime (weekly) | Data returned (weekly) |
| 5,050,000 invocations | 20,200 minutes | 99 GB |
| Storage | ||
| Storage capacity (seats) | Reads (weekly) | Writes (weekly) |
| 40,400 MB | 80,800 MB | 20,200 MB |
| Resource updates | ||
| File upload (weekly) | File uploads (weekly) | |
| 150 MB | 500 uploads | |
To estimate how much of the quota the app will use, assume that all of your users are on the standard edition of Jira Software.
The app has two modules that consume FaaS resources: a Jira issue activity panel using custom UI and a product trigger that's listening to the issue created event.
The Jira issue activity panel loads whenever an issue is viewed, and invokes its resolver function once. The resolver takes an average of 500 ms to run, and returns an average of 32 KB to the client. In other words, the app will consume one FaaS invocation, 500 ms of FaaS runtime, and 32 KB of FaaS data returned every time a user views an issue in Jira.
In this example, the view issue event has 70 issue views per seat, per week, for the app’s 10-seat licenses, and 25 issue views per seat for the 500-seat licenses. The app has an estimated 3,500 issue views across the app’s 10-seat licenses and 125,000 issue views across the 500-seat licenses, or 128,500 issue views per week in total.
1 2(70 * 50) + (25 * 5000) = 128,500 weekly invocations (128,500 * 500 ms)/1000/60 = 1,071 minutes (128,500 * 32 KB)/1000/1000 = 3.9 GB
The product trigger fires whenever a Jira issue is created, and takes an average of 2000 ms to run. Note that triggers don't return data, and therefore don't consume the FaaS data quota.
In this example, the create issue event has three issues created per seat for the app’s 10-seat licenses, and one issue created per seat for the 500-seat licenses. The app has an estimated 150 issues created across the app’s 10-seat licenses and 5,000 issues created across the 500-seat licenses, or 5,150 issues created per week total.
1 2(3 * 50) + (1 * 5000) = 5,150 weekly issues (5,150 * 2000 ms)/1000/60 = 172 minutes
Add the totals from the Jira issue panel and product trigger together to get the total FaaS usage of for the app, and calculate the percentage of the quota that you’ll likely use:
1 2128,500 + 5,150 = 133,650 invocations (2.6% of our quota of 5,050,000) 1,071 + 172 = 1,243 minutes (6.2% of our quota of 20,200) 4 GB data returned (4.1% of our quota of 99 GB)
The Jira issue activity panel app uses custom UI, and bundles some static resources that are served to users when they use the app. Note that only resources used in custom UI have quotas applied. Forge JavaScript functions and dependencies are not counted towards the app’s quota. Only deployments to the production environment count towards the quota. Deployments to the development and staging environments do not count towards the quota.
In this example, the static resources include an HTML file (1 MB), a JavaScript file (1 MB), a CSS file (1 MB), a PNG file (1 MB), and a GIF (1 MB); which is a total of 5 files and 5 MB.
Each time the app is deployed, the following quota is consumed:
1 25 * 1 MB = 5 MB uploaded (3% of the 150 MB quota) 5 files uploaded (1% of the 500 files quota)
This app consumes the weekly “File uploads (MB)” resource quota at a greater rate than our “File uploads (file count)” resource quota. Divide the total quota by the MB consumed per deploy to determine how many times the app can be deployed weekly before exceeding the quota.
1 2150 MB quota per week / 5 MB deployment size = 30 production deployments per week
If the app consumes the “File uploads (file count)” quota faster than the “File uploads (MB)” quota, the number of files being deployed is the limiting factor in how many deployments can be performed in a given week.
The quotas listed below apply to an app installation; E.g. the example app, installed on example.atlassian.net in the production environment.
There are three tiers for quotas, depending on how your app is deployed:
The FaaS quotas are consumed when the function is invoked in any environment, and scale with the number of seats in your app’s install base. Runtime is metered by millisecond or part thereof. Data returned is metered by KB or part thereof. These quotas are refreshed weekly.
| Paid apps | Free apps | Distributed apps | ||||
|---|---|---|---|---|---|---|
| First 100 seats, total | Per seat thereafter | Up to 100 seats, total | Per seat thereafter | Up to 100 seats, total | Per seat thereafter | |
| Invocations (weekly) | 100,000 invocations | 1,000 invocations | 50,000 invocations | 500 invocations | 50,000 invocations | 500 invocations |
| Runtime (weekly) | 400 minutes | 4 minutes | 200 minutes | 2 minutes | 200 minutes | 2 minutes |
| Data returned (weekly) | 2,000 MB | 20 MB | 1,000 MB | 10 MB | 1,000 MB | 10 MB |
These quotas apply to the static resources packaged with your app that are used by custom UI functions. Note that Forge JavaScript functions and dependencies are not counted towards the app’s quota. Resource quotas are consumed per deployment to your production environment; deployments to development and staging environments are unmetered. These quotas are refreshed weekly.
| Paid apps | Free apps | Distributed apps | |
|---|---|---|---|
| Per app | Per app | Per app | |
| File capacity (weekly) | 150 MB | 75 MB | 75 MB |
| Files uploaded (weekly) | 500 files | 250 files | 250 files |
These quotas apply to usage of the Forge Storage API in any environment, and scale with the number of seats in your app's install base.
If an installation decreases its seat count, quotas will currently not decrease accordingly. This may change in the future, at which point we will provide guidance on how to react to these events. Meanwhile, follow your GDPR responsibilities with respect to storing, reporting and erasing user data.
Currently, the Storage API is not intended for large objects such as media files.
For the time being, consider storing large objects as product attachments (see the issue attachment API for Jira Cloud or the content - attachment API for Confluence Cloud), or using an external storage solution such as Amazon S3.
As with all quotas and limits, if you suspect the Storage API quotas will prevent you from implementing your Forge app, contact us to discuss your use case.
Storage capacity (MB) is the total amount of storage provisioned per seat for each installation of your app.
The Storage API provides a way to store sensitive credentials (secrets), which is subject to a separate total storage quota from general storage.
| Paid apps | Free apps | Distributed apps | ||||
|---|---|---|---|---|---|---|
| First 100 seats, total | Per seat thereafter | Up to 100 seats, total | Per seat thereafter | Up to 100 seats, total | Per seat thereafter | |
| Storage capacity | 800 MB | 8 MB | 400 MB | 4 MB | 400 MB | 4 MB |
| Secret storage capacity | 200 MB | 2 MB | 100 MB | 1 MB | 100 MB | 1 MB |
Read and write capacity quotas are the amount of data that can be transferred in or out of the Storage API each week, per seat. These quotas are refreshed weekly.
| Paid apps | Free apps | Distributed apps | ||||
|---|---|---|---|---|---|---|
| First 100 seats, total | Per seat thereafter | Up to 100 seats, total | Per seat thereafter | Up to 100 seats, total | Per seat thereafter | |
| Read capacity (weekly) | 1600 MB | 16 MB | 800 MB | 8 MB | 800 MB | 8 MB |
| Write capacity (weekly) | 400 MB | 4 MB | 200 MB | 2 MB | 200 MB | 2 MB |
The Forge platform has additional limits that cannot be scaled with your app's usage. To prevent your app from exceeding these limits, you may need to tune your app or remove some resources. Learn more about exceeding Forge limits and quotas.
The limits listed below apply to an app when it's invoked.
| Resource | Limit | Description |
|---|---|---|
| Runtime seconds | 25 | Total runtime permitted before the app is stopped. |
| Log lines per invocation | 30 | Number of log entries per invocation. |
| Network requests | 100 | Number of network requests per invocation, excluding those made using requestJira or requestConfluence. |
| Memory | 128MB | Available memory per invocation. |
The limits listed below apply to resources bundled with an app.
| Resource | Limit | Description |
|---|---|---|
| Bundle files | 10,000 | Maximum number of files declared in a single custom UI resource bundle |
| Bundle size | 50 | Maximum bundle size in megabytes (MB) for a custom UI resource |
When using the app storage API, we strongly recommend that you:
The app storage API is currently experimental, with several features under development. Let us know if you encounter problems or missing functionality; your feedback will help shape the future of Forge.
At present, the Atlassian Cloud only backs up the entire hosted storage for disaster recovery. Data and content stored from the Forge storage API is not backed up. That is, any data stored at the app level is not backed up.
We will add the ability to back up app data in a future update.
The limits listed below apply to the Storage API for each installation of your app.
If an installation of your app exceeds these limits due to bulk processing (for example, triggered by a bulk issue update in Jira), consider using the Async events API to queue your interactions with the Storage API.
| Resource | Limit | Description |
|---|---|---|
| Delete operations | 10 | Maximum delete operations per second per installation |
| Query operations | 10 | Maximum query operations per second per installation |
| Read operations | 50 | Maximum read operations per second per installation |
| Update operations | 20 | Maximum update operations per second per installation |
The Storage API has the following limits on keys and values.
You do not need to include an app or installation identifier in your key.
Internally, Forge automatically prepends an identifier for your app and the current installation to every key. This means that you can use the full key length without worrying about conflicts across apps or installations.
| Resource | Limit | Description |
|---|---|---|
| Key length | 500 | Maximum length of a key |
| Key format | /^[a-zA-Z0-9:._\s-#]+$/ | Keys must match the regex |
| Value size | 128 KB | Maximum size of a single persisted value |
The limits listed below apply to the Async events API for each installation of your app.
| Resource | Limit | Description |
|---|---|---|
| Event per request | 50 | Maximum number of events pushed in a single request |
| Event per minute | 500 | Maximum number of events pushed in one minute |
| Payload size | 200kb | Maximum combined payload size of events in single request |
| Cyclic invocation limit | 1000 | An event resolver can push more events to the queue thus creating a cycle. This limit applies to the maximum cyclic depth up to which events resolver can push more events to the queue. |
The limits listed below apply to an app.
| Resource | Limit | Description |
|---|---|---|
| App description | 1,000 | Maximum number of characters that the app description can have. |
| App name | 1 to 50 | The app name must be between the character limits. |
| App size | 100 | Maximum app size in megabytes (MB). |
| Base URL | 2,048 | Maximum number of characters that the app baseUrl can have. |
| Modules per app | 100 | Maximum number of unique modules that can be declared in a single app manifest. |
| Resources per app | 10 | Maximum number of unique resources that can be declared in a single app manifest. |
The limits listed below apply to a developer's account.
| Resource | Limit | Description |
|---|---|---|
| Apps | 100 | Maximum number of apps that can be created or owned by a single developer. |
If your app exceeds any quotas or limits, you can often fix the issue yourself:
Most app limits are enforced through Forge CLI validation, where you'll immediately receive an error. Most errors have trivial fixes, such as shortening your app's name.
For resource-bound limit errors (such as the total number of apps), you need to
remove the relevant resources. You can uninstall an app with the forge uninstall command.
Once you remove all installations of an app, delete it from the
developer console.
We understand that some quotas can be hard to monitor; as such, we are working on better monitoring tools for future releases. Meanwhile, if we detect that your app consistently exceeds our quotas or limits, we'll first contact you to understand why. If your app needs higher storage capacity, you can contact us through the Developer Service Desk. If your app needs an increase in other quotas or limits, please let us know through the Forge Jira Project.
We aim to unblock reasonable use cases, and we will work with you to achieve this. However, repeated or prolonged failure to address requests to comply with quotas may result in further action being taken (such as app suspension).
An app may be temporarily suspended if it negatively impacts the Forge platform, regardless of whether it’s in breach of any quotas or limits.
Suspended apps cannot be:
Invoked: Suspended apps cannot be invoked by any existing installations. Invoking
a suspended app will return an App is currently unavailable, please try again later error.
Installed: Attempting to install a suspended app will return an
App installation is not available while the app is suspended error.
Deployed: Running forge deploy command on a suspended app will return an
App management is unavailable while the app is suspended error.
If your app is suspended, we'll raise a ticket on the Developer Service Desk and mention you, so that you can help us fix the issue as soon as possible. If you're not a Jira user, we’ll email you a link to the issue.
If have an issue with quotas or limits but haven't been contacted by our team, you can seek assistance from the Forge developer community.
See the Forge Terms for more information.
Rate this page: