Skip to main content

get_rule_list

Get all automation rule configurations for this tenant. Rules define automatic actions triggered by events.
Property
Read-onlyYes

Parameters

None.

Returns

A list of ConfigRule objects with rule details including ID, name, and trigger configuration.

create_rule

Create a new automation rule.
Property
Read-onlyNo

Parameters

ParameterTypeRequiredDescription
namestringYesRule name.

Returns

The created ConfigRule. Requires super admin.

update_rule

Update an existing automation rule. Only provided fields are updated.
Property
Read-onlyNo

Parameters

ParameterTypeRequiredDescription
ruleIdstringYesThe rule ID. Use get_rule_list.
namestringNoNew rule name.

Returns

The updated ConfigRule. Requires super admin.

delete_rule

Delete an automation rule.
Property
Read-onlyNo

Parameters

ParameterTypeRequiredDescription
ruleIdstringYesThe rule ID. Use get_rule_list.

Returns

A confirmation message. Requires super admin.