Neu: Temperatur, Lüfter, Netzteile und SSD-Zustand je Server. Hardware-Gesundheit ansehen

Kostenlos testen

Über die Schnittstellen von PeakNode binden Sie Ihr Ticket-System an, bauen eigene Auswertungen und legen Monitore automatisch an, zum Beispiel aus einem Deployment-Skript. Dafür gibt es eine REST-API, einen Export im Prometheus-Format und Webhooks, die Ereignisse an Ihr System senden.

Darstellung: Der Agent sendet nur nach außen über Port 443. Mit der Maus drehbar.

Was ist API und Webhooks?

Die API von PeakNode ist eine REST-Schnittstelle unter /api, die mit einem API-Schlüssel per Bearer-Authentifizierung arbeitet. Über sie lassen sich Uptime-Monitore, Heartbeats, Server-Monitore, DNS-Monitore, Domains, Statusseiten, Kanäle, Wartungsfenster und Vorfälle abrufen und verwalten. Ein eigener Endpunkt liefert die aktuellen Werte im Prometheus-Format. Webhooks gehen den umgekehrten Weg: PeakNode sendet bei einem Ereignis einen POST-Request an Ihre URL.

Vier Wege zu Ihren Daten

Verwalten über die REST-API, Messwerte über Prometheus, Ereignisse über Webhooks, Listen über den Export.

Anmeldung mit einem API-Schlüssel

Jedes Konto hat einen API-Schlüssel, zu finden im Konto unter „API“ und dort neu erzeugbar. Er wird als Authorization: Bearer im Header gesendet. Der Schlüssel gilt für das ganze Konto, abgestufte oder nur lesende Schlüssel gibt es nicht. Behandeln Sie ihn wie ein Passwort.

Monitore automatisch anlegen und verwalten

Uptime-Monitore, Heartbeats, Server-Monitore, DNS-Monitore, Domains, Statusseiten, Benachrichtigungskanäle, Projekte und Wartungsfenster lassen sich auflisten, einzeln abrufen, anlegen, ändern und löschen. Ein Deployment-Skript kann so den Monitor für einen neuen Server gleich mit anlegen. Jede Änderung über die API steht im Änderungsprotokoll.

Vorfälle lesen und bestätigen

Vorfälle lassen sich filtern, abrufen, kommentieren und über POST /api/incidents/{incident_id}/acknowledge bestätigen. Das entspricht „Ich kümmere mich“ im Portal und stoppt Erinnerungen und Eskalation, ein Ticket-System meldet so die Übernahme zurück. Vorfälle gibt es zu Uptime-Monitoren und Heartbeats: Ein Server-Monitor, der offline ist, hat keinen Vorfall und lässt sich nur im Portal oder aus der Alarm-E-Mail bestätigen.

Messwerte für Prometheus

GET /api/metrics liefert die aktuellen Werte des Kontos im Textformat von Prometheus: Uptime-Monitore, Heartbeats, Server-Monitore mit GPUs, Restlaufzeiten von Domains und Zertifikaten, offene Vorfälle. Alle Metriken tragen das Präfix peaknode_. Unbekanntes wird weggelassen und nie als 0 gemeldet.

Webhooks für Ereignisse

Der Benachrichtigungskanal Webhook sendet bei jeder Meldung, die an ihn geht, einen POST-Request an Ihre URL, formularkodiert, mit dem User-Agent PeakNode/1.0: bei Alarm und Entwarnung ebenso wie bei Erinnerung, Eskalation, Grenzwert oder DNS-Änderung. Ist Ihr Server nicht erreichbar oder antwortet er mit 408, 425, 429 oder einem Fehler ab 500, wiederholt PeakNode die Zustellung über rund 4 Stunden und ergänzt das Feld original_datetime. Kommt die Verbindung zustande und bleibt nur die Antwort aus, wird nicht wiederholt, damit Ihr System nichts doppelt auslöst. Eine Signatur trägt der Request nicht.

Export und Import

Listen und Verläufe lassen sich als CSV oder JSON herunterladen, zum Beispiel die Prüfungen eines Monitors über einen gewählten Zeitraum. PDF entsteht über die Druckansicht des Browsers, ein fertiges PDF gibt es beim SLA-Bericht. Monitore, Heartbeats, Server-Monitore, DNS-Monitore und Domains lassen sich per CSV importieren. Welche Exportarten ein Konto nutzen kann, legt der Tarif fest.

Felder eines Webhooks bei einem Ausfall

Uptime-Monitor offline

FeldBeispielwertBedeutung
nameapi-prodName des Uptime-Monitors
targethttps://api.example.com/healthGeprüftes Ziel
is_ok00 = Ausfall, 1 = Entwarnung
errorVerbindung abgelehntGrund im Klartext, in der Sprache des Kontos
start_datetime2026-11-11 02:14:00Beginn des Vorfalls
incident_urlhttps://peaknode.de/incident/123Adresse des Vorfalls im Portal
datetime_timezoneUTCZeitzone aller Datumsfelder

Beispiel: Felder des Webhooks eines Uptime-Monitors, gesendet als formularkodierter POST-Request. Dazu kommen monitor_id und monitor_url, bei der Entwarnung end_datetime und length.

Ressourcen und Methoden

Die Endpunkte folgen einem Muster: GET listet oder liest, POST legt an oder ändert, DELETE löscht. Geändert wird per POST auf die Adresse des einzelnen Eintrags.

RessourceEndpunktMethoden
Uptime-Monitore/api/monitorsGET, POST, DELETE
Heartbeats/api/heartbeatsGET, POST, DELETE
Server-Monitore/api/server-monitorsGET, POST, DELETE. Die Antwort enthält den letzten Bericht je Server und je GPU
DNS-Monitore/api/dns-monitorsGET, POST, DELETE
Domains und SSL/api/domain-namesGET, POST, DELETE
Vorfälle/api/incidentsGET, POST für den Kommentar, POST auf /acknowledge zum Bestätigen, DELETE
Wartungsfenster/api/maintenance-windowsGET, POST, DELETE
Statusseiten/api/status-pagesGET, POST, DELETE
Benachrichtigungskanäle/api/notification-handlersGET, POST, DELETE
Projekte/api/projectsGET, POST, DELETE
Änderungsprotokoll/api/change-logGET
Prometheus-Export/api/metricsGET, Antwort als Text im Prometheus-Format

Basis-URL: https://peaknode.de/api. Listen nehmen page und results_per_page entgegen (feste Stufen von 10 bis 1.000, laut Dokumentation Vorgabe 25). Fehler kommen als JSON mit Statuscode, bei überschrittener Grenze 429. Der Prometheus-Export wird je Konto 15 Sekunden zwischengespeichert und nimmt 30 Abrufe je Minute an. Alle Parameter und Beispielantworten stehen in der API-Dokumentation.

Welche Felder ein Webhook je Ereignis sendet

Der Webhook überträgt die Daten des Ereignisses als einzelne Formularfelder. Ein Feld ohne Wert entfällt, zum Beispiel error, wenn kein Grund vorliegt. Bei den Meldungen eines Server-Monitors kommen nicht belegte Felder dagegen leer an.

EreignisFelder
Uptime-Monitor offline oder wieder onlinemonitor_id, name, target, is_ok, monitor_url, incident_url, start_datetime, bei Ausfall error, bei Entwarnung end_datetime und length
Heartbeat ausgeblieben oder wieder daheartbeat_id, name, is_ok, heartbeat_url, incident_url, start_datetime, bei Entwarnung end_datetime und length
Server-Monitor: Grenzwert, offline, online, Hardware-Ereignisserver_monitor_id, name, target, alert_metric, alert_metric_value, alert_rule, alert_trigger, alert_trigger_value, url. Bei offline und online steht der Zustand in alert_metric_value, die Felder zu Regel und Auslöser sind dann leer
Erinnerung oder Eskalation zu einem laufenden Ausfallmonitor_id, heartbeat_id oder server_monitor_id, name, target (nicht bei Heartbeats), event mit reminder oder escalation, start_datetime, url, bei Vorfällen incident_id, dazu reminder und reminders_max bzw. escalation_minutes
DNS-Änderungdns_monitor_id, name, target, url. Die einzelnen Änderungen stehen nicht im Webhook, sondern auf der verlinkten Seite
Ablauf von Domain oder Zertifikatdomain_name_id, name, target, expires_in_days, url, dazu die Felder mit whois_ bzw. ssl_ wie whois_end_datetime oder ssl_end_datetime

Jeder Request ist ein POST mit Content-Type: application/x-www-form-urlencoded und dem zusätzlichen Feld datetime_timezone mit dem Wert UTC. Die URL muss öffentlich erreichbar sein und http oder https verwenden. PeakNode wartet höchstens 5 Sekunden auf die Antwort.

In drei Schritten angebunden

Voraussetzung ist ein Tarif mit API-Zugang. Webhooks sind ein Benachrichtigungskanal und brauchen keinen API-Schlüssel.

  1. API-Schlüssel holen

    Im Portal im Konto unter „API“ den Schlüssel kopieren. Wer ihn dort neu erzeugt, macht den alten ungültig.

  2. Ersten Abruf senden

    Die Liste der Uptime-Monitore abrufen. {api_key} steht für Ihren Schlüssel.

    curl --request GET \
      --url 'https://peaknode.de/api/monitors/' \
      --header 'Authorization: Bearer {api_key}'
  3. Prometheus oder Webhook anbinden

    Für Messwerte den Eintrag unter scrape_configs in die prometheus.yml übernehmen. Für Ereignisse einen Benachrichtigungskanal vom Typ Webhook mit der URL Ihres Systems anlegen und am Monitor auswählen.

    scrape_configs:
      - job_name: peaknode
        scrape_interval: 60s
        scheme: https
        metrics_path: /api/metrics
        authorization:
          type: Bearer
          credentials: {api_key}
        static_configs:
          - targets: ['peaknode.de']

Hat PeakNode eine API, und wofür brauche ich sie?

Ja. Über die REST-API von PeakNode lassen sich Uptime-Monitore, Heartbeats, Server-Monitore, DNS-Monitore, Domains, Statusseiten, Benachrichtigungskanäle, Projekte, Wartungsfenster und Vorfälle abrufen und verwalten, etwa für eigene Auswertungen oder um Monitore automatisch anzulegen. Voraussetzung ist ein Tarif mit API-Zugang. Die Referenz mit allen Parametern steht in der API-Dokumentation.

Wie kommen Alarme in unser Ticket-System?

Über den Benachrichtigungskanal Webhook: PeakNode sendet bei einem Ereignis einen POST-Request mit den Feldern des Ereignisses als Formulardaten an Ihre URL. Bei einem Uptime-Monitor sind das unter anderem Name, Ziel, Zustand, Grund, Beginn und die Adresse des Vorfalls, bei der Entwarnung zusätzlich Ende und Dauer. Alle Zeiten sind UTC. Eine Signatur zur Prüfung der Herkunft sendet PeakNode nicht mit.

Wie bestätigt ein Ticket-System einen Vorfall?

Mit einem POST auf /api/incidents/{incident_id}/acknowledge. Als Person steht der Inhaber des API-Schlüssels am Vorfall, als Weg „über die API“. Ist der Vorfall schon bestätigt oder beendet, antwortet die API mit 409.

Wie authentifiziere ich mich an der API?

Mit dem API-Schlüssel Ihres Kontos, gesendet als Header Authorization: Bearer. Den Schlüssel finden Sie im Konto unter „API“. Er gilt für das ganze Konto, eine Zwei-Faktor-Pflicht betrifft ihn nicht.

Gibt es ein Rate-Limit?

Ja, 60 Requests in 60 Sekunden je API-Schlüssel. Jede Antwort nennt die Grenze und den Rest in den Headern X-RateLimit-Limit und X-RateLimit-Remaining. Darüber antwortet die API mit dem Statuscode 429. Der Prometheus-Export hat zusätzlich eine eigene Grenze von 30 Abrufen je Minute und Konto.

Kann ich die Messwerte in Prometheus übernehmen?

Ja. Der Endpunkt /api/metrics liefert die aktuellen Werte Ihres Kontos im Textformat von Prometheus, authentifiziert mit dem API-Schlüssel. Enthalten sind unter anderem Auslastung, Speicher, Temperatur und Leistung je GPU, CPU und RAM je Server, der Zustand von Monitoren und Heartbeats und die Restlaufzeit von Zertifikaten. Ein Abrufintervall von 60 Sekunden passt zum Takt der Prüfungen.

Kann ich über die API Messwerte der letzten Wochen abrufen?

Nein. Die API liefert je Server-Monitor den Stand des letzten Berichts, keine Zeitreihe. Für Verläufe gibt es zwei Wege: den Prometheus-Export regelmäßig abrufen und selbst speichern, oder die Daten im Portal für einen Zeitraum als CSV oder JSON exportieren.

Kann ich PeakNode-Werte in Grafana anzeigen?

Ja, über Prometheus: Ein Prometheus-Server ruft /api/metrics mit dem API-Schlüssel ab und speichert die Werte, Grafana zeigt sie mit Prometheus als Datenquelle an. Ein fertiges Grafana-Dashboard liefert PeakNode nicht mit. Ohne Grafana stehen die Messwerte im Portal, etwa beim GPU-Server-Monitoring.

PeakNode an die eigenen Werkzeuge anbinden

Konto anlegen, API-Schlüssel kopieren, den ersten Abruf senden. Voraussetzung ist ein Tarif mit API-Zugang.