API - Rule Rerun
Authentication required
Before calling this API, ensure you have a valid Bearer token. See API Authentication for how to obtain one.
The Rule Rerun API allows triggering the execution of specific scheduled rules for a past or current date.
Important
execution_date cannot be in the future and cannot be more than 30 days old (default limit).
Future dates are not allowed for rerun requests.
info
- Rule Scheduling: Rule execution is determined by the scheduled day configured within the detection rules. For example, if the rerun endpoint is called with the "date" set as 22nd of November, it will process the requested live rules scheduled to run on November 22nd, irrespective of the time of day.
- Multiple Reruns: Reruns for a valid past date can be requested multiple times and will always reprocess the requested rules, subject to guardrails.
- Schedule Enforcement: A rule that is not scheduled for the specified date will not execute regardless of how many times the rerun is requested.
Request Constraints
- The specified date must not be in the future (today is allowed).
- The specified date must not be older than 30 days.
- For same-day reruns, the rerun is only permitted after the rule's scheduled execution hour has passed. Reruns for a future hour on the current day are not allowed.
Limits
- A tenant may perform a maximum of 10 rule reruns per day.
- A single request may include up to 20% of the tenant's daily rule rerun quota.
- Standard API rate limits also apply:
- 5 requests per day
- 1 request per hour
note
These limits are default values and can be adjusted based on the tenant's specific transaction and rule volume needs.
Response Details
The response includes two lists:
accepted_rules: Rules that will be executed for the givenexecution_date.rejected_rules: Rules that will not be executed. Each rejection includes a reason - review these carefully.
Loading ...