Uploaded image for project: 'Automation for Cloud'
  1. Automation for Cloud
  2. AUTO-51

Official REST API to manage rules, export/import and access automation audit logs

    • 0
    • Our product teams collect and evaluate feedback from a number of different sources. To learn more about how we use customer feedback in the planning process, check out our new feature policy.

      Problem Definition

      It is not possible to create, edit, delete, enable, export/import or disable automation rules using a REST API.

      In some cases, for example when creating a new staging instance from production data, it is desired to have some or all automation rules disabled or edited at once, in an automated way.

      Suggested Solution

      Implement a public REST API to allow the following operations:

      • Create rules
      • Edit rules
      • Enable/disable rules
      • Delete rules
      • Get list of rules
      • Export/Import rules

      ***

      We would like to export Jira automation logs to an external dashboarding system. Unfortunately, both the /auditlog and the /automation endpoints are internal APIs. They are not available outside Jira.

       

      Is it possible to expose automation-related APIs to allow us to do the following either via a Rest API or a Webhook:

      1. Export automation audit logs
      2. Create/Delete/Edit/View automation rules
      3. Export Automation rules

       

            [AUTO-51] Official REST API to manage rules, export/import and access automation audit logs

            Bernd Degen added a comment -

            I’d like to strongly endorse the addition of a public REST API for Automation rules—one that supports both exporting and importing JSON definitions. By exposing this functionality via API, we unlock powerful capabilities that go far beyond a manual UI import:

            • Git-backed version control: Store your rule definitions in a GitHub repo to track every change, revert to prior versions, and correlate rule updates with code changes or Jira issue commits.
            • Automated CI/CD pipelines: Leverage existing CI tools (GitHub Actions, Jenkins, etc.) to automatically validate, test, and deploy rule changes across multiple projects or environments—eliminating manual steps and reducing human error.
            • Peer review & auditability: Treat automation rules as code: open PRs for new or updated rules, have teammates review the JSON before merging, and maintain a clear audit trail of who changed what and why.
            • Backup & disaster recovery: Regularly pull all rule definitions via the API and store them off-site, ensuring you can quickly restore or replicate your automations in case of data loss.
            • Cross-project consistency: Use scripts to push standardized rule libraries to dozens of projects at once, guaranteeing uniform behavior without painstaking manual setup.

            In short, a true REST API for Automation rules would transform them from siloed UI artifacts into first-class “infrastructure as code.” Please consider this enhancement to empower teams with modern DevOps practices for managing their Jira automations.

            Bernd Degen added a comment - I’d like to strongly endorse the addition of a public REST API for Automation rules—one that supports both exporting and importing JSON definitions. By exposing this functionality via API, we unlock powerful capabilities that go far beyond a manual UI import: Git-backed version control: Store your rule definitions in a GitHub repo to track every change, revert to prior versions, and correlate rule updates with code changes or Jira issue commits. Automated CI/CD pipelines: Leverage existing CI tools (GitHub Actions, Jenkins, etc.) to automatically validate, test, and deploy rule changes across multiple projects or environments—eliminating manual steps and reducing human error. Peer review & auditability: Treat automation rules as code: open PRs for new or updated rules, have teammates review the JSON before merging, and maintain a clear audit trail of who changed what and why. Backup & disaster recovery: Regularly pull all rule definitions via the API and store them off-site, ensuring you can quickly restore or replicate your automations in case of data loss. Cross-project consistency: Use scripts to push standardized rule libraries to dozens of projects at once, guaranteeing uniform behavior without painstaking manual setup. In short, a true REST API for Automation rules would transform them from siloed UI artifacts into first-class “infrastructure as code.” Please consider this enhancement to empower teams with modern DevOps practices for managing their Jira automations.

            With a big system and data integrity enforcement, having almost close to 3000 rules caused a huge pain while refreshing data from prod to test system and making these rules enable/disable same as Prod env. 

            As importing rules with json file of > 5 MB not supported, had to spilt these rules info multiple files and import those one by one (for ours it was 19 files to be imported for ~ 3000 rules) is a tedious, laborious and error prone process.

            API automation would help us manage any rules in the system and also for such data refresh.

            Appreciate your considering for such support soon to help us.

            Abhijit Saha added a comment - With a big system and data integrity enforcement, having almost close to 3000 rules caused a huge pain while refreshing data from prod to test system and making these rules enable/disable same as Prod env.  As importing rules with json file of > 5 MB not supported, had to spilt these rules info multiple files and import those one by one (for ours it was 19 files to be imported for ~ 3000 rules) is a tedious, laborious and error prone process. API automation would help us manage any rules in the system and also for such data refresh. Appreciate your considering for such support soon to help us.

            Since there's no way of having backups, we're implementing "backups" based on getting information from API calls. But no API endpoints for this, since 2021. It's critical for our business model and also for Atlassian being what we chose. 

            Rubén Cardenal added a comment - Since there's no way of having backups, we're implementing "backups" based on getting information from API calls. But no API endpoints for this, since 2021. It's critical for our business model and also for Atlassian being what we chose. 

            Please implement this - it would be very useful for Monitoring and Alerting. Additionally an endpoint to retrieve current automation limits per Jira product

            William.Shore added a comment - Please implement this - it would be very useful for Monitoring and Alerting. Additionally an endpoint to retrieve current automation limits per Jira product

            Oh brother another feature missing

            Miguel Ângelo Aleixo Fernandes (maaf) added a comment - Oh brother another feature missing

            This could be very helpful. +1 to the implementation of: Get list of rules.

            One further use case I see: if you create a matrix (e.g.  approvers for specific employees) via automation branches, and for audit purposes you would need to see the automation blocks content. Otherwise you would need to keep this matrix in a separate place.

            Tomáš Kleman added a comment - This could be very helpful. +1 to the implementation of: Get list of rules. One further use case I see: if you create a matrix (e.g.  approvers for specific employees) via automation branches, and for audit purposes you would need to see the automation blocks content. Otherwise you would need to keep this matrix in a separate place.

            Ping ! Atlassian

            Nicolas Le Corno added a comment - Ping ! Atlassian

            Hi 89403358cf11,

            As I've seen comments over 1 month ago, this feature is not available. could you please let me know if this feature is currently available? if not when will it be available? 

            Thanks!

            Nikhitha Muniganti added a comment - Hi 89403358cf11 , As I've seen comments over 1 month ago, this feature is not available. could you please let me know if this feature is currently available? if not when will it be available?  Thanks!

            Jay added a comment -

            Hi 89403358cf11 62534117e636 

            Do we have any timeline for future release of this? This is a major block in a lot of projects and seems a basic requirement the platform should have. Others certainly do.

            Thanks!

            Jay added a comment - Hi 89403358cf11 62534117e636   Do we have any timeline for future release of this? This is a major block in a lot of projects and seems a basic requirement the platform should have. Others certainly do. Thanks!

            Josh added a comment -

            Thank you, 89403358cf11, for being responsive to the feedback here and reopening the request!

            Josh added a comment - Thank you, 89403358cf11 , for being responsive to the feedback here and reopening the request!

              e0eb84d6fb47 Dhanapal Mohanasamy
              vfontes Vinicius Fontes
              Votes:
              822 Vote for this issue
              Watchers:
              438 Start watching this issue

                Created:
                Updated: