API Settings

API Settings


Introduction

To optimize performance of Boards and Reports, Agile Hive offers a variety of read-only custom fields which values are calculated in the background automatically on work item changes.

The Problem

The background processing works fine up to a considerable frequency of work item changes. If a large quantity of work items is updated simultaneously, Atlassians APIs are responding with rate limit responses. When an automated process within or outside of Jira changes field values of work items, Agile Hive listens to the resulting update events and detects if the change requires an update of a calculated field of Agile Hive. These calls are by default performed by an app user that the Atlassian platform creates for every app. This means a single app user has to do all API requests in order to detect field updates from all work item changes on a site. On high frequencies, this might lead to rate limits and aborted background calculations.

Account Pooling

This setting is located in the global app administration and requires global admin permission to access. It allows to configure a set of user accounts to be used for background update operations instead of the app user. in order to operate correctly, it is necessary that these users have browse permissions in all projects of the organization of Agile Hive.

  1. Create dedicated users to be used for Agile Hive background update. We recommend to give them unique recognizable names.

  2. Give these users browse permission in all projects related to Agile Hive. The easiest way would be to create a dedicated group i.e. named agile-hive-api-users and add this group to the permission schemes of all projects.

  3. Add the users to the pool in the API settings tab of the global app administration and click save.

    image-20251023-112122.png
    Account Pool with 2 user accounts
  4. Double check if all users have all permissions. The status indicates if these users have the right permissions. If not there will be an indicator that is clickable to see where the user is missing browse permissions.

image-20251023-111940.png
Account status with all necessary permissions

Limitations

Internal testing showed that 1 account already helps to improve availability of the UI because different users are used to deliver UI responses and perform background updates. Even 2 accounts might lead to an increased reliability of background field updates.

3, 4, or even more accounts are discouraged. This might lead to different problems and reaching limits within the application platform instead of the REST APIs.

This approach does not completely eliminate rate limit issues. But it should provide more reliability and availability of Agile Hive and its reports.

At the time of the release (Oct 23, 2025) service accounts are not supported by the platform.