Anwendungsfall · API-Monitoring

API-Monitoring

APIs fallen selten komplett aus. Sie liefern Fehler im Inhalt, werden langsam oder lehnen Tokens ab. UptimeShield prüft deshalb Antwort und Inhalt, nicht nur die Erreichbarkeit.

  • Kostenlos starten
  • DSGVO · Made in Germany
  • In 30 Sekunden eingerichtet
6
Monitore im kostenlosen Tarif
5 Min.
kürzestes Prüfintervall (Pro)
2
Messstandorte je Monitor (Pro)
180 Tage
Verlauf im Tarif Pro
Kurz erklärt

API-Monitoring prüft einen oder mehrere Endpunkte regelmäßig von außen. Der API/JSON-Monitor von UptimeShield ruft den Endpunkt auf, bewertet den Statuscode und kontrolliert einen Wert an einem JSON-Pfad mit einem Operator (exists, eq, neq, contains, gt oder lt). Zugangs-Header werden verschlüsselt gespeichert.

Das Problem

Typische API-Ausfälle

APIs fallen selten laut aus. Meist antworten sie freundlich mit 200 und liefern trotzdem das Falsche, zu spät oder gar nichts Brauchbares.

5xx-Fehler

Der Server meldet einen internen Fehler. Das ist der klare Fall, den fast jeder Monitor erkennt.

Timeouts und Latenz

Die API antwortet, aber nach Sekunden. Clients laufen in Timeouts, ohne dass es einen Fehlercode gibt.

Auth-Fehler

Ein abgelaufenes Token oder geänderte Rechte führen zu 401 oder 403, obwohl der Dienst läuft.

200 mit falschem Inhalt

Der Statuscode ist in Ordnung, aber die Antwort enthält einen Fehlertext, ein leeres Array oder veraltete Daten.

Die Lösung

Wie UptimeShield APIs prüft

UptimeShield prüft nicht nur, ob die API antwortet, sondern was sie antwortet und wie schnell.

JSON-Pfad mit Operator

Prüfen Sie einen Wert, zum Beispiel status gleich ok oder queue.length kleiner als 100. Operatoren: exists, eq, neq, contains, gt, lt.

Eigene Header

Bis zu 8 Header, etwa Authorization oder X-API-Key, werden verschlüsselt gespeichert. Nutzen Sie dafür ein Token mit reinen Leserechten.

Langsam-Schwelle

Legen Sie fest, wann eine Antwort zu langsam ist. Der Verlauf zeigt Median, p95 und Durchschnitt.

Alarm mit Bestätigung

Ein Alarm entsteht erst nach 2 Fehlschlägen in Folge. Wiederherstellung wird ebenfalls gemeldet, per E-Mail, Webhook oder Chat.

Mehrere Messstandorte

Ab Pro prüfen bis zu 2 Standorte, Max bis zu 3 je Monitor. Die Mehrheit entscheidet, offline gemeldete Standorte werden ausgeschlossen.

Abläufe (Max)

Der Mehrschritt-Monitor führt bis zu 8 Anfragen nacheinander aus und gibt Werte aus früheren Antworten weiter, zum Beispiel ein Token.

Im Alltag

Beispiele aus der Praxis

Vier Fehlerbilder aus dem API-Betrieb und wie der Monitor sie erkennt.

  1. 1

    Health-Endpunkt

    Der Endpunkt /health liefert {"status":"ok"}. Der Monitor erwartet genau das und meldet, wenn der Wert „degraded“ lautet.

  2. 2

    Warteschlange läuft voll

    Der Wert queue.length steigt. Ein gt-Operator meldet, sobald er einen Grenzwert überschreitet.

  3. 3

    Token abgelaufen

    Die API antwortet 401. Der Monitor schlägt fehl, bevor Kunden-Clients ausfallen.

  4. 4

    Langsame Antwort nach Release

    Die Antwortzeit steigt von 120 auf 900 ms. Der Verlauf zeigt den Sprung zum Zeitpunkt des Deployments.

So starten Sie

Einrichtung in vier Schritten

Ein Endpunkt, ein erwarteter Wert, ein Alarm.

  1. 1

    Monitor vom Typ API/JSON anlegen

    URL, Methode und erwarteten Statuscode angeben.

  2. 2

    JSON-Pfad festlegen

    Pfad, Operator und Vergleichswert eintragen, zum Beispiel status eq ok.

  3. 3

    Header hinterlegen

    Falls nötig, Token als Header eintragen (Leserechte genügen).

  4. 4

    Alarm und Schwelle

    Kanäle wählen und die Langsam-Schwelle in Millisekunden festlegen.

Kostenlos starten Erst die Website prüfen

Ehrlich gesagt

Was API-Monitoring hier nicht ist

Gutes Monitoring sagt, was es kann und was nicht. So wissen Sie, worauf Sie sich verlassen können.

  • Es ist kein APM und kein Lasttest. Geprüft wird die Antwort, nicht Datenbank, Code oder Durchsatz.

  • Bewertet wird nur die ausgelieferte Antwort, nicht die Korrektheit der dahinterliegenden Daten.

  • Mehrstufige Abläufe mit Anmeldung gehören zum Mehrschritt-Monitor im Tarif Max. Zwei-Faktor-Verfahren und Captchas sind nicht prüfbar.

Tarife

Welcher Tarif passt?

Der API/JSON-Monitor ist in allen Tarifen enthalten, auch im kostenlosen Solo (6 Monitore, Intervall ab 30 Minuten). Wer jede Minute prüfen, mehrere Standorte nutzen oder Chat-Kanäle verbinden will, wählt Pro. Mehrschritt-Abläufe gibt es im Tarif Max.

Solo

kostenlos
  • 6 Monitore
  • Intervall ab 30 Min.
  • 30 Tage Verlauf

Pro

ab 7,90 € / Monat
  • 35 Monitore
  • Intervall ab 5 Min.
  • 2 Messstandorte, 180 Tage Verlauf

Max

ab 24,90 € / Monat
  • 120 Monitore
  • Mehrschritt-Monitor, White-Label
  • 3 Messstandorte, 365 Tage Verlauf

Alle Tarife und Limits ansehen

Häufige Fragen

Reicht ein Status 200 als Gesundheitsprüfung?

Nein. Viele Fehler liefern 200 mit einem Fehlertext oder leeren Daten. Deshalb prüft der API/JSON-Monitor zusätzlich einen Wert im JSON, etwa status gleich ok.

Kann ich geschützte Endpunkte prüfen?

Ja, mit eigenen Headern wie Authorization oder X-API-Key. Sie werden verschlüsselt gespeichert und nicht im Klartext angezeigt. Verwenden Sie ein eigenes Token mit reinen Leserechten für den Monitor.

Welche Prüfintervalle gibt es?

1, 5, 10, 15, 30, 60 Minuten. Das kürzeste Intervall hängt vom Tarif ab: Solo ab 30, Pro und Max ab 5 Min.

Werde ich bei kurzen Aussetzern gleich alarmiert?

Nein. Erst nach 2 Fehlschlägen in Folge wird eine Störung gemeldet. Das verhindert Fehlalarme durch einzelne Ausreißer.

Kann ich Webhooks als Alarmkanal nutzen?

Ja, ab dem kostenlosen Tarif. Der Webhook sendet die Meldung als JSON und trägt eine HMAC-SHA256-Signatur, mit der Sie die Echtheit prüfen können (siehe Benachrichtigungen).

Kann ich Monitore per API anlegen?

Ja, ab Pro. Die REST-API legt Monitore an, wertet sie aus und liefert Berichte als JSON.

Website jetzt prüfen oder dauerhaft überwachen

Starten Sie mit einer Sofortprüfung. Für die dauerhafte Überwachung genügt ein kostenloses Konto.