Rules API
Create, update, and manage alert rules.List Rules
Parameters
| Parameter | Type | Description |
|---|---|---|
source | string | Filter by source |
severity | string | Filter by severity |
enabled | boolean | Filter by enabled status |
Response
Create Rule
Request
Parameters
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Rule name |
source | string | Yes | Data source: flux, pulse, reflex, recall |
source_name | string | Yes | Metric/event name |
rule_type | string | Yes | threshold, anomaly, absence, composite |
operator | string | Threshold | gt, gte, lt, lte, eq |
threshold | number | Threshold | Threshold value |
deviation | number | Anomaly | Standard deviations |
window | string | Yes | Evaluation window |
severity | string | Yes | info, warning, critical |
notify_channels | array | No | Channel IDs to notify |
tags | object | No | Rule tags |
enabled | boolean | No | Enable rule (default: true) |
Response
Get Rule
Update Rule
Request
Delete Rule
Mute Rule
Temporarily disable a rule:Request
Unmute Rule
Enable/Disable Rule
Errors
| Code | Description |
|---|---|
rule_not_found | Rule does not exist |
invalid_rule_type | Invalid rule type |
invalid_source | Invalid data source |
invalid_operator | Invalid operator for rule type |