Free tools Windows power users keep installed
One-click scans. No signup required.
Use Atlassian’s Automation REST API to find, inspect, create, update, enable, disable, or change the scope of Jira Automation rules. Its manual-rule endpoints separately let an integration find and invoke a manual rule for Jira objects. The API requires the correct product and cloud ID in its base path, and the caller must have the relevant product permissions. Atlassian’s documented summary endpoints support cursor-and-limit pagination, but the available reference does not establish a universal numeric page-size maximum, request-rate quota, or plan-based execution allowance.
Which Jira API should you use?
Atlassian calls the Automation REST API the primary way to get and modify Automation data across products. Use it for Automation rule configuration and manual-rule operations. Jira Cloud platform REST API v3 is the broader API for Jira resources such as issues and other platform data; use the endpoint for the Jira resource you need rather than treating the two APIs as interchangeable.
As an Amazon Associate I earn from qualifying purchases.
Atlassian’s Rule management reference documents the rule operations below. For general Jira platform resources, see the Jira Cloud platform REST API v3 reference.
What’s actually slowing this PC down?
Pick the symptom - the matching free tool is one click away.
Set the Automation API base path
Atlassian documents two base paths. Replace {product} with jira for Jira, and {cloudid} with the cloud ID for the site you are targeting:
#1 Best Overall
https://api.atlassian.com/automation/public/{product}/{cloudid}https://{sitename}/gateway/api/automation/public/{product}/{cloudid}
The cloud ID identifies the site’s cloud tenant. Atlassian says it can be found through the site’s /_edge/tenant_info endpoint. See Atlassian’s Automation API paths documentation for the base-path details.
Authentication and permissions
The api.atlassian.com base path accepts API tokens. The site-specific gateway path can also be used with browser session cookies. Authentication alone does not guarantee access: authorization is based on the caller’s relevant product permissions. Atlassian’s API introduction covers authentication and authorization.
Rule-management endpoints
Append one of these paths to the Automation API base path. The rule-management reference documents each operation:
Do these 3 things before closing this tab:
1Scan for outdated or missing drivers - takes under a minute2Repair Windows errors before they cause bigger problems3Fix the driver behind crashes, sound loss and screen glitches| Method and path | What it does |
|---|---|
GET /rest/v1/rule/summary |
Lists rule summaries. |
POST /rest/v1/rule/summary |
Searches summaries using fields such as trigger, state, scope, author, cursor, and limit. At least one of trigger, state, scope, or limit must be supplied. |
POST /rest/v1/rule |
Creates a rule. If you supply a UUID, it must be unique and UUIDv7. |
GET /rest/v1/rule/{ruleUuid} |
Retrieves a rule configuration by UUID. |
PUT /rest/v1/rule/{ruleUuid} |
Updates a rule. |
DELETE /rest/v1/rule/{ruleUuid} |
Deletes a disabled rule. |
PUT /rest/v1/rule/{ruleUuid}/state |
Enables or disables a rule. |
PUT /rest/v1/rule/{ruleUuid}/rule-scope |
Changes a rule’s scope. |
Check the reference for the request and response schema for the operation you intend to call. One integration caveat is that Forge and OAuth2 apps cannot access several rule-management resources, including summary listing and search, rule creation, and rule retrieval. Verify access restrictions for the specific operation and authentication model before designing an app integration. The response’s links field has a deprecation notice: it now returns query parameters rather than absolute links.
Manual-rule search and invocation
Manual rules have their own endpoints; invoking one is not the same as running a scheduled or event-triggered rule. The manual-rules reference documents:
POST /rest/v1/rule/manual/searchto search available manual rules.POST /rest/v1/rule/manual/{ruleId}/invocationto invoke a manual rule.
An invocation request can include target objects and typed user inputs. This is useful when an external integration needs to find an available manual rule and invoke it for specified Jira objects. See Atlassian’s Manual rules reference for the operation details.
Independent reader supportYour contribution helps us test, update, and keep practical guides available for everyone.What is known about API limits?
The summary endpoints expose cursor and limit parameters. Atlassian explains that response sizing helps limit payload size and conserve server resources, so integrations should paginate and honor the paging information returned by the API rather than assume a single response contains every rule.
Recommended Free Tools
The cited Automation API material does not establish a universal numeric maximum page size, an API-wide request-rate quota, or plan-based Automation execution allowances. These are separate limits: pagination controls the size of a response; throttling concerns how frequently an API can be called; execution allowances concern how often Automation rules can run under a product plan. Do not infer one from another. Check current Atlassian documentation and the relevant site’s plan or usage information before relying on a numeric quota.
Choose the operation that matches the job
- Inventory or discover rules: list summaries or search them by supported fields such as state, trigger, scope, or author. Use cursor-based pagination for multi-page results.
- Review or manage configuration: retrieve a rule by UUID, then use the documented create or update operation as appropriate.
- Administer rule availability: change a rule’s state or scope. Deletion is documented for disabled rules.
- Run an available manual workflow for objects: search manual rules, then call the invocation endpoint with the relevant target objects and configured inputs.
- Work with other Jira data: use the relevant Jira Cloud platform API endpoint rather than a rule-management endpoint.
These uses follow from the documented operations; the references do not promise particular performance, delivery guarantees, or suitability for every deployment.
Quick Recap
Product prices and availability are accurate as of the date/time indicated and are subject to change. Any price and availability information displayed on Amazon at the time of purchase will apply.
