PulseAPI-Dokumentation

PulseAPI überwacht Ihre API-Endpunkte und benachrichtigt Sie, wenn etwas schiefläuft. Diese Dokumentation behandelt Einrichtung, REST-API und Kernkonzepte.

Erste Schritte

Monitoring in unter 5 Minuten einrichten.

API-Referenz

Vollständige REST-API mit curl-Beispielen.

Framework-Guides

Copy-paste Health-Endpoint-Code für Next.js, Django, Rails, FastAPI, Express, Laravel, NestJS, Spring Boot und TanStack Query.

Headless API

Eigene Status-UI auf Basis unserer Public REST + SSE. React, Vue, reines HTML — beliebiges Frontend.

Kernkonzepte

Endpunkte

URLs, die Sie überwachen möchten. Jeder Endpunkt wird in einem konfigurierbaren Intervall (1 Min. bis 1 Stunde) per HTTP geprüft.

Pruefungen

Einzelne Überwachungsprüfungen. Jeder Check zeichnet Statuscode, Antwortzeit und optionale Assertionsergebnisse auf.

Alarme

Werden automatisch nach 2+ aufeinanderfolgenden Fehlern ausgelöst. Wiederherstellungsalarme werden gesendet, wenn der Endpunkt zurückkehrt. Alarme bei langsamer Antwort sind auf 1/Stunde begrenzt.

Statusseiten

Öffentliche Seiten, die Endpunkt-Gesundheit, Verfügbarkeitsbalken und Vorfälle anzeigen. Unterstützen benutzerdefinierte Domains und Branding.

Vorfälle

Verfolgen Sie Ausfälle mit Zeitleisten-Updates, Schweregrade und Postmortems. Abonnenten werden automatisch benachrichtigt.

Basis-URL

https://api.pulseapi.tech

Alle API-Endpunkte sind relativ zu dieser Basis-URL.

Public Endpoints (ohne Auth)

Diese Endpoints liefern dieselben Daten, die Kunden auf der gehosteten Statusseite sehen. Sicher im Browser aufrufbar; ideal, um den Status in eigene App, README oder Docs einzubetten.

GET/status/:slugStatus-Daten

JSON mit Page-Metadaten, Overall-Status, Endpoint-Status, Uptime-Arrays, Incidents und Komponenten.

SSE/sse/status/:slugRealtime-Stream (SSE)

Server-Sent-Events-Stream — Statusänderungen, neue Incidents und Check-Ergebnisse in Echtzeit. Kein Polling.

GET/badge/:slug/uptime.svgEinbettbare Badges

Shields.io-kompatible SVG-Badges für Uptime-Prozent, aktuellen Status und durchschnittliche Response-Zeit. In jedes README oder Landing einfügen.

Realtime-Beispiel

const es = new EventSource('https://api.pulseapi.tech/sse/status/acme')

es.addEventListener('status:changed', (e) => {
  const payload = JSON.parse(e.data)
  updateBanner(payload.status)
})

es.addEventListener('incident:created', (e) => {
  showNotification(JSON.parse(e.data))
})

Schnellbeispiel

# Create an API key in Dashboard > Settings > API Keys, then:

# List your endpoints
curl -H "Authorization: pk_live_abc123..." \
  https://api.pulseapi.tech/endpoints

# Create a new endpoint
curl -X POST https://api.pulseapi.tech/endpoints \
  -H "Authorization: pk_live_abc123..." \
  -H "Content-Type: application/json" \
  -d '{"name":"My API","url":"https://api.example.com/health","method":"GET","checkInterval":300,"timeout":10}'

# Check uptime stats
curl -H "Authorization: pk_live_abc123..." \
  "https://api.pulseapi.tech/endpoints/ENDPOINT_ID/stats?period=24h"

Bereit loszulegen? Lesen Sie die Erste Schritte oder springen Sie zur API-Referenz.