Setting configuration properties

Platform Notice: Data Center Only - This article only applies to Atlassian products on the Data Center platform.

Note that this KB was created for the Data Center version of the product. Data Center KBs for non-Data-Center-specific features may also work for Server versions of the product, however they have not been tested. Support for Server* products ended on February 15th 2024. If you are running a Server product, you can visit the Atlassian Server end of support announcement to review your migration options.

*Except Fisheye and Crucible

Summary

Automation for Jira includes a number of configuration properties that let you check or change the default values related to various actions, conditions, and other items.

What permission do you need?

You need to be a Jira administrator to view or change the configuration properties.

Solution

Checking the current value

To check the property’s current value:

curl -u <user>:<password> http://<JIRA_BASE_URL>/rest/cb-automation/1/configuration/property/<PROPERTY_KEY>

Changing the value

To change the value:

curl -u <user>:<password> -X PUT -H 'Content-type: application/json' --data '{"key":"<PROPERTY_KEY>","value":"<VALUE>"}' http://<JIRA_BASE_URL>/rest/cb-automation/1/configuration/property/

For example:

curl -u admin:admin -X PUT -H 'Content-type: application/json' --data '{"key":"outgoing.webhook.timeout.ms","value":"50000"}' http://jira.atlassian.com:8080/jira/rest/cb-automation/1/configuration/property/

For Jira running on Windows server, you can use Invoke-webrequest. The script below was tested on Windows Server 2016:

$user = 'YOUR_USER_ADMIN'$pass = 'PASSWORD'$pair = "$($user):$($pass)"$encodedCreds = [System.Convert]::ToBase64String([System.Text.Encoding]::ASCII.GetBytes($pair))$basicAuthValue = "Basic $encodedCreds"$Headers = @{Authorization = $basicAuthValue}$Uri = 'http://YOURJIRABASEURL/rest/cb-automation/1/configuration/property/bulk'$Form = @{"ms.teams.notification.action.url.prefix"="https://"}Invoke-WebRequest -Uri $Uri -Method Put -Body ($Form|ConvertTo-Json) -ContentType "application/json" -Headers $Headers

List of properties

Here’s a list of properties that you might find useful. We’ll keep updating it.

CategoryProperty keyData typeDefault valueDescription
Project Admin permissionspermissions.project.admin.allowBooleantrueSpecifies whether project admins can manage automation rules.
Project Admin permissionspermissions.project.admin.groupsStringnullLets you limit project admins who can manage automation rules to specific groups only. The value contains a CSV list of groups.
Service limitsmax.issues.per.searchLong1000Limits the number of issues returned by the JQL search.
Service limitsmax.processing.time.per.dayLong3600Specifies how long the same rule is allowed to run per day. The value is in seconds.
Service limitsrule.rate.per.five.secondLong2Specifies how many times the same rule can be executed during a 5-second time window.
Service limitsmax.rules.per.hourLong5000Specifies the maximum number of times the same rule can be executed per hour.
Service limitsmax.queued.items.per.ruleLong25000Specifies the maximum number of executions that can be queued for the same rule.
Service limitsmax.queued.itemsLong100000Specifies the maximum number of items in the automation queue.
Service limitsaggressive.timeout.thresholdLong30000Specifies the maximum rule execution time. After this time, the rule is reported as causing timeouts. The value is in milliseconds.
Service limitsshort.scheduled.interval.issue.limitLong1000Limits the number of issues returned by the JQL search in the scheduled trigger.
Service limitsbranch.rule.immediate.priority.item.limitLong10Specifies the maximum number of branch executions with immediate priority.
Service limitsaudit.log.retention.period.daysLong90Specifies how long audit log entries are kept for a rule. The value is in days.
Action and condition specificoutgoing.webhook.timeout.msLong30000HTTP timeout for outgoing webhooks. The value is in milliseconds.
Action and condition specificuser.condition.get.users.limitInteger50Specifies the maximum number of users that can be retrieved from a single role in the User condition.

Updated on May 31, 2024

Still need help?

The Atlassian Community is here for you.