REST API Changelog

4 October 2023

added Manual rules API

Released the API for search and invoke "manual" rule.

Manual rules can be fetched and invoked for one or more objects. Initially only issue and alert objects are supported.

10 December 2024

updated Changes in the response payload of Create a rule from a template API

The numeric ruleId property in the response of the "Create a rule from a template" API is deprecated and replaced with ruleUuid property, which is a string in UUID V7 format. The ruleId property will be removed in Jan 2025.

16 June 2025

added Rule Management API

Released an experimental API for rule management operations, such as creating, updating, and searching for rules.

For the initial release, searching for rule summaries only supports filtering by trigger, rule state, and rule scope (single ARI).

1 August 2025

deprecation notice Breaking change for cursor pagination

We're introducing a breaking change to the cursor pagination links returned in the response body of Automation API endpoints. Currently, the links object in the response body of the search APIs contain absolute links to the next page of results, for example https://example.com/public/search/?cursor=bbbbbb&limit=2. As of August 11th, 2025, this will change to only return the query parameters, for example ?cursor=bbbbbb&limit=2.

29 August 2025

announcement Rule Management APIs enter GA

Rule management APIs are no longer experimental and are now generally available. Rule connections can now be created on rule write operations.