Forge Developer

Forge Developer

Last updatedFeb 23, 2021

Rate this page:

Platform quotas and limits

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.

We will reach out for an individual conversation if your app is at risk of consistently exceeding the quotas. Learn more about exceeding Forge limits and quotas.

These guidelines apply until the end of December 2023.

Usage-based quotas

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.

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.

Jira issue panel app example

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 invocations20,200 minutes99 GB
Storage
Storage capacity (seats)Reads (weekly)Writes (weekly)
19,800 MB39,600 MB9,900 MB
Resource updates
File upload (weekly)File uploads (weekly)
150 MB500 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.

Calculate FaaS usage

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
3
 (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
2
3
128,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)

Calculate resources usage

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
2
5 * 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
150 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.

Installation quotas

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:

  • Paid apps - Apps listed on the Atlassian Marketplace with a paid license.
  • Free apps - Apps listed on the Atlassian Marketplace with a free license.
  • Distributed apps - Apps distributed via the developer console.

Function as a Service quotas

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.

 Paid appsFree appsDistributed apps
 First 100 seats, totalPer seat thereafterUp to 100 seats, totalPer seat thereafterUp to 100 seats, totalPer seat thereafter
Invocations100,000 invocations1,000 invocations50,000 invocations500 invocations50,000 invocations500 invocations
Runtime400 minutes4 minutes200 minutes2 minutes200 minutes2 minutes
Data returned2,000 MB20 MB1,000 MB10 MB1,000 MB10 MB

Resource update quotas

These quotas apply to the static resources packaged with your app that are used by custom UI functions. Resource quotas are consumed per deployment to your production environment; deployments to development and staging environments are unmetered.

 Paid appsFree appsDistributed apps
 Per appPer appPer app
File capacity150 MB75 MB75 MB
Files uploaded500 files250 files250 files

Storage quotas

These quotas apply to usage of the Forge Storage API in any environment, and scale with the number of seats in your apps install base. Storage capacity (MB) is the total amount of storage provisioned per seat; it is not incremental week-to-week. Read and write capacity quotas are refreshed each week.

 Paid appsFree appsDistributed apps
 First 100 seats, totalPer seat thereafterUp to 100 seats, totalPer seat thereafterUp to 100 seats, totalPer seat thereafter
Storage capacity400 MB4 MB200 MB2 MB200 MB2 MB
Read capacity800 MB8 MB400 MB4 MB400 MB4 MB
Write capacity200 MB2 MB100 MB1 MB100 MB1 MB

Platform limits

The Forge platform has additional limits that cannot be scaled with your app's usage. Rather than exceeding these limits, you may need to remove some existing resources. Learn more about exceeding Forge limits and quotas.

Invocation limits

The limits listed below apply to an app when it's invoked.

ResourceLimitDescription
Runtime seconds10Total runtime permitted before the app is stopped.
Log lines per invocation100Number of log entries per invocation.
Network requests100Number of network requests per invocation, excluding those made using requestJira or requestConfluence.

Resource limits

The limits listed below apply to resources bundled with an app.

ResourceLimitDescription
Bundle files10,000Maximum number of files declared in a single custom UI resource bundle
Bundle size50Maximum bundle size in megabytes (MB) for a custom UI resource

Storage limits

The limits listed below apply to the Storage API for each installation of your app.

ResourceLimitDescription
Delete operations10Maximum delete operations per second
Query operations10Maximum query operations per second
Read operations50Maximum read operations per second
Update operations10Maximum update operations per second

In addition to the operations quotas above, the Storage API has the following limits.

ResourceLimitDescription
Key length100Maximum length of a key
Key format/^[a-zA-Z0-9:._\s-#]+$/Keys must match the regex
Value size32 KBMaximum size of a single persisted value

App limits

The limits listed below apply to an app.

ResourceLimitDescription
App description1,000Maximum number of characters that the app description can have.
App name1 to 50The app name must be between the character limits.
App size100Maximum app size in megabytes (MB).
Base URL2,048Maximum number of characters that the app baseUrl can have.
Modules per app100Maximum number of unique modules that can be declared in a single app manifest.
Resources per app10Maximum number of unique resources that can be declared in a single app manifest.

Developer limits

The limits listed below apply to a developer's account.

ResourceLimitDescription
Apps100Maximum number of apps that can be created or owned by a single developer.

Apps exceeding quotas or limits

App limits on this page are generally enforced through validation in the Forge CLI, where you'll immediately receive an error. These errors often have trivial fixes, such as shortening your app's name.

For the resource-bound limit errors, such as the total number of apps, you need to remove some apps. You can uninstall an app with the forge uninstall command. Once all installations of that app are removed, delete the app from the developer console.

If an app is consistently exceeding the quotas, we will reach out for an individual conversation with you to understand the usage. Repeated or prolonged failure to address requests to comply with quotas may result in further action being taken such as suspending the app.

You can also reach out to us via the Developer support Jira project.

Suspended apps

An app may be temporarily suspended if it's negatively impacting the Forge platform.

When an app is suspended, the following actions are not available:

  • Invoking the app: When an app is suspended, it will not be invoked by any existing installations. Instead, it will return an App is currently unavailable, please try again later error.

  • Installing the app on new sites: Users trying to install the app will receive an App installation is not available while the app is suspended error.

  • Deploying the app: The forge deploy command returns an App management is unavailable while the app is suspended error.

If your app is suspended, we'll raise a ticket on the Developer support Jira project 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 you've got an issue with quotas or limits and you've not been contacted, you can seek assistance from the Forge developer community.

See the Forge Terms for more information.

Rate this page: