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. The static summary keeps the endpoint purpose, authentication, schema names, and API error guidance available before the interactive reference loads.
The details below are static HTML generated from the same OpenAPI schema, so they remain readable without client-side JavaScript. The interactive component after this section provides expandable examples and richer schema browsing.
Endpoint summary for quick scanning before using the generated reference:
| Method | Path | Purpose | Authentication | Request body / schema | Success response / schema | Errors |
|---|---|---|---|---|---|---|
GET | /v1/alert-deliveries | List Alert Deliveries | Bearer token (BearerAuth) | None. | 200 application/json: Page_AlertDeliveryResponse_ | API errors: 400, 401, 403, 404, 409, 422, 429 |
GET | /v1/alert-rules | List Alert Rules | Bearer token (BearerAuth) | None. | 200 application/json: Page_AlertRuleResponse_ | API errors: 400, 401, 403, 404, 409, 422, 429 |
POST | /v1/alert-rules | Create Alert Rule | Bearer token (BearerAuth) | application/json: AlertRuleCreateRequestBody | 201 application/json: AlertRuleResponse | API errors: 400, 401, 403, 404, 409, 422, 429 |
GET | /v1/alert-rules/{alert_rule_id} | Get Alert Rule | Bearer token (BearerAuth) | None. | 200 application/json: AlertRuleResponse | API errors: 400, 401, 403, 404, 409, 422, 429 |
PATCH | /v1/alert-rules/{alert_rule_id} | Update Alert Rule | Bearer token (BearerAuth) | application/json: AlertRuleUpdateRequestBody | 200 application/json: AlertRuleResponse | API errors: 400, 401, 403, 404, 409, 422, 429 |
DELETE | /v1/alert-rules/{alert_rule_id} | Delete Alert Rule | Bearer token (BearerAuth) | None. | 200 application/json: AlertRuleResponse | API errors: 400, 401, 403, 404, 409, 422, 429 |
Loading API reference...