Automation Rule Management API is now Generally Available!

[#1]

Hi Atlassian Community,

In our previous post we announced our new Rule Management APIs available for testing. Today we’re excited to announce that the Automation Rule Management API has graduated from Early Access and is now Generally Available (GA) for all customers! 🎉

This release brings new capabilities for managing automation at scale, making it easier than ever for admins and developers to programmatically control rule configurations across your Jira sites

What’s new in GA?

• Developer documentation updated: Find the latest API details, usage patterns, and best practices in our developer documentation.
• Create connections via API: You can now create connections directly through the API, enabling more seamless integration with external systems.
• Create new labels on the fly: When creating or updating rules, you can now specify new labels that will be created automatically if they don’t already exist.
• Specify rule UUIDs: When creating a rule, you can provide a UUID. If it’s not already taken, it will be used for your new rule, making migrations and imports much simpler.

How does it work?

Here are some practical API use cases and examples to help you get started:

Import/Export a Rule

Export a rule using the “get a rule by UUID” API:

curl --request GET \
  --url '{baseSiteURL}/gateway/api/automation/public/jira/{cloudid}/rest/v1/rule/{ruleUuid}' \
  --header 'Accept: application/json' \
  --header 'Authorization: {authorisationToken}'

To import (clone) a rule, remove the uuid field from the payload if importing into the same site, then use:

curl --request POST \
  --url '{baseSiteURL}/gateway/api/automation/public/jira/{cloudid}/rest/v1/rule' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: {authorisationToken}' \
  --data '{ ... }'

Bulk Update Rule Scope

To update the scope of multiple rules (e.g., after creating a new project):

Search for rules by scope:

curl --request POST \
  --url '{baseSiteURL}/gateway/api/automation/public/jira/{cloudid}/rest/v1/rule/summary' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: {authorisationToken}' \
  --data '{ "scope": "ari:cloud:jira:{cloudId}:project/10001" }'

Update rule scope for each rule:

curl --request PUT \
  --url 'https://api.atlassian.com/automation/public/{product}/{cloudid}/rest/v1/rule/{ruleUuid}/rule-scope' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: {authorisationToken}' \
  --data '{ "ruleScopeARIs": [ "ari:cloud:jira:{cloudId}:project/10001", "ari:cloud:jira:{cloudId}:project/{newProjectId}" ] }'

Update Rules in Bulk

To update a set of rules (e.g., after a field rename):

Search for rules by trigger:

curl --request POST \
  --url '{baseSiteURL}/gateway/api/automation/public/jira/{cloudid}/rest/v1/rule/summary' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: {authorisationToken}' \
  --data '{ "trigger": "jira.incoming.webhook" }'

For each rule, fetch details, edit as needed, and update:

curl --request PUT \
  --url 'https://api.atlassian.com/automation/public/{product}/{cloudid}/rest/v1/rule/{ruleUuid}' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{ "rule": {updatedRuleConfig} }'

Get Started

Check out the developer documentation for how to get started.

We want your feedback!

Have questions or want to share how you’re using the API? Drop your thoughts in the comments below. Your feedback helps us shape future improvements.

Thanks for being part of the Atlassian Community!

[Bill Sheboy]

Hi @Scott Bell 

Thank you for the updated information.  I have a couple of questions:

What can you share on progress to create endpoints and webhooks for accessing automation audit logs?

While there is some older documentation for Data Center on component types and structure in rule JSON, there is nothing newer or for Cloud's Jira, Confluence, and JSM automation.  As a result, customers must first create many example rules and analyze them to identify the content to use for endpoints to create / update rules.  What can you share on plans to create such documentation to support using the endpoints?

Kind regards,
Bill