APIReference
Alert Rules API
Generated OpenAPI reference for the Alert Rules API surface.
Overview
Alert Rules endpoints are part of the public Everyn API. Event-based alert rules and public-safe alert delivery inspection.
Endpoints
The generated OpenAPI component below contains request parameters, request bodies, response bodies, status codes, and schemas for this tag.
Endpoint summary for quick scanning before using the generated reference:
Failures use the PublicErrorEnvelope shape with an X-Request-Id header. Most endpoints below return 400, 401, 403, 404, 409, 422, 429; the few that differ list their own statuses in the table, which otherwise shows only success responses. See API errors for the envelope and recovery patterns.
| Method | Path | Summary | Request body | Success response |
|---|---|---|---|---|
GET | /v1/alert-deliveries | List Alert Deliveries | None. | 200 application/json: Page_AlertDeliveryResponse_ |
GET | /v1/alert-rules | List Alert Rules | None. | 200 application/json: Page_AlertRuleResponse_ |
POST | /v1/alert-rules | Create Alert Rule | application/json: AlertRuleCreateRequestBody | 201 application/json: AlertRuleResponse |
GET | /v1/alert-rules/{alert_rule_id} | Get Alert Rule | None. | 200 application/json: AlertRuleResponse |
PATCH | /v1/alert-rules/{alert_rule_id} | Update Alert Rule | application/json: AlertRuleUpdateRequestBody | 200 application/json: AlertRuleResponse |
DELETE | /v1/alert-rules/{alert_rule_id} | Delete Alert Rule | None. | 200 application/json: AlertRuleResponse |
Loading API reference...