API-Endpoints Übersicht

Überblick über alle verfügbaren API-Endpunkte (die einzelnen URLs der REST-API, die Sie aufrufen). Basis-URL: https://epulz.io/api/v1

Autorisierung: senden Sie den Header Authorization: Bearer epulzio_.... Das Anfragelimit (Rate Limit) beträgt 60 Anfragen pro Minute und Token. Einen Token erzeugen Sie unter Einstellungen -> API-Tokens.

Status / Token-Prüfung

• GET /status - prüft den Token, gibt E-Mail, Tarif, Anzahl der Monitore und Anzahl der offenen Vorfälle zurück.

Monitore

• GET /monitors - Liste aller Ihrer Monitore (einschließlich Verfügbarkeit der letzten 24 h).
• GET /monitors/{id} - Details eines einzelnen Monitors.
• POST /monitors - erstellt einen neuen Monitor. Senden Sie im Anfragetext (JSON) die Felder name, type, target, interval_minutes, expected_status, expected_keyword, forbidden_keyword.
• POST /monitors/bulk - Massenimport (höchstens 200 Monitore in einer Anfrage).
• PATCH /monitors/{id} - Bearbeitung eines bestehenden Monitors (senden Sie nur die Felder, die Sie ändern möchten).
• POST /monitors/{id}/check - startet eine sofortige Prüfung außerhalb des geplanten Intervalls; gibt den aktualisierten Monitor zurück.
• GET /monitors/{id}/uptime?days=30 - Verfügbarkeit in % über die letzten N Tage (1-365, standardmäßig 30); Wartungsfenster sind ausgenommen.
• DELETE /monitors/{id} - löscht den Monitor (samt Prüf- und Vorfallverlauf).

Prüfungen (Verlauf)

• GET /monitors/{id}/checks?limit=100 - die letzten N Prüfungen eines Monitors (Status, Antwortzeit, HTTP-Statuscode, etwaiger Fehler, Region). Der Parameter limit kann 1 bis 500 sein, standardmäßig 50.

Vorfälle

• GET /incidents - Liste der Vorfälle. Optionale Filter: monitor_id, resolved (true/false), limit (1-500, standardmäßig 50).

Fehlercodes

• 401 - fehlender oder ungültiger Token.
• 403 - Monitorlimit Ihres Tarifs überschritten (beim Erstellen).
• 404 - der Monitor gehört nicht Ihnen oder existiert nicht.
• 429 - Anfragelimit überschritten (60 pro Minute und Token).

Maschinenlesbare Dokumentation

Die vollständige Spezifikation im OpenAPI-Standard ist unter /api/openapi.json verfügbar. Die interaktive Dokumentation, in der Sie die Endpunkte direkt ausprobieren können (Swagger UI), finden Sie unter /api/docs. Beide erfordern eine Anmeldung oder einen gültigen Token.