API-Monitoring

Mit API-Monitoren prüfen Sie automatisch, ob Ihre API-Endpunkte erreichbar sind, performant antworten und die richtigen Daten zurückgeben. So stellen Sie sicher, dass Ihre Anwendungen und Integrationen wie vorgesehen funktionieren.

Wie bei anderen Monitoren können Sie, wenn ein API-Monitor ein Problem erkennt, gemeinsam mit Ihrem Team den Vorfall beheben und optional Ihre Statusseite aktualisieren.

Wichtigste Funktionen

• Testen Sie Ihre API-Endpunkte alle 30 Sekunden von verschiedenen Standorten weltweit.
• Prüfen Sie HTTP-Statuscodes, JSON-Body, Header und Antwortzeiten.
• Fügen Sie eigene Header, Query-Parameter oder JSON-Payloads hinzu.
• Werden Sie sofort benachrichtigt, wenn ein Endpunkt ausfällt, langsam ist oder unerwartete Ergebnisse liefert.
• Nutzen Sie Slack, E-Mail, SMS, Telefonanrufe, Webhooks und mehr.

Ihren ersten API-Monitor hinzufügen

Um einen Monitor zu erstellen, gehen Sie zu Ihrem Projekt → Monitore → Monitor hinzufügen.

Monitortyp

Wählen Sie API als Monitortyp.

Geben Sie die Endpunkt-URL ein, die Sie überwachen möchten – zum Beispiel
https://api.ihrservice.com/v1/users.

Request-Konfiguration

Sie können Ihre API-Anfrage vollständig anpassen:

• HTTP-Methode: GET, POST, PUT, PATCH, DELETE, OPTIONS oder HEAD
• Body: Senden Sie JSON, Formulardaten, GraphQL oder Klartext mit Ihrer Anfrage
• Auth: Fügen Sie Basic Authentication, einen API-Schlüssel oder einen Bearer-Token hinzu
• Query-Parameter: Hängen Sie Schlüssel-Wert-Paare an Ihre Anfrage-URL an
• Header: Fügen Sie eigene Header hinzu, die für Ihre API-Anfrage nötig sind

Monitor ist erfolgreich, wenn

Ein API-Monitor ist erfolgreich, wenn alle festgelegten Prüfungen erfüllt sind.
Sie können eine oder mehrere der folgenden Prüfungen festlegen:

• Statuscode: z. B. Antwort ist 200 OK
• Antwortzeit: z. B. unter 1 Sekunde
• Body enthält: z. B. "success": true
• JSON-Pfad: z. B. data.status ist gleich "active"
• Header enthält: z. B. Content-Type: application/json

Wird eine dieser Bedingungen nicht erfüllt, wird der Monitor als ausgefallen markiert und Alarme werden gemäß Ihren Alarmeinstellungen gesendet.

Erweiterte Einstellungen

• Anzeigename: Geben Sie Ihrem Monitor einen aussagekräftigen Namen zur leichteren Identifikation.
• Prüfungen ausführen alle: Legen Sie fest, wie häufig der Endpunkt getestet wird.
• Ausführen von: Wählen Sie die Teststandorte (Vereinigte Staaten, Kanada, Europa, Asien).
• Zur Statusseite hinzufügen: Zeigen Sie Verfügbarkeit und Antwortstatistiken der API öffentlich an.
• Wenn ein Monitor ausfällt: Erstellen Sie einen Vorfall, benachrichtigen Sie Abonnenten oder veröffentlichen Sie auf Ihrer Statusseite.
• Wenn sich ein Monitor erholt: Lösen Sie Vorfälle und aktualisieren Sie Ihre Statusseite automatisch.