Automation Rule Management API is now in Open EAP - Try it out and share your feedback!

[#1]

Hey Atlassian Community,

We’re excited to announce the introduction of Automation Rule Management APIs, now available in Open Early Access Program(EAP) for Global Administrators.

These APIs give you programmatic control over rule configurations, making it easier to manage automation at scale. As part of this beta, you’ll be able to perform following operations:

• Get rule summaries for all rules

• Search for rule summaries

• Create a new rule

• Get rule by UUID

• Update an existing rule

• Enable or disable a rule

• Update rule scope

This is a key step in making automation more manageable and scalable in large organisations

Try it out

If you're a Global Administrator, you can start using the APIs today:

- API documentation: https://developer.atlassian.com/cloud/automation/rest/api-group-rule-management/#api-group-rule-management

- Feature request: https://jira.atlassian.com/browse/AUTO-51

We’d love your feedback and suggestions

We’d love to hear how you’re using these APIs and where we can improve during this EAP. Please drop your feedback in the comments below or add it directly to the public feature request ticket above.

Thanks for being part of this beta!

Dhanapal Mohanasamy
Atlassian Automation Team

[Calvin]

Woo awesome work, have a few ideas where I might be able to use this. Though the thought of an automation creating an automation creating an automation sounds tempting hehe.

[Brita Moorus]

I had the same thought, @Calvin 😄

[Rune Rasmussen]

For most of the endpoints we have to specify a {product}.
It would be nice with a link to the Base paths page. It'll save API novices like myself some frustration.
And maybe an exhaustive list on that page rather than just "e.g. jira, confluence".

I see that you can scope automations to Teams, but I can't select that in the UI when creating a new or modifying an existing rule.
Is this foreshadowing something else that is going to be released soon?

Using the UI:

Set with API:

[Bill Sheboy]

Hi @Dhanapal Mohanasamy 

Thanks for the information and the work the team is doing on automation improvements!

As this REST API seems related to this open suggestion, what progress can you share on endpoints to manage / monitor the automation audit logs: https://jira.atlassian.com/browse/AUTO-51

I have been experimenting with these endpoints for a few weeks, and while useful, the response limits make some usage scenarios challenging.  For example, one cannot easily get and document rules on a Confluence page because paging is required for more than 100 rules returned (although they could be more easily looped from an external app rather than using a rule to perform documentation management). 

Additionally, the Search for Rule Summaries endpoint has neither a query-by used-actions nor an "expand" for all rule details.  Perhaps another more generic Rule Search endpoint would help.

Finally, some unrelated rule testing I was doing showed no limitations on accessing and modifying a rule from that same rule scope.  This opens some risky scenarios of self-modifying rules.  What can you share about any new automation service limits regarding use of these endpoints, perhaps helping customers prevent accidental misuse.

Kind regards,
Bill

[Marc Koppelaar]

Hi @Rune Rasmussen 

Scope for Team is also available, but only for teams with Operations setup.

Team scopes:

Single team: Rule will run only for a specific team. Only teams with Operations set up can be selected.

Multiple teams: Rule will run across several different teams of your choosing. Only teams with Operations set up can be selected.

Read more about Operations teams

[Oleksii Melnyk]

Amazing news!  @Dhanapal Mohanasamy will it be available and when for Forge?

[Vadim_S]

Update & Solution:  The problem has been resolved. My 403 Forbidden errors were caused by using an incorrect REST API endpoint (and not because of lack of access to EAP as I thought).

According to the documentation (Base Paths - thanks @Rune Rasmussen  for link and Rule Management, the correct endpoint for listing rule summaries is (both valid URL formats are working correctly):

1. https://api.atlassian.com/automation/public/jira/{cloudId}/rest/v1/rule/summary
2. https://YOUR_SITE.atlassian.net/gateway/api/automation/public/jira/{cloudId}/rest/v1/rule/summary

The original message below is left as a record of our debugging journey and is no longer relevant:

Hello, this is great news - thank you! Please tell me how to become a participant of Open Early Access Program(EAP) so that APIs becomes available? (I'm a Global Administrator in my Atlassian instances) 

[Bill Sheboy]

Hi @Vadim_S -- Welcome to the Atlassian Community!

I believe any Jira site admin (or higher permissions) may use those endpoints now so please try them, as needed: https://developer.atlassian.com/cloud/automation/rest/intro/#about

Kind regards,
Bill

[Vadim_S]

Hi @Bill Sheboy, thanks a lot for your quick reply! We've tried to use the GET /rest/v1/rule endpoint with a Global Administrator's API token, but unfortunately, we are consistently receiving a 403 Forbidden error.
Could this mean that the API is still in a limited EAP and not yet available for all admin accounts on all sites, as the note in the documentation suggests? We have already requested to join the EAP in this thread and are looking forward to any updates.
Thanks again for your help!

[Bill Sheboy]

@Vadim_S -- As many of those endpoints are still listed as "experimental", did you add the additional header?

• Key: X-ExperimentalApi
• Value: opt-in

[Vadim_S]

Hi @Bill Sheboy ,

Thank you very much again for your help and expertise. We really appreciate you taking the time to guide us.

Following your advice, we conducted a thorough investigation, and it seems the issue is indeed related to EAP access. I wanted to share our findings, as it might be helpful for the community.

Here is a summary of our tests:

1. Direct API Call: We tried sending a GET request to the /rest/v1/rule endpoint using a standard API token from a Site Administrator account. We included the X-ExperimentalApi: opt-in header as you suggested. The result was consistently a 403 Forbidden error on two different Jira sites.

2. Forge App Approach: We then tried to build a Forge app. When we added the required scopes (read:automation:jira and manage:automation:jira) to the manifest.yml file, the forge deploy command failed with an Invalid 'scopes' permission error. The Forge linter did not recognize these scopes as valid, referencing the official public list of permissions where they are indeed absent.

This leads us to the firm conclusion that access to the Automation Rule Management API (and its corresponding Forge scopes) is strictly controlled and requires the Jira site to be explicitly added to the EAP.

Thank you again for pointing us in the right direction! Your advice helped us to conclusively identify the root cause.

Kind regards,
Vadim

[Bill Sheboy]

Thanks for the additional information, @Vadim_S 

I do not recall requesting addition to that EAP for my test site, but I have been able to call the endpoints from automation rules for weeks using an API token for the site admin (me).  That is, I am using the Send Web Request action in a rule to call the various endpoints.

If you are on a paid license, I recommend contacting support to ask for access to the EAP for your testing.

[Vadim_S]

Hi @Bill Sheboy 

I'm ashamed to admit it, but all my 403 Forbidden errors were caused by an incorrect URL in my GET requests.

I was using .../rest/v1/rule (like in the POST /rest/v1/rule request for creating a rule) instead of the correct .../rest/v1/rule/summary for listing the rules.

Thank you for your help – your responses made me intuitively feel that I was doing something wrong.

Also thanks to this whole story, I figured out how to make applications in Forge and re-learned the lesson that documentation needs to be read carefully.

Thanks again!