APIReferenz
Alert Rules API
Generierte OpenAPI-Referenz für die Alert Rules-API-Oberfläche.
Überblick
Alert Rules-Endpoints gehören zur öffentlichen Everyn-API. Event-based alert rules and public-safe alert delivery inspection.
Endpunkte
Die generierte OpenAPI-Komponente unten enthält Request-Parameter, Request Bodies, Response Bodies, Statuscodes und Schemas für dieses Tag.
Endpoint-Zusammenfassung für den schnellen Überblick vor der generierten Referenz:
Fehler nutzen die PublicErrorEnvelope-Form mit einem X-Request-Id-Header. Die meisten Endpoints unten liefern 400, 401, 403, 404, 409, 422, 429; die wenigen Abweichungen listen ihre eigenen Statuscodes in der Tabelle, die sonst nur Erfolgs-Responses zeigt. Siehe API-Fehler für Envelope und Recovery-Muster.
| Methode | Pfad | Zusammenfassung | Request Body | Erfolgs-Response |
|---|---|---|---|---|
GET | /v1/alert-deliveries | List Alert Deliveries | Keine. | 200 application/json: Page_AlertDeliveryResponse_ |
GET | /v1/alert-rules | List Alert Rules | Keine. | 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 | Keine. | 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 | Keine. | 200 application/json: AlertRuleResponse |
API-Referenz wird geladen...