Alert Rules
Alert rule management
List alert rule types
Required Permissions: None (authentication only)
List all available alert rule types with their configuration metadata
List alert rule types › Responses
Alert rule types retrieved successfully
categoryconfigdescriptiongranularityhouseinternalmanaged_bynametiertype_idGet alert rule type config metadata
Required Permissions: None (authentication only)
Get configuration metadata for a specific alert rule type by its type ID
path Parameters
alert_rule_type_idAlert Rule Type ID
Get alert rule type config metadata › Responses
Alert rule type config metadata retrieved successfully
categoryconfigdescriptiongranularityhouseinternalmanaged_bynametiertype_idGet all alert rules
Create a new alert rule
Required Permissions:
alert_rule:write
Create a new alert rule with the provided details
path Parameters
organization_idOrganization ID
Create a new alert rule › Request Body
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object | |
| type = object |
Create a new alert rule › Responses
Alert rule created successfully
activecreated_atdescriptionidmanaged_bynameorganization_idpipeline_idsseveritytypeupdated_atGet alert rule by ID
Required Permissions:
alert_rule:read
Retrieve an alert rule by its ID
path Parameters
organization_idOrganization ID
alert_rule_idAlert Rule ID to retrieve
Get alert rule by ID › Responses
Alert rule retrieved successfully
activecreated_atdescriptionidmanaged_bynameorganization_idpipeline_idsseveritytypeupdated_atUpdate alert rule
Required Permissions:
alert_rule:write
Update an existing alert rule
path Parameters
organization_idOrganization ID
alert_rule_idAlert Rule ID to update
Update alert rule › Request Body
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object | |
| type = object |
Update alert rule › Responses
Alert rule updated successfully
activecreated_atdescriptionidmanaged_bynameorganization_idpipeline_idsseveritytypeupdated_at