Die PingMon REST-API
Automatisiere dein Monitoring: Monitore anlegen, Checks und Uptime auslesen, Wartungsfenster direkt aus der Deploy-Pipeline setzen. Eine API, ein stabiler Vertrag — für n8n, Grafana, GitHub Actions und eigene Skripte.
1. API-Key erstellen
Im Dashboard unter Einstellungen → API erzeugst du deinen Konto-Key. Er gilt für das ganze Konto — behandle ihn wie ein Passwort. Rotieren macht den alten Key sofort ungültig.
2. Ersten Request senden
Der Key wandert in den Header X-API-Key. Alle Antworten sind JSON, alle Zeitstempel ISO 8601 in UTC.
curl -H "X-API-Key: YOUR_API_KEY" https://pingmon.de/api/v1/status
3. Referenz erkunden
Alle Routen, Schemata und Beispiele findest du in der interaktiven Referenz — du kannst Requests direkt im Browser ausprobieren.
Beispiele
Monitor anlegen — der erste Check läuft sofort:
curl -X POST https://pingmon.de/api/v1/endpoints \
-H "X-API-Key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"name": "Shop API", "url": "https://shop.example.com/health"}'
Wartungsfenster aus der Deploy-Pipeline — keine Fehlalarme beim Rollout (z. B. als Schritt in GitHub Actions):
curl -X POST https://pingmon.de/api/v1/maintenance-windows \
-H "X-API-Key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"title": "Deploy v2.4.0",
"starts_at": "2026-07-12T22:00:00Z",
"ends_at": "2026-07-12T22:30:00Z"
}'
Ressourcen
| Route | Zweck |
|---|---|
/api/v1/endpoints | Monitore verwalten — anlegen, ändern, pausieren, löschen, Sofort-Check |
/api/v1/endpoints/{id}/checks | Check-Historie (neueste zuerst, Fenster je nach Tarif) |
/api/v1/endpoints/{id}/uptime | Tages-Uptime, lückenlos ein Eintrag pro Tag |
/api/v1/status | Live-Status aller Monitore — ideal für Dashboards (z. B. Grafana) |
/api/v1/summary | Konto-Zusammenfassung: gesamt / online / offline / Ø-Antwortzeit |
/api/v1/incidents | Ausfälle mit Beginn, Ende und Dauer — laufende zuerst |
/api/v1/maintenance-windows | Wartungsfenster — unterdrückt Alarme, erscheint auf der Statusseite |
/api/v1/account | Tarif, Limits und Verbrauch des Kontos |
Fehler-Format
Jeder Fehler kommt im selben Umschlag — mit stabilem Maschinen-Code zum Auswerten und einer lesbaren Meldung:
{
"error": {
"code": "endpoint_limit_reached",
"message": "Endpoint limit reached (5 on your current plan). Upgrade for more endpoints."
}
}
missing_api_key/invalid_api_key— 401, Header fehlt oder Key ungültigendpoint_limit_reached— 403, Tarif-Limit erreichtinvalid_url/interval_too_low— 400, Eingabe passt nicht zum Monitor-Typ bzw. Tarifrate_limited/check_cooldown— 429, kurz warten (Retry-After-Header beachten)not_found— 404, Ressource existiert nicht oder gehört nicht zu deinem Konto
Stabilität & Rate-Limit
v1 ist ein Vertrag: keine brechenden Änderungen, nur neue Felder und Routen. Brechendes käme als /api/v2. Pro API-Key sind 120 Requests pro Minute frei — genug für Dashboards im Sekundentakt.
Der API-Key hat Vollzugriff auf dein Monitoring-Konto (ohne Abrechnung & Konto-Verwaltung — die bleiben bewusst API-frei). In Team-Konten sehen nur Admins und der Inhaber den Key.