STP Rules
API Reference
DraftLast reviewed 2026-06-23Straight-Through Processing threshold rule management
Get STP rule by ID
Returns a single STP rule by its identifier, regardless of enabled status.
Update STP rule
Updates all fields of an existing STP rule and reloads the in-memory rule cache.
Disable STP rule
Sets the rule's enabled flag to false and reloads the in-memory rule cache. The rule record is retained in the database.
Reorder STP rules
Persists a new order_index for each rule_id in the supplied list, starting at 1. Reloads the in-memory rule cache.
List enabled STP rules
Returns all currently enabled STP threshold rules ordered by rule ID.
Create STP rule
Persists a new STP threshold rule and reloads the in-memory rule cache.